CSGTorus.xml 1.9 KB

1234567891011121314151617181920212223242526272829303132333435363738
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="CSGTorus" inherits="CSGPrimitive" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
  3. <brief_description>
  4. A CSG Torus shape.
  5. </brief_description>
  6. <description>
  7. This node allows you to create a torus for use with the CSG system.
  8. [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 [MeshInstance] with a [PrimitiveMesh]. Moving a CSG node within another CSG node also has a significant CPU cost, so it should be avoided during gameplay.
  9. </description>
  10. <tutorials>
  11. <link title="Prototyping levels with CSG">$DOCS_URL/tutorials/3d/csg_tools.html</link>
  12. </tutorials>
  13. <methods>
  14. </methods>
  15. <members>
  16. <member name="inner_radius" type="float" setter="set_inner_radius" getter="get_inner_radius" default="2.0">
  17. The inner radius of the torus.
  18. </member>
  19. <member name="material" type="Material" setter="set_material" getter="get_material">
  20. The material used to render the torus.
  21. </member>
  22. <member name="outer_radius" type="float" setter="set_outer_radius" getter="get_outer_radius" default="3.0">
  23. The outer radius of the torus.
  24. </member>
  25. <member name="ring_sides" type="int" setter="set_ring_sides" getter="get_ring_sides" default="6">
  26. The number of edges each ring of the torus is constructed of.
  27. </member>
  28. <member name="sides" type="int" setter="set_sides" getter="get_sides" default="8">
  29. The number of slices the torus is constructed of.
  30. </member>
  31. <member name="smooth_faces" type="bool" setter="set_smooth_faces" getter="get_smooth_faces" default="true">
  32. 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.
  33. </member>
  34. </members>
  35. <constants>
  36. </constants>
  37. </class>