class_prismmesh.rst 3.7 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 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. **Category:** Core
  10. Brief 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>` |
  17. +-------------------------------+--------------------------------------------------------------------+
  18. | :ref:`Vector3<class_Vector3>` | :ref:`size<class_PrismMesh_property_size>` |
  19. +-------------------------------+--------------------------------------------------------------------+
  20. | :ref:`int<class_int>` | :ref:`subdivide_depth<class_PrismMesh_property_subdivide_depth>` |
  21. +-------------------------------+--------------------------------------------------------------------+
  22. | :ref:`int<class_int>` | :ref:`subdivide_height<class_PrismMesh_property_subdivide_height>` |
  23. +-------------------------------+--------------------------------------------------------------------+
  24. | :ref:`int<class_int>` | :ref:`subdivide_width<class_PrismMesh_property_subdivide_width>` |
  25. +-------------------------------+--------------------------------------------------------------------+
  26. Description
  27. -----------
  28. Class representing a prism-shaped :ref:`PrimitiveMesh<class_PrimitiveMesh>`.
  29. Property Descriptions
  30. ---------------------
  31. .. _class_PrismMesh_property_left_to_right:
  32. - :ref:`float<class_float>` **left_to_right**
  33. +----------+--------------------------+
  34. | *Setter* | set_left_to_right(value) |
  35. +----------+--------------------------+
  36. | *Getter* | get_left_to_right() |
  37. +----------+--------------------------+
  38. Displacement of the upper edge along the X axis. 0.0 positions edge straight above the bottom-left edge. Defaults to 0.5 (positioned on the midpoint).
  39. ----
  40. .. _class_PrismMesh_property_size:
  41. - :ref:`Vector3<class_Vector3>` **size**
  42. +----------+-----------------+
  43. | *Setter* | set_size(value) |
  44. +----------+-----------------+
  45. | *Getter* | get_size() |
  46. +----------+-----------------+
  47. Size of the prism. Defaults to (2.0, 2.0, 2.0).
  48. ----
  49. .. _class_PrismMesh_property_subdivide_depth:
  50. - :ref:`int<class_int>` **subdivide_depth**
  51. +----------+----------------------------+
  52. | *Setter* | set_subdivide_depth(value) |
  53. +----------+----------------------------+
  54. | *Getter* | get_subdivide_depth() |
  55. +----------+----------------------------+
  56. Number of added edge loops along the Z axis. Defaults to 0.
  57. ----
  58. .. _class_PrismMesh_property_subdivide_height:
  59. - :ref:`int<class_int>` **subdivide_height**
  60. +----------+-----------------------------+
  61. | *Setter* | set_subdivide_height(value) |
  62. +----------+-----------------------------+
  63. | *Getter* | get_subdivide_height() |
  64. +----------+-----------------------------+
  65. Number of added edge loops along the Y axis. Defaults to 0.
  66. ----
  67. .. _class_PrismMesh_property_subdivide_width:
  68. - :ref:`int<class_int>` **subdivide_width**
  69. +----------+----------------------------+
  70. | *Setter* | set_subdivide_width(value) |
  71. +----------+----------------------------+
  72. | *Getter* | get_subdivide_width() |
  73. +----------+----------------------------+
  74. Number of added edge loops along the X axis. Defaults to 0.