maxmustermann/godot
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Update documentation for Transform3D

Browse source
This commit is contained in:
Aaron Franke 2020-05-03 04:27:36 -04:00
parent 39e28c49ed
commit 0ac4051c00
No known key found for this signature in database
GPG key ID: 40A1750B977E56BF
43 changed files with 153 additions and 153 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
doc/classes/@GlobalScope.xml
View file

@ -2605,8 +2605,8 @@
<constant name="TYPE_BASIS" value="15" enum="Variant.Type">
Variable is of type [Basis].
</constant>
<constant name="TYPE_TRANSFORM" value="16" enum="Variant.Type">
Variable is of type [Transform].
<constant name="TYPE_TRANSFORM3D" value="16" enum="Variant.Type">
Variable is of type [Transform3D].
</constant>
<constant name="TYPE_COLOR" value="17" enum="Variant.Type">
Variable is of type [Color].

2
doc/classes/AABB.xml
View file

@ -242,7 +242,7 @@
<method name="operator *" qualifiers="operator">
<return type="AABB">
</return>
<argument index="0" name="right" type="Transform">
<argument index="0" name="right" type="Transform3D">
</argument>
<description>
</description>

4
doc/classes/AnimationTree.xml
View file

@ -21,10 +21,10 @@
</description>
</method>
<method name="get_root_motion_transform" qualifiers="const">
<return type="Transform">
<return type="Transform3D">
</return>
<description>
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.
</description>
</method>
<method name="rename_parameter">

2
doc/classes/ArrayMesh.xml
View file

@ -113,7 +113,7 @@
<method name="lightmap_unwrap">
<return type="int" enum="Error">
</return>
<argument index="0" name="transform" type="Transform">
<argument index="0" name="transform" type="Transform3D">
</argument>
<argument index="1" name="texel_size" type="float">
</argument>

2
doc/classes/Basis.xml
View file

@ -4,7 +4,7 @@
3×3 matrix datatype.
</brief_description>
<description>
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.

2
doc/classes/Camera3D.xml
View file

@ -27,7 +27,7 @@
</description>
</method>
<method name="get_camera_transform" qualifiers="const">
<return type="Transform">
<return type="Transform3D">
</return>
<description>
Gets the camera transform. Subclassed cameras such as [ClippedCamera3D] may provide different transforms than the [Node] transform.

8
doc/classes/CollisionObject3D.xml
View file

@ -179,12 +179,12 @@
</description>
</method>
<method name="shape_owner_get_transform" qualifiers="const">
<return type="Transform">
<return type="Transform3D">
</return>
<argument index="0" name="owner_id" type="int">
</argument>
<description>
Returns the shape owner's [Transform].
Returns the shape owner's [Transform3D].
</description>
</method>
<method name="shape_owner_remove_shape">
@ -214,10 +214,10 @@
</return>
<argument index="0" name="owner_id" type="int">
</argument>
<argument index="1" name="transform" type="Transform">
<argument index="1" name="transform" type="Transform3D">
</argument>
<description>
Sets the [Transform] of the given shape owner.
Sets the [Transform3D] of the given shape owner.
</description>
</method>
</methods>

4
doc/classes/GIProbeData.xml
View file

@ -11,7 +11,7 @@
<method name="allocate">
<return type="void">
</return>
<argument index="0" name="to_cell_xform" type="Transform">
<argument index="0" name="to_cell_xform" type="Transform3D">
</argument>
<argument index="1" name="aabb" type="AABB">
</argument>
@ -59,7 +59,7 @@
</description>
</method>
<method name="get_to_cell_xform" qualifiers="const">
<return type="Transform">
<return type="Transform3D">
</return>
<description>
</description>

2
doc/classes/GPUParticles3D.xml
View file

@ -22,7 +22,7 @@
<method name="emit_particle">
<return type="void">
</return>
<argument index="0" name="xform" type="Transform">
<argument index="0" name="xform" type="Transform3D">
</argument>
<argument index="1" name="velocity" type="Vector3">
</argument>

4
doc/classes/KinematicBody3D.xml
View file

@ -155,14 +155,14 @@
<method name="test_move">
<return type="bool">
</return>
<argument index="0" name="from" type="Transform">
<argument index="0" name="from" type="Transform3D">
</argument>
<argument index="1" name="rel_vec" type="Vector3">
</argument>
<argument index="2" name="infinite_inertia" type="bool" default="true">
</argument>
<description>
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.
</description>
</method>
</methods>

4
doc/classes/Listener3D.xml
View file

