godotengine/godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #57752 from Calinou/doc-csg-nodes-performance

Browse Source
This commit is contained in:
Rémi Verschelde 2022-02-07 18:27:58 +01:00 committed by GitHub
commit 05bad19a9a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
9 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
modules/csg/doc_classes/CSGBox3D.xml
View File

@ -5,8 +5,10 @@
</brief_description> </brief_description>
<description> <description>
This node allows you to create a box for use with the CSG system. This node allows you to create a box 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.
</description> </description>
<tutorials> <tutorials>
<link title="Prototyping levels with CSG">$DOCS_URL/tutorials/3d/csg_tools.html</link>
</tutorials> </tutorials>
<members> <members>
<member name="material" type="Material" setter="set_material" getter="get_material"> <member name="material" type="Material" setter="set_material" getter="get_material">

2
modules/csg/doc_classes/CSGCombiner3D.xml
View File

@ -5,7 +5,9 @@
</brief_description> </brief_description>
<description> <description>
For complex arrangements of shapes, it is sometimes needed to add structure to your CSG nodes. The CSGCombiner3D node allows you to create this structure. The node encapsulates the result of the CSG operations of its children. In this way, it is possible to do operations on one set of shapes that are children of one CSGCombiner3D node, and a set of separate operations on a second set of shapes that are children of a second CSGCombiner3D node, and then do an operation that takes the two end results as its input to create the final shape. For complex arrangements of shapes, it is sometimes needed to add structure to your CSG nodes. The CSGCombiner3D node allows you to create this structure. The node encapsulates the result of the CSG operations of its children. In this way, it is possible to do operations on one set of shapes that are children of one CSGCombiner3D node, and a set of separate operations on a second set of shapes that are children of a second CSGCombiner3D node, and then do an operation that takes the two end results as its input to create the final shape.
[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.
</description> </description>
<tutorials> <tutorials>
<link title="Prototyping levels with CSG">$DOCS_URL/tutorials/3d/csg_tools.html</link>
</tutorials> </tutorials>
</class> </class>

2
modules/csg/doc_classes/CSGCylinder3D.xml
View File

@ -5,8 +5,10 @@
</brief_description> </brief_description>
<description> <description>
This node allows you to create a cylinder (or cone) for use with the CSG system. This node allows you to create a cylinder (or cone) 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.
</description> </description>
<tutorials> <tutorials>
<link title="Prototyping levels with CSG">$DOCS_URL/tutorials/3d/csg_tools.html</link>
</tutorials> </tutorials>
<members> <members>
<member name="cone" type="bool" setter="set_cone" getter="is_cone" default="false"> <member name="cone" type="bool" setter="set_cone" getter="is_cone" default="false">

2
modules/csg/doc_classes/CSGMesh3D.xml
View File

@ -5,8 +5,10 @@
</brief_description> </brief_description>
<description> <description>
This CSG node allows you to use any mesh resource as a CSG shape, provided it is closed, does not self-intersect, does not contain internal faces and has no edges that connect to more than two faces. See also [CSGPolygon3D] for drawing 2D extruded polygons to be used as CSG nodes. This CSG node allows you to use any mesh resource as a CSG shape, provided it is closed, does not self-intersect, does not contain internal faces and has no edges that connect to more than two faces. See also [CSGPolygon3D] for drawing 2D extruded polygons to be used as CSG nodes.
[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.
</description> </description>
<tutorials> <tutorials>
<link title="Prototyping levels with CSG">$DOCS_URL/tutorials/3d/csg_tools.html</link>
</tutorials> </tutorials>
<members> <members>
<member name="material" type="Material" setter="set_material" getter="get_material"> <member name="material" type="Material" setter="set_material" getter="get_material">

2
modules/csg/doc_classes/CSGPolygon3D.xml
View File

@ -5,8 +5,10 @@
</brief_description> </brief_description>
<description> <description>
An array of 2D points is extruded to quickly and easily create a variety of 3D meshes. See also [CSGMesh3D] for using 3D meshes as CSG nodes. An array of 2D points is extruded to quickly and easily create a variety of 3D meshes. See also [CSGMesh3D] for using 3D meshes as CSG nodes.
[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.
</description> </description>
<tutorials> <tutorials>
<link title="Prototyping levels with CSG">$DOCS_URL/tutorials/3d/csg_tools.html</link>
</tutorials> </tutorials>
<members> <members>
<member name="depth" type="float" setter="set_depth" getter="get_depth" default="1.0"> <member name="depth" type="float" setter="set_depth" getter="get_depth" default="1.0">

2
modules/csg/doc_classes/CSGPrimitive3D.xml
View File

@ -5,8 +5,10 @@
</brief_description> </brief_description>
<description> <description>
Parent class for various CSG primitives. It contains code and functionality that is common between them. It cannot be used directly. Instead use one of the various classes that inherit from it. Parent class for various CSG primitives. It contains code and functionality that is common between them. It cannot be used directly. Instead use one of the various classes that inherit from it.
[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.
</description> </description>
<tutorials> <tutorials>
<link title="Prototyping levels with CSG">$DOCS_URL/tutorials/3d/csg_tools.html</link>
</tutorials> </tutorials>
<members> <members>
<member name="invert_faces" type="bool" setter="set_invert_faces" getter="is_inverting_faces" default="false"> <member name="invert_faces" type="bool" setter="set_invert_faces" getter="is_inverting_faces" default="false">

2
modules/csg/doc_classes/CSGShape3D.xml
View File

@ -5,8 +5,10 @@
</brief_description> </brief_description>
<description> <description>
This is the CSG base class that provides CSG operation support to the various CSG nodes in Godot. This is the CSG base class that provides CSG operation support to the various CSG nodes in Godot.
[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.
</description> </description>
<tutorials> <tutorials>
<link title="Prototyping levels with CSG">$DOCS_URL/tutorials/3d/csg_tools.html</link>
</tutorials> </tutorials>
<methods> <methods>
<method name="get_collision_layer_value" qualifiers="const"> <method name="get_collision_layer_value" qualifiers="const">

2
modules/csg/doc_classes/CSGSphere3D.xml
View File

@ -5,8 +5,10 @@
</brief_description> </brief_description>
<description> <description>
This node allows you to create a sphere for use with the CSG system. This node allows you to create a sphere 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.
</description> </description>
<tutorials> <tutorials>
<link title="Prototyping levels with CSG">$DOCS_URL/tutorials/3d/csg_tools.html</link>
</tutorials> </tutorials>
<members> <members>
<member name="material" type="Material" setter="set_material" getter="get_material"> <member name="material" type="Material" setter="set_material" getter="get_material">

2
modules/csg/doc_classes/CSGTorus3D.xml
View File

@ -5,8 +5,10 @@
</brief_description> </brief_description>
<description> <description>
This node allows you to create a torus for use with the CSG system. 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.
</description> </description>
<tutorials> <tutorials>
<link title="Prototyping levels with CSG">$DOCS_URL/tutorials/3d/csg_tools.html</link>
</tutorials> </tutorials>
<members> <members>
<member name="inner_radius" type="float" setter="set_inner_radius" getter="get_inner_radius" default="0.5"> <member name="inner_radius" type="float" setter="set_inner_radius" getter="get_inner_radius" default="0.5">