Files
godot-docs/classes/class_planemesh.rst
2019-01-07 10:14:12 +01:00

74 lines
2.4 KiB
ReStructuredText

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the PlaneMesh.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_PlaneMesh:
PlaneMesh
=========
**Inherits:** :ref:`PrimitiveMesh<class_PrimitiveMesh>` **<** :ref:`Mesh<class_Mesh>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
**Category:** Core
Brief Description
-----------------
Class representing a planar :ref:`PrimitiveMesh<class_PrimitiveMesh>`.
Properties
----------
+-------------------------------+------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`size<class_PlaneMesh_property_size>` |
+-------------------------------+------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`subdivide_depth<class_PlaneMesh_property_subdivide_depth>` |
+-------------------------------+------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`subdivide_width<class_PlaneMesh_property_subdivide_width>` |
+-------------------------------+------------------------------------------------------------------+
Description
-----------
Class representing a planar :ref:`PrimitiveMesh<class_PrimitiveMesh>`. This flat mesh does not have a thickness.
Property Descriptions
---------------------
.. _class_PlaneMesh_property_size:
- :ref:`Vector2<class_Vector2>` **size**
+----------+-----------------+
| *Setter* | set_size(value) |
+----------+-----------------+
| *Getter* | get_size() |
+----------+-----------------+
Size of the generated plane. Defaults to (2.0, 2.0).
.. _class_PlaneMesh_property_subdivide_depth:
- :ref:`int<class_int>` **subdivide_depth**
+----------+----------------------------+
| *Setter* | set_subdivide_depth(value) |
+----------+----------------------------+
| *Getter* | get_subdivide_depth() |
+----------+----------------------------+
Number of subdivision along the z-axis. Defaults to 0.
.. _class_PlaneMesh_property_subdivide_width:
- :ref:`int<class_int>` **subdivide_width**
+----------+----------------------------+
| *Setter* | set_subdivide_width(value) |
+----------+----------------------------+
| *Getter* | get_subdivide_width() |
+----------+----------------------------+
Number of subdivision along the x-axis. Defaults to 0.