class_csgprimitive.rst 1.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546
  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 CSGPrimitive.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_CSGPrimitive:
  6. CSGPrimitive
  7. ============
  8. **Inherits:** :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. **Inherited By:** :ref:`CSGBox<class_CSGBox>`, :ref:`CSGCylinder<class_CSGCylinder>`, :ref:`CSGMesh<class_CSGMesh>`, :ref:`CSGPolygon<class_CSGPolygon>`, :ref:`CSGSphere<class_CSGSphere>`, :ref:`CSGTorus<class_CSGTorus>`
  10. Base class for CSG primitives.
  11. Description
  12. -----------
  13. Parent class for various CSG primitives. It contains code and functionality that is common between them. It cannot be used directly. Instead use one of the various classes that inherit from it.
  14. Properties
  15. ----------
  16. +-------------------------+---------------------------------------------------------------+-----------+
  17. | :ref:`bool<class_bool>` | :ref:`invert_faces<class_CSGPrimitive_property_invert_faces>` | ``false`` |
  18. +-------------------------+---------------------------------------------------------------+-----------+
  19. Property Descriptions
  20. ---------------------
  21. .. _class_CSGPrimitive_property_invert_faces:
  22. - :ref:`bool<class_bool>` **invert_faces**
  23. +-----------+-------------------------+
  24. | *Default* | ``false`` |
  25. +-----------+-------------------------+
  26. | *Setter* | set_invert_faces(value) |
  27. +-----------+-------------------------+
  28. | *Getter* | is_inverting_faces() |
  29. +-----------+-------------------------+
  30. Invert the faces of the mesh.