godot-docs/classes/class_cylindermesh.rst

:github_url: hide

.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CylinderMesh.xml.

.. _class_CylinderMesh:

CylinderMesh
============

**Inherits:** :ref:`PrimitiveMesh<class_PrimitiveMesh>` **<** :ref:`Mesh<class_Mesh>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :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>`     | ``0.5``  |
+---------------------------+---------------------------------------------------------------------+----------+
| :ref:`bool<class_bool>`   | :ref:`cap_bottom<class_CylinderMesh_property_cap_bottom>`           | ``true`` |
+---------------------------+---------------------------------------------------------------------+----------+
| :ref:`bool<class_bool>`   | :ref:`cap_top<class_CylinderMesh_property_cap_top>`                 | ``true`` |
+---------------------------+---------------------------------------------------------------------+----------+
| :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>`           | ``0.5``  |
+---------------------------+---------------------------------------------------------------------+----------+

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

.. _class_CylinderMesh_property_bottom_radius:

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

+-----------+--------------------------+
| *Default* | ``0.5``                  |
+-----------+--------------------------+
| *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. See also :ref:`cap_bottom<class_CylinderMesh_property_cap_bottom>`.

----

.. _class_CylinderMesh_property_cap_bottom:

- :ref:`bool<class_bool>` **cap_bottom**

+-----------+-----------------------+
| *Default* | ``true``              |
+-----------+-----------------------+
| *Setter*  | set_cap_bottom(value) |
+-----------+-----------------------+
| *Getter*  | is_cap_bottom()       |
+-----------+-----------------------+

If ``true``, generates a cap at the bottom of the cylinder. This can be set to ``false`` to speed up generation and rendering when the cap is never seen by the camera. See also :ref:`bottom_radius<class_CylinderMesh_property_bottom_radius>`.

\ **Note:** If :ref:`bottom_radius<class_CylinderMesh_property_bottom_radius>` is ``0.0``, cap generation is always skipped even if :ref:`cap_bottom<class_CylinderMesh_property_cap_bottom>` is ``true``.

----

.. _class_CylinderMesh_property_cap_top:

- :ref:`bool<class_bool>` **cap_top**

+-----------+--------------------+
| *Default* | ``true``           |
+-----------+--------------------+
| *Setter*  | set_cap_top(value) |
+-----------+--------------------+
| *Getter*  | is_cap_top()       |
+-----------+--------------------+

If ``true``, generates a cap at the top of the cylinder. This can be set to ``false`` to speed up generation and rendering when the cap is never seen by the camera. See also :ref:`top_radius<class_CylinderMesh_property_top_radius>`.

\ **Note:** If :ref:`top_radius<class_CylinderMesh_property_top_radius>` is ``0.0``, cap generation is always skipped even if :ref:`cap_top<class_CylinderMesh_property_cap_top>` is ``true``.

----

.. _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* | ``0.5``               |
+-----------+-----------------------+
| *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. See also :ref:`cap_top<class_CylinderMesh_property_cap_top>`.

.. |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.)`
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`