class_csgmesh.rst 2.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the CSGMesh.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_CSGMesh:
  6. CSGMesh
  7. =======
  8. **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>`
  9. A CSG Mesh shape that uses a mesh resource.
  10. Description
  11. -----------
  12. 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.
  13. Properties
  14. ----------
  15. +---------------------------------+--------------------------------------------------+
  16. | :ref:`Material<class_Material>` | :ref:`material<class_CSGMesh_property_material>` |
  17. +---------------------------------+--------------------------------------------------+
  18. | :ref:`Mesh<class_Mesh>` | :ref:`mesh<class_CSGMesh_property_mesh>` |
  19. +---------------------------------+--------------------------------------------------+
  20. Property Descriptions
  21. ---------------------
  22. .. _class_CSGMesh_property_material:
  23. - :ref:`Material<class_Material>` **material**
  24. +----------+---------------------+
  25. | *Setter* | set_material(value) |
  26. +----------+---------------------+
  27. | *Getter* | get_material() |
  28. +----------+---------------------+
  29. The :ref:`Material<class_Material>` used in drawing the CSG shape.
  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 :ref:`Mesh<class_Mesh>` resource to use as a CSG shape.
  39. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  40. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  41. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`