diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2018-06-15 08:49:27 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-06-15 08:49:27 +0200 |
| commit | 8e73629def2132a057c6b444d1b867a5afd66b33 (patch) | |
| tree | 167a3a8b83bc53d38ef677f48b7f4ab9a05803ad /doc | |
| parent | 4da621603eaf4b85dbaacb64a010ec2e62574ec5 (diff) | |
| parent | 195e96361399b6d38b5e148b989d3d0e60a2e758 (diff) | |
| download | redot-engine-8e73629def2132a057c6b444d1b867a5afd66b33.tar.gz | |
Merge pull request #19575 from tagcup/skeleton_doc
Added some details in skeleton docs.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/Skeleton.xml | 12 |
1 files changed, 10 insertions, 2 deletions
diff --git a/doc/classes/Skeleton.xml b/doc/classes/Skeleton.xml index 0f96ee01ff..f6662fbe0e 100644 --- a/doc/classes/Skeleton.xml +++ b/doc/classes/Skeleton.xml @@ -5,6 +5,11 @@ </brief_description> <description> Skeleton provides a hierarchical interface for managing bones, including pose, rest and animation (see [Animation]). Skeleton will support rag doll dynamics in the future. + + The overall transform of a bone with respect to the skeleton is determined by the following hierarchical order: rest pose, custom pose and pose. + + Note that "global pose" below refers to the overall transform of the bone with respect to skeleton, so it not the actual global/world transform of the bone. + </description> <tutorials> </tutorials> @@ -60,6 +65,7 @@ <argument index="0" name="bone_idx" type="int"> </argument> <description> + Return the custom pose of the specified bone. Custom pose is applied on top of the rest pose. </description> </method> <method name="get_bone_global_pose" qualifiers="const"> @@ -68,6 +74,7 @@ <argument index="0" name="bone_idx" type="int"> </argument> <description> + Return the overall transform of the specified bone, with respect to the skeleton. Being relative to the skeleton frame, this is not the actual "global" transform of the bone. </description> </method> <method name="get_bone_name" qualifiers="const"> @@ -76,7 +83,7 @@ <argument index="0" name="bone_idx" type="int"> </argument> <description> - Return the name of the bone at index "index" + Return the name of the bone at index "index". </description> </method> <method name="get_bone_parent" qualifiers="const"> @@ -94,7 +101,7 @@ <argument index="0" name="bone_idx" type="int"> </argument> <description> - Return the pose transform for bone "bone_idx". + Return the pose transform of the specified bone. Pose is applied on top of the custom pose, which is applied on top the rest pose. </description> </method> <method name="get_bone_rest" qualifiers="const"> @@ -112,6 +119,7 @@ <argument index="0" name="bone_idx" type="int"> </argument> <description> + Return the combination of custom pose and pose. The returned transform is in skeleton's reference frame. </description> </method> <method name="get_bound_child_nodes_to_bone" qualifiers="const"> |