classref: Sync with current master branch (f87858a8f)

This commit is contained in:
Yuri Sizov
2022-12-05 20:38:58 +03:00
parent 913ff5e602
commit a7745c4cc4
843 changed files with 158186 additions and 80821 deletions
+80 -59
View File
@@ -14,6 +14,8 @@ CSGTorus3D
A CSG Torus shape.
.. rst-class:: classref-introduction-group
Description
-----------
@@ -21,120 +23,139 @@ 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.
.. rst-class:: classref-introduction-group
Tutorials
---------
- :doc:`Prototyping levels with CSG <../tutorials/3d/csg_tools>`
.. rst-class:: classref-reftable-group
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`` |
+---------------------------------+-------------------------------------------------------------+----------+
.. table::
:widths: auto
+---------------------------------+-------------------------------------------------------------+----------+
| :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`` |
+---------------------------------+-------------------------------------------------------------+----------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Property Descriptions
---------------------
.. _class_CSGTorus3D_property_inner_radius:
- :ref:`float<class_float>` **inner_radius**
.. rst-class:: classref-property
+-----------+-------------------------+
| *Default* | ``0.5`` |
+-----------+-------------------------+
| *Setter* | set_inner_radius(value) |
+-----------+-------------------------+
| *Getter* | get_inner_radius() |
+-----------+-------------------------+
: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_CSGTorus3D_property_material:
- :ref:`Material<class_Material>` **material**
.. rst-class:: classref-property
+----------+---------------------+
| *Setter* | set_material(value) |
+----------+---------------------+
| *Getter* | get_material() |
+----------+---------------------+
: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_CSGTorus3D_property_outer_radius:
- :ref:`float<class_float>` **outer_radius**
.. rst-class:: classref-property
+-----------+-------------------------+
| *Default* | ``1.0`` |
+-----------+-------------------------+
| *Setter* | set_outer_radius(value) |
+-----------+-------------------------+
| *Getter* | get_outer_radius() |
+-----------+-------------------------+
: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_CSGTorus3D_property_ring_sides:
- :ref:`int<class_int>` **ring_sides**
.. rst-class:: classref-property
+-----------+-----------------------+
| *Default* | ``6`` |
+-----------+-----------------------+
| *Setter* | set_ring_sides(value) |
+-----------+-----------------------+
| *Getter* | get_ring_sides() |
+-----------+-----------------------+
: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_CSGTorus3D_property_sides:
- :ref:`int<class_int>` **sides**
.. rst-class:: classref-property
+-----------+------------------+
| *Default* | ``8`` |
+-----------+------------------+
| *Setter* | set_sides(value) |
+-----------+------------------+
| *Getter* | get_sides() |
+-----------+------------------+
: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_CSGTorus3D_property_smooth_faces:
- :ref:`bool<class_bool>` **smooth_faces**
.. rst-class:: classref-property
+-----------+-------------------------+
| *Default* | ``true`` |
+-----------+-------------------------+
| *Setter* | set_smooth_faces(value) |
+-----------+-------------------------+
| *Getter* | get_smooth_faces() |
+-----------+-------------------------+
: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.