summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorSilc Renew <tokage.it.lab@gmail.com>2022-07-05 14:04:17 +0900
committerSilc Renew <tokage.it.lab@gmail.com>2022-07-16 19:53:11 +0900
commitf3af3aedfe7ed72ecf6671439ebe00e03f86ed8c (patch)
tree9c044932b62a2c1d07e09b19c2896e5641c56ea6 /doc
parent9904a9db5a90f2f1896b6b7e1603ca2dd2745bad (diff)
add rest fixer to importer retarget
Diffstat (limited to 'doc')
-rw-r--r--doc/classes/SkeletonProfile.xml79
1 files changed, 79 insertions, 0 deletions
diff --git a/doc/classes/SkeletonProfile.xml b/doc/classes/SkeletonProfile.xml
index 55a2ea6759..a7f5f7a0a6 100644
--- a/doc/classes/SkeletonProfile.xml
+++ b/doc/classes/SkeletonProfile.xml
@@ -9,6 +9,13 @@
<tutorials>
</tutorials>
<methods>
+ <method name="find_bone" qualifiers="const">
+ <return type="int" />
+ <argument index="0" name="bone_name" type="StringName" />
+ <description>
+ Returns the bone index that matches [code]bone_name[/code] as its name.
+ </description>
+ </method>
<method name="get_bone_name" qualifiers="const">
<return type="StringName" />
<argument index="0" name="bone_idx" type="int" />
@@ -17,6 +24,20 @@
In the retargeting process, the returned bone name is the bone name of the target skeleton.
</description>
</method>
+ <method name="get_bone_parent" qualifiers="const">
+ <return type="StringName" />
+ <argument index="0" name="bone_idx" type="int" />
+ <description>
+ Returns the name of the bone which is the parent to the bone at [code]bone_idx[/code]. The result is empty if the bone has no parent.
+ </description>
+ </method>
+ <method name="get_bone_tail" qualifiers="const">
+ <return type="StringName" />
+ <argument index="0" name="bone_idx" type="int" />
+ <description>
+ Returns the name of the bone which is the tail of the bone at [code]bone_idx[/code].
+ </description>
+ </method>
<method name="get_group" qualifiers="const">
<return type="StringName" />
<argument index="0" name="bone_idx" type="int" />
@@ -39,6 +60,20 @@
This is the offset with origin at the top left corner of the square.
</description>
</method>
+ <method name="get_reference_pose" qualifiers="const">
+ <return type="Transform3D" />
+ <argument index="0" name="bone_idx" type="int" />
+ <description>
+ Returns the reference pose transform for bone [code]bone_idx[/code].
+ </description>
+ </method>
+ <method name="get_tail_direction" qualifiers="const">
+ <return type="int" enum="SkeletonProfile.TailDirection" />
+ <argument index="0" name="bone_idx" type="int" />
+ <description>
+ Returns the tail direction of the bone at [code]bone_idx[/code].
+ </description>
+ </method>
<method name="get_texture" qualifiers="const">
<return type="Texture2D" />
<argument index="0" name="group_idx" type="int" />
@@ -55,6 +90,22 @@
In the retargeting process, the setting bone name is the bone name of the target skeleton.
</description>
</method>
+ <method name="set_bone_parent">
+ <return type="void" />
+ <argument index="0" name="bone_idx" type="int" />
+ <argument index="1" name="bone_parent" type="StringName" />
+ <description>
+ Sets the bone with name [code]bone_parent[/code] as the parent of the bone at [code]bone_idx[/code]. If an empty string is passed, then the bone has no parent.
+ </description>
+ </method>
+ <method name="set_bone_tail">
+ <return type="void" />
+ <argument index="0" name="bone_idx" type="int" />
+ <argument index="1" name="bone_tail" type="StringName" />
+ <description>
+ Sets the bone with name [code]bone_tail[/code] as the tail of the bone at [code]bone_idx[/code].
+ </description>
+ </method>
<method name="set_group">
<return type="void" />
<argument index="0" name="bone_idx" type="int" />
@@ -80,6 +131,23 @@
This is the offset with origin at the top left corner of the square.
</description>
</method>
+ <method name="set_reference_pose">
+ <return type="void" />
+ <argument index="0" name="bone_idx" type="int" />
+ <argument index="1" name="bone_name" type="Transform3D" />
+ <description>
+ Sets the reference pose transform for bone [code]bone_idx[/code].
+ </description>
+ </method>
+ <method name="set_tail_direction">
+ <return type="void" />
+ <argument index="0" name="bone_idx" type="int" />
+ <argument index="1" name="tail_direction" type="int" enum="SkeletonProfile.TailDirection" />
+ <description>
+ Sets the tail direction of the bone at [code]bone_idx[/code].
+ [b]Note:[/b] This only specifies the method of calculation. The actual coordinates required should be stored in an external skeleton, so the calculation itself needs to be done externally.
+ </description>
+ </method>
<method name="set_texture">
<return type="void" />
<argument index="0" name="group_idx" type="int" />
@@ -103,4 +171,15 @@
</description>
</signal>
</signals>
+ <constants>
+ <constant name="TAIL_DIRECTION_AVERAGE_CHILDREN" value="0" enum="TailDirection">
+ Direction to the average coordinates of bone children.
+ </constant>
+ <constant name="TAIL_DIRECTION_SPECIFIC_CHILD" value="1" enum="TailDirection">
+ Direction to the coordinates of specified bone child.
+ </constant>
+ <constant name="TAIL_DIRECTION_END" value="2" enum="TailDirection">
+ Direction is not calculated.
+ </constant>
+ </constants>
</class>