class_planemesh.rst 3.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the PlaneMesh.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_PlaneMesh:
  5. PlaneMesh
  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. Class representing a planar :ref:`PrimitiveMesh<class_primitivemesh>`.
  12. Member Functions
  13. ----------------
  14. +--------------------------------+---------------------------------------------------------------------------------------------------------------+
  15. | :ref:`Vector2<class_vector2>` | :ref:`get_size<class_PlaneMesh_get_size>` **(** **)** const |
  16. +--------------------------------+---------------------------------------------------------------------------------------------------------------+
  17. | :ref:`int<class_int>` | :ref:`get_subdivide_depth<class_PlaneMesh_get_subdivide_depth>` **(** **)** const |
  18. +--------------------------------+---------------------------------------------------------------------------------------------------------------+
  19. | :ref:`int<class_int>` | :ref:`get_subdivide_width<class_PlaneMesh_get_subdivide_width>` **(** **)** const |
  20. +--------------------------------+---------------------------------------------------------------------------------------------------------------+
  21. | void | :ref:`set_size<class_PlaneMesh_set_size>` **(** :ref:`Vector2<class_vector2>` size **)** |
  22. +--------------------------------+---------------------------------------------------------------------------------------------------------------+
  23. | void | :ref:`set_subdivide_depth<class_PlaneMesh_set_subdivide_depth>` **(** :ref:`int<class_int>` subdivide **)** |
  24. +--------------------------------+---------------------------------------------------------------------------------------------------------------+
  25. | void | :ref:`set_subdivide_width<class_PlaneMesh_set_subdivide_width>` **(** :ref:`int<class_int>` subdivide **)** |
  26. +--------------------------------+---------------------------------------------------------------------------------------------------------------+
  27. Member Variables
  28. ----------------
  29. - :ref:`Vector2<class_vector2>` **size** - Size of the generated plane. Defaults to (2.0, 2.0).
  30. - :ref:`int<class_int>` **subdivide_depth** - Number of subdivision along the z-axis. Defaults to 0.
  31. - :ref:`int<class_int>` **subdivide_width** - Number of subdivision along the x-axis. Defaults to 0.
  32. Description
  33. -----------
  34. Class representing a planar :ref:`PrimitiveMesh<class_primitivemesh>`. This flat mesh does not have a thickness.
  35. Member Function Description
  36. ---------------------------
  37. .. _class_PlaneMesh_get_size:
  38. - :ref:`Vector2<class_vector2>` **get_size** **(** **)** const
  39. .. _class_PlaneMesh_get_subdivide_depth:
  40. - :ref:`int<class_int>` **get_subdivide_depth** **(** **)** const
  41. .. _class_PlaneMesh_get_subdivide_width:
  42. - :ref:`int<class_int>` **get_subdivide_width** **(** **)** const
  43. .. _class_PlaneMesh_set_size:
  44. - void **set_size** **(** :ref:`Vector2<class_vector2>` size **)**
  45. .. _class_PlaneMesh_set_subdivide_depth:
  46. - void **set_subdivide_depth** **(** :ref:`int<class_int>` subdivide **)**
  47. .. _class_PlaneMesh_set_subdivide_width:
  48. - void **set_subdivide_width** **(** :ref:`int<class_int>` subdivide **)**