118 lines
3.8 KiB
ReStructuredText
118 lines
3.8 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. DO NOT EDIT THIS FILE!!!
|
|
.. Generated automatically from Godot engine sources.
|
|
.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py.
|
|
.. XML source: https://github.com/godotengine/godot/tree/3.6/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>`.
|
|
|
|
.. rst-class:: classref-introduction-group
|
|
|
|
Description
|
|
-----------
|
|
|
|
Class representing a torus :ref:`PrimitiveMesh<class_PrimitiveMesh>`.
|
|
|
|
.. rst-class:: classref-reftable-group
|
|
|
|
Properties
|
|
----------
|
|
|
|
.. table::
|
|
:widths: auto
|
|
|
|
+---------------------------+--------------------------------------------------------------+---------+
|
|
| :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`` |
|
|
+---------------------------+--------------------------------------------------------------+---------+
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_TorusMesh_property_inner_radius:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`float<class_float>` **inner_radius** = ``0.5``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_inner_radius** **(** :ref:`float<class_float>` value **)**
|
|
- :ref:`float<class_float>` **get_inner_radius** **(** **)**
|
|
|
|
The inner radius of the torus.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_TorusMesh_property_outer_radius:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`float<class_float>` **outer_radius** = ``1.0``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_outer_radius** **(** :ref:`float<class_float>` value **)**
|
|
- :ref:`float<class_float>` **get_outer_radius** **(** **)**
|
|
|
|
The outer radius of the torus.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_TorusMesh_property_ring_segments:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`int<class_int>` **ring_segments** = ``32``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_ring_segments** **(** :ref:`int<class_int>` value **)**
|
|
- :ref:`int<class_int>` **get_ring_segments** **(** **)**
|
|
|
|
The number of edges each ring of the torus is constructed of.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_TorusMesh_property_rings:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`int<class_int>` **rings** = ``64``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_rings** **(** :ref:`int<class_int>` value **)**
|
|
- :ref:`int<class_int>` **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.)`
|
|
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
|