godot/modules/csg/doc_classes/CSGMesh3D.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="CSGMesh3D" inherits="CSGPrimitive3D" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
	<brief_description>
		A CSG Mesh shape that uses a mesh resource.
	</brief_description>
	<description>
		This CSG node allows you to use any mesh resource as a CSG shape, provided it is closed, does not self-intersect, does not contain internal faces and has no edges that connect to more than two faces. See also [CSGPolygon3D] for drawing 2D extruded polygons to be used as CSG nodes.
		[b]Note:[/b] CSG nodes are intended to be used for level prototyping. Creating CSG nodes has a significant CPU cost compared to creating a [MeshInstance3D] with a [PrimitiveMesh]. Moving a CSG node within another CSG node also has a significant CPU cost, so it should be avoided during gameplay.
	</description>
	<tutorials>
		<link title="Prototyping levels with CSG">$DOCS_URL/tutorials/3d/csg_tools.html</link>
	</tutorials>
	<members>
		<member name="material" type="Material" setter="set_material" getter="get_material">
			The [Material] used in drawing the CSG shape.
		</member>
		<member name="mesh" type="Mesh" setter="set_mesh" getter="get_mesh">
			The [Mesh] resource to use as a CSG shape.
			[b]Note:[/b] When using an [ArrayMesh], avoid meshes with vertex normals unless a flat shader is required. By default, CSGMesh will ignore the mesh's vertex normals and use a smooth shader calculated using the faces' normals. If a flat shader is required, ensure that all faces' vertex normals are parallel.
		</member>
	</members>
</class>
Sync classref with current source 2018-05-12 07:38:00 +00: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 13:18:53 +00:00			`<class name="CSGMesh3D" inherits="CSGPrimitive3D" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">`
Sync classref with current source 2018-05-12 07:38:00 +00:00			`<brief_description>`
Added some documentation for the CSG nodes 2018-07-19 09:31:12 +00:00			`A CSG Mesh shape that uses a mesh resource.`
Sync classref with current source 2018-05-12 07:38:00 +00:00			`</brief_description>`
			`<description>`
Improve CSGPolygon3D documentation - Describe why polygon triangulation usually fails in the error message. 2022-01-21 18:57:52 +00:00			`This CSG node allows you to use any mesh resource as a CSG shape, provided it is closed, does not self-intersect, does not contain internal faces and has no edges that connect to more than two faces. See also [CSGPolygon3D] for drawing 2D extruded polygons to be used as CSG nodes.`
Document performance limitations with CSG nodes, link to tutorial 2022-02-07 12:58:08 +00:00			`[b]Note:[/b] CSG nodes are intended to be used for level prototyping. Creating CSG nodes has a significant CPU cost compared to creating a [MeshInstance3D] with a [PrimitiveMesh]. Moving a CSG node within another CSG node also has a significant CPU cost, so it should be avoided during gameplay.`
Sync classref with current source 2018-05-12 07:38:00 +00:00			`</description>`
			`<tutorials>`
Document performance limitations with CSG nodes, link to tutorial 2022-02-07 12:58:08 +00:00			`<link title="Prototyping levels with CSG">$DOCS_URL/tutorials/3d/csg_tools.html</link>`
Sync classref with current source 2018-05-12 07:38:00 +00:00			`</tutorials>`
			`<members>`
doc: Sync classref with current source 2019-07-15 18:42:47 +00:00			`<member name="material" type="Material" setter="set_material" getter="get_material">`
Finish documenting CSG* and *probes 2020-01-23 06:12:52 +00:00			`The [Material] used in drawing the CSG shape.`
Added inspector plugin documentation. Fixed plugin bindings. 2019-04-23 19:39:09 +00:00			`</member>`
doc: Sync classref with current source 2019-07-15 18:42:47 +00:00			`<member name="mesh" type="Mesh" setter="set_mesh" getter="get_mesh">`
Finish documenting CSG* and *probes 2020-01-23 06:12:52 +00:00			`The [Mesh] resource to use as a CSG shape.`
Update CSGMesh3D's documentation to explain how vertex normals are used 2021-04-27 17:32:25 +00:00			`[b]Note:[/b] When using an [ArrayMesh], avoid meshes with vertex normals unless a flat shader is required. By default, CSGMesh will ignore the mesh's vertex normals and use a smooth shader calculated using the faces' normals. If a flat shader is required, ensure that all faces' vertex normals are parallel.`
Sync classref with current source 2018-05-12 07:38:00 +00:00			`</member>`
			`</members>`
			`</class>`