class_csgsphere.rst 3.4 KB

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