:github_url: hide

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

.. _class_TorusMesh:

TorusMesh
=========

**Inherits:** :ref:`PrimitiveMesh<class_PrimitiveMesh>` **<** :ref:`Mesh<class_Mesh>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`

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

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

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

Properties
----------

+---------------------------+--------------------------------------------------------------+---------+
| :ref:`float<class_float>` | :ref:`inner_radius<class_TorusMesh_property_inner_radius>`   | ``0.5`` |
+---------------------------+--------------------------------------------------------------+---------+
| :ref:`float<class_float>` | :ref:`outer_radius<class_TorusMesh_property_outer_radius>`   | ``1.0`` |
+---------------------------+--------------------------------------------------------------+---------+
| :ref:`int<class_int>`     | :ref:`ring_segments<class_TorusMesh_property_ring_segments>` | ``32``  |
+---------------------------+--------------------------------------------------------------+---------+
| :ref:`int<class_int>`     | :ref:`rings<class_TorusMesh_property_rings>`                 | ``64``  |
+---------------------------+--------------------------------------------------------------+---------+

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

.. _class_TorusMesh_property_inner_radius:

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

+-----------+-------------------------+
| *Default* | ``0.5``                 |
+-----------+-------------------------+
| *Setter*  | set_inner_radius(value) |
+-----------+-------------------------+
| *Getter*  | get_inner_radius()      |
+-----------+-------------------------+

The inner radius of the torus.

----

.. _class_TorusMesh_property_outer_radius:

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

+-----------+-------------------------+
| *Default* | ``1.0``                 |
+-----------+-------------------------+
| *Setter*  | set_outer_radius(value) |
+-----------+-------------------------+
| *Getter*  | get_outer_radius()      |
+-----------+-------------------------+

The outer radius of the torus.

----

.. _class_TorusMesh_property_ring_segments:

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

+-----------+--------------------------+
| *Default* | ``32``                   |
+-----------+--------------------------+
| *Setter*  | set_ring_segments(value) |
+-----------+--------------------------+
| *Getter*  | get_ring_segments()      |
+-----------+--------------------------+

The number of edges each ring of the torus is constructed of.

----

.. _class_TorusMesh_property_rings:

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

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

The number of slices the torus is constructed of.

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