class_csgtorus.rst 1.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the CSGTorus.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_CSGTorus:
  5. CSGTorus
  6. ========
  7. **Inherits:** :ref:`CSGPrimitive<class_csgprimitive>` **<** :ref:`CSGShape<class_csgshape>` **<** :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 Torus shape.
  12. Member Variables
  13. ----------------
  14. .. _class_CSGTorus_inner_radius:
  15. - :ref:`float<class_float>` **inner_radius** - The inner radius of the torus.
  16. .. _class_CSGTorus_material:
  17. - :ref:`Material<class_material>` **material** - The material used to render the torus.
  18. .. _class_CSGTorus_outer_radius:
  19. - :ref:`float<class_float>` **outer_radius** - The outer radius of the torus.
  20. .. _class_CSGTorus_ring_sides:
  21. - :ref:`int<class_int>` **ring_sides** - The number of edges each ring of the torus is constructed of.
  22. .. _class_CSGTorus_sides:
  23. - :ref:`int<class_int>` **sides** - The number of slices the torus is constructed of.
  24. .. _class_CSGTorus_smooth_faces:
  25. - :ref:`bool<class_bool>` **smooth_faces** - If true the normals of the torus are set to give a smooth effect making the torus seem rounded. When false the torus will have a flat shaded look.
  26. Description
  27. -----------
  28. This node allows you to create a torus for use with the CSG system.