godot/doc/classes/PlaneMesh.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="PlaneMesh" inherits="PrimitiveMesh" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		Class representing a planar [PrimitiveMesh].
	</brief_description>
	<description>
		Class representing a planar [PrimitiveMesh]. This flat mesh does not have a thickness. By default, this mesh is aligned on the X and Z axes; this default rotation isn't suited for use with billboarded materials. For billboarded materials, change [member orientation] to [constant FACE_Z].
		[b]Note:[/b] When using a large textured [PlaneMesh] (e.g. as a floor), you may stumble upon UV jittering issues depending on the camera angle. To solve this, increase [member subdivide_depth] and [member subdivide_width] until you no longer notice UV jittering.
	</description>
	<tutorials>
	</tutorials>
	<members>
		<member name="center_offset" type="Vector3" setter="set_center_offset" getter="get_center_offset" default="Vector3(0, 0, 0)">
			Offset of the generated plane. Useful for particles.
		</member>
		<member name="orientation" type="int" setter="set_orientation" getter="get_orientation" enum="PlaneMesh.Orientation" default="1">
			Direction that the [PlaneMesh] is facing. See [enum Orientation] for options.
		</member>
		<member name="size" type="Vector2" setter="set_size" getter="get_size" default="Vector2(2, 2)">
			Size of the generated plane.
		</member>
		<member name="subdivide_depth" type="int" setter="set_subdivide_depth" getter="get_subdivide_depth" default="0">
			Number of subdivision along the Z axis.
		</member>
		<member name="subdivide_width" type="int" setter="set_subdivide_width" getter="get_subdivide_width" default="0">
			Number of subdivision along the X axis.
		</member>
	</members>
	<constants>
		<constant name="FACE_X" value="0" enum="Orientation">
			[PlaneMesh] will face the positive X-axis.
		</constant>
		<constant name="FACE_Y" value="1" enum="Orientation">
			[PlaneMesh] will face the positive Y-axis. This matches the behavior of the [PlaneMesh] in Godot 3.x.
		</constant>
		<constant name="FACE_Z" value="2" enum="Orientation">
			[PlaneMesh] will face the positive Z-axis. This matches the behavior of the QuadMesh in Godot 3.x.
		</constant>
	</constants>
</class>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`<?xml version="1.0" encoding="UTF-8" ?>`
Bump version to 4.1-dev Can't stop, won't stop, they said, huh? 2023-03-01 08:44:37 +08:00			`<class name="PlaneMesh" inherits="PrimitiveMesh" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`<brief_description>`
			`Class representing a planar [PrimitiveMesh].`
			`</brief_description>`
			`<description>`
Remove QuadMesh and add orientation parameter to PlaneMesh 2022-08-24 05:15:40 +08:00			`Class representing a planar [PrimitiveMesh]. This flat mesh does not have a thickness. By default, this mesh is aligned on the X and Z axes; this default rotation isn't suited for use with billboarded materials. For billboarded materials, change [member orientation] to [constant FACE_Z].`
Document how to solve UV jittering when using large procedural meshes 2020-12-20 01:16:52 +08:00			`[b]Note:[/b] When using a large textured [PlaneMesh] (e.g. as a floor), you may stumble upon UV jittering issues depending on the camera angle. To solve this, increase [member subdivide_depth] and [member subdivide_width] until you no longer notice UV jittering.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</description>`
			`<tutorials>`
			`</tutorials>`
			`<members>`
added offset for plane mesh and quad mesh 2021-05-16 20:20:24 +08:00			`<member name="center_offset" type="Vector3" setter="set_center_offset" getter="get_center_offset" default="Vector3(0, 0, 0)">`
			`Offset of the generated plane. Useful for particles.`
			`</member>`
Remove QuadMesh and add orientation parameter to PlaneMesh 2022-08-24 05:15:40 +08:00			`<member name="orientation" type="int" setter="set_orientation" getter="get_orientation" enum="PlaneMesh.Orientation" default="1">`
			`Direction that the [PlaneMesh] is facing. See [enum Orientation] for options.`
			`</member>`
Better format arguments in variant parser 2019-09-25 01:45:03 +08:00			`<member name="size" type="Vector2" setter="set_size" getter="get_size" default="Vector2(2, 2)">`
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool. 2019-06-29 21:24:23 +08:00			`Size of the generated plane.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 18:38:01 +08:00			`<member name="subdivide_depth" type="int" setter="set_subdivide_depth" getter="get_subdivide_depth" default="0">`
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool. 2019-06-29 21:24:23 +08:00			`Number of subdivision along the Z axis.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 18:38:01 +08:00			`<member name="subdivide_width" type="int" setter="set_subdivide_width" getter="get_subdivide_width" default="0">`
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool. 2019-06-29 21:24:23 +08:00			`Number of subdivision along the X axis.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</member>`
			`</members>`
Remove QuadMesh and add orientation parameter to PlaneMesh 2022-08-24 05:15:40 +08:00			`<constants>`
			`<constant name="FACE_X" value="0" enum="Orientation">`
			`[PlaneMesh] will face the positive X-axis.`
			`</constant>`
			`<constant name="FACE_Y" value="1" enum="Orientation">`
Add QuadMesh back as a subclass of PlaneMesh. This simplifies the creation of billboarded meshes without any code overhead. 2022-09-17 00:54:42 +08:00			`[PlaneMesh] will face the positive Y-axis. This matches the behavior of the [PlaneMesh] in Godot 3.x.`
Remove QuadMesh and add orientation parameter to PlaneMesh 2022-08-24 05:15:40 +08:00			`</constant>`
			`<constant name="FACE_Z" value="2" enum="Orientation">`
Add QuadMesh back as a subclass of PlaneMesh. This simplifies the creation of billboarded meshes without any code overhead. 2022-09-17 00:54:42 +08:00			`[PlaneMesh] will face the positive Z-axis. This matches the behavior of the QuadMesh in Godot 3.x.`
Remove QuadMesh and add orientation parameter to PlaneMesh 2022-08-24 05:15:40 +08:00			`</constant>`
			`</constants>`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</class>`