virtualx-engine/modules/csg/doc_classes/CSGMesh3D.xml

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

23 lines
1.6 KiB
XML
Raw Normal View History

2018-05-12 09:38:00 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
<class name="CSGMesh3D" inherits="CSGPrimitive3D" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
2018-05-12 09:38:00 +02:00
<brief_description>
A CSG Mesh shape that uses a mesh resource.
2018-05-12 09:38:00 +02:00
</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.
2018-05-12 09:38:00 +02:00
</description>
<tutorials>
<link title="Prototyping levels with CSG">$DOCS_URL/tutorials/3d/csg_tools.html</link>
2018-05-12 09:38:00 +02:00
</tutorials>
<members>
2019-07-15 20:42:47 +02:00
<member name="material" type="Material" setter="set_material" getter="get_material">
2020-01-23 07:12:52 +01:00
The [Material] used in drawing the CSG shape.
</member>
2019-07-15 20:42:47 +02:00
<member name="mesh" type="Mesh" setter="set_mesh" getter="get_mesh">
2020-01-23 07:12:52 +01:00
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.
2018-05-12 09:38:00 +02:00
</member>
</members>
</class>