.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the CapsuleMesh.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_CapsuleMesh:

CapsuleMesh
===========

**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 capsule-shaped :ref:`PrimitiveMesh<class_primitivemesh>`.

Member Functions
----------------

+----------------------------+----------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`  | :ref:`get_mid_height<class_CapsuleMesh_get_mid_height>`  **(** **)** const                                     |
+----------------------------+----------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`      | :ref:`get_radial_segments<class_CapsuleMesh_get_radial_segments>`  **(** **)** const                           |
+----------------------------+----------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`  | :ref:`get_radius<class_CapsuleMesh_get_radius>`  **(** **)** const                                             |
+----------------------------+----------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`      | :ref:`get_rings<class_CapsuleMesh_get_rings>`  **(** **)** const                                               |
+----------------------------+----------------------------------------------------------------------------------------------------------------+
| void                       | :ref:`set_mid_height<class_CapsuleMesh_set_mid_height>`  **(** :ref:`float<class_float>` mid_height  **)**     |
+----------------------------+----------------------------------------------------------------------------------------------------------------+
| void                       | :ref:`set_radial_segments<class_CapsuleMesh_set_radial_segments>`  **(** :ref:`int<class_int>` segments  **)** |
+----------------------------+----------------------------------------------------------------------------------------------------------------+
| void                       | :ref:`set_radius<class_CapsuleMesh_set_radius>`  **(** :ref:`float<class_float>` radius  **)**                 |
+----------------------------+----------------------------------------------------------------------------------------------------------------+
| void                       | :ref:`set_rings<class_CapsuleMesh_set_rings>`  **(** :ref:`int<class_int>` rings  **)**                        |
+----------------------------+----------------------------------------------------------------------------------------------------------------+

Member Variables
----------------

- :ref:`float<class_float>` **mid_height** - Height of the capsule mesh from the center point. Defaults to 1.0.
- :ref:`int<class_int>` **radial_segments** - Number of radial segments on the capsule mesh. Defaults to 64.
- :ref:`float<class_float>` **radius** - Radius of the capsule mesh. Defaults to 1.0.
- :ref:`int<class_int>` **rings** - Number of rings along the height of the capsule. Defaults to 8.

Description
-----------

Class representing a capsule-shaped :ref:`PrimitiveMesh<class_primitivemesh>`.

Member Function Description
---------------------------

.. _class_CapsuleMesh_get_mid_height:

- :ref:`float<class_float>`  **get_mid_height**  **(** **)** const

.. _class_CapsuleMesh_get_radial_segments:

- :ref:`int<class_int>`  **get_radial_segments**  **(** **)** const

.. _class_CapsuleMesh_get_radius:

- :ref:`float<class_float>`  **get_radius**  **(** **)** const

.. _class_CapsuleMesh_get_rings:

- :ref:`int<class_int>`  **get_rings**  **(** **)** const

.. _class_CapsuleMesh_set_mid_height:

- void  **set_mid_height**  **(** :ref:`float<class_float>` mid_height  **)**

.. _class_CapsuleMesh_set_radial_segments:

- void  **set_radial_segments**  **(** :ref:`int<class_int>` segments  **)**

.. _class_CapsuleMesh_set_radius:

- void  **set_radius**  **(** :ref:`float<class_float>` radius  **)**

.. _class_CapsuleMesh_set_rings:

- void  **set_rings**  **(** :ref:`int<class_int>` rings  **)**