class_csgcylinder.rst 4.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127
  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 CSGCylinder.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_CSGCylinder:
  6. CSGCylinder
  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. **Category:** Core
  10. Brief Description
  11. -----------------
  12. A CSG Cylinder shape.
  13. Properties
  14. ----------
  15. +---------------------------------+--------------------------------------------------------------+-------+
  16. | :ref:`bool<class_bool>` | :ref:`cone<class_CSGCylinder_property_cone>` | false |
  17. +---------------------------------+--------------------------------------------------------------+-------+
  18. | :ref:`float<class_float>` | :ref:`height<class_CSGCylinder_property_height>` | 1.0 |
  19. +---------------------------------+--------------------------------------------------------------+-------+
  20. | :ref:`Material<class_Material>` | :ref:`material<class_CSGCylinder_property_material>` | |
  21. +---------------------------------+--------------------------------------------------------------+-------+
  22. | :ref:`float<class_float>` | :ref:`radius<class_CSGCylinder_property_radius>` | 1.0 |
  23. +---------------------------------+--------------------------------------------------------------+-------+
  24. | :ref:`int<class_int>` | :ref:`sides<class_CSGCylinder_property_sides>` | 8 |
  25. +---------------------------------+--------------------------------------------------------------+-------+
  26. | :ref:`bool<class_bool>` | :ref:`smooth_faces<class_CSGCylinder_property_smooth_faces>` | true |
  27. +---------------------------------+--------------------------------------------------------------+-------+
  28. Description
  29. -----------
  30. This node allows you to create a cylinder (or cone) for use with the CSG system.
  31. Property Descriptions
  32. ---------------------
  33. .. _class_CSGCylinder_property_cone:
  34. - :ref:`bool<class_bool>` **cone**
  35. +-----------+-----------------+
  36. | *Default* | false |
  37. +-----------+-----------------+
  38. | *Setter* | set_cone(value) |
  39. +-----------+-----------------+
  40. | *Getter* | is_cone() |
  41. +-----------+-----------------+
  42. If ``true`` a cone is created, the :ref:`radius<class_CSGCylinder_property_radius>` will only apply to one side.
  43. .. _class_CSGCylinder_property_height:
  44. - :ref:`float<class_float>` **height**
  45. +-----------+-------------------+
  46. | *Default* | 1.0 |
  47. +-----------+-------------------+
  48. | *Setter* | set_height(value) |
  49. +-----------+-------------------+
  50. | *Getter* | get_height() |
  51. +-----------+-------------------+
  52. The height of the cylinder.
  53. .. _class_CSGCylinder_property_material:
  54. - :ref:`Material<class_Material>` **material**
  55. +----------+---------------------+
  56. | *Setter* | set_material(value) |
  57. +----------+---------------------+
  58. | *Getter* | get_material() |
  59. +----------+---------------------+
  60. The material used to render the cylinder.
  61. .. _class_CSGCylinder_property_radius:
  62. - :ref:`float<class_float>` **radius**
  63. +-----------+-------------------+
  64. | *Default* | 1.0 |
  65. +-----------+-------------------+
  66. | *Setter* | set_radius(value) |
  67. +-----------+-------------------+
  68. | *Getter* | get_radius() |
  69. +-----------+-------------------+
  70. The radius of the cylinder.
  71. .. _class_CSGCylinder_property_sides:
  72. - :ref:`int<class_int>` **sides**
  73. +-----------+------------------+
  74. | *Default* | 8 |
  75. +-----------+------------------+
  76. | *Setter* | set_sides(value) |
  77. +-----------+------------------+
  78. | *Getter* | get_sides() |
  79. +-----------+------------------+
  80. The number of sides of the cylinder, the higher this number the more detail there will be in the cylinder.
  81. .. _class_CSGCylinder_property_smooth_faces:
  82. - :ref:`bool<class_bool>` **smooth_faces**
  83. +-----------+-------------------------+
  84. | *Default* | true |
  85. +-----------+-------------------------+
  86. | *Setter* | set_smooth_faces(value) |
  87. +-----------+-------------------------+
  88. | *Getter* | get_smooth_faces() |
  89. +-----------+-------------------------+
  90. If ``true`` the normals of the cylinder are set to give a smooth effect making the cylinder seem rounded. If ``false`` the cylinder will have a flat shaded look.