virtualx-engine/modules/csg/doc_classes/CSGTorus3D.xml

34 lines
1.9 KiB
XML
Raw Normal View History

2018-05-12 09:38:00 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
<class name="CSGTorus3D" inherits="CSGPrimitive3D" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
2018-05-12 09:38:00 +02:00
<brief_description>
A CSG Torus shape.
2018-05-12 09:38:00 +02:00
</brief_description>
<description>
This node allows you to create a torus for use with the CSG system.
[b]Note:[/b] CSG nodes are intended to be used for level prototyping. Creating CSG nodes has a significant CPU cost compared to creating a [MeshInstance3D] with a [PrimitiveMesh]. Moving a CSG node within another CSG node also has a significant CPU cost, so it should be avoided during gameplay.
2018-05-12 09:38:00 +02:00
</description>
<tutorials>
<link title="Prototyping levels with CSG">$DOCS_URL/tutorials/3d/csg_tools.html</link>
2018-05-12 09:38:00 +02:00
</tutorials>
<members>
<member name="inner_radius" type="float" setter="set_inner_radius" getter="get_inner_radius" default="0.5">
The inner radius of the torus.
2018-05-12 09:38:00 +02:00
</member>
2019-07-15 20:42:47 +02:00
<member name="material" type="Material" setter="set_material" getter="get_material">
The material used to render the torus.
2018-05-12 09:38:00 +02:00
</member>
<member name="outer_radius" type="float" setter="set_outer_radius" getter="get_outer_radius" default="1.0">
The outer radius of the torus.
2018-05-12 09:38:00 +02:00
</member>
<member name="ring_sides" type="int" setter="set_ring_sides" getter="get_ring_sides" default="6">
The number of edges each ring of the torus is constructed of.
2018-05-12 09:38:00 +02:00
</member>
<member name="sides" type="int" setter="set_sides" getter="get_sides" default="8">
The number of slices the torus is constructed of.
2018-05-12 09:38:00 +02:00
</member>
<member name="smooth_faces" type="bool" setter="set_smooth_faces" getter="get_smooth_faces" default="true">
2019-04-17 13:42:56 +02:00
If [code]true[/code] the normals of the torus are set to give a smooth effect making the torus seem rounded. If [code]false[/code] the torus will have a flat shaded look.
2018-05-12 09:38:00 +02:00
</member>
</members>
</class>