mirror of
https://github.com/stan220/godot-docs.git
synced 2026-09-08 18:29:11 +00:00
117 lines
5.8 KiB
ReStructuredText
117 lines
5.8 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>`.
|
|
|
|
Member Functions
|
|
----------------
|
|
|
|
+--------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`float<class_float>` | :ref:`get_left_to_right<class_PrismMesh_get_left_to_right>` **(** **)** const |
|
|
+--------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Vector3<class_vector3>` | :ref:`get_size<class_PrismMesh_get_size>` **(** **)** const |
|
|
+--------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`get_subdivide_depth<class_PrismMesh_get_subdivide_depth>` **(** **)** const |
|
|
+--------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`get_subdivide_height<class_PrismMesh_get_subdivide_height>` **(** **)** const |
|
|
+--------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`get_subdivide_width<class_PrismMesh_get_subdivide_width>` **(** **)** const |
|
|
+--------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_left_to_right<class_PrismMesh_set_left_to_right>` **(** :ref:`float<class_float>` left_to_right **)** |
|
|
+--------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_size<class_PrismMesh_set_size>` **(** :ref:`Vector3<class_vector3>` size **)** |
|
|
+--------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_subdivide_depth<class_PrismMesh_set_subdivide_depth>` **(** :ref:`int<class_int>` segments **)** |
|
|
+--------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_subdivide_height<class_PrismMesh_set_subdivide_height>` **(** :ref:`int<class_int>` segments **)** |
|
|
+--------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_subdivide_width<class_PrismMesh_set_subdivide_width>` **(** :ref:`int<class_int>` segments **)** |
|
|
+--------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
|
|
|
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>`.
|
|
|
|
Member Function Description
|
|
---------------------------
|
|
|
|
.. _class_PrismMesh_get_left_to_right:
|
|
|
|
- :ref:`float<class_float>` **get_left_to_right** **(** **)** const
|
|
|
|
.. _class_PrismMesh_get_size:
|
|
|
|
- :ref:`Vector3<class_vector3>` **get_size** **(** **)** const
|
|
|
|
.. _class_PrismMesh_get_subdivide_depth:
|
|
|
|
- :ref:`int<class_int>` **get_subdivide_depth** **(** **)** const
|
|
|
|
.. _class_PrismMesh_get_subdivide_height:
|
|
|
|
- :ref:`int<class_int>` **get_subdivide_height** **(** **)** const
|
|
|
|
.. _class_PrismMesh_get_subdivide_width:
|
|
|
|
- :ref:`int<class_int>` **get_subdivide_width** **(** **)** const
|
|
|
|
.. _class_PrismMesh_set_left_to_right:
|
|
|
|
- void **set_left_to_right** **(** :ref:`float<class_float>` left_to_right **)**
|
|
|
|
.. _class_PrismMesh_set_size:
|
|
|
|
- void **set_size** **(** :ref:`Vector3<class_vector3>` size **)**
|
|
|
|
.. _class_PrismMesh_set_subdivide_depth:
|
|
|
|
- void **set_subdivide_depth** **(** :ref:`int<class_int>` segments **)**
|
|
|
|
.. _class_PrismMesh_set_subdivide_height:
|
|
|
|
- void **set_subdivide_height** **(** :ref:`int<class_int>` segments **)**
|
|
|
|
.. _class_PrismMesh_set_subdivide_width:
|
|
|
|
- void **set_subdivide_width** **(** :ref:`int<class_int>` segments **)**
|
|
|
|
|