@ -18,10 +18,10 @@
</description>
</method>
<method name="get_listener_transform" qualifiers="const">
<return type="Transform">
<return type="Transform3D">
</return>
<description>
Returns the listener's global orthonormalized [Transform].
Returns the listener's global orthonormalized [Transform3D].
</description>
</method>
<method name="is_current" qualifiers="const">

8
doc/classes/MeshLibrary.xml
View file

@ -72,7 +72,7 @@
</description>
</method>
<method name="get_item_navmesh_transform" qualifiers="const">
<return type="Transform">
<return type="Transform3D">
</return>
<argument index="0" name="id" type="int">
</argument>
@ -96,7 +96,7 @@
</argument>
<description>
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].
</description>
</method>
<method name="get_last_unused_item_id" qualifiers="const">
@ -154,7 +154,7 @@
</return>
<argument index="0" name="id" type="int">
</argument>
<argument index="1" name="navmesh" type="Transform">
<argument index="1" name="navmesh" type="Transform3D">
</argument>
<description>
Sets the transform to apply to the item's navigation mesh.
@ -180,7 +180,7 @@
</argument>
<description>
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].
</description>
</method>
</methods>

8
doc/classes/MultiMesh.xml
View file

@ -40,12 +40,12 @@
</description>
</method>
<method name="get_instance_transform" qualifiers="const">
<return type="Transform">
<return type="Transform3D">
</return>
<argument index="0" name="instance" type="int">
</argument>
<description>
Returns the [Transform] of a specific instance.
Returns the [Transform3D] of a specific instance.
</description>
</method>
<method name="get_instance_transform_2d" qualifiers="const">
@ -86,10 +86,10 @@
</return>
<argument index="0" name="instance" type="int">
</argument>
<argument index="1" name="transform" type="Transform">
<argument index="1" name="transform" type="Transform3D">
</argument>
<description>
Sets the [Transform] for a specific instance.
Sets the [Transform3D] for a specific instance.
</description>
</method>
<method name="set_instance_transform_2d">

2
doc/classes/NavigationServer3D.xml
View file

@ -413,7 +413,7 @@
</return>
<argument index="0" name="region" type="RID">
</argument>
<argument index="1" name="transform" type="Transform">
<argument index="1" name="transform" type="Transform3D">
</argument>
<description>
Sets the global transformation for the region.

14
doc/classes/Node3D.xml
View file

@ -4,7 +4,7 @@
Most basic 3D game object, parent of all 3D-related nodes.
</brief_description>
<description>
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].
</description>
@ -128,7 +128,7 @@
<return type="void">
</return>
<description>
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].
</description>
</method>
<method name="rotate">
@ -202,7 +202,7 @@
<return type="void">
</return>
<description>
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).
</description>
</method>
<method name="set_ignore_transform_notification">
@ -288,8 +288,8 @@
<member name="gizmo" type="Node3DGizmo" setter="set_gizmo" getter="get_gizmo">
The [Node3DGizmo] for this node. Used for example in [EditorNode3DGizmo] as custom visualization and editing handles in Editor.
</member>
<member name="global_transform" type="Transform" setter="set_global_transform" getter="get_global_transform">
World3D space (global) [Transform] of this node.
<member name="global_transform" type="Transform3D" setter="set_global_transform" getter="get_global_transform">
World3D space (global) [Transform3D] of this node.
</member>
<member name="rotation" type="Vector3" setter="set_rotation" getter="get_rotation">
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 @@
<member name="top_level" type="bool" setter="set_as_top_level" getter="is_set_as_top_level" default="false">
If [code]true[/code], the node will not inherit its transformations from its parent. Node transformations are only in global space.
</member>
<member name="transform" type="Transform" setter="set_transform" getter="get_transform" default="Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )">
Local space [Transform] of this node, with respect to the parent node.
<member name="transform" type="Transform3D" setter="set_transform" getter="get_transform" default="Transform3D( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )">
Local space [Transform3D] of this node, with respect to the parent node.
</member>
<member name="translation" type="Vector3" setter="set_translation" getter="get_translation" default="Vector3( 0, 0, 0 )">
Local translation of this node.

2
doc/classes/PackedVector3Array.xml
View file

@ -106,7 +106,7 @@
<method name="operator *" qualifiers="operator">
<return type="PackedVector3Array">
</return>
<argument index="0" name="right" type="Transform">
<argument index="0" name="right" type="Transform3D">
</argument>
<description>
</description>

4
doc/classes/PhysicalBone3D.xml
View file

