asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

Add missing documentation for Skeleton3D methods

Browse source 
Adds description for get/set pose position/rotation/scale.
This commit is contained in:
Nathan Frank 2023-09-15 11:22:25 -04:00 committed by Yuri Sizov
parent bdd9034ad0
commit 13e2e4e5d8
1 changed files with 6 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
doc/classes/Skeleton3D.xml
View file

@ -126,18 +126,21 @@
<return type="Vector3" /> <return type="Vector3" />
<param index="0" name="bone_idx" type="int" /> <param index="0" name="bone_idx" type="int" />
<description> <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> </description>
</method> </method>
<method name="get_bone_pose_rotation" qualifiers="const"> <method name="get_bone_pose_rotation" qualifiers="const">
<return type="Quaternion" /> <return type="Quaternion" />
<param index="0" name="bone_idx" type="int" /> <param index="0" name="bone_idx" type="int" />
<description> <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> </description>
</method> </method>
<method name="get_bone_pose_scale" qualifiers="const"> <method name="get_bone_pose_scale" qualifiers="const">
<return type="Vector3" /> <return type="Vector3" />
<param index="0" name="bone_idx" type="int" /> <param index="0" name="bone_idx" type="int" />
<description> <description>
Returns the pose scale of the bone at [param bone_idx].
</description> </description>
</method> </method>
<method name="get_bone_rest" qualifiers="const"> <method name="get_bone_rest" qualifiers="const">
@ -265,6 +268,7 @@
<param index="0" name="bone_idx" type="int" /> <param index="0" name="bone_idx" type="int" />
<param index="1" name="position" type="Vector3" /> <param index="1" name="position" type="Vector3" />
<description> <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> </description>
</method> </method>
<method name="set_bone_pose_rotation"> <method name="set_bone_pose_rotation">
@ -272,6 +276,7 @@
<param index="0" name="bone_idx" type="int" /> <param index="0" name="bone_idx" type="int" />
<param index="1" name="rotation" type="Quaternion" /> <param index="1" name="rotation" type="Quaternion" />
<description> <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> </description>
</method> </method>
<method name="set_bone_pose_scale"> <method name="set_bone_pose_scale">
@ -279,6 +284,7 @@
<param index="0" name="bone_idx" type="int" /> <param index="0" name="bone_idx" type="int" />
<param index="1" name="scale" type="Vector3" /> <param index="1" name="scale" type="Vector3" />
<description> <description>
Sets the pose scale of the bone at [param bone_idx] to [param scale].
</description> </description>
</method> </method>
<method name="set_bone_rest"> <method name="set_bone_rest">