.. 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>`.

Member Functions
----------------

+--------------------------------+---------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>`  | :ref:`get_size<class_PlaneMesh_get_size>`  **(** **)** const                                                  |
+--------------------------------+---------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`          | :ref:`get_subdivide_depth<class_PlaneMesh_get_subdivide_depth>`  **(** **)** const                            |
+--------------------------------+---------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`          | :ref:`get_subdivide_width<class_PlaneMesh_get_subdivide_width>`  **(** **)** const                            |
+--------------------------------+---------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_size<class_PlaneMesh_set_size>`  **(** :ref:`Vector2<class_vector2>` size  **)**                    |
+--------------------------------+---------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_subdivide_depth<class_PlaneMesh_set_subdivide_depth>`  **(** :ref:`int<class_int>` subdivide  **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_subdivide_width<class_PlaneMesh_set_subdivide_width>`  **(** :ref:`int<class_int>` subdivide  **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------+

Member Variables
----------------

- :ref:`Vector2<class_vector2>` **size** - Size of the generated plane. Defaults to (2.0, 2.0).
- :ref:`int<class_int>` **subdivide_depth** - Number of subdivision along the z-axis. Defaults to 0.
- :ref:`int<class_int>` **subdivide_width** - Number of subdivision along the x-axis. Defaults to 0.

Description
-----------

Class representing a planar :ref:`PrimitiveMesh<class_primitivemesh>`. This flat mesh does not have a thickness.

Member Function Description
---------------------------

.. _class_PlaneMesh_get_size:

- :ref:`Vector2<class_vector2>`  **get_size**  **(** **)** const

.. _class_PlaneMesh_get_subdivide_depth:

- :ref:`int<class_int>`  **get_subdivide_depth**  **(** **)** const

.. _class_PlaneMesh_get_subdivide_width:

- :ref:`int<class_int>`  **get_subdivide_width**  **(** **)** const

.. _class_PlaneMesh_set_size:

- void  **set_size**  **(** :ref:`Vector2<class_vector2>` size  **)**

.. _class_PlaneMesh_set_subdivide_depth:

- void  **set_subdivide_depth**  **(** :ref:`int<class_int>` subdivide  **)**

.. _class_PlaneMesh_set_subdivide_width:

- void  **set_subdivide_width**  **(** :ref:`int<class_int>` subdivide  **)**