godot-docs/classes/class_cylindermesh.rst

:github_url: hide

.. Generated automatically by doc/tools/make_rst.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>`

Class representing a cylindrical :ref:`PrimitiveMesh<class_PrimitiveMesh>`.

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``.

Properties
----------

+---------------------------+---------------------------------------------------------------------+---------+
| :ref:`float<class_float>` | :ref:`bottom_radius<class_CylinderMesh_property_bottom_radius>`     | ``1.0`` |
+---------------------------+---------------------------------------------------------------------+---------+
| :ref:`float<class_float>` | :ref:`height<class_CylinderMesh_property_height>`                   | ``2.0`` |
+---------------------------+---------------------------------------------------------------------+---------+
| :ref:`int<class_int>`     | :ref:`radial_segments<class_CylinderMesh_property_radial_segments>` | ``64``  |
+---------------------------+---------------------------------------------------------------------+---------+
| :ref:`int<class_int>`     | :ref:`rings<class_CylinderMesh_property_rings>`                     | ``4``   |
+---------------------------+---------------------------------------------------------------------+---------+
| :ref:`float<class_float>` | :ref:`top_radius<class_CylinderMesh_property_top_radius>`           | ``1.0`` |
+---------------------------+---------------------------------------------------------------------+---------+

Property Descriptions
---------------------

.. _class_CylinderMesh_property_bottom_radius:

- :ref:`float<class_float>` **bottom_radius**

+-----------+--------------------------+
| *Default* | ``1.0``                  |
+-----------+--------------------------+
| *Setter*  | set_bottom_radius(value) |
+-----------+--------------------------+
| *Getter*  | get_bottom_radius()      |
+-----------+--------------------------+

Bottom radius of the cylinder. If set to ``0.0``, the bottom faces will not be generated, resulting in a conic shape.

----

.. _class_CylinderMesh_property_height:

- :ref:`float<class_float>` **height**

+-----------+-------------------+
| *Default* | ``2.0``           |
+-----------+-------------------+
| *Setter*  | set_height(value) |
+-----------+-------------------+
| *Getter*  | get_height()      |
+-----------+-------------------+

Full height of the cylinder.

----

.. _class_CylinderMesh_property_radial_segments:

- :ref:`int<class_int>` **radial_segments**

+-----------+----------------------------+
| *Default* | ``64``                     |
+-----------+----------------------------+
| *Setter*  | set_radial_segments(value) |
+-----------+----------------------------+
| *Getter*  | get_radial_segments()      |
+-----------+----------------------------+

Number of radial segments on the cylinder. Higher values result in a more detailed cylinder/cone at the cost of performance.

----

.. _class_CylinderMesh_property_rings:

- :ref:`int<class_int>` **rings**

+-----------+------------------+
| *Default* | ``4``            |
+-----------+------------------+
| *Setter*  | set_rings(value) |
+-----------+------------------+
| *Getter*  | get_rings()      |
+-----------+------------------+

Number of edge rings along the height of the cylinder. Changing :ref:`rings<class_CylinderMesh_property_rings>` does not have any visual impact unless a shader or procedural mesh tool is used to alter the vertex data. Higher values result in more subdivisions, which can be used to create smoother-looking effects with shaders or procedural mesh tools (at the cost of performance). When not altering the vertex data using a shader or procedural mesh tool, :ref:`rings<class_CylinderMesh_property_rings>` should be kept to its default value.

----

.. _class_CylinderMesh_property_top_radius:

- :ref:`float<class_float>` **top_radius**

+-----------+-----------------------+
| *Default* | ``1.0``               |
+-----------+-----------------------+
| *Setter*  | set_top_radius(value) |
+-----------+-----------------------+
| *Getter*  | get_top_radius()      |
+-----------+-----------------------+

Top radius of the cylinder. If set to ``0.0``, the top faces will not be generated, resulting in a conic shape.

.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`