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

102 lines
3.6 KiB
ReStructuredText

.. 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>`.
Properties
----------
+-------------------------------+--------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`left_to_right<class_PrismMesh_property_left_to_right>` |
+-------------------------------+--------------------------------------------------------------------+
| :ref:`Vector3<class_Vector3>` | :ref:`size<class_PrismMesh_property_size>` |
+-------------------------------+--------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`subdivide_depth<class_PrismMesh_property_subdivide_depth>` |
+-------------------------------+--------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`subdivide_height<class_PrismMesh_property_subdivide_height>` |
+-------------------------------+--------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`subdivide_width<class_PrismMesh_property_subdivide_width>` |
+-------------------------------+--------------------------------------------------------------------+
Description
-----------
Class representing a prism-shaped :ref:`PrimitiveMesh<class_PrimitiveMesh>`.
Property Descriptions
---------------------
.. _class_PrismMesh_property_left_to_right:
- :ref:`float<class_float>` **left_to_right**
+----------+--------------------------+
| *Setter* | set_left_to_right(value) |
+----------+--------------------------+
| *Getter* | get_left_to_right() |
+----------+--------------------------+
Displacement 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_property_size:
- :ref:`Vector3<class_Vector3>` **size**
+----------+-----------------+
| *Setter* | set_size(value) |
+----------+-----------------+
| *Getter* | get_size() |
+----------+-----------------+
Size of the prism. Defaults to (2.0, 2.0, 2.0).
.. _class_PrismMesh_property_subdivide_depth:
- :ref:`int<class_int>` **subdivide_depth**
+----------+----------------------------+
| *Setter* | set_subdivide_depth(value) |
+----------+----------------------------+
| *Getter* | get_subdivide_depth() |
+----------+----------------------------+
Number of added edge loops along the z-axis. Defaults to 0.
.. _class_PrismMesh_property_subdivide_height:
- :ref:`int<class_int>` **subdivide_height**
+----------+-----------------------------+
| *Setter* | set_subdivide_height(value) |
+----------+-----------------------------+
| *Getter* | get_subdivide_height() |
+----------+-----------------------------+
Number of added edge loops along the y-axis. Defaults to 0.
.. _class_PrismMesh_property_subdivide_width:
- :ref:`int<class_int>` **subdivide_width**
+----------+----------------------------+
| *Setter* | set_subdivide_width(value) |
+----------+----------------------------+
| *Getter* | get_subdivide_width() |
+----------+----------------------------+
Number of added edge loops along the x-axis. Defaults to 0.