diff options
| author | Nathan Frank <nathanjf@usc.edu> | 2023-09-15 11:22:25 -0400 |
|---|---|---|
| committer | Yuri Sizov <yuris@humnom.net> | 2023-11-10 19:07:04 +0100 |
| commit | 13e2e4e5d8b2230f2e875582f1b055baadf38441 (patch) | |
| tree | cacc6cc8fe206dc38a328b28caccc9f0e7413772 /doc/classes/Skeleton3D.xml | |
| parent | bdd9034ad05e1824ff5d9c750acd87caeafe6dca (diff) | |
| download | redot-engine-13e2e4e5d8b2230f2e875582f1b055baadf38441.tar.gz | |
Add missing documentation for Skeleton3D methods
Adds description for get/set pose position/rotation/scale.
Diffstat (limited to 'doc/classes/Skeleton3D.xml')
| -rw-r--r-- | doc/classes/Skeleton3D.xml | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/classes/Skeleton3D.xml b/doc/classes/Skeleton3D.xml index b4c42ea399..bc3782d1a0 100644 --- a/doc/classes/Skeleton3D.xml +++ b/doc/classes/Skeleton3D.xml @@ -126,18 +126,21 @@ <return type="Vector3" /> <param index="0" name="bone_idx" type="int" /> <description> + Returns the pose position of the bone at [param bone_idx]. The returned [Vector3] is in the local coordinate space of the [Skeleton3D] node. </description> </method> <method name="get_bone_pose_rotation" qualifiers="const"> <return type="Quaternion" /> <param index="0" name="bone_idx" type="int" /> <description> + Returns the pose rotation of the bone at [param bone_idx]. The returned [Quaternion] is local to the bone with respect to the rotation of any parent bones. </description> </method> <method name="get_bone_pose_scale" qualifiers="const"> <return type="Vector3" /> <param index="0" name="bone_idx" type="int" /> <description> + Returns the pose scale of the bone at [param bone_idx]. </description> </method> <method name="get_bone_rest" qualifiers="const"> @@ -265,6 +268,7 @@ <param index="0" name="bone_idx" type="int" /> <param index="1" name="position" type="Vector3" /> <description> + Sets the pose position of the bone at [param bone_idx] to [param position]. [param position] is a [Vector3] describing a position local to the [Skeleton3D] node. </description> </method> <method name="set_bone_pose_rotation"> @@ -272,6 +276,7 @@ <param index="0" name="bone_idx" type="int" /> <param index="1" name="rotation" type="Quaternion" /> <description> + Sets the pose rotation of the bone at [param bone_idx] to [param rotation]. [param rotation] is a [Quaternion] describing a rotation in the bone's local coordinate space with respect to the rotation of any parent bones. </description> </method> <method name="set_bone_pose_scale"> @@ -279,6 +284,7 @@ <param index="0" name="bone_idx" type="int" /> <param index="1" name="scale" type="Vector3" /> <description> + Sets the pose scale of the bone at [param bone_idx] to [param scale]. </description> </method> <method name="set_bone_rest"> |