class_cubemesh.rst 3.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697
  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 CubeMesh.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_CubeMesh:
  6. CubeMesh
  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. Generate an axis-aligned cuboid :ref:`PrimitiveMesh<class_PrimitiveMesh>`.
  13. Properties
  14. ----------
  15. +-------------------------------+-------------------------------------------------------------------+
  16. | :ref:`Vector3<class_Vector3>` | :ref:`size<class_CubeMesh_property_size>` |
  17. +-------------------------------+-------------------------------------------------------------------+
  18. | :ref:`int<class_int>` | :ref:`subdivide_depth<class_CubeMesh_property_subdivide_depth>` |
  19. +-------------------------------+-------------------------------------------------------------------+
  20. | :ref:`int<class_int>` | :ref:`subdivide_height<class_CubeMesh_property_subdivide_height>` |
  21. +-------------------------------+-------------------------------------------------------------------+
  22. | :ref:`int<class_int>` | :ref:`subdivide_width<class_CubeMesh_property_subdivide_width>` |
  23. +-------------------------------+-------------------------------------------------------------------+
  24. Description
  25. -----------
  26. Generate an axis-aligned cuboid :ref:`PrimitiveMesh<class_PrimitiveMesh>`.
  27. The cube's UV layout is arranged in a 3×2 layout that allows texturing each face individually. To apply the same texture on all faces, change the material's UV property to ``Vector3(3, 2, 1)``.
  28. Property Descriptions
  29. ---------------------
  30. .. _class_CubeMesh_property_size:
  31. - :ref:`Vector3<class_Vector3>` **size**
  32. +----------+-----------------+
  33. | *Setter* | set_size(value) |
  34. +----------+-----------------+
  35. | *Getter* | get_size() |
  36. +----------+-----------------+
  37. Size of the cuboid mesh. Defaults to (2, 2, 2).
  38. ----
  39. .. _class_CubeMesh_property_subdivide_depth:
  40. - :ref:`int<class_int>` **subdivide_depth**
  41. +----------+----------------------------+
  42. | *Setter* | set_subdivide_depth(value) |
  43. +----------+----------------------------+
  44. | *Getter* | get_subdivide_depth() |
  45. +----------+----------------------------+
  46. Number of extra edge loops inserted along the z-axis. Defaults to 0.
  47. ----
  48. .. _class_CubeMesh_property_subdivide_height:
  49. - :ref:`int<class_int>` **subdivide_height**
  50. +----------+-----------------------------+
  51. | *Setter* | set_subdivide_height(value) |
  52. +----------+-----------------------------+
  53. | *Getter* | get_subdivide_height() |
  54. +----------+-----------------------------+
  55. Number of extra edge loops inserted along the y-axis. Defaults to 0.
  56. ----
  57. .. _class_CubeMesh_property_subdivide_width:
  58. - :ref:`int<class_int>` **subdivide_width**
  59. +----------+----------------------------+
  60. | *Setter* | set_subdivide_width(value) |
  61. +----------+----------------------------+
  62. | *Getter* | get_subdivide_width() |
  63. +----------+----------------------------+
  64. Number of extra edge loops inserted along the x-axis. Defaults to 0.