class_quadmesh.rst 3.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/QuadMesh.xml.
  6. .. _class_QuadMesh:
  7. QuadMesh
  8. ========
  9. **Inherits:** :ref:`PrimitiveMesh<class_PrimitiveMesh>` **<** :ref:`Mesh<class_Mesh>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  10. Class representing a square mesh.
  11. Description
  12. -----------
  13. 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.
  14. Tutorials
  15. ---------
  16. - `GUI in 3D Demo <https://godotengine.org/asset-library/asset/127>`__
  17. - `2D in 3D Demo <https://godotengine.org/asset-library/asset/129>`__
  18. Properties
  19. ----------
  20. +-------------------------------+-------------------------------------------------------------+----------------------+
  21. | :ref:`Vector3<class_Vector3>` | :ref:`center_offset<class_QuadMesh_property_center_offset>` | ``Vector3(0, 0, 0)`` |
  22. +-------------------------------+-------------------------------------------------------------+----------------------+
  23. | :ref:`Vector2<class_Vector2>` | :ref:`size<class_QuadMesh_property_size>` | ``Vector2(1, 1)`` |
  24. +-------------------------------+-------------------------------------------------------------+----------------------+
  25. Property Descriptions
  26. ---------------------
  27. .. _class_QuadMesh_property_center_offset:
  28. - :ref:`Vector3<class_Vector3>` **center_offset**
  29. +-----------+--------------------------+
  30. | *Default* | ``Vector3(0, 0, 0)`` |
  31. +-----------+--------------------------+
  32. | *Setter* | set_center_offset(value) |
  33. +-----------+--------------------------+
  34. | *Getter* | get_center_offset() |
  35. +-----------+--------------------------+
  36. Offset of the generated Quad. Useful for particles.
  37. ----
  38. .. _class_QuadMesh_property_size:
  39. - :ref:`Vector2<class_Vector2>` **size**
  40. +-----------+-------------------+
  41. | *Default* | ``Vector2(1, 1)`` |
  42. +-----------+-------------------+
  43. | *Setter* | set_size(value) |
  44. +-----------+-------------------+
  45. | *Getter* | get_size() |
  46. +-----------+-------------------+
  47. Size on the X and Y axes.
  48. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  49. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  50. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  51. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  52. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  53. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`