@ -84,7 +84,7 @@
<member name="axis_lock_linear_z" type="bool" setter="set_axis_lock" getter="get_axis_lock" default="false">
Lock the body's movement in the Z axis.
</member>
<member name="body_offset" type="Transform" setter="set_body_offset" getter="get_body_offset" default="Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )">
<member name="body_offset" type="Transform3D" setter="set_body_offset" getter="get_body_offset" default="Transform3D( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )">
Sets the body's transform.
</member>
<member name="bounce" type="float" setter="set_bounce" getter="get_bounce" default="0.0">
@ -99,7 +99,7 @@
<member name="gravity_scale" type="float" setter="set_gravity_scale" getter="get_gravity_scale" default="1.0">
This is multiplied by the global 3D gravity setting found in [b]Project &gt; Project Settings &gt; Physics &gt; 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.
</member>
<member name="joint_offset" type="Transform" setter="set_joint_offset" getter="get_joint_offset" default="Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )">
<member name="joint_offset" type="Transform3D" setter="set_joint_offset" getter="get_joint_offset" default="Transform3D( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )">
Sets the joint's transform.
</member>
<member name="joint_rotation" type="Vector3" setter="set_joint_rotation" getter="get_joint_rotation">

2
doc/classes/PhysicsDirectBodyState3D.xml
View file

@ -214,7 +214,7 @@
<member name="total_linear_damp" type="float" setter="" getter="get_total_linear_damp">
The rate at which the body stops moving, if there are not any other forces moving it.
</member>
<member name="transform" type="Transform" setter="set_transform" getter="get_transform">
<member name="transform" type="Transform3D" setter="set_transform" getter="get_transform">
The body's transformation matrix.
</member>
</members>

32
doc/classes/PhysicsServer3D.xml
View file

@ -16,7 +16,7 @@
</argument>
<argument index="1" name="shape" type="RID">
</argument>
<argument index="2" name="transform" type="Transform" default="Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )">
<argument index="2" name="transform" type="Transform3D" default="Transform3D( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )">
</argument>
<argument index="3" name="disabled" type="bool" default="false">
</argument>
@ -92,7 +92,7 @@
</description>
</method>
<method name="area_get_shape_transform" qualifiers="const">
<return type="Transform">
<return type="Transform3D">
</return>
<argument index="0" name="area" type="RID">
</argument>
@ -121,7 +121,7 @@
</description>
</method>
<method name="area_get_transform" qualifiers="const">
<return type="Transform">
<return type="Transform3D">
</return>
<argument index="0" name="area" type="RID">
</argument>
@ -258,7 +258,7 @@
</argument>
<argument index="1" name="shape_idx" type="int">
</argument>
<argument index="2" name="transform" type="Transform">
<argument index="2" name="transform" type="Transform3D">
</argument>
<description>
Sets the transform matrix for an area shape.
@ -291,7 +291,7 @@
</return>
<argument index="0" name="area" type="RID">
</argument>
<argument index="1" name="transform" type="Transform">
<argument index="1" name="transform" type="Transform3D">
</argument>
<description>
Sets the transform matrix for an area.
@ -337,7 +337,7 @@
</argument>
<argument index="1" name="shape" type="RID">
</argument>
<argument index="2" name="transform" type="Transform" default="Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )">
<argument index="2" name="transform" type="Transform3D" default="Transform3D( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )">
</argument>
<argument index="3" name="disabled" type="bool" default="false">
</argument>
@ -510,7 +510,7 @@
</description>
</method>
<method name="body_get_shape_transform" qualifiers="const">
<return type="Transform">
<return type="Transform3D">
</return>
<argument index="0" name="body" type="RID">
</argument>
@ -760,7 +760,7 @@
</argument>
<argument index="1" name="shape_idx" type="int">
</argument>
<argument index="2" name="transform" type="Transform">
<argument index="2" name="transform" type="Transform3D">
</argument>
<description>
Sets the transform matrix for a body shape.
@ -1017,11 +1017,11 @@
</argument>
<argument index="1" name="body_A" type="RID">
</argument>
<argument index="2" name="local_ref_A" type="Transform">
<argument index="2" name="local_ref_A" type="Transform3D">
</argument>
<argument index="3" name="body_B" type="RID">
</argument>
<argument index="4" name="local_ref_B" type="Transform">
<argument index="4" name="local_ref_B" type="Transform3D">
</argument>
<description>
</description>
@ -1033,11 +1033,11 @@
</argument>
<argument index="1" name="body_A" type="RID">
</argument>
<argument index="2" name="local_ref_A" type="Transform">
<argument index="2" name="local_ref_A" type="Transform3D">
</argument>
<argument index="3" name="body_B" type="RID">
</argument>
<argument index="4" name="local_ref_B" type="Transform">
<argument index="4" name="local_ref_B" type="Transform3D">
</argument>
<description>
</description>
@ -1049,11 +1049,11 @@
</argument>
<argument index="1" name="body_A" type="RID">
</argument>
<argument index="2" name="hinge_A" type="Transform">
<argument index="2" name="hinge_A" type="Transform3D">
</argument>
<argument index="3" name="body_B" type="RID">
</argument>
<argument index="4" name="hinge_B" type="Transform">
<argument index="4" name="hinge_B" type="Transform3D">
</argument>
<description>
</description>
@ -1081,11 +1081,11 @@
</argument>
<argument index="1" name="body_A" type="RID">
</argument>
<argument index="2" name="local_ref_A" type="Transform">
<argument index="2" name="local_ref_A" type="Transform3D">
</argument>
<argument index="3" name="body_B" type="RID">
</argument>
<argument index="4" name="local_ref_B" type="Transform">
<argument index="4" name="local_ref_B" type="Transform3D">
</argument>
<description>
</description>

