: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` **<** :ref:`Mesh` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` Class representing a cylindrical :ref:`PrimitiveMesh`. .. rst-class:: classref-introduction-group Description ----------- Class representing a cylindrical :ref:`PrimitiveMesh`. This class can be used to create cones by setting either the :ref:`top_radius` or :ref:`bottom_radius` properties to ``0.0``. .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +---------------------------+---------------------------------------------------------------------+----------+ | :ref:`float` | :ref:`bottom_radius` | ``0.5`` | +---------------------------+---------------------------------------------------------------------+----------+ | :ref:`bool` | :ref:`cap_bottom` | ``true`` | +---------------------------+---------------------------------------------------------------------+----------+ | :ref:`bool` | :ref:`cap_top` | ``true`` | +---------------------------+---------------------------------------------------------------------+----------+ | :ref:`float` | :ref:`height` | ``2.0`` | +---------------------------+---------------------------------------------------------------------+----------+ | :ref:`int` | :ref:`radial_segments` | ``64`` | +---------------------------+---------------------------------------------------------------------+----------+ | :ref:`int` | :ref:`rings` | ``4`` | +---------------------------+---------------------------------------------------------------------+----------+ | :ref:`float` | :ref:`top_radius` | ``0.5`` | +---------------------------+---------------------------------------------------------------------+----------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_CylinderMesh_property_bottom_radius: .. rst-class:: classref-property :ref:`float` **bottom_radius** = ``0.5`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_bottom_radius**\ (\ value\: :ref:`float`\ ) - :ref:`float` **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`. .. rst-class:: classref-item-separator ---- .. _class_CylinderMesh_property_cap_bottom: .. rst-class:: classref-property :ref:`bool` **cap_bottom** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_cap_bottom**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **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`. \ **Note:** If :ref:`bottom_radius` is ``0.0``, cap generation is always skipped even if :ref:`cap_bottom` is ``true``. .. rst-class:: classref-item-separator ---- .. _class_CylinderMesh_property_cap_top: .. rst-class:: classref-property :ref:`bool` **cap_top** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_cap_top**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **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`. \ **Note:** If :ref:`top_radius` is ``0.0``, cap generation is always skipped even if :ref:`cap_top` is ``true``. .. rst-class:: classref-item-separator ---- .. _class_CylinderMesh_property_height: .. rst-class:: classref-property :ref:`float` **height** = ``2.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_height**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_height**\ (\ ) Full height of the cylinder. .. rst-class:: classref-item-separator ---- .. _class_CylinderMesh_property_radial_segments: .. rst-class:: classref-property :ref:`int` **radial_segments** = ``64`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_radial_segments**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_radial_segments**\ (\ ) Number of radial segments on the cylinder. Higher values result in a more detailed cylinder/cone at the cost of performance. .. rst-class:: classref-item-separator ---- .. _class_CylinderMesh_property_rings: .. rst-class:: classref-property :ref:`int` **rings** = ``4`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_rings**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_rings**\ (\ ) Number of edge rings along the height of the cylinder. Changing :ref:`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` should be kept to its default value. .. rst-class:: classref-item-separator ---- .. _class_CylinderMesh_property_top_radius: .. rst-class:: classref-property :ref:`float` **top_radius** = ``0.5`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_top_radius**\ (\ value\: :ref:`float`\ ) - :ref:`float` **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`. .. |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.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` .. |void| replace:: :abbr:`void (No return value.)`