class_quadmesh.rst 2.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the QuadMesh.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_QuadMesh:
  6. QuadMesh
  7. ========
  8. **Inherits:** :ref:`PrimitiveMesh<class_PrimitiveMesh>` **<** :ref:`Mesh<class_Mesh>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. Class representing a square mesh.
  10. Description
  11. -----------
  12. Class representing a square :ref:`PrimitiveMesh<class_PrimitiveMesh>`. This flat mesh does not have a thickness. By default, this mesh is aligned on the X and Y axes; this default rotation is more suited for use with billboarded materials. Unlike :ref:`PlaneMesh<class_PlaneMesh>`, this mesh doesn't provide subdivision options.
  13. Tutorials
  14. ---------
  15. - `GUI in 3D Demo <https://godotengine.org/asset-library/asset/127>`__
  16. - `2D in 3D Demo <https://godotengine.org/asset-library/asset/129>`__
  17. Properties
  18. ----------
  19. +-------------------------------+-------------------------------------------------------------+------------------------+
  20. | :ref:`Vector3<class_Vector3>` | :ref:`center_offset<class_QuadMesh_property_center_offset>` | ``Vector3( 0, 0, 0 )`` |
  21. +-------------------------------+-------------------------------------------------------------+------------------------+
  22. | :ref:`Vector2<class_Vector2>` | :ref:`size<class_QuadMesh_property_size>` | ``Vector2( 1, 1 )`` |
  23. +-------------------------------+-------------------------------------------------------------+------------------------+
  24. Property Descriptions
  25. ---------------------
  26. .. _class_QuadMesh_property_center_offset:
  27. - :ref:`Vector3<class_Vector3>` **center_offset**
  28. +-----------+--------------------------+
  29. | *Default* | ``Vector3( 0, 0, 0 )`` |
  30. +-----------+--------------------------+
  31. | *Setter* | set_center_offset(value) |
  32. +-----------+--------------------------+
  33. | *Getter* | get_center_offset() |
  34. +-----------+--------------------------+
  35. Offset of the generated Quad. Useful for particles.
  36. ----
  37. .. _class_QuadMesh_property_size:
  38. - :ref:`Vector2<class_Vector2>` **size**
  39. +-----------+---------------------+
  40. | *Default* | ``Vector2( 1, 1 )`` |
  41. +-----------+---------------------+
  42. | *Setter* | set_size(value) |
  43. +-----------+---------------------+
  44. | *Getter* | get_size() |
  45. +-----------+---------------------+
  46. Size on the X and Y axes.
  47. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  48. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  49. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`