| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091 |
- :github_url: hide
- .. DO NOT EDIT THIS FILE!!!
- .. Generated automatically from Godot engine sources.
- .. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py.
- .. XML source: https://github.com/godotengine/godot/tree/3.6/modules/csg/doc_classes/CSGMesh.xml.
- .. _class_CSGMesh:
- CSGMesh
- =======
- **Inherits:** :ref:`CSGPrimitive<class_CSGPrimitive>` **<** :ref:`CSGShape<class_CSGShape>` **<** :ref:`GeometryInstance<class_GeometryInstance>` **<** :ref:`VisualInstance<class_VisualInstance>` **<** :ref:`CullInstance<class_CullInstance>` **<** :ref:`Spatial<class_Spatial>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
- A CSG Mesh shape that uses a mesh resource.
- .. rst-class:: classref-introduction-group
- 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 :ref:`CSGPolygon<class_CSGPolygon>` for drawing 2D extruded polygons to be used as CSG nodes.
- \ **Note:** CSG nodes are intended to be used for level prototyping. Creating CSG nodes has a significant CPU cost compared to creating a :ref:`MeshInstance<class_MeshInstance>` with a :ref:`PrimitiveMesh<class_PrimitiveMesh>`. Moving a CSG node within another CSG node also has a significant CPU cost, so it should be avoided during gameplay.
- .. rst-class:: classref-introduction-group
- Tutorials
- ---------
- - :doc:`Prototyping levels with CSG <../tutorials/3d/csg_tools>`
- .. rst-class:: classref-reftable-group
- Properties
- ----------
- .. table::
- :widths: auto
- +---------------------------------+--------------------------------------------------+
- | :ref:`Material<class_Material>` | :ref:`material<class_CSGMesh_property_material>` |
- +---------------------------------+--------------------------------------------------+
- | :ref:`Mesh<class_Mesh>` | :ref:`mesh<class_CSGMesh_property_mesh>` |
- +---------------------------------+--------------------------------------------------+
- .. rst-class:: classref-section-separator
- ----
- .. rst-class:: classref-descriptions-group
- Property Descriptions
- ---------------------
- .. _class_CSGMesh_property_material:
- .. rst-class:: classref-property
- :ref:`Material<class_Material>` **material**
- .. rst-class:: classref-property-setget
- - void **set_material** **(** :ref:`Material<class_Material>` value **)**
- - :ref:`Material<class_Material>` **get_material** **(** **)**
- The :ref:`Material<class_Material>` used in drawing the CSG shape.
- .. rst-class:: classref-item-separator
- ----
- .. _class_CSGMesh_property_mesh:
- .. rst-class:: classref-property
- :ref:`Mesh<class_Mesh>` **mesh**
- .. rst-class:: classref-property-setget
- - void **set_mesh** **(** :ref:`Mesh<class_Mesh>` value **)**
- - :ref:`Mesh<class_Mesh>` **get_mesh** **(** **)**
- The :ref:`Mesh<class_Mesh>` resource to use as a CSG shape.
- \ **Note:** When using an :ref:`ArrayMesh<class_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.
- .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
- .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
- .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
- .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
|
