class_cubemesh.rst 4.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the CubeMesh.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_CubeMesh:
  5. CubeMesh
  6. ========
  7. **Inherits:** :ref:`PrimitiveMesh<class_primitivemesh>` **<** :ref:`Mesh<class_mesh>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. Generate an axis-aligned cuboid :ref:`PrimitiveMesh<class_primitivemesh>`.
  12. Member Functions
  13. ----------------
  14. +--------------------------------+----------------------------------------------------------------------------------------------------------------+
  15. | :ref:`Vector3<class_vector3>` | :ref:`get_size<class_CubeMesh_get_size>` **(** **)** const |
  16. +--------------------------------+----------------------------------------------------------------------------------------------------------------+
  17. | :ref:`int<class_int>` | :ref:`get_subdivide_depth<class_CubeMesh_get_subdivide_depth>` **(** **)** const |
  18. +--------------------------------+----------------------------------------------------------------------------------------------------------------+
  19. | :ref:`int<class_int>` | :ref:`get_subdivide_height<class_CubeMesh_get_subdivide_height>` **(** **)** const |
  20. +--------------------------------+----------------------------------------------------------------------------------------------------------------+
  21. | :ref:`int<class_int>` | :ref:`get_subdivide_width<class_CubeMesh_get_subdivide_width>` **(** **)** const |
  22. +--------------------------------+----------------------------------------------------------------------------------------------------------------+
  23. | void | :ref:`set_size<class_CubeMesh_set_size>` **(** :ref:`Vector3<class_vector3>` size **)** |
  24. +--------------------------------+----------------------------------------------------------------------------------------------------------------+
  25. | void | :ref:`set_subdivide_depth<class_CubeMesh_set_subdivide_depth>` **(** :ref:`int<class_int>` divisions **)** |
  26. +--------------------------------+----------------------------------------------------------------------------------------------------------------+
  27. | void | :ref:`set_subdivide_height<class_CubeMesh_set_subdivide_height>` **(** :ref:`int<class_int>` divisions **)** |
  28. +--------------------------------+----------------------------------------------------------------------------------------------------------------+
  29. | void | :ref:`set_subdivide_width<class_CubeMesh_set_subdivide_width>` **(** :ref:`int<class_int>` subdivide **)** |
  30. +--------------------------------+----------------------------------------------------------------------------------------------------------------+
  31. Member Variables
  32. ----------------
  33. - :ref:`Vector3<class_vector3>` **size** - Size of the cuboid mesh. Defaults to (2, 2, 2).
  34. - :ref:`int<class_int>` **subdivide_depth** - Number of extra edge loops inserted along the z-axis. Defaults to 0.
  35. - :ref:`int<class_int>` **subdivide_height** - Number of extra edge loops inserted along the y-axis. Defaults to 0.
  36. - :ref:`int<class_int>` **subdivide_width** - Number of extra edge loops inserted along the x-axis. Defaults to 0.
  37. Description
  38. -----------
  39. Generate an axis-aligned cuboid :ref:`PrimitiveMesh<class_primitivemesh>`.
  40. Member Function Description
  41. ---------------------------
  42. .. _class_CubeMesh_get_size:
  43. - :ref:`Vector3<class_vector3>` **get_size** **(** **)** const
  44. .. _class_CubeMesh_get_subdivide_depth:
  45. - :ref:`int<class_int>` **get_subdivide_depth** **(** **)** const
  46. .. _class_CubeMesh_get_subdivide_height:
  47. - :ref:`int<class_int>` **get_subdivide_height** **(** **)** const
  48. .. _class_CubeMesh_get_subdivide_width:
  49. - :ref:`int<class_int>` **get_subdivide_width** **(** **)** const
  50. .. _class_CubeMesh_set_size:
  51. - void **set_size** **(** :ref:`Vector3<class_vector3>` size **)**
  52. .. _class_CubeMesh_set_subdivide_depth:
  53. - void **set_subdivide_depth** **(** :ref:`int<class_int>` divisions **)**
  54. .. _class_CubeMesh_set_subdivide_height:
  55. - void **set_subdivide_height** **(** :ref:`int<class_int>` divisions **)**
  56. .. _class_CubeMesh_set_subdivide_width:
  57. - void **set_subdivide_width** **(** :ref:`int<class_int>` subdivide **)**