From 0ac4051c00898b316ae11e7075d3f3a9e3c46be3 Mon Sep 17 00:00:00 2001 From: Aaron Franke Date: Sun, 3 May 2020 04:27:36 -0400 Subject: Update documentation for Transform3D --- doc/classes/@GlobalScope.xml | 4 +- doc/classes/AABB.xml | 2 +- doc/classes/AnimationTree.xml | 4 +- doc/classes/ArrayMesh.xml | 2 +- doc/classes/Basis.xml | 2 +- doc/classes/Camera3D.xml | 2 +- doc/classes/CollisionObject3D.xml | 8 +- doc/classes/GIProbeData.xml | 4 +- doc/classes/GPUParticles3D.xml | 2 +- doc/classes/KinematicBody3D.xml | 4 +- doc/classes/Listener3D.xml | 4 +- doc/classes/MeshLibrary.xml | 8 +- doc/classes/MultiMesh.xml | 8 +- doc/classes/NavigationServer3D.xml | 2 +- doc/classes/Node3D.xml | 14 +- doc/classes/PackedVector3Array.xml | 2 +- doc/classes/PhysicalBone3D.xml | 4 +- doc/classes/PhysicsDirectBodyState3D.xml | 2 +- doc/classes/PhysicsServer3D.xml | 32 +-- doc/classes/PhysicsShapeQueryParameters3D.xml | 2 +- doc/classes/RemoteTransform3D.xml | 4 +- doc/classes/RenderingServer.xml | 28 +-- doc/classes/Skeleton3D.xml | 26 +-- doc/classes/SkeletonIK3D.xml | 2 +- doc/classes/Skin.xml | 6 +- doc/classes/SurfaceTool.xml | 4 +- doc/classes/Transform.xml | 216 --------------------- doc/classes/Transform2D.xml | 2 +- doc/classes/Transform3D.xml | 216 +++++++++++++++++++++ doc/classes/Vector3.xml | 2 +- doc/classes/VisualInstance3D.xml | 2 +- doc/classes/VisualShaderNodeDeterminant.xml | 2 +- doc/classes/VisualShaderNodeTransformCompose.xml | 2 +- doc/classes/VisualShaderNodeTransformConstant.xml | 8 +- doc/classes/VisualShaderNodeTransformDecompose.xml | 2 +- doc/classes/VisualShaderNodeTransformFunc.xml | 8 +- doc/classes/VisualShaderNodeTransformMult.xml | 2 +- doc/classes/VisualShaderNodeTransformUniform.xml | 4 +- doc/classes/VisualShaderNodeTransformVecMult.xml | 2 +- doc/classes/XRPositionalTracker.xml | 2 +- doc/classes/XRServer.xml | 4 +- modules/csg/doc_classes/CSGShape3D.xml | 2 +- modules/gltf/doc_classes/GLTFNode.xml | 2 +- modules/gridmap/doc_classes/GridMap.xml | 4 +- 44 files changed, 332 insertions(+), 332 deletions(-) delete mode 100644 doc/classes/Transform.xml create mode 100644 doc/classes/Transform3D.xml diff --git a/doc/classes/@GlobalScope.xml b/doc/classes/@GlobalScope.xml index e210fa8808..00bfb3dbb9 100644 --- a/doc/classes/@GlobalScope.xml +++ b/doc/classes/@GlobalScope.xml @@ -2605,8 +2605,8 @@ Variable is of type [Basis]. - - Variable is of type [Transform]. + + Variable is of type [Transform3D]. Variable is of type [Color]. diff --git a/doc/classes/AABB.xml b/doc/classes/AABB.xml index a28bde9946..af34a948f5 100644 --- a/doc/classes/AABB.xml +++ b/doc/classes/AABB.xml @@ -242,7 +242,7 @@ - + diff --git a/doc/classes/AnimationTree.xml b/doc/classes/AnimationTree.xml index 2517941133..07ce30db5d 100644 --- a/doc/classes/AnimationTree.xml +++ b/doc/classes/AnimationTree.xml @@ -21,10 +21,10 @@ - + - Retrieve the motion of the [member root_motion_track] as a [Transform] that can be used elsewhere. If [member root_motion_track] is not a path to a track of type [constant Animation.TYPE_TRANSFORM], returns an identity transformation. + Retrieve the motion of the [member root_motion_track] as a [Transform3D] that can be used elsewhere. If [member root_motion_track] is not a path to a track of type [constant Animation.TYPE_TRANSFORM], returns an identity transformation. diff --git a/doc/classes/ArrayMesh.xml b/doc/classes/ArrayMesh.xml index 7c1c4656f8..7826932179 100644 --- a/doc/classes/ArrayMesh.xml +++ b/doc/classes/ArrayMesh.xml @@ -113,7 +113,7 @@ - + diff --git a/doc/classes/Basis.xml b/doc/classes/Basis.xml index 55ae58ee3a..f01a11e399 100644 --- a/doc/classes/Basis.xml +++ b/doc/classes/Basis.xml @@ -4,7 +4,7 @@ 3×3 matrix datatype. - 3×3 matrix used for 3D rotation and scale. Almost always used as an orthogonal basis for a Transform. + 3×3 matrix used for 3D rotation and scale. Almost always used as an orthogonal basis for a [Transform3D]. Contains 3 vector fields X, Y and Z as its columns, which are typically interpreted as the local basis vectors of a transformation. For such use, it is composed of a scaling and a rotation matrix, in that order (M = R.S). Can also be accessed as array of 3D vectors. These vectors are normally orthogonal to each other, but are not necessarily normalized (due to scaling). For more information, read the "Matrices and transforms" documentation article. diff --git a/doc/classes/Camera3D.xml b/doc/classes/Camera3D.xml index 9f1d6d8e31..30f6c2b951 100644 --- a/doc/classes/Camera3D.xml +++ b/doc/classes/Camera3D.xml @@ -27,7 +27,7 @@ - + Gets the camera transform. Subclassed cameras such as [ClippedCamera3D] may provide different transforms than the [Node] transform. diff --git a/doc/classes/CollisionObject3D.xml b/doc/classes/CollisionObject3D.xml index 522eec5cbe..eb71407cf2 100644 --- a/doc/classes/CollisionObject3D.xml +++ b/doc/classes/CollisionObject3D.xml @@ -179,12 +179,12 @@ - + - Returns the shape owner's [Transform]. + Returns the shape owner's [Transform3D]. @@ -214,10 +214,10 @@ - + - Sets the [Transform] of the given shape owner. + Sets the [Transform3D] of the given shape owner. diff --git a/doc/classes/GIProbeData.xml b/doc/classes/GIProbeData.xml index 693df8f819..8549011b19 100644 --- a/doc/classes/GIProbeData.xml +++ b/doc/classes/GIProbeData.xml @@ -11,7 +11,7 @@ - + @@ -59,7 +59,7 @@ - + diff --git a/doc/classes/GPUParticles3D.xml b/doc/classes/GPUParticles3D.xml index 76f0fdb406..47bdd9d745 100644 --- a/doc/classes/GPUParticles3D.xml +++ b/doc/classes/GPUParticles3D.xml @@ -22,7 +22,7 @@ - + diff --git a/doc/classes/KinematicBody3D.xml b/doc/classes/KinematicBody3D.xml index efd3f58f88..1a197be0fb 100644 --- a/doc/classes/KinematicBody3D.xml +++ b/doc/classes/KinematicBody3D.xml @@ -155,14 +155,14 @@ - + - Checks for collisions without moving the body. Virtually sets the node's position, scale and rotation to that of the given [Transform], then tries to move the body along the vector [code]rel_vec[/code]. Returns [code]true[/code] if a collision would occur. + Checks for collisions without moving the body. Virtually sets the node's position, scale and rotation to that of the given [Transform3D], then tries to move the body along the vector [code]rel_vec[/code]. Returns [code]true[/code] if a collision would occur. diff --git a/doc/classes/Listener3D.xml b/doc/classes/Listener3D.xml index 998ea757ff..b2fcbe534d 100644 --- a/doc/classes/Listener3D.xml +++ b/doc/classes/Listener3D.xml @@ -18,10 +18,10 @@ - + - Returns the listener's global orthonormalized [Transform]. + Returns the listener's global orthonormalized [Transform3D]. diff --git a/doc/classes/MeshLibrary.xml b/doc/classes/MeshLibrary.xml index ad8bd6991d..b33bcc89e3 100644 --- a/doc/classes/MeshLibrary.xml +++ b/doc/classes/MeshLibrary.xml @@ -72,7 +72,7 @@ - + @@ -96,7 +96,7 @@ Returns an item's collision shapes. - The array consists of each [Shape3D] followed by its [Transform]. + The array consists of each [Shape3D] followed by its [Transform3D]. @@ -154,7 +154,7 @@ - + Sets the transform to apply to the item's navigation mesh. @@ -180,7 +180,7 @@ Sets an item's collision shapes. - The array should consist of [Shape3D] objects, each followed by a [Transform] that will be applied to it. For shapes that should not have a transform, use [constant Transform.IDENTITY]. + The array should consist of [Shape3D] objects, each followed by a [Transform3D] that will be applied to it. For shapes that should not have a transform, use [constant Transform3D.IDENTITY]. diff --git a/doc/classes/MultiMesh.xml b/doc/classes/MultiMesh.xml index 2adebdb306..02628f4960 100644 --- a/doc/classes/MultiMesh.xml +++ b/doc/classes/MultiMesh.xml @@ -40,12 +40,12 @@ - + - Returns the [Transform] of a specific instance. + Returns the [Transform3D] of a specific instance. @@ -86,10 +86,10 @@ - + - Sets the [Transform] for a specific instance. + Sets the [Transform3D] for a specific instance. diff --git a/doc/classes/NavigationServer3D.xml b/doc/classes/NavigationServer3D.xml index b098a7fc20..ef9efcb99c 100644 --- a/doc/classes/NavigationServer3D.xml +++ b/doc/classes/NavigationServer3D.xml @@ -413,7 +413,7 @@ - + Sets the global transformation for the region. diff --git a/doc/classes/Node3D.xml b/doc/classes/Node3D.xml index 5c29c0d48f..6cc5bf61e9 100644 --- a/doc/classes/Node3D.xml +++ b/doc/classes/Node3D.xml @@ -4,7 +4,7 @@ Most basic 3D game object, parent of all 3D-related nodes. - Most basic 3D game object, with a 3D [Transform] and visibility settings. All other 3D game objects inherit from Node3D. Use [Node3D] as a parent node to move, scale, rotate and show/hide children in a 3D project. + Most basic 3D game object, with a 3D [Transform3D] and visibility settings. All other 3D game objects inherit from Node3D. Use [Node3D] as a parent node to move, scale, rotate and show/hide children in a 3D project. Affine operations (rotate, scale, translate) happen in parent's local coordinate system, unless the [Node3D] object is set as top-level. Affine operations in this coordinate system correspond to direct affine operations on the [Node3D]'s transform. The word local below refers to this coordinate system. The coordinate system that is attached to the [Node3D] object itself is referred to as object-local coordinate system. [b]Note:[/b] Unless otherwise specified, all methods that have angle parameters must have angles specified as [i]radians[/i]. To convert degrees to radians, use [method @GlobalScope.deg2rad]. @@ -128,7 +128,7 @@ - Resets this node's transformations (like scale, skew and taper) preserving its rotation and translation by performing Gram-Schmidt orthonormalization on this node's [Transform]. + Resets this node's transformations (like scale, skew and taper) preserving its rotation and translation by performing Gram-Schmidt orthonormalization on this node's [Transform3D]. @@ -202,7 +202,7 @@ - Reset all transformations for this node (sets its [Transform] to the identity matrix). + Reset all transformations for this node (sets its [Transform3D] to the identity matrix). @@ -288,8 +288,8 @@ The [Node3DGizmo] for this node. Used for example in [EditorNode3DGizmo] as custom visualization and editing handles in Editor. - - World3D space (global) [Transform] of this node. + + World3D space (global) [Transform3D] of this node. Rotation part of the local transformation in radians, specified in terms of YXZ-Euler angles in the format (X angle, Y angle, Z angle). @@ -304,8 +304,8 @@ If [code]true[/code], the node will not inherit its transformations from its parent. Node transformations are only in global space. - - Local space [Transform] of this node, with respect to the parent node. + + Local space [Transform3D] of this node, with respect to the parent node. Local translation of this node. diff --git a/doc/classes/PackedVector3Array.xml b/doc/classes/PackedVector3Array.xml index 85d41d7519..00ded39082 100644 --- a/doc/classes/PackedVector3Array.xml +++ b/doc/classes/PackedVector3Array.xml @@ -106,7 +106,7 @@ - + diff --git a/doc/classes/PhysicalBone3D.xml b/doc/classes/PhysicalBone3D.xml index 38d9f722b1..656bcfc15c 100644 --- a/doc/classes/PhysicalBone3D.xml +++ b/doc/classes/PhysicalBone3D.xml @@ -84,7 +84,7 @@ Lock the body's movement in the Z axis. - + Sets the body's transform. @@ -99,7 +99,7 @@ This is multiplied by the global 3D gravity setting found in [b]Project > Project Settings > Physics > 3d[/b] to produce the body's gravity. For example, a value of 1 will be normal gravity, 2 will apply double gravity, and 0.5 will apply half gravity to this object. - + Sets the joint's transform. diff --git a/doc/classes/PhysicsDirectBodyState3D.xml b/doc/classes/PhysicsDirectBodyState3D.xml index eea681e696..09cc230253 100644 --- a/doc/classes/PhysicsDirectBodyState3D.xml +++ b/doc/classes/PhysicsDirectBodyState3D.xml @@ -214,7 +214,7 @@ The rate at which the body stops moving, if there are not any other forces moving it. - + The body's transformation matrix. diff --git a/doc/classes/PhysicsServer3D.xml b/doc/classes/PhysicsServer3D.xml index 46de9e5282..18194d53a0 100644 --- a/doc/classes/PhysicsServer3D.xml +++ b/doc/classes/PhysicsServer3D.xml @@ -16,7 +16,7 @@ - + @@ -92,7 +92,7 @@ - + @@ -121,7 +121,7 @@ - + @@ -258,7 +258,7 @@ - + Sets the transform matrix for an area shape. @@ -291,7 +291,7 @@ - + Sets the transform matrix for an area. @@ -337,7 +337,7 @@ - + @@ -510,7 +510,7 @@ - + @@ -760,7 +760,7 @@ - + Sets the transform matrix for a body shape. @@ -1017,11 +1017,11 @@ - + - + @@ -1033,11 +1033,11 @@ - + - + @@ -1049,11 +1049,11 @@ - + - + @@ -1081,11 +1081,11 @@ - + - + diff --git a/doc/classes/PhysicsShapeQueryParameters3D.xml b/doc/classes/PhysicsShapeQueryParameters3D.xml index 4b43ea66fc..79bc29057f 100644 --- a/doc/classes/PhysicsShapeQueryParameters3D.xml +++ b/doc/classes/PhysicsShapeQueryParameters3D.xml @@ -60,7 +60,7 @@ [/csharp] [/codeblocks] - + The queried shape's transform matrix. diff --git a/doc/classes/RemoteTransform3D.xml b/doc/classes/RemoteTransform3D.xml index bd3da2aea9..453177496f 100644 --- a/doc/classes/RemoteTransform3D.xml +++ b/doc/classes/RemoteTransform3D.xml @@ -1,10 +1,10 @@ - RemoteTransform3D pushes its own [Transform] to another [Node3D] derived Node in the scene. + RemoteTransform3D pushes its own [Transform3D] to another [Node3D] derived Node in the scene. - RemoteTransform3D pushes its own [Transform] to another [Node3D] derived Node (called the remote node) in the scene. + RemoteTransform3D pushes its own [Transform3D] to another [Node3D] derived Node (called the remote node) in the scene. It can be set to update another Node's position, rotation and/or scale. It can use either global or local coordinates. diff --git a/doc/classes/RenderingServer.xml b/doc/classes/RenderingServer.xml index 7a345f726d..02130333f9 100644 --- a/doc/classes/RenderingServer.xml +++ b/doc/classes/RenderingServer.xml @@ -130,10 +130,10 @@ - + - Sets [Transform] of camera. + Sets [Transform3D] of camera. @@ -1335,7 +1335,7 @@ - + Sets the world space transform of the instance. Equivalent to [member Node3D.transform]. @@ -1894,14 +1894,14 @@ - + - Returns the [Transform] of the specified instance. + Returns the [Transform3D] of the specified instance. @@ -1948,10 +1948,10 @@ - + - Sets the [Transform] for this instance. Equivalent to [method MultiMesh.set_instance_transform]. + Sets the [Transform3D] for this instance. Equivalent to [method MultiMesh.set_instance_transform]. @@ -2142,10 +2142,10 @@ - + - Sets the [Transform] that will be used by the particles when they first emit. + Sets the [Transform3D] that will be used by the particles when they first emit. @@ -2590,14 +2590,14 @@ - + - Returns the [Transform] set for a specific bone of this skeleton. + Returns the [Transform3D] set for a specific bone of this skeleton. @@ -2618,10 +2618,10 @@ - + - Sets the [Transform] for a specific bone of this skeleton. + Sets the [Transform3D] for a specific bone of this skeleton. @@ -3267,7 +3267,7 @@ Use [Transform2D] to store MultiMesh transform. - Use [Transform] to store MultiMesh transform. + Use [Transform3D] to store MultiMesh transform. Is a directional (sun) light. diff --git a/doc/classes/Skeleton3D.xml b/doc/classes/Skeleton3D.xml index 44ad460459..d8b35ad272 100644 --- a/doc/classes/Skeleton3D.xml +++ b/doc/classes/Skeleton3D.xml @@ -23,9 +23,9 @@ - + - + Takes the given bone pose/transform and converts it to a world transform, relative to the [Skeleton3D] node. @@ -63,7 +63,7 @@ - + @@ -72,7 +72,7 @@ - + @@ -81,7 +81,7 @@ - + @@ -109,7 +109,7 @@ - + @@ -124,7 +124,7 @@ - + @@ -199,7 +199,7 @@ - + Sets the custom pose transform, [code]custom_pose[/code], for the bone at [code]bone_idx[/code]. This pose is an addition to the bone rest pose. @@ -222,7 +222,7 @@ - + @@ -261,7 +261,7 @@ - + Sets the pose transform for bone [code]bone_idx[/code]. @@ -273,7 +273,7 @@ - + Sets the rest transform for bone [code]bone_idx[/code]. @@ -289,9 +289,9 @@ - + - + Takes the given world transform, relative to the [Skeleton3D], and converts it to a bone pose/transform. diff --git a/doc/classes/SkeletonIK3D.xml b/doc/classes/SkeletonIK3D.xml index 5193109447..5949ad54fd 100644 --- a/doc/classes/SkeletonIK3D.xml +++ b/doc/classes/SkeletonIK3D.xml @@ -48,7 +48,7 @@ - + diff --git a/doc/classes/Skin.xml b/doc/classes/Skin.xml index e22feb42f0..f409b6c80c 100644 --- a/doc/classes/Skin.xml +++ b/doc/classes/Skin.xml @@ -12,7 +12,7 @@ - + @@ -46,7 +46,7 @@ - + @@ -86,7 +86,7 @@ - + diff --git a/doc/classes/SurfaceTool.xml b/doc/classes/SurfaceTool.xml index 1195e4aa2b..d434f5c2c9 100644 --- a/doc/classes/SurfaceTool.xml +++ b/doc/classes/SurfaceTool.xml @@ -76,10 +76,10 @@ - + - Append vertices from a given [Mesh] surface onto the current vertex array with specified [Transform]. + Append vertices from a given [Mesh] surface onto the current vertex array with specified [Transform3D]. diff --git a/doc/classes/Transform.xml b/doc/classes/Transform.xml deleted file mode 100644 index 9d8721e2de..0000000000 --- a/doc/classes/Transform.xml +++ /dev/null @@ -1,216 +0,0 @@ - - - - 3D transformation (3×4 matrix). - - - 3×4 matrix (3 rows, 4 columns) used for 3D linear transformations. It can represent transformations such as translation, rotation, or scaling. It consists of a [member basis] (first 3 columns) and a [Vector3] for the [member origin] (last column). - For more information, read the "Matrices and transforms" documentation article. - - - https://docs.godotengine.org/en/latest/tutorials/math/index.html - https://docs.godotengine.org/en/latest/tutorials/math/matrices_and_transforms.html - https://docs.godotengine.org/en/latest/tutorials/3d/using_transforms.html - https://godotengine.org/asset-library/asset/584 - https://godotengine.org/asset-library/asset/125 - https://godotengine.org/asset-library/asset/583 - - - - - - - Constructs a default-initialized [Transform] set to [constant IDENTITY]. - - - - - - - - - Constructs a [Transform] as a copy of the given [Transform]. - - - - - - - - - - - Constructs a Transform from a [Basis] and [Vector3]. - - - - - - - - - - - - - - - Constructs a Transform from four [Vector3] values (matrix columns). Each axis corresponds to local basis vectors (some of which may be scaled). - - - - - - - Returns the inverse of the transform, under the assumption that the transformation is composed of rotation, scaling and translation. - - - - - - - - - - - Interpolates the transform to other Transform by weight amount (on the range of 0.0 to 1.0). - - - - - - - Returns the inverse of the transform, under the assumption that the transformation is composed of rotation and translation (no scaling, use affine_inverse for transforms with scaling). - - - - - - - - - Returns [code]true[/code] if this transform and [code]transform[/code] are approximately equal, by calling [code]is_equal_approx[/code] on each component. - - - - - - - - - - - Returns a copy of the transform rotated such that its -Z axis points towards the [code]target[/code] position. - The transform will first be rotated around the given [code]up[/code] vector, and then fully aligned to the target by a further rotation around an axis perpendicular to both the [code]target[/code] and [code]up[/code] vectors. - Operations take place in global space. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Returns the transform with the basis orthogonal (90 degrees), and normalized axis vectors. - - - - - - - - - - - Rotates the transform around the given axis by the given angle (in radians), using matrix multiplication. The axis must be a normalized vector. - - - - - - - - - Scales basis and origin of the transform by the given scale factor, using matrix multiplication. - - - - - - - - - Translates the transform by the given offset, relative to the transform's basis vectors. - Unlike [method rotated] and [method scaled], this does not use matrix multiplication. - - - - - - The basis is a matrix containing 3 [Vector3] as its columns: X axis, Y axis, and Z axis. These vectors can be interpreted as the basis vectors of local coordinate system traveling with the object. - - - The translation offset of the transform (column 3, the fourth column). Equivalent to array index [code]3[/code]. - - - - - [Transform] with no translation, rotation or scaling applied. When applied to other data structures, [constant IDENTITY] performs no transformation. - - - [Transform] with mirroring applied perpendicular to the YZ plane. - - - [Transform] with mirroring applied perpendicular to the XZ plane. - - - [Transform] with mirroring applied perpendicular to the XY plane. - - - diff --git a/doc/classes/Transform2D.xml b/doc/classes/Transform2D.xml index 6ae7fbcf79..e748ceb281 100644 --- a/doc/classes/Transform2D.xml +++ b/doc/classes/Transform2D.xml @@ -18,7 +18,7 @@ - Constructs a default-initialized [Transform] set to [constant IDENTITY]. + Constructs a default-initialized [Transform2D] set to [constant IDENTITY]. diff --git a/doc/classes/Transform3D.xml b/doc/classes/Transform3D.xml new file mode 100644 index 0000000000..0d49255523 --- /dev/null +++ b/doc/classes/Transform3D.xml @@ -0,0 +1,216 @@ + + + + 3D transformation (3×4 matrix). + + + 3×4 matrix (3 rows, 4 columns) used for 3D linear transformations. It can represent transformations such as translation, rotation, or scaling. It consists of a [member basis] (first 3 columns) and a [Vector3] for the [member origin] (last column). + For more information, read the "Matrices and transforms" documentation article. + + + https://docs.godotengine.org/en/latest/tutorials/math/index.html + https://docs.godotengine.org/en/latest/tutorials/math/matrices_and_transforms.html + https://docs.godotengine.org/en/latest/tutorials/3d/using_transforms.html + https://godotengine.org/asset-library/asset/584 + https://godotengine.org/asset-library/asset/125 + https://godotengine.org/asset-library/asset/583 + + + + + + + Constructs a default-initialized [Transform3D] set to [constant IDENTITY]. + + + + + + + + + Constructs a [Transform3D] as a copy of the given [Transform3D]. + + + + + + + + + + + Constructs a Transform3D from a [Basis] and [Vector3]. + + + + + + + + + + + + + + + Constructs a Transform3D from four [Vector3] values (matrix columns). Each axis corresponds to local basis vectors (some of which may be scaled). + + + + + + + Returns the inverse of the transform, under the assumption that the transformation is composed of rotation, scaling and translation. + + + + + + + + + + + Interpolates the transform to other Transform3D by weight amount (on the range of 0.0 to 1.0). + + + + + + + Returns the inverse of the transform, under the assumption that the transformation is composed of rotation and translation (no scaling, use affine_inverse for transforms with scaling). + + + + + + + + + Returns [code]true[/code] if this transform and [code]transform[/code] are approximately equal, by calling [code]is_equal_approx[/code] on each component. + + + + + + + + + + + Returns a copy of the transform rotated such that its -Z axis points towards the [code]target[/code] position. + The transform will first be rotated around the given [code]up[/code] vector, and then fully aligned to the target by a further rotation around an axis perpendicular to both the [code]target[/code] and [code]up[/code] vectors. + Operations take place in global space. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Returns the transform with the basis orthogonal (90 degrees), and normalized axis vectors. + + + + + + + + + + + Rotates the transform around the given axis by the given angle (in radians), using matrix multiplication. The axis must be a normalized vector. + + + + + + + + + Scales basis and origin of the transform by the given scale factor, using matrix multiplication. + + + + + + + + + Translates the transform by the given offset, relative to the transform's basis vectors. + Unlike [method rotated] and [method scaled], this does not use matrix multiplication. + + + + + + The basis is a matrix containing 3 [Vector3] as its columns: X axis, Y axis, and Z axis. These vectors can be interpreted as the basis vectors of local coordinate system traveling with the object. + + + The translation offset of the transform (column 3, the fourth column). Equivalent to array index [code]3[/code]. + + + + + [Transform3D] with no translation, rotation or scaling applied. When applied to other data structures, [constant IDENTITY] performs no transformation. + + + [Transform3D] with mirroring applied perpendicular to the YZ plane. + + + [Transform3D] with mirroring applied perpendicular to the XZ plane. + + + [Transform3D] with mirroring applied perpendicular to the XY plane. + + + diff --git a/doc/classes/Vector3.xml b/doc/classes/Vector3.xml index 0a86369506..db837d3f0c 100644 --- a/doc/classes/Vector3.xml +++ b/doc/classes/Vector3.xml @@ -274,7 +274,7 @@ - + diff --git a/doc/classes/VisualInstance3D.xml b/doc/classes/VisualInstance3D.xml index 01d569d9c8..2a12254b71 100644 --- a/doc/classes/VisualInstance3D.xml +++ b/doc/classes/VisualInstance3D.xml @@ -44,7 +44,7 @@ Returns the transformed [AABB] (also known as the bounding box) for this [VisualInstance3D]. - Transformed in this case means the [AABB] plus the position, rotation, and scale of the [Node3D]'s [Transform]. See also [method get_aabb]. + Transformed in this case means the [AABB] plus the position, rotation, and scale of the [Node3D]'s [Transform3D]. See also [method get_aabb]. diff --git a/doc/classes/VisualShaderNodeDeterminant.xml b/doc/classes/VisualShaderNodeDeterminant.xml index 6b042f6172..06b05addfa 100644 --- a/doc/classes/VisualShaderNodeDeterminant.xml +++ b/doc/classes/VisualShaderNodeDeterminant.xml @@ -1,7 +1,7 @@ - Calculates the determinant of a [Transform] within the visual shader graph. + Calculates the determinant of a [Transform3D] within the visual shader graph. Translates to [code]determinant(x)[/code] in the shader language. diff --git a/doc/classes/VisualShaderNodeTransformCompose.xml b/doc/classes/VisualShaderNodeTransformCompose.xml index 41762b0099..b82ce9bdd8 100644 --- a/doc/classes/VisualShaderNodeTransformCompose.xml +++ b/doc/classes/VisualShaderNodeTransformCompose.xml @@ -1,7 +1,7 @@ - Composes a [Transform] from four [Vector3]s within the visual shader graph. + Composes a [Transform3D] from four [Vector3]s within the visual shader graph. Creates a 4x4 transform matrix using four vectors of type [code]vec3[/code]. Each vector is one row in the matrix and the last column is a [code]vec4(0, 0, 0, 1)[/code]. diff --git a/doc/classes/VisualShaderNodeTransformConstant.xml b/doc/classes/VisualShaderNodeTransformConstant.xml index b8f054e914..550ed829c9 100644 --- a/doc/classes/VisualShaderNodeTransformConstant.xml +++ b/doc/classes/VisualShaderNodeTransformConstant.xml @@ -1,18 +1,18 @@ - A [Transform] constant for use within the visual shader graph. + A [Transform3D] constant for use within the visual shader graph. - A constant [Transform], which can be used as an input node. + A constant [Transform3D], which can be used as an input node. - - A [Transform] constant which represents the state of this node. + + A [Transform3D] constant which represents the state of this node. diff --git a/doc/classes/VisualShaderNodeTransformDecompose.xml b/doc/classes/VisualShaderNodeTransformDecompose.xml index c8d893db00..b815efc67a 100644 --- a/doc/classes/VisualShaderNodeTransformDecompose.xml +++ b/doc/classes/VisualShaderNodeTransformDecompose.xml @@ -1,7 +1,7 @@ - Decomposes a [Transform] into four [Vector3]s within the visual shader graph. + Decomposes a [Transform3D] into four [Vector3]s within the visual shader graph. Takes a 4x4 transform matrix and decomposes it into four [code]vec3[/code] values, one from each row of the matrix. diff --git a/doc/classes/VisualShaderNodeTransformFunc.xml b/doc/classes/VisualShaderNodeTransformFunc.xml index d0b5c5129d..41a58e1458 100644 --- a/doc/classes/VisualShaderNodeTransformFunc.xml +++ b/doc/classes/VisualShaderNodeTransformFunc.xml @@ -1,10 +1,10 @@ - Computes a [Transform] function within the visual shader graph. + Computes a [Transform3D] function within the visual shader graph. - Computes an inverse or transpose function on the provided [Transform]. + Computes an inverse or transpose function on the provided [Transform3D]. @@ -17,10 +17,10 @@ - Perform the inverse operation on the [Transform] matrix. + Perform the inverse operation on the [Transform3D] matrix. - Perform the transpose operation on the [Transform] matrix. + Perform the transpose operation on the [Transform3D] matrix. diff --git a/doc/classes/VisualShaderNodeTransformMult.xml b/doc/classes/VisualShaderNodeTransformMult.xml index 02b6e0cd1c..f26f60a1f3 100644 --- a/doc/classes/VisualShaderNodeTransformMult.xml +++ b/doc/classes/VisualShaderNodeTransformMult.xml @@ -1,7 +1,7 @@ - Multiplies [Transform] by [Transform] within the visual shader graph. + Multiplies [Transform3D] by [Transform3D] within the visual shader graph. A multiplication operation on two transforms (4x4 matrices), with support for different multiplication operators. diff --git a/doc/classes/VisualShaderNodeTransformUniform.xml b/doc/classes/VisualShaderNodeTransformUniform.xml index ff6246618d..1f1cc4b630 100644 --- a/doc/classes/VisualShaderNodeTransformUniform.xml +++ b/doc/classes/VisualShaderNodeTransformUniform.xml @@ -1,7 +1,7 @@ - A [Transform] uniform for use within the visual shader graph. + A [Transform3D] uniform for use within the visual shader graph. Translated to [code]uniform mat4[/code] in the shader language. @@ -11,7 +11,7 @@ - + A default value to be assigned within the shader. diff --git a/doc/classes/VisualShaderNodeTransformVecMult.xml b/doc/classes/VisualShaderNodeTransformVecMult.xml index 3d5f87f727..2c9c115d9c 100644 --- a/doc/classes/VisualShaderNodeTransformVecMult.xml +++ b/doc/classes/VisualShaderNodeTransformVecMult.xml @@ -1,7 +1,7 @@ - Multiplies a [Transform] and a [Vector3] within the visual shader graph. + Multiplies a [Transform3D] and a [Vector3] within the visual shader graph. A multiplication operation on a transform (4x4 matrix) and a vector, with support for different multiplication operators. diff --git a/doc/classes/XRPositionalTracker.xml b/doc/classes/XRPositionalTracker.xml index 5274d952fd..2cf8e1d6f5 100644 --- a/doc/classes/XRPositionalTracker.xml +++ b/doc/classes/XRPositionalTracker.xml @@ -69,7 +69,7 @@ - + diff --git a/doc/classes/XRServer.xml b/doc/classes/XRServer.xml index d0edf91fed..8284fa4a89 100644 --- a/doc/classes/XRServer.xml +++ b/doc/classes/XRServer.xml @@ -63,7 +63,7 @@ - + Returns the primary interface's transformation. @@ -114,7 +114,7 @@ - + Returns the reference frame transform. Mostly used internally and exposed for GDNative build interfaces. diff --git a/modules/csg/doc_classes/CSGShape3D.xml b/modules/csg/doc_classes/CSGShape3D.xml index dac556c7f1..01ec46e707 100644 --- a/modules/csg/doc_classes/CSGShape3D.xml +++ b/modules/csg/doc_classes/CSGShape3D.xml @@ -31,7 +31,7 @@ - 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 an [Array] with two elements, the first is the [Transform3D] of this node and the second is the root [Mesh] of this node. Only works when this node is the root shape. diff --git a/modules/gltf/doc_classes/GLTFNode.xml b/modules/gltf/doc_classes/GLTFNode.xml index af7be55e4b..33aad0028e 100644 --- a/modules/gltf/doc_classes/GLTFNode.xml +++ b/modules/gltf/doc_classes/GLTFNode.xml @@ -33,7 +33,7 @@ - + diff --git a/modules/gridmap/doc_classes/GridMap.xml b/modules/gridmap/doc_classes/GridMap.xml index 9b6fa138e5..fb0a2c9953 100644 --- a/modules/gridmap/doc_classes/GridMap.xml +++ b/modules/gridmap/doc_classes/GridMap.xml @@ -41,7 +41,7 @@ - Returns an array of [ArrayMesh]es and [Transform] references of all bake meshes that exist within the current GridMap. + Returns an array of [ArrayMesh]es and [Transform3D] references of all bake meshes that exist within the current GridMap. @@ -84,7 +84,7 @@ - Returns an array of [Transform] and [Mesh] references corresponding to the non-empty cells in the grid. The transforms are specified in world space. + Returns an array of [Transform3D] and [Mesh] references corresponding to the non-empty cells in the grid. The transforms are specified in world space. -- cgit v1.2.3