godot-docs/classes/class_csgtorus.rst

:github_url: hide

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

.. _class_CSGTorus:

CSGTorus
========

**Inherits:** :ref:`CSGPrimitive<class_CSGPrimitive>` **<** :ref:`CSGShape<class_CSGShape>` **<** :ref:`GeometryInstance<class_GeometryInstance>` **<** :ref:`VisualInstance<class_VisualInstance>` **<** :ref:`CullInstance<class_CullInstance>` **<** :ref:`Spatial<class_Spatial>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`

A CSG Torus shape.

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

This node allows you to create a torus for use with the CSG system.

**Note:** CSG nodes are intended to be used for level prototyping. Creating CSG nodes has a significant CPU cost compared to creating a :ref:`MeshInstance<class_MeshInstance>` with a :ref:`PrimitiveMesh<class_PrimitiveMesh>`. Moving a CSG node within another CSG node also has a significant CPU cost, so it should be avoided during gameplay.

Tutorials
---------

- `Prototyping levels with CSG <$DOCS_URL/tutorials/3d/csg_tools.html>`__

Properties
----------

+---------------------------------+-----------------------------------------------------------+----------+
| :ref:`float<class_float>`       | :ref:`inner_radius<class_CSGTorus_property_inner_radius>` | ``2.0``  |
+---------------------------------+-----------------------------------------------------------+----------+
| :ref:`Material<class_Material>` | :ref:`material<class_CSGTorus_property_material>`         |          |
+---------------------------------+-----------------------------------------------------------+----------+
| :ref:`float<class_float>`       | :ref:`outer_radius<class_CSGTorus_property_outer_radius>` | ``3.0``  |
+---------------------------------+-----------------------------------------------------------+----------+
| :ref:`int<class_int>`           | :ref:`ring_sides<class_CSGTorus_property_ring_sides>`     | ``6``    |
+---------------------------------+-----------------------------------------------------------+----------+
| :ref:`int<class_int>`           | :ref:`sides<class_CSGTorus_property_sides>`               | ``8``    |
+---------------------------------+-----------------------------------------------------------+----------+
| :ref:`bool<class_bool>`         | :ref:`smooth_faces<class_CSGTorus_property_smooth_faces>` | ``true`` |
+---------------------------------+-----------------------------------------------------------+----------+

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

.. _class_CSGTorus_property_inner_radius:

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

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

The inner radius of the torus.

----

.. _class_CSGTorus_property_material:

- :ref:`Material<class_Material>` **material**

+----------+---------------------+
| *Setter* | set_material(value) |
+----------+---------------------+
| *Getter* | get_material()      |
+----------+---------------------+

The material used to render the torus.

----

.. _class_CSGTorus_property_outer_radius:

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

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

The outer radius of the torus.

----

.. _class_CSGTorus_property_ring_sides:

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

+-----------+-----------------------+
| *Default* | ``6``                 |
+-----------+-----------------------+
| *Setter*  | set_ring_sides(value) |
+-----------+-----------------------+
| *Getter*  | get_ring_sides()      |
+-----------+-----------------------+

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

----

.. _class_CSGTorus_property_sides:

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

+-----------+------------------+
| *Default* | ``8``            |
+-----------+------------------+
| *Setter*  | set_sides(value) |
+-----------+------------------+
| *Getter*  | get_sides()      |
+-----------+------------------+

The number of slices the torus is constructed of.

----

.. _class_CSGTorus_property_smooth_faces:

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

+-----------+-------------------------+
| *Default* | ``true``                |
+-----------+-------------------------+
| *Setter*  | set_smooth_faces(value) |
+-----------+-------------------------+
| *Getter*  | get_smooth_faces()      |
+-----------+-------------------------+

If ``true`` the normals of the torus are set to give a smooth effect making the torus seem rounded. If ``false`` the torus will have a flat shaded look.

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