mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-03 05:48:42 +03:00
146 lines
5.6 KiB
ReStructuredText
146 lines
5.6 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
|
|
.. DO NOT EDIT THIS FILE, but the CSGTorus3D.xml source instead.
|
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
|
|
|
.. _class_CSGTorus3D:
|
|
|
|
CSGTorus3D
|
|
==========
|
|
|
|
**Inherits:** :ref:`CSGPrimitive3D<class_CSGPrimitive3D>` **<** :ref:`CSGShape3D<class_CSGShape3D>` **<** :ref:`GeometryInstance3D<class_GeometryInstance3D>` **<** :ref:`VisualInstance3D<class_VisualInstance3D>` **<** :ref:`Node3D<class_Node3D>` **<** :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:`MeshInstance3D<class_MeshInstance3D>` 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
|
|
---------
|
|
|
|
- :doc:`Prototyping levels with CSG <../tutorials/3d/csg_tools>`
|
|
|
|
Properties
|
|
----------
|
|
|
|
+---------------------------------+-------------------------------------------------------------+----------+
|
|
| :ref:`float<class_float>` | :ref:`inner_radius<class_CSGTorus3D_property_inner_radius>` | ``0.5`` |
|
|
+---------------------------------+-------------------------------------------------------------+----------+
|
|
| :ref:`Material<class_Material>` | :ref:`material<class_CSGTorus3D_property_material>` | |
|
|
+---------------------------------+-------------------------------------------------------------+----------+
|
|
| :ref:`float<class_float>` | :ref:`outer_radius<class_CSGTorus3D_property_outer_radius>` | ``1.0`` |
|
|
+---------------------------------+-------------------------------------------------------------+----------+
|
|
| :ref:`int<class_int>` | :ref:`ring_sides<class_CSGTorus3D_property_ring_sides>` | ``6`` |
|
|
+---------------------------------+-------------------------------------------------------------+----------+
|
|
| :ref:`int<class_int>` | :ref:`sides<class_CSGTorus3D_property_sides>` | ``8`` |
|
|
+---------------------------------+-------------------------------------------------------------+----------+
|
|
| :ref:`bool<class_bool>` | :ref:`smooth_faces<class_CSGTorus3D_property_smooth_faces>` | ``true`` |
|
|
+---------------------------------+-------------------------------------------------------------+----------+
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_CSGTorus3D_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_CSGTorus3D_property_material:
|
|
|
|
- :ref:`Material<class_Material>` **material**
|
|
|
|
+----------+---------------------+
|
|
| *Setter* | set_material(value) |
|
|
+----------+---------------------+
|
|
| *Getter* | get_material() |
|
|
+----------+---------------------+
|
|
|
|
The material used to render the torus.
|
|
|
|
----
|
|
|
|
.. _class_CSGTorus3D_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_CSGTorus3D_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_CSGTorus3D_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_CSGTorus3D_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.)`
|
|
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
|
|
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
|
|
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
|