Files
godot-docs/classes/class_quadmesh.rst
2021-10-06 11:19:07 +02:00

76 lines
3.1 KiB
ReStructuredText

:github_url: hide
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the QuadMesh.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_QuadMesh:
QuadMesh
========
**Inherits:** :ref:`PrimitiveMesh<class_PrimitiveMesh>` **<** :ref:`Mesh<class_Mesh>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
Class representing a square mesh.
Description
-----------
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.
Tutorials
---------
- `GUI in 3D Demo <https://godotengine.org/asset-library/asset/127>`__
- `2D in 3D Demo <https://godotengine.org/asset-library/asset/129>`__
Properties
----------
+-------------------------------+-------------------------------------------------------------+----------------------+
| :ref:`Vector3<class_Vector3>` | :ref:`center_offset<class_QuadMesh_property_center_offset>` | ``Vector3(0, 0, 0)`` |
+-------------------------------+-------------------------------------------------------------+----------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`size<class_QuadMesh_property_size>` | ``Vector2(1, 1)`` |
+-------------------------------+-------------------------------------------------------------+----------------------+
Property Descriptions
---------------------
.. _class_QuadMesh_property_center_offset:
- :ref:`Vector3<class_Vector3>` **center_offset**
+-----------+--------------------------+
| *Default* | ``Vector3(0, 0, 0)`` |
+-----------+--------------------------+
| *Setter* | set_center_offset(value) |
+-----------+--------------------------+
| *Getter* | get_center_offset() |
+-----------+--------------------------+
Offset of the generated Quad. Useful for particles.
----
.. _class_QuadMesh_property_size:
- :ref:`Vector2<class_Vector2>` **size**
+-----------+-------------------+
| *Default* | ``Vector2(1, 1)`` |
+-----------+-------------------+
| *Setter* | set_size(value) |
+-----------+-------------------+
| *Getter* | get_size() |
+-----------+-------------------+
Size on the X and Y axes.
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`