class_csgsphere.rst 3.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111
  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 CSGSphere.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_CSGSphere:
  6. CSGSphere
  7. =========
  8. **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>`
  9. **Category:** Core
  10. Brief Description
  11. -----------------
  12. A CSG Sphere shape.
  13. Properties
  14. ----------
  15. +---------------------------------+------------------------------------------------------------------+
  16. | :ref:`Material<class_Material>` | :ref:`material<class_CSGSphere_property_material>` |
  17. +---------------------------------+------------------------------------------------------------------+
  18. | :ref:`int<class_int>` | :ref:`radial_segments<class_CSGSphere_property_radial_segments>` |
  19. +---------------------------------+------------------------------------------------------------------+
  20. | :ref:`float<class_float>` | :ref:`radius<class_CSGSphere_property_radius>` |
  21. +---------------------------------+------------------------------------------------------------------+
  22. | :ref:`int<class_int>` | :ref:`rings<class_CSGSphere_property_rings>` |
  23. +---------------------------------+------------------------------------------------------------------+
  24. | :ref:`bool<class_bool>` | :ref:`smooth_faces<class_CSGSphere_property_smooth_faces>` |
  25. +---------------------------------+------------------------------------------------------------------+
  26. Description
  27. -----------
  28. This node allows you to create a sphere for use with the CSG system.
  29. Property Descriptions
  30. ---------------------
  31. .. _class_CSGSphere_property_material:
  32. - :ref:`Material<class_Material>` **material**
  33. +----------+---------------------+
  34. | *Setter* | set_material(value) |
  35. +----------+---------------------+
  36. | *Getter* | get_material() |
  37. +----------+---------------------+
  38. The material used to render the sphere.
  39. ----
  40. .. _class_CSGSphere_property_radial_segments:
  41. - :ref:`int<class_int>` **radial_segments**
  42. +----------+----------------------------+
  43. | *Setter* | set_radial_segments(value) |
  44. +----------+----------------------------+
  45. | *Getter* | get_radial_segments() |
  46. +----------+----------------------------+
  47. Number of vertical slices for the sphere.
  48. ----
  49. .. _class_CSGSphere_property_radius:
  50. - :ref:`float<class_float>` **radius**
  51. +----------+-------------------+
  52. | *Setter* | set_radius(value) |
  53. +----------+-------------------+
  54. | *Getter* | get_radius() |
  55. +----------+-------------------+
  56. Radius of the sphere.
  57. ----
  58. .. _class_CSGSphere_property_rings:
  59. - :ref:`int<class_int>` **rings**
  60. +----------+------------------+
  61. | *Setter* | set_rings(value) |
  62. +----------+------------------+
  63. | *Getter* | get_rings() |
  64. +----------+------------------+
  65. Number of horizontal slices for the sphere.
  66. ----
  67. .. _class_CSGSphere_property_smooth_faces:
  68. - :ref:`bool<class_bool>` **smooth_faces**
  69. +----------+-------------------------+
  70. | *Setter* | set_smooth_faces(value) |
  71. +----------+-------------------------+
  72. | *Getter* | get_smooth_faces() |
  73. +----------+-------------------------+
  74. If ``true`` the normals of the sphere are set to give a smooth effect making the sphere seem rounded. If ``false`` the sphere will have a flat shaded look.