class_cubemesh.rst 4.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100
  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. .. _class_CubeMesh_size:
  34. - :ref:`Vector3<class_vector3>` **size** - Size of the cuboid mesh. Defaults to (2, 2, 2).
  35. .. _class_CubeMesh_subdivide_depth:
  36. - :ref:`int<class_int>` **subdivide_depth** - Number of extra edge loops inserted along the z-axis. Defaults to 0.
  37. .. _class_CubeMesh_subdivide_height:
  38. - :ref:`int<class_int>` **subdivide_height** - Number of extra edge loops inserted along the y-axis. Defaults to 0.
  39. .. _class_CubeMesh_subdivide_width:
  40. - :ref:`int<class_int>` **subdivide_width** - Number of extra edge loops inserted along the x-axis. Defaults to 0.
  41. Description
  42. -----------
  43. Generate an axis-aligned cuboid :ref:`PrimitiveMesh<class_primitivemesh>`.
  44. Member Function Description
  45. ---------------------------
  46. .. _class_CubeMesh_get_size:
  47. - :ref:`Vector3<class_vector3>` **get_size** **(** **)** const
  48. .. _class_CubeMesh_get_subdivide_depth:
  49. - :ref:`int<class_int>` **get_subdivide_depth** **(** **)** const
  50. .. _class_CubeMesh_get_subdivide_height:
  51. - :ref:`int<class_int>` **get_subdivide_height** **(** **)** const
  52. .. _class_CubeMesh_get_subdivide_width:
  53. - :ref:`int<class_int>` **get_subdivide_width** **(** **)** const
  54. .. _class_CubeMesh_set_size:
  55. - void **set_size** **(** :ref:`Vector3<class_vector3>` size **)**
  56. .. _class_CubeMesh_set_subdivide_depth:
  57. - void **set_subdivide_depth** **(** :ref:`int<class_int>` divisions **)**
  58. .. _class_CubeMesh_set_subdivide_height:
  59. - void **set_subdivide_height** **(** :ref:`int<class_int>` divisions **)**
  60. .. _class_CubeMesh_set_subdivide_width:
  61. - void **set_subdivide_width** **(** :ref:`int<class_int>` subdivide **)**