mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-05 22:09:56 +03:00
128 lines
4.5 KiB
ReStructuredText
128 lines
4.5 KiB
ReStructuredText
.. Generated automatically by doc/tools/makerst.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:`Spatial<class_Spatial>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
|
|
|
|
**Category:** Core
|
|
|
|
Brief Description
|
|
-----------------
|
|
|
|
A CSG Torus shape.
|
|
|
|
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>` | null |
|
|
+---------------------------------+-----------------------------------------------------------+------+
|
|
| :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 |
|
|
+---------------------------------+-----------------------------------------------------------+------+
|
|
|
|
Description
|
|
-----------
|
|
|
|
This node allows you to create a torus for use with the CSG system.
|
|
|
|
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**
|
|
|
|
+-----------+---------------------+
|
|
| *Default* | null |
|
|
+-----------+---------------------+
|
|
| *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.
|
|
|