class_csgmesh.rst 1.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the CSGMesh.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_CSGMesh:
  5. CSGMesh
  6. =======
  7. **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>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. A CSG Mesh shape that uses a mesh resource.
  12. Properties
  13. ----------
  14. +---------------------------------+--------------------------------------------------+
  15. | :ref:`Material<class_Material>` | :ref:`material<class_CSGMesh_property_material>` |
  16. +---------------------------------+--------------------------------------------------+
  17. | :ref:`Mesh<class_Mesh>` | :ref:`mesh<class_CSGMesh_property_mesh>` |
  18. +---------------------------------+--------------------------------------------------+
  19. Description
  20. -----------
  21. 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.
  22. Property Descriptions
  23. ---------------------
  24. .. _class_CSGMesh_property_material:
  25. - :ref:`Material<class_Material>` **material**
  26. +----------+---------------------+
  27. | *Setter* | set_material(value) |
  28. +----------+---------------------+
  29. | *Getter* | get_material() |
  30. +----------+---------------------+
  31. .. _class_CSGMesh_property_mesh:
  32. - :ref:`Mesh<class_Mesh>` **mesh**
  33. +----------+-----------------+
  34. | *Setter* | set_mesh(value) |
  35. +----------+-----------------+
  36. | *Getter* | get_mesh() |
  37. +----------+-----------------+
  38. The mesh resource to use as a CSG shape.