2
doc/classes/PhysicsShapeQueryParameters3D.xml
View file

@ -60,7 +60,7 @@
[/csharp]
[/codeblocks]
</member>
<member name="transform" type="Transform" setter="set_transform" getter="get_transform" default="Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )">
<member name="transform" type="Transform3D" setter="set_transform" getter="get_transform" default="Transform3D( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )">
The queried shape's transform matrix.
</member>
</members>

4
doc/classes/RemoteTransform3D.xml
View file

@ -1,10 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="RemoteTransform3D" inherits="Node3D" version="4.0">
<brief_description>
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.
</brief_description>
<description>
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.
</description>
<tutorials>

28
doc/classes/RenderingServer.xml
View file

@ -130,10 +130,10 @@
</return>
<argument index="0" name="camera" type="RID">
</argument>
<argument index="1" name="transform" type="Transform">
<argument index="1" name="transform" type="Transform3D">
</argument>
<description>
Sets [Transform] of camera.
Sets [Transform3D] of camera.
</description>
</method>
<method name="camera_set_use_vertical_aspect">
@ -1335,7 +1335,7 @@
</return>
<argument index="0" name="instance" type="RID">
</argument>
<argument index="1" name="transform" type="Transform">
<argument index="1" name="transform" type="Transform3D">
</argument>
<description>
Sets the world space transform of the instance. Equivalent to [member Node3D.transform].
@ -1894,14 +1894,14 @@
</description>
</method>
<method name="multimesh_instance_get_transform" qualifiers="const">
<return type="Transform">
<return type="Transform3D">
</return>
<argument index="0" name="multimesh" type="RID">
</argument>
<argument index="1" name="index" type="int">
</argument>
<description>
Returns the [Transform] of the specified instance.
Returns the [Transform3D] of the specified instance.
</description>
</method>
<method name="multimesh_instance_get_transform_2d" qualifiers="const">
@ -1948,10 +1948,10 @@
</argument>
<argument index="1" name="index" type="int">
</argument>
<argument index="2" name="transform" type="Transform">
<argument index="2" name="transform" type="Transform3D">
</argument>
<description>
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].
</description>
</method>
<method name="multimesh_instance_set_transform_2d">
@ -2142,10 +2142,10 @@
</return>
<argument index="0" name="particles" type="RID">
</argument>
<argument index="1" name="transform" type="Transform">
<argument index="1" name="transform" type="Transform3D">
</argument>
<description>
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.
</description>
</method>
<method name="particles_set_emitting">
@ -2590,14 +2590,14 @@
</description>
</method>
<method name="skeleton_bone_get_transform" qualifiers="const">
<return type="Transform">
<return type="Transform3D">
</return>
<argument index="0" name="skeleton" type="RID">
</argument>
<argument index="1" name="bone" type="int">
</argument>
<description>
Returns the [Transform] set for a specific bone of this skeleton.
Returns the [Transform3D] set for a specific bone of this skeleton.
</description>
</method>
<method name="skeleton_bone_get_transform_2d" qualifiers="const">
@ -2618,10 +2618,10 @@
</argument>
<argument index="1" name="bone" type="int">
</argument>
<argument index="2" name="transform" type="Transform">
<argument index="2" name="transform" type="Transform3D">
</argument>
<description>
Sets the [Transform] for a specific bone of this skeleton.
Sets the [Transform3D] for a specific bone of this skeleton.
</description>
</method>
<method name="skeleton_bone_set_transform_2d">
@ -3267,7 +3267,7 @@
Use [Transform2D] to store MultiMesh transform.
</constant>
<constant name="MULTIMESH_TRANSFORM_3D" value="1" enum="MultimeshTransformFormat">
Use [Transform] to store MultiMesh transform.
Use [Transform3D] to store MultiMesh transform.
</constant>
<constant name="LIGHT_DIRECTIONAL" value="0" enum="LightType">
Is a directional (sun) light.

