godot-docs/classes/class_prismmesh.rst

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the PrismMesh.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_PrismMesh:

PrismMesh
=========

**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 prism-shaped :ref:`PrimitiveMesh<class_primitivemesh>`.

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

  .. _class_PrismMesh_left_to_right:

- :ref:`float<class_float>` **left_to_right** - Displacement of of the upper edge along the x-axis. 0.0 positions edge straight above the bottome left edge. Defaults to 0.5 (positioned on the midpoint).

  .. _class_PrismMesh_size:

- :ref:`Vector3<class_vector3>` **size** - Size of the prism. Defaults to (2.0, 2.0, 2.0).

  .. _class_PrismMesh_subdivide_depth:

- :ref:`int<class_int>` **subdivide_depth** - Number of added edge loops along the z-axis. Defaults to 0.

  .. _class_PrismMesh_subdivide_height:

- :ref:`int<class_int>` **subdivide_height** - Number of added edge loops along the y-axis. Defaults to 0.

  .. _class_PrismMesh_subdivide_width:

- :ref:`int<class_int>` **subdivide_width** - Number of added edge loops along the x-axis. Defaults to 0.


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

Class representing a prism-shaped :ref:`PrimitiveMesh<class_primitivemesh>`.