mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-04 14:11:02 +03:00
102 lines
5.3 KiB
ReStructuredText
102 lines
5.3 KiB
ReStructuredText
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
|
.. DO NOT EDIT THIS FILE, but the CylinderMesh.xml source instead.
|
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
|
|
|
.. _class_CylinderMesh:
|
|
|
|
CylinderMesh
|
|
============
|
|
|
|
**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 cylindrical :ref:`PrimitiveMesh<class_primitivemesh>`.
|
|
|
|
Member Functions
|
|
----------------
|
|
|
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`float<class_float>` | :ref:`get_bottom_radius<class_CylinderMesh_get_bottom_radius>` **(** **)** const |
|
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`float<class_float>` | :ref:`get_height<class_CylinderMesh_get_height>` **(** **)** const |
|
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`get_radial_segments<class_CylinderMesh_get_radial_segments>` **(** **)** const |
|
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`get_rings<class_CylinderMesh_get_rings>` **(** **)** const |
|
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`float<class_float>` | :ref:`get_top_radius<class_CylinderMesh_get_top_radius>` **(** **)** const |
|
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_bottom_radius<class_CylinderMesh_set_bottom_radius>` **(** :ref:`float<class_float>` radius **)** |
|
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_height<class_CylinderMesh_set_height>` **(** :ref:`float<class_float>` height **)** |
|
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_radial_segments<class_CylinderMesh_set_radial_segments>` **(** :ref:`int<class_int>` segments **)** |
|
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_rings<class_CylinderMesh_set_rings>` **(** :ref:`int<class_int>` rings **)** |
|
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_top_radius<class_CylinderMesh_set_top_radius>` **(** :ref:`float<class_float>` radius **)** |
|
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
|
|
|
|
Member Variables
|
|
----------------
|
|
|
|
- :ref:`float<class_float>` **bottom_radius** - Bottom radius of the cylinder. Defaults to 1.0.
|
|
- :ref:`float<class_float>` **height** - Full height of the cylinder. Defaults to 2.0.
|
|
- :ref:`int<class_int>` **radial_segments** - Number of radial segments on the cylinder. Defaults to 64.
|
|
- :ref:`int<class_int>` **rings** - Number of edge rings along the height of the cylinder. Defaults to 4.
|
|
- :ref:`float<class_float>` **top_radius** - Top radius of the cylinder. Defaults to 1.0.
|
|
|
|
Description
|
|
-----------
|
|
|
|
Class representing a cylindrical :ref:`PrimitiveMesh<class_primitivemesh>`.
|
|
|
|
Member Function Description
|
|
---------------------------
|
|
|
|
.. _class_CylinderMesh_get_bottom_radius:
|
|
|
|
- :ref:`float<class_float>` **get_bottom_radius** **(** **)** const
|
|
|
|
.. _class_CylinderMesh_get_height:
|
|
|
|
- :ref:`float<class_float>` **get_height** **(** **)** const
|
|
|
|
.. _class_CylinderMesh_get_radial_segments:
|
|
|
|
- :ref:`int<class_int>` **get_radial_segments** **(** **)** const
|
|
|
|
.. _class_CylinderMesh_get_rings:
|
|
|
|
- :ref:`int<class_int>` **get_rings** **(** **)** const
|
|
|
|
.. _class_CylinderMesh_get_top_radius:
|
|
|
|
- :ref:`float<class_float>` **get_top_radius** **(** **)** const
|
|
|
|
.. _class_CylinderMesh_set_bottom_radius:
|
|
|
|
- void **set_bottom_radius** **(** :ref:`float<class_float>` radius **)**
|
|
|
|
.. _class_CylinderMesh_set_height:
|
|
|
|
- void **set_height** **(** :ref:`float<class_float>` height **)**
|
|
|
|
.. _class_CylinderMesh_set_radial_segments:
|
|
|
|
- void **set_radial_segments** **(** :ref:`int<class_int>` segments **)**
|
|
|
|
.. _class_CylinderMesh_set_rings:
|
|
|
|
- void **set_rings** **(** :ref:`int<class_int>` rings **)**
|
|
|
|
.. _class_CylinderMesh_set_top_radius:
|
|
|
|
- void **set_top_radius** **(** :ref:`float<class_float>` radius **)**
|
|
|
|
|