26
doc/classes/Skeleton3D.xml
View file

@ -23,9 +23,9 @@
</description>
</method>
<method name="bone_transform_to_world_transform">
<return type="Transform">
<return type="Transform3D">
</return>
<argument index="0" name="bone_transform" type="Transform">
<argument index="0" name="bone_transform" type="Transform3D">
</argument>
<description>
Takes the given bone pose/transform and converts it to a world transform, relative to the [Skeleton3D] node.
@ -63,7 +63,7 @@
</description>
</method>
<method name="get_bone_custom_pose" qualifiers="const">
<return type="Transform">
<return type="Transform3D">
</return>
<argument index="0" name="bone_idx" type="int">
</argument>
@ -72,7 +72,7 @@
</description>
</method>
<method name="get_bone_global_pose" qualifiers="const">
<return type="Transform">
<return type="Transform3D">
</return>
<argument index="0" name="bone_idx" type="int">
</argument>
@ -81,7 +81,7 @@
</description>
</method>
<method name="get_bone_global_pose_no_override" qualifiers="const">
<return type="Transform">
<return type="Transform3D">
</return>
<argument index="0" name="bone_idx" type="int">
</argument>
@ -109,7 +109,7 @@
</description>
</method>
<method name="get_bone_pose" qualifiers="const">
<return type="Transform">
<return type="Transform3D">
</return>
<argument index="0" name="bone_idx" type="int">
</argument>
@ -124,7 +124,7 @@
</description>
</method>
<method name="get_bone_rest" qualifiers="const">
<return type="Transform">
<return type="Transform3D">
</return>
<argument index="0" name="bone_idx" type="int">
</argument>
@ -199,7 +199,7 @@
</return>
<argument index="0" name="bone_idx" type="int">
</argument>
<argument index="1" name="custom_pose" type="Transform">
<argument index="1" name="custom_pose" type="Transform3D">
</argument>
<description>
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 @@
</return>
<argument index="0" name="bone_idx" type="int">
</argument>
<argument index="1" name="pose" type="Transform">
<argument index="1" name="pose" type="Transform3D">
</argument>
<argument index="2" name="amount" type="float">
</argument>
@ -261,7 +261,7 @@
</return>
<argument index="0" name="bone_idx" type="int">
</argument>
<argument index="1" name="pose" type="Transform">
<argument index="1" name="pose" type="Transform3D">
</argument>
<description>
Sets the pose transform for bone [code]bone_idx[/code].
@ -273,7 +273,7 @@
</return>
<argument index="0" name="bone_idx" type="int">
</argument>
<argument index="1" name="rest" type="Transform">
<argument index="1" name="rest" type="Transform3D">
</argument>
<description>
Sets the rest transform for bone [code]bone_idx[/code].
@ -289,9 +289,9 @@
</description>
</method>
<method name="world_transform_to_bone_transform">
<return type="Transform">
<return type="Transform3D">
</return>
<argument index="0" name="world_transform" type="Transform">
<argument index="0" name="world_transform" type="Transform3D">
</argument>
<description>
Takes the given world transform, relative to the [Skeleton3D], and converts it to a bone pose/transform.

2
doc/classes/SkeletonIK3D.xml
View file

@ -48,7 +48,7 @@
</member>
<member name="root_bone" type="StringName" setter="set_root_bone" getter="get_root_bone" default="@&quot;&quot;">
</member>
<member name="target" type="Transform" setter="set_target_transform" getter="get_target_transform" default="Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )">
<member name="target" type="Transform3D" setter="set_target_transform" getter="get_target_transform" default="Transform3D( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )">
</member>
<member name="target_node" type="NodePath" setter="set_target_node" getter="get_target_node" default="NodePath(&quot;&quot;)">
</member>

6
doc/classes/Skin.xml
View file

@ -12,7 +12,7 @@
</return>
<argument index="0" name="bone" type="int">
</argument>
<argument index="1" name="pose" type="Transform">
<argument index="1" name="pose" type="Transform3D">
</argument>
<description>
</description>
@ -46,7 +46,7 @@
</description>
</method>
<method name="get_bind_pose" qualifiers="const">
<return type="Transform">
<return type="Transform3D">
</return>
<argument index="0" name="bind_index" type="int">
</argument>
@ -86,7 +86,7 @@
</return>
<argument index="0" name="bind_index" type="int">
</argument>
<argument index="1" name="pose" type="Transform">
<argument index="1" name="pose" type="Transform3D">
</argument>
<description>
</description>

4
doc/classes/SurfaceTool.xml
View file

@ -76,10 +76,10 @@
</argument>
<argument index="1" name="surface" type="int">
</argument>
<argument index="2" name="transform" type="Transform">
<argument index="2" name="transform" type="Transform3D">
</argument>
<description>
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].
</description>
</method>
<method name="begin">

