godot-docs/classes/class_csgmesh.rst

:github_url: hide

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the CSGMesh.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_CSGMesh:

CSGMesh
=======

**Inherits:** :ref:`CSGPrimitive<class_CSGPrimitive>` **<** :ref:`CSGShape<class_CSGShape>` **<** :ref:`GeometryInstance<class_GeometryInstance>` **<** :ref:`VisualInstance<class_VisualInstance>` **<** :ref:`Spatial<class_Spatial>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`

**Category:** Core

Brief Description
-----------------

A CSG Mesh shape that uses a mesh resource.

Properties
----------

+---------------------------------+--------------------------------------------------+
| :ref:`Material<class_Material>` | :ref:`material<class_CSGMesh_property_material>` |
+---------------------------------+--------------------------------------------------+
| :ref:`Mesh<class_Mesh>`         | :ref:`mesh<class_CSGMesh_property_mesh>`         |
+---------------------------------+--------------------------------------------------+

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 then two faces.

Property Descriptions
---------------------

.. _class_CSGMesh_property_material:

- :ref:`Material<class_Material>` **material**

+----------+---------------------+
| *Setter* | set_material(value) |
+----------+---------------------+
| *Getter* | get_material()      |
+----------+---------------------+

.. _class_CSGMesh_property_mesh:

- :ref:`Mesh<class_Mesh>` **mesh**

+----------+-----------------+
| *Setter* | set_mesh(value) |
+----------+-----------------+
| *Getter* | get_mesh()      |
+----------+-----------------+

The mesh resource to use as a CSG shape.