godot/doc/classes/BoxMesh.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="BoxMesh" inherits="PrimitiveMesh" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		Generate an axis-aligned box [PrimitiveMesh].
	</brief_description>
	<description>
		Generate an axis-aligned box [PrimitiveMesh].
		The box's UV layout is arranged in a 3×2 layout that allows texturing each face individually. To apply the same texture on all faces, change the material's UV property to [code]Vector3(3, 2, 1)[/code].
		[b]Note:[/b] When using a large textured [BoxMesh] (e.g. as a floor), you may stumble upon UV jittering issues depending on the camera angle. To solve this, increase [member subdivide_depth], [member subdivide_height] and [member subdivide_width] until you no longer notice UV jittering.
	</description>
	<tutorials>
	</tutorials>
	<members>
		<member name="size" type="Vector3" setter="set_size" getter="get_size" default="Vector3(1, 1, 1)">
			The box's width, height and depth.
		</member>
		<member name="subdivide_depth" type="int" setter="set_subdivide_depth" getter="get_subdivide_depth" default="0">
			Number of extra edge loops inserted along the Z axis.
		</member>
		<member name="subdivide_height" type="int" setter="set_subdivide_height" getter="get_subdivide_height" default="0">
			Number of extra edge loops inserted along the Y axis.
		</member>
		<member name="subdivide_width" type="int" setter="set_subdivide_width" getter="get_subdivide_width" default="0">
			Number of extra edge loops inserted along the X axis.
		</member>
	</members>
</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" ?>
-												Add an XML schema for documentation

This makes it easier to spot syntax errors when editing the
class reference. The schema is referenced locally so validation
can still work offline.

Each class XML's schema conformance is also checked on GitHub Actions.

											
										
										
											2022-02-14 21:18:53 +08:00
+								<class name="BoxMesh" inherits="PrimitiveMesh" version="4.0" 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>
-												Rename CubeMesh BoxMesh

											
										
										
											2020-12-04 23:39:45 +08:00
+										Generate an axis-aligned box [PrimitiveMesh].
-												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>
 									<description>
-												Rename CubeMesh BoxMesh

											
										
										
											2020-12-04 23:39:45 +08:00
+										Generate an axis-aligned box [PrimitiveMesh].
 										The box's UV layout is arranged in a 3×2 layout that allows texturing each face individually. To apply the same texture on all faces, change the material's UV property to [code]Vector3(3, 2, 1)[/code].
-												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 [BoxMesh] (e.g. as a floor), you may stumble upon UV jittering issues depending on the camera angle. To solve this, increase [member subdivide_depth], [member subdivide_height] 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>
-												Improve the default size for 3D shapes (Box, Capsule, and Cylinder)

											
										
										
											2021-12-31 07:20:56 +08:00
+										<member name="size" type="Vector3" setter="set_size" getter="get_size" default="Vector3(1, 1, 1)">
-												Use Vector3 instead of 3 floats for CSGBox3D dimensions

											
										
										
											2020-12-08 02:54:12 +08:00
+											The box's width, height and depth.
-												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 extra edge loops inserted 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_height" type="int" setter="set_subdivide_height" getter="get_subdivide_height" 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 extra edge loops inserted along the Y 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 extra edge loops inserted 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>
 								</class>