2
doc/classes/Transform2D.xml
View file

@ -18,7 +18,7 @@
<return type="Transform2D">
</return>
<description>
Constructs a default-initialized [Transform] set to [constant IDENTITY].
Constructs a default-initialized [Transform2D] set to [constant IDENTITY].
</description>
</method>
<method name="Transform2D" qualifiers="constructor">

74
doc/classes/Transform.xml → doc/classes/Transform3D.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="Transform" version="4.0">
<class name="Transform3D" version="4.0">
<brief_description>
3D transformation (3×4 matrix).
</brief_description>
@ -16,35 +16,35 @@
<link title="2.5D Demo">https://godotengine.org/asset-library/asset/583</link>
</tutorials>
<methods>
<method name="Transform" qualifiers="constructor">
<return type="Transform">
<method name="Transform3D" qualifiers="constructor">
<return type="Transform3D">
</return>
<description>
Constructs a default-initialized [Transform] set to [constant IDENTITY].
Constructs a default-initialized [Transform3D] set to [constant IDENTITY].
</description>
</method>
<method name="Transform" qualifiers="constructor">
<return type="Transform">
<method name="Transform3D" qualifiers="constructor">
<return type="Transform3D">
</return>
<argument index="0" name="from" type="Transform">
<argument index="0" name="from" type="Transform3D">
</argument>
<description>
Constructs a [Transform] as a copy of the given [Transform].
Constructs a [Transform3D] as a copy of the given [Transform3D].
</description>
</method>
<method name="Transform" qualifiers="constructor">
<return type="Transform">
<method name="Transform3D" qualifiers="constructor">
<return type="Transform3D">
</return>
<argument index="0" name="basis" type="Basis">
</argument>
<argument index="1" name="origin" type="Vector3">
</argument>
<description>
Constructs a Transform from a [Basis] and [Vector3].
Constructs a Transform3D from a [Basis] and [Vector3].
</description>
</method>
<method name="Transform" qualifiers="constructor">
<return type="Transform">
<method name="Transform3D" qualifiers="constructor">
<return type="Transform3D">
</return>
<argument index="0" name="x_axis" type="Vector3">
</argument>
@ -55,29 +55,29 @@
<argument index="3" name="origin" type="Vector3">
</argument>
<description>
Constructs a Transform from four [Vector3] values (matrix columns). Each axis corresponds to local basis vectors (some of which may be scaled).
Constructs a Transform3D from four [Vector3] values (matrix columns). Each axis corresponds to local basis vectors (some of which may be scaled).
</description>
</method>
<method name="affine_inverse" qualifiers="const">
<return type="Transform">
<return type="Transform3D">
</return>
<description>
Returns the inverse of the transform, under the assumption that the transformation is composed of rotation, scaling and translation.
</description>
</method>
<method name="interpolate_with" qualifiers="const">
<return type="Transform">
<return type="Transform3D">
</return>
<argument index="0" name="xform" type="Transform">
<argument index="0" name="xform" type="Transform3D">
</argument>
<argument index="1" name="weight" type="float">
</argument>
<description>
Interpolates the transform to other Transform by weight amount (on the range of 0.0 to 1.0).
Interpolates the transform to other Transform3D by weight amount (on the range of 0.0 to 1.0).
</description>
</method>
<method name="inverse" qualifiers="const">
<return type="Transform">
<return type="Transform3D">
</return>
<description>
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).
@ -86,14 +86,14 @@
<method name="is_equal_approx" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="xform" type="Transform">
<argument index="0" name="xform" type="Transform3D">
</argument>
<description>
Returns [code]true[/code] if this transform and [code]transform[/code] are approximately equal, by calling [code]is_equal_approx[/code] on each component.
</description>
</method>
<method name="looking_at" qualifiers="const">
<return type="Transform">
<return type="Transform3D">
</return>
<argument index="0" name="target" type="Vector3">
</argument>
@ -108,7 +108,7 @@
<method name="operator !=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="Transform">
<argument index="0" name="right" type="Transform3D">
</argument>
<description>
</description>
@ -122,9 +122,9 @@
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="Transform">
<return type="Transform3D">
</return>
<argument index="0" name="right" type="Transform">
<argument index="0" name="right" type="Transform3D">
</argument>
<description>
</description>
@ -148,20 +148,20 @@
<method name="operator ==" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="Transform">
<argument index="0" name="right" type="Transform3D">
</argument>
<description>
</description>
</method>
<method name="orthonormalized" qualifiers="const">
<return type="Transform">
<return type="Transform3D">
</return>
<description>
Returns the transform with the basis orthogonal (90 degrees), and normalized axis vectors.
</description>
</method>
<method name="rotated" qualifiers="const">
<return type="Transform">
<return type="Transform3D">
</return>
<argument index="0" name="axis" type="Vector3">
</argument>
@ -172,7 +172,7 @@
</description>
</method>
<method name="scaled" qualifiers="const">
<return type="Transform">
<return type="Transform3D">
</return>
<argument index="0" name="scale" type="Vector3">
</argument>
@ -181,7 +181,7 @@
</description>
</method>
<method name="translated" qualifiers="const">
<return type="Transform">
<return type="Transform3D">
</return>
<argument index="0" name="offset" type="Vector3">
</argument>
@ -200,17 +200,17 @@
</member>
</members>
<constants>
<constant name="IDENTITY" value="Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )">
[Transform] with no translation, rotation or scaling applied. When applied to other data structures, [constant IDENTITY] performs no transformation.
<constant name="IDENTITY" value="Transform3D( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )">
[Transform3D] with no translation, rotation or scaling applied. When applied to other data structures, [constant IDENTITY] performs no transformation.
</constant>
<constant name="FLIP_X" value="Transform( -1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )">
[Transform] with mirroring applied perpendicular to the YZ plane.
<constant name="FLIP_X" value="Transform3D( -1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )">
[Transform3D] with mirroring applied perpendicular to the YZ plane.
</constant>
<constant name="FLIP_Y" value="Transform( 1, 0, 0, 0, -1, 0, 0, 0, 1, 0, 0, 0 )">
[Transform] with mirroring applied perpendicular to the XZ plane.
<constant name="FLIP_Y" value="Transform3D( 1, 0, 0, 0, -1, 0, 0, 0, 1, 0, 0, 0 )">
[Transform3D] with mirroring applied perpendicular to the XZ plane.
</constant>
<constant name="FLIP_Z" value="Transform( 1, 0, 0, 0, 1, 0, 0, 0, -1, 0, 0, 0 )">
[Transform] with mirroring applied perpendicular to the XY plane.
<constant name="FLIP_Z" value="Transform3D( 1, 0, 0, 0, 1, 0, 0, 0, -1, 0, 0, 0 )">
[Transform3D] with mirroring applied perpendicular to the XY plane.
</constant>
</constants>
</class>

