165 lines
5.7 KiB
ReStructuredText
165 lines
5.7 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/modules/csg/doc_classes/CSGTorus.xml.
|
|
|
|
.. _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.
|
|
|
|
.. rst-class:: classref-introduction-group
|
|
|
|
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.
|
|
|
|
.. rst-class:: classref-introduction-group
|
|
|
|
Tutorials
|
|
---------
|
|
|
|
- :doc:`Prototyping levels with CSG <../tutorials/3d/csg_tools>`
|
|
|
|
.. rst-class:: classref-reftable-group
|
|
|
|
Properties
|
|
----------
|
|
|
|
.. table::
|
|
:widths: auto
|
|
|
|
+---------------------------------+-----------------------------------------------------------+----------+
|
|
| :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`` |
|
|
+---------------------------------+-----------------------------------------------------------+----------+
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_CSGTorus_property_inner_radius:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`float<class_float>` **inner_radius** = ``2.0``
|
|
|
|
.. 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_CSGTorus_property_material:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`Material<class_Material>` **material**
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_material** **(** :ref:`Material<class_Material>` value **)**
|
|
- :ref:`Material<class_Material>` **get_material** **(** **)**
|
|
|
|
The material used to render the torus.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_CSGTorus_property_outer_radius:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`float<class_float>` **outer_radius** = ``3.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_CSGTorus_property_ring_sides:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`int<class_int>` **ring_sides** = ``6``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_ring_sides** **(** :ref:`int<class_int>` value **)**
|
|
- :ref:`int<class_int>` **get_ring_sides** **(** **)**
|
|
|
|
The number of edges each ring of the torus is constructed of.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_CSGTorus_property_sides:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`int<class_int>` **sides** = ``8``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_sides** **(** :ref:`int<class_int>` value **)**
|
|
- :ref:`int<class_int>` **get_sides** **(** **)**
|
|
|
|
The number of slices the torus is constructed of.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_CSGTorus_property_smooth_faces:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`bool<class_bool>` **smooth_faces** = ``true``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_smooth_faces** **(** :ref:`bool<class_bool>` value **)**
|
|
- :ref:`bool<class_bool>` **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.)`
|
|
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
|