Skip to content

Commit

Permalink
Add missing documentation for Skeleton3D methods
Browse files Browse the repository at this point in the history
Adds description for get/set pose position/rotation/scale.
  • Loading branch information
Nathan Frank authored and YuriSizov committed Nov 10, 2023
1 parent bdd9034 commit 13e2e4e
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions doc/classes/Skeleton3D.xml
Original file line number Diff line number Diff line change
Expand Up @@ -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">
Expand Down Expand Up @@ -265,20 +268,23 @@
<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">
<return type="void" />
<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">
<return type="void" />
<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">
Expand Down

0 comments on commit 13e2e4e

Please sign in to comment.