2
doc/classes/Vector3.xml
View file

@ -274,7 +274,7 @@
<method name="operator *" qualifiers="operator">
<return type="Vector3">
</return>
<argument index="0" name="right" type="Transform">
<argument index="0" name="right" type="Transform3D">
</argument>
<description>
</description>

2
doc/classes/VisualInstance3D.xml
View file

@ -44,7 +44,7 @@
</return>
<description>
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].
</description>
</method>
<method name="set_base">

2
doc/classes/VisualShaderNodeDeterminant.xml
View file

@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualShaderNodeDeterminant" inherits="VisualShaderNode" version="4.0">
<brief_description>
Calculates the determinant of a [Transform] within the visual shader graph.
Calculates the determinant of a [Transform3D] within the visual shader graph.
</brief_description>
<description>
Translates to [code]determinant(x)[/code] in the shader language.

2
doc/classes/VisualShaderNodeTransformCompose.xml
View file

@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualShaderNodeTransformCompose" inherits="VisualShaderNode" version="4.0">
<brief_description>
Composes a [Transform] from four [Vector3]s within the visual shader graph.
Composes a [Transform3D] from four [Vector3]s within the visual shader graph.
</brief_description>
<description>
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].

8
doc/classes/VisualShaderNodeTransformConstant.xml
View file

@ -1,18 +1,18 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualShaderNodeTransformConstant" inherits="VisualShaderNodeConstant" version="4.0">
<brief_description>
A [Transform] constant for use within the visual shader graph.
A [Transform3D] constant for use within the visual shader graph.
</brief_description>
<description>
A constant [Transform], which can be used as an input node.
A constant [Transform3D], which can be used as an input node.
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<members>
<member name="constant" type="Transform" setter="set_constant" getter="get_constant" default="Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )">
A [Transform] constant which represents the state of this node.
<member name="constant" type="Transform3D" setter="set_constant" getter="get_constant" default="Transform3D( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )">
A [Transform3D] constant which represents the state of this node.
</member>
</members>
<constants>

2
doc/classes/VisualShaderNodeTransformDecompose.xml
View file

@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualShaderNodeTransformDecompose" inherits="VisualShaderNode" version="4.0">
<brief_description>
Decomposes a [Transform] into four [Vector3]s within the visual shader graph.
Decomposes a [Transform3D] into four [Vector3]s within the visual shader graph.
</brief_description>
<description>
Takes a 4x4 transform matrix and decomposes it into four [code]vec3[/code] values, one from each row of the matrix.

