From eaaee63b629d6999fcc0c84e38886b964f6d051d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Mon, 30 Mar 2020 18:22:57 +0200 Subject: doc: Update classref with node renames A few extra renames for classes which were missed in last week's PRs. --- modules/csg/config.py | 18 +++--- modules/csg/doc_classes/CSGBox.xml | 29 --------- modules/csg/doc_classes/CSGBox3D.xml | 29 +++++++++ modules/csg/doc_classes/CSGCombiner.xml | 15 ----- modules/csg/doc_classes/CSGCombiner3D.xml | 15 +++++ modules/csg/doc_classes/CSGCylinder.xml | 35 ---------- modules/csg/doc_classes/CSGCylinder3D.xml | 35 ++++++++++ modules/csg/doc_classes/CSGMesh.xml | 23 ------- modules/csg/doc_classes/CSGMesh3D.xml | 23 +++++++ modules/csg/doc_classes/CSGPolygon.xml | 74 --------------------- modules/csg/doc_classes/CSGPolygon3D.xml | 74 +++++++++++++++++++++ modules/csg/doc_classes/CSGPrimitive.xml | 20 ------ modules/csg/doc_classes/CSGPrimitive3D.xml | 20 ++++++ modules/csg/doc_classes/CSGShape.xml | 100 ----------------------------- modules/csg/doc_classes/CSGShape3D.xml | 100 +++++++++++++++++++++++++++++ modules/csg/doc_classes/CSGSphere.xml | 32 --------- modules/csg/doc_classes/CSGSphere3D.xml | 32 +++++++++ modules/csg/doc_classes/CSGTorus.xml | 35 ---------- modules/csg/doc_classes/CSGTorus3D.xml | 35 ++++++++++ modules/csg/register_types.cpp | 9 --- 20 files changed, 372 insertions(+), 381 deletions(-) delete mode 100644 modules/csg/doc_classes/CSGBox.xml create mode 100644 modules/csg/doc_classes/CSGBox3D.xml delete mode 100644 modules/csg/doc_classes/CSGCombiner.xml create mode 100644 modules/csg/doc_classes/CSGCombiner3D.xml delete mode 100644 modules/csg/doc_classes/CSGCylinder.xml create mode 100644 modules/csg/doc_classes/CSGCylinder3D.xml delete mode 100644 modules/csg/doc_classes/CSGMesh.xml create mode 100644 modules/csg/doc_classes/CSGMesh3D.xml delete mode 100644 modules/csg/doc_classes/CSGPolygon.xml create mode 100644 modules/csg/doc_classes/CSGPolygon3D.xml delete mode 100644 modules/csg/doc_classes/CSGPrimitive.xml create mode 100644 modules/csg/doc_classes/CSGPrimitive3D.xml delete mode 100644 modules/csg/doc_classes/CSGShape.xml create mode 100644 modules/csg/doc_classes/CSGShape3D.xml delete mode 100644 modules/csg/doc_classes/CSGSphere.xml create mode 100644 modules/csg/doc_classes/CSGSphere3D.xml delete mode 100644 modules/csg/doc_classes/CSGTorus.xml create mode 100644 modules/csg/doc_classes/CSGTorus3D.xml (limited to 'modules/csg') diff --git a/modules/csg/config.py b/modules/csg/config.py index 38ccc66d91..1634cbd7b4 100644 --- a/modules/csg/config.py +++ b/modules/csg/config.py @@ -6,15 +6,15 @@ def configure(env): def get_doc_classes(): return [ - "CSGBox", - "CSGCombiner", - "CSGCylinder", - "CSGMesh", - "CSGPolygon", - "CSGPrimitive", - "CSGShape", - "CSGSphere", - "CSGTorus", + "CSGBox3D", + "CSGCombiner3D", + "CSGCylinder3D", + "CSGMesh3D", + "CSGPolygon3D", + "CSGPrimitive3D", + "CSGShape3D", + "CSGSphere3D", + "CSGTorus3D", ] def get_doc_path(): diff --git a/modules/csg/doc_classes/CSGBox.xml b/modules/csg/doc_classes/CSGBox.xml deleted file mode 100644 index e2f0f8488a..0000000000 --- a/modules/csg/doc_classes/CSGBox.xml +++ /dev/null @@ -1,29 +0,0 @@ - - - - A CSG Box shape. - - - This node allows you to create a box for use with the CSG system. - - - - - - - - Depth of the box measured from the center of the box. - - - Height of the box measured from the center of the box. - - - The material used to render the box. - - - Width of the box measured from the center of the box. - - - - - diff --git a/modules/csg/doc_classes/CSGBox3D.xml b/modules/csg/doc_classes/CSGBox3D.xml new file mode 100644 index 0000000000..492bf68c44 --- /dev/null +++ b/modules/csg/doc_classes/CSGBox3D.xml @@ -0,0 +1,29 @@ + + + + A CSG Box shape. + + + This node allows you to create a box for use with the CSG system. + + + + + + + + Depth of the box measured from the center of the box. + + + Height of the box measured from the center of the box. + + + The material used to render the box. + + + Width of the box measured from the center of the box. + + + + + diff --git a/modules/csg/doc_classes/CSGCombiner.xml b/modules/csg/doc_classes/CSGCombiner.xml deleted file mode 100644 index ab95d3c3ee..0000000000 --- a/modules/csg/doc_classes/CSGCombiner.xml +++ /dev/null @@ -1,15 +0,0 @@ - - - - A CSG node that allows you to combine other CSG modifiers. - - - For complex arrangements of shapes, it is sometimes needed to add structure to your CSG nodes. The CSGCombiner 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 CSGCombiner node, and a set of separate operations on a second set of shapes that are children of a second CSGCombiner node, and then do an operation that takes the two end results as its input to create the final shape. - - - - - - - - diff --git a/modules/csg/doc_classes/CSGCombiner3D.xml b/modules/csg/doc_classes/CSGCombiner3D.xml new file mode 100644 index 0000000000..b55111eee4 --- /dev/null +++ b/modules/csg/doc_classes/CSGCombiner3D.xml @@ -0,0 +1,15 @@ + + + + A CSG node that allows you to combine other CSG modifiers. + + + 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. + + + + + + + + diff --git a/modules/csg/doc_classes/CSGCylinder.xml b/modules/csg/doc_classes/CSGCylinder.xml deleted file mode 100644 index 2dd8c6a8d0..0000000000 --- a/modules/csg/doc_classes/CSGCylinder.xml +++ /dev/null @@ -1,35 +0,0 @@ - - - - A CSG Cylinder shape. - - - This node allows you to create a cylinder (or cone) for use with the CSG system. - - - - - - - - If [code]true[/code] a cone is created, the [member radius] will only apply to one side. - - - The height of the cylinder. - - - The material used to render the cylinder. - - - The radius of the cylinder. - - - The number of sides of the cylinder, the higher this number the more detail there will be in the cylinder. - - - If [code]true[/code] the normals of the cylinder are set to give a smooth effect making the cylinder seem rounded. If [code]false[/code] the cylinder will have a flat shaded look. - - - - - diff --git a/modules/csg/doc_classes/CSGCylinder3D.xml b/modules/csg/doc_classes/CSGCylinder3D.xml new file mode 100644 index 0000000000..bfd2a5d5f2 --- /dev/null +++ b/modules/csg/doc_classes/CSGCylinder3D.xml @@ -0,0 +1,35 @@ + + + + A CSG Cylinder shape. + + + This node allows you to create a cylinder (or cone) for use with the CSG system. + + + + + + + + If [code]true[/code] a cone is created, the [member radius] will only apply to one side. + + + The height of the cylinder. + + + The material used to render the cylinder. + + + The radius of the cylinder. + + + The number of sides of the cylinder, the higher this number the more detail there will be in the cylinder. + + + If [code]true[/code] the normals of the cylinder are set to give a smooth effect making the cylinder seem rounded. If [code]false[/code] the cylinder will have a flat shaded look. + + + + + diff --git a/modules/csg/doc_classes/CSGMesh.xml b/modules/csg/doc_classes/CSGMesh.xml deleted file mode 100644 index f1fe2c286b..0000000000 --- a/modules/csg/doc_classes/CSGMesh.xml +++ /dev/null @@ -1,23 +0,0 @@ - - - - A CSG Mesh shape that uses a mesh resource. - - - 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 then two faces. - - - - - - - - The [Material] used in drawing the CSG shape. - - - The [Mesh] resource to use as a CSG shape. - - - - - diff --git a/modules/csg/doc_classes/CSGMesh3D.xml b/modules/csg/doc_classes/CSGMesh3D.xml new file mode 100644 index 0000000000..1bab8f4ee9 --- /dev/null +++ b/modules/csg/doc_classes/CSGMesh3D.xml @@ -0,0 +1,23 @@ + + + + A CSG Mesh shape that uses a mesh resource. + + + 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 then two faces. + + + + + + + + The [Material] used in drawing the CSG shape. + + + The [Mesh] resource to use as a CSG shape. + + + + + diff --git a/modules/csg/doc_classes/CSGPolygon.xml b/modules/csg/doc_classes/CSGPolygon.xml deleted file mode 100644 index 02b2e8b03f..0000000000 --- a/modules/csg/doc_classes/CSGPolygon.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - Extrudes a 2D polygon shape to create a 3D mesh. - - - This node takes a 2D polygon shape and extrudes it to create a 3D mesh. - - - - - - - - Extrusion depth when [member mode] is [constant MODE_DEPTH]. - - - Material to use for the resulting mesh. - - - Extrusion mode. - - - If [code]true[/code] the u component of our uv will continuously increase in unison with the distance traveled along our path when [member mode] is [constant MODE_PATH]. - - - Interval at which a new extrusion slice is added along the path when [member mode] is [constant MODE_PATH]. - - - If [code]true[/code] the start and end of our path are joined together ensuring there is no seam when [member mode] is [constant MODE_PATH]. - - - If [code]false[/code] we extrude centered on our path, if [code]true[/code] we extrude in relation to the position of our CSGPolygon when [member mode] is [constant MODE_PATH]. - - - The [Shape] object containing the path along which we extrude when [member mode] is [constant MODE_PATH]. - - - The method by which each slice is rotated along the path when [member mode] is [constant MODE_PATH]. - - - Point array that defines the shape that we'll extrude. - - - Generates smooth normals so smooth shading is applied to our mesh. - - - Degrees to rotate our extrusion for each slice when [member mode] is [constant MODE_SPIN]. - - - Number of extrusion when [member mode] is [constant MODE_SPIN]. - - - - - Shape is extruded to [member depth]. - - - Shape is extruded by rotating it around an axis. - - - Shape is extruded along a path set by a [Shape] set in [member path_node]. - - - Slice is not rotated. - - - Slice is rotated around the up vector of the path. - - - Slice is rotate to match the path exactly. - - - diff --git a/modules/csg/doc_classes/CSGPolygon3D.xml b/modules/csg/doc_classes/CSGPolygon3D.xml new file mode 100644 index 0000000000..c55fa0983e --- /dev/null +++ b/modules/csg/doc_classes/CSGPolygon3D.xml @@ -0,0 +1,74 @@ + + + + Extrudes a 2D polygon shape to create a 3D mesh. + + + This node takes a 2D polygon shape and extrudes it to create a 3D mesh. + + + + + + + + Extrusion depth when [member mode] is [constant MODE_DEPTH]. + + + Material to use for the resulting mesh. + + + Extrusion mode. + + + If [code]true[/code] the u component of our uv will continuously increase in unison with the distance traveled along our path when [member mode] is [constant MODE_PATH]. + + + Interval at which a new extrusion slice is added along the path when [member mode] is [constant MODE_PATH]. + + + If [code]true[/code] the start and end of our path are joined together ensuring there is no seam when [member mode] is [constant MODE_PATH]. + + + If [code]false[/code] we extrude centered on our path, if [code]true[/code] we extrude in relation to the position of our CSGPolygon3D when [member mode] is [constant MODE_PATH]. + + + The [Shape3D] object containing the path along which we extrude when [member mode] is [constant MODE_PATH]. + + + The method by which each slice is rotated along the path when [member mode] is [constant MODE_PATH]. + + + Point array that defines the shape that we'll extrude. + + + Generates smooth normals so smooth shading is applied to our mesh. + + + Degrees to rotate our extrusion for each slice when [member mode] is [constant MODE_SPIN]. + + + Number of extrusion when [member mode] is [constant MODE_SPIN]. + + + + + Shape3D is extruded to [member depth]. + + + Shape3D is extruded by rotating it around an axis. + + + Shape3D is extruded along a path set by a [Shape3D] set in [member path_node]. + + + Slice is not rotated. + + + Slice is rotated around the up vector of the path. + + + Slice is rotate to match the path exactly. + + + diff --git a/modules/csg/doc_classes/CSGPrimitive.xml b/modules/csg/doc_classes/CSGPrimitive.xml deleted file mode 100644 index ba395b7edd..0000000000 --- a/modules/csg/doc_classes/CSGPrimitive.xml +++ /dev/null @@ -1,20 +0,0 @@ - - - - Base class for CSG primitives. - - - 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. - - - - - - - - Invert the faces of the mesh. - - - - - diff --git a/modules/csg/doc_classes/CSGPrimitive3D.xml b/modules/csg/doc_classes/CSGPrimitive3D.xml new file mode 100644 index 0000000000..31b7360fac --- /dev/null +++ b/modules/csg/doc_classes/CSGPrimitive3D.xml @@ -0,0 +1,20 @@ + + + + Base class for CSG primitives. + + + 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. + + + + + + + + Invert the faces of the mesh. + + + + + diff --git a/modules/csg/doc_classes/CSGShape.xml b/modules/csg/doc_classes/CSGShape.xml deleted file mode 100644 index 64a2fb1840..0000000000 --- a/modules/csg/doc_classes/CSGShape.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - The CSG base class. - - - This is the CSG base class that provides CSG operation support to the various CSG nodes in Godot. - - - - - - - - - - - Returns an individual bit on the collision mask. - - - - - - - - - Returns an individual bit on the collision mask. - - - - - - - Returns an [Array] with two elements, the first is the [Transform] of this node and the second is the root [Mesh] of this node. Only works when this node is the root shape. - - - - - - - Returns [code]true[/code] if this is a root shape and is thus the object that is rendered. - - - - - - - - - - - Sets individual bits on the layer mask. Use this if you only need to change one layer's value. - - - - - - - - - - - Sets individual bits on the collision mask. Use this if you only need to change one layer's value. - - - - - - Calculate tangents for the CSG shape which allows the use of normal maps. This is only applied on the root shape, this setting is ignored on any child. - - - The physics layers this area is in. - Collidable objects can exist in any of 32 different layers. These layers work like a tagging system, and are not visual. A collidable can use these layers to select with which objects it can collide, using the collision_mask property. - A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A. - - - The physics layers this CSG shape scans for collisions. - - - The operation that is performed on this shape. This is ignored for the first CSG child node as the operation is between this node and the previous child of this nodes parent. - - - Snap makes the mesh snap to a given distance so that the faces of two meshes can be perfectly aligned. A lower value results in greater precision but may be harder to adjust. - - - Adds a collision shape to the physics engine for our CSG shape. This will always act like a static body. Note that the collision shape is still active even if the CSG shape itself is hidden. - - - - - Geometry of both primitives is merged, intersecting geometry is removed. - - - Only intersecting geometry remains, the rest is removed. - - - The second shape is subtracted from the first, leaving a dent with its shape. - - - diff --git a/modules/csg/doc_classes/CSGShape3D.xml b/modules/csg/doc_classes/CSGShape3D.xml new file mode 100644 index 0000000000..43ce988c30 --- /dev/null +++ b/modules/csg/doc_classes/CSGShape3D.xml @@ -0,0 +1,100 @@ + + + + The CSG base class. + + + This is the CSG base class that provides CSG operation support to the various CSG nodes in Godot. + + + + + + + + + + + Returns an individual bit on the collision mask. + + + + + + + + + Returns an individual bit on the collision mask. + + + + + + + Returns an [Array] with two elements, the first is the [Transform] of this node and the second is the root [Mesh] of this node. Only works when this node is the root shape. + + + + + + + Returns [code]true[/code] if this is a root shape and is thus the object that is rendered. + + + + + + + + + + + Sets individual bits on the layer mask. Use this if you only need to change one layer's value. + + + + + + + + + + + Sets individual bits on the collision mask. Use this if you only need to change one layer's value. + + + + + + Calculate tangents for the CSG shape which allows the use of normal maps. This is only applied on the root shape, this setting is ignored on any child. + + + The physics layers this area is in. + Collidable objects can exist in any of 32 different layers. These layers work like a tagging system, and are not visual. A collidable can use these layers to select with which objects it can collide, using the collision_mask property. + A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A. + + + The physics layers this CSG shape scans for collisions. + + + The operation that is performed on this shape. This is ignored for the first CSG child node as the operation is between this node and the previous child of this nodes parent. + + + Snap makes the mesh snap to a given distance so that the faces of two meshes can be perfectly aligned. A lower value results in greater precision but may be harder to adjust. + + + Adds a collision shape to the physics engine for our CSG shape. This will always act like a static body. Note that the collision shape is still active even if the CSG shape itself is hidden. + + + + + Geometry of both primitives is merged, intersecting geometry is removed. + + + Only intersecting geometry remains, the rest is removed. + + + The second shape is subtracted from the first, leaving a dent with its shape. + + + diff --git a/modules/csg/doc_classes/CSGSphere.xml b/modules/csg/doc_classes/CSGSphere.xml deleted file mode 100644 index 847cc63586..0000000000 --- a/modules/csg/doc_classes/CSGSphere.xml +++ /dev/null @@ -1,32 +0,0 @@ - - - - A CSG Sphere shape. - - - This node allows you to create a sphere for use with the CSG system. - - - - - - - - The material used to render the sphere. - - - Number of vertical slices for the sphere. - - - Radius of the sphere. - - - Number of horizontal slices for the sphere. - - - If [code]true[/code] the normals of the sphere are set to give a smooth effect making the sphere seem rounded. If [code]false[/code] the sphere will have a flat shaded look. - - - - - diff --git a/modules/csg/doc_classes/CSGSphere3D.xml b/modules/csg/doc_classes/CSGSphere3D.xml new file mode 100644 index 0000000000..4d5b3be099 --- /dev/null +++ b/modules/csg/doc_classes/CSGSphere3D.xml @@ -0,0 +1,32 @@ + + + + A CSG Sphere shape. + + + This node allows you to create a sphere for use with the CSG system. + + + + + + + + The material used to render the sphere. + + + Number of vertical slices for the sphere. + + + Radius of the sphere. + + + Number of horizontal slices for the sphere. + + + If [code]true[/code] the normals of the sphere are set to give a smooth effect making the sphere seem rounded. If [code]false[/code] the sphere will have a flat shaded look. + + + + + diff --git a/modules/csg/doc_classes/CSGTorus.xml b/modules/csg/doc_classes/CSGTorus.xml deleted file mode 100644 index 84a08edaf5..0000000000 --- a/modules/csg/doc_classes/CSGTorus.xml +++ /dev/null @@ -1,35 +0,0 @@ - - - - A CSG Torus shape. - - - This node allows you to create a torus for use with the CSG system. - - - - - - - - The inner radius of the torus. - - - The material used to render the torus. - - - The outer radius of the torus. - - - The number of edges each ring of the torus is constructed of. - - - The number of slices the torus is constructed of. - - - 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. - - - - - diff --git a/modules/csg/doc_classes/CSGTorus3D.xml b/modules/csg/doc_classes/CSGTorus3D.xml new file mode 100644 index 0000000000..abe3eab913 --- /dev/null +++ b/modules/csg/doc_classes/CSGTorus3D.xml @@ -0,0 +1,35 @@ + + + + A CSG Torus shape. + + + This node allows you to create a torus for use with the CSG system. + + + + + + + + The inner radius of the torus. + + + The material used to render the torus. + + + The outer radius of the torus. + + + The number of edges each ring of the torus is constructed of. + + + The number of slices the torus is constructed of. + + + 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. + + + + + diff --git a/modules/csg/register_types.cpp b/modules/csg/register_types.cpp index 1a12a6706d..40eef84b1b 100644 --- a/modules/csg/register_types.cpp +++ b/modules/csg/register_types.cpp @@ -47,15 +47,6 @@ void register_csg_types() { ClassDB::register_class(); ClassDB::register_class(); - ClassDB::add_compatibility_class("CSGShape", "CSGShape3D"); - ClassDB::add_compatibility_class("CSGMesh", "CSGMesh3D"); - ClassDB::add_compatibility_class("CSGSphere", "CSGSphere3D"); - ClassDB::add_compatibility_class("CSGBox", "CSGBox3D"); - ClassDB::add_compatibility_class("CSGCylinder", "CSGCylinder3D"); - ClassDB::add_compatibility_class("CSGTorus", "CSGTorus3D"); - ClassDB::add_compatibility_class("CSGPolygon", "CSGPolygon3D"); - ClassDB::add_compatibility_class("CSGCombiner", "CSGCombiner3D"); - #ifdef TOOLS_ENABLED EditorPlugins::add_by_type(); #endif -- cgit v1.2.3