class_prismmesh.rst 4.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the PrismMesh.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_PrismMesh:
  6. PrismMesh
  7. =========
  8. **Inherits:** :ref:`PrimitiveMesh<class_PrimitiveMesh>` **<** :ref:`Mesh<class_Mesh>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. Class representing a prism-shaped :ref:`PrimitiveMesh<class_PrimitiveMesh>`.
  10. Description
  11. -----------
  12. Class representing a prism-shaped :ref:`PrimitiveMesh<class_PrimitiveMesh>`.
  13. Properties
  14. ----------
  15. +-------------------------------+--------------------------------------------------------------------+------------------------+
  16. | :ref:`float<class_float>` | :ref:`left_to_right<class_PrismMesh_property_left_to_right>` | ``0.5`` |
  17. +-------------------------------+--------------------------------------------------------------------+------------------------+
  18. | :ref:`Vector3<class_Vector3>` | :ref:`size<class_PrismMesh_property_size>` | ``Vector3( 2, 2, 2 )`` |
  19. +-------------------------------+--------------------------------------------------------------------+------------------------+
  20. | :ref:`int<class_int>` | :ref:`subdivide_depth<class_PrismMesh_property_subdivide_depth>` | ``0`` |
  21. +-------------------------------+--------------------------------------------------------------------+------------------------+
  22. | :ref:`int<class_int>` | :ref:`subdivide_height<class_PrismMesh_property_subdivide_height>` | ``0`` |
  23. +-------------------------------+--------------------------------------------------------------------+------------------------+
  24. | :ref:`int<class_int>` | :ref:`subdivide_width<class_PrismMesh_property_subdivide_width>` | ``0`` |
  25. +-------------------------------+--------------------------------------------------------------------+------------------------+
  26. Property Descriptions
  27. ---------------------
  28. .. _class_PrismMesh_property_left_to_right:
  29. - :ref:`float<class_float>` **left_to_right**
  30. +-----------+--------------------------+
  31. | *Default* | ``0.5`` |
  32. +-----------+--------------------------+
  33. | *Setter* | set_left_to_right(value) |
  34. +-----------+--------------------------+
  35. | *Getter* | get_left_to_right() |
  36. +-----------+--------------------------+
  37. Displacement of the upper edge along the X axis. 0.0 positions edge straight above the bottom-left edge.
  38. ----
  39. .. _class_PrismMesh_property_size:
  40. - :ref:`Vector3<class_Vector3>` **size**
  41. +-----------+------------------------+
  42. | *Default* | ``Vector3( 2, 2, 2 )`` |
  43. +-----------+------------------------+
  44. | *Setter* | set_size(value) |
  45. +-----------+------------------------+
  46. | *Getter* | get_size() |
  47. +-----------+------------------------+
  48. Size of the prism.
  49. ----
  50. .. _class_PrismMesh_property_subdivide_depth:
  51. - :ref:`int<class_int>` **subdivide_depth**
  52. +-----------+----------------------------+
  53. | *Default* | ``0`` |
  54. +-----------+----------------------------+
  55. | *Setter* | set_subdivide_depth(value) |
  56. +-----------+----------------------------+
  57. | *Getter* | get_subdivide_depth() |
  58. +-----------+----------------------------+
  59. Number of added edge loops along the Z axis.
  60. ----
  61. .. _class_PrismMesh_property_subdivide_height:
  62. - :ref:`int<class_int>` **subdivide_height**
  63. +-----------+-----------------------------+
  64. | *Default* | ``0`` |
  65. +-----------+-----------------------------+
  66. | *Setter* | set_subdivide_height(value) |
  67. +-----------+-----------------------------+
  68. | *Getter* | get_subdivide_height() |
  69. +-----------+-----------------------------+
  70. Number of added edge loops along the Y axis.
  71. ----
  72. .. _class_PrismMesh_property_subdivide_width:
  73. - :ref:`int<class_int>` **subdivide_width**
  74. +-----------+----------------------------+
  75. | *Default* | ``0`` |
  76. +-----------+----------------------------+
  77. | *Setter* | set_subdivide_width(value) |
  78. +-----------+----------------------------+
  79. | *Getter* | get_subdivide_width() |
  80. +-----------+----------------------------+
  81. Number of added edge loops along the X axis.
  82. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  83. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  84. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`