8
doc/classes/VisualShaderNodeTransformFunc.xml
View file

@ -1,10 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualShaderNodeTransformFunc" inherits="VisualShaderNode" version="4.0">
<brief_description>
Computes a [Transform] function within the visual shader graph.
Computes a [Transform3D] function within the visual shader graph.
</brief_description>
<description>
Computes an inverse or transpose function on the provided [Transform].
Computes an inverse or transpose function on the provided [Transform3D].
</description>
<tutorials>
</tutorials>
@ -17,10 +17,10 @@
</members>
<constants>
<constant name="FUNC_INVERSE" value="0" enum="Function">
Perform the inverse operation on the [Transform] matrix.
Perform the inverse operation on the [Transform3D] matrix.
</constant>
<constant name="FUNC_TRANSPOSE" value="1" enum="Function">
Perform the transpose operation on the [Transform] matrix.
Perform the transpose operation on the [Transform3D] matrix.
</constant>
</constants>
</class>

2
doc/classes/VisualShaderNodeTransformMult.xml
View file

@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualShaderNodeTransformMult" inherits="VisualShaderNode" version="4.0">
<brief_description>
Multiplies [Transform] by [Transform] within the visual shader graph.
Multiplies [Transform3D] by [Transform3D] within the visual shader graph.
</brief_description>
<description>
A multiplication operation on two transforms (4x4 matrices), with support for different multiplication operators.

4
doc/classes/VisualShaderNodeTransformUniform.xml
View file

@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualShaderNodeTransformUniform" inherits="VisualShaderNodeUniform" version="4.0">
<brief_description>
A [Transform] uniform for use within the visual shader graph.
A [Transform3D] uniform for use within the visual shader graph.
</brief_description>
<description>
Translated to [code]uniform mat4[/code] in the shader language.
@ -11,7 +11,7 @@
<methods>
</methods>
<members>
<member name="default_value" type="Transform" setter="set_default_value" getter="get_default_value" default="Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )">
<member name="default_value" type="Transform3D" setter="set_default_value" getter="get_default_value" default="Transform3D( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )">
A default value to be assigned within the shader.
</member>
<member name="default_value_enabled" type="bool" setter="set_default_value_enabled" getter="is_default_value_enabled" default="false">

2
doc/classes/VisualShaderNodeTransformVecMult.xml
View file

@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualShaderNodeTransformVecMult" inherits="VisualShaderNode" version="4.0">
<brief_description>
Multiplies a [Transform] and a [Vector3] within the visual shader graph.
Multiplies a [Transform3D] and a [Vector3] within the visual shader graph.
</brief_description>
<description>
A multiplication operation on a transform (4x4 matrix) and a vector, with support for different multiplication operators.

2
doc/classes/XRPositionalTracker.xml
View file

@ -69,7 +69,7 @@
</description>
</method>
<method name="get_transform" qualifiers="const">
<return type="Transform">
<return type="Transform3D">
</return>
<argument index="0" name="adjust_by_reference_frame" type="bool">
</argument>

4
doc/classes/XRServer.xml
View file

@ -63,7 +63,7 @@
</description>
</method>
<method name="get_hmd_transform">
<return type="Transform">
<return type="Transform3D">
</return>
<description>
Returns the primary interface's transformation.
@ -114,7 +114,7 @@
</description>
</method>
<method name="get_reference_frame" qualifiers="const">
<return type="Transform">
<return type="Transform3D">
</return>
<description>
Returns the reference frame transform. Mostly used internally and exposed for GDNative build interfaces.

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

@ -31,7 +31,7 @@
<return type="Array">
</return>
<description>
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.
</description>
</method>
<method name="is_root_shape" qualifiers="const">

2
modules/gltf/doc_classes/GLTFNode.xml
View file

@ -33,7 +33,7 @@
</member>
<member name="translation" type="Vector3" setter="set_translation" getter="get_translation" default="Vector3( 0, 0, 0 )">
</member>
<member name="xform" type="Transform" setter="set_xform" getter="get_xform" default="Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )">
<member name="xform" type="Transform3D" setter="set_xform" getter="get_xform" default="Transform3D( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )">
</member>
</members>
<constants>

4
modules/gridmap/doc_classes/GridMap.xml
View file

@ -41,7 +41,7 @@
<return type="Array">
</return>
<description>
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.
</description>
</method>
<method name="get_cell_item" qualifiers="const">
@ -84,7 +84,7 @@
<return type="Array">
</return>
<description>
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.
</description>
</method>
<method name="get_used_cells" qualifiers="const">