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

36 lines
1.4 KiB
XML
Raw Normal View History

2018-05-12 09:38:00 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
2021-11-05 15:02:42 +01:00
<class name="CSGTorus" inherits="CSGPrimitive" version="3.5">
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.
2018-05-12 09:38:00 +02:00
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<members>
<member name="inner_radius" type="float" setter="set_inner_radius" getter="get_inner_radius" default="2.0">
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="3.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>
<constants>
</constants>
</class>