mirror of
https://github.com/godotengine/godot-docs.git
synced 2025-12-31 17:49:03 +03:00
102 lines
3.6 KiB
ReStructuredText
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 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>`.
|
|
|
|
Properties
|
|
----------
|
|
|
|
+---------------------------+---------------------------------------------------------------------+
|
|
| :ref:`float<class_float>` | :ref:`bottom_radius<class_CylinderMesh_property_bottom_radius>` |
|
|
+---------------------------+---------------------------------------------------------------------+
|
|
| :ref:`float<class_float>` | :ref:`height<class_CylinderMesh_property_height>` |
|
|
+---------------------------+---------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`radial_segments<class_CylinderMesh_property_radial_segments>` |
|
|
+---------------------------+---------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`rings<class_CylinderMesh_property_rings>` |
|
|
+---------------------------+---------------------------------------------------------------------+
|
|
| :ref:`float<class_float>` | :ref:`top_radius<class_CylinderMesh_property_top_radius>` |
|
|
+---------------------------+---------------------------------------------------------------------+
|
|
|
|
Description
|
|
-----------
|
|
|
|
Class representing a cylindrical :ref:`PrimitiveMesh<class_PrimitiveMesh>`. This class can be used to create cones by setting either the :ref:`top_radius<class_CylinderMesh_property_top_radius>` or :ref:`bottom_radius<class_CylinderMesh_property_bottom_radius>` properties to 0.0.
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_CylinderMesh_property_bottom_radius:
|
|
|
|
- :ref:`float<class_float>` **bottom_radius**
|
|
|
|
+----------+--------------------------+
|
|
| *Setter* | set_bottom_radius(value) |
|
|
+----------+--------------------------+
|
|
| *Getter* | get_bottom_radius() |
|
|
+----------+--------------------------+
|
|
|
|
Bottom radius of the cylinder. Defaults to 1.0.
|
|
|
|
.. _class_CylinderMesh_property_height:
|
|
|
|
- :ref:`float<class_float>` **height**
|
|
|
|
+----------+-------------------+
|
|
| *Setter* | set_height(value) |
|
|
+----------+-------------------+
|
|
| *Getter* | get_height() |
|
|
+----------+-------------------+
|
|
|
|
Full height of the cylinder. Defaults to 2.0.
|
|
|
|
.. _class_CylinderMesh_property_radial_segments:
|
|
|
|
- :ref:`int<class_int>` **radial_segments**
|
|
|
|
+----------+----------------------------+
|
|
| *Setter* | set_radial_segments(value) |
|
|
+----------+----------------------------+
|
|
| *Getter* | get_radial_segments() |
|
|
+----------+----------------------------+
|
|
|
|
Number of radial segments on the cylinder. Defaults to 64.
|
|
|
|
.. _class_CylinderMesh_property_rings:
|
|
|
|
- :ref:`int<class_int>` **rings**
|
|
|
|
+----------+------------------+
|
|
| *Setter* | set_rings(value) |
|
|
+----------+------------------+
|
|
| *Getter* | get_rings() |
|
|
+----------+------------------+
|
|
|
|
Number of edge rings along the height of the cylinder. Defaults to 4.
|
|
|
|
.. _class_CylinderMesh_property_top_radius:
|
|
|
|
- :ref:`float<class_float>` **top_radius**
|
|
|
|
+----------+-----------------------+
|
|
| *Setter* | set_top_radius(value) |
|
|
+----------+-----------------------+
|
|
| *Getter* | get_top_radius() |
|
|
+----------+-----------------------+
|
|
|
|
Top radius of the cylinder. Defaults to 1.0.
|
|
|