diff options
Diffstat (limited to 'doc/classes/SkeletonModification2DTwoBoneIK.xml')
| -rw-r--r-- | doc/classes/SkeletonModification2DTwoBoneIK.xml | 38 |
1 files changed, 13 insertions, 25 deletions
diff --git a/doc/classes/SkeletonModification2DTwoBoneIK.xml b/doc/classes/SkeletonModification2DTwoBoneIK.xml index 554515556b..25ee981d5d 100644 --- a/doc/classes/SkeletonModification2DTwoBoneIK.xml +++ b/doc/classes/SkeletonModification2DTwoBoneIK.xml @@ -4,72 +4,60 @@ A modification that rotates two bones using the law of cosigns to reach the target. </brief_description> <description> - This [SkeletonModification2D] uses an algorithm typically called TwoBoneIK. This algorithm works by leveraging the law of cosigns and the lengths of the bones to figure out what rotation the bones currently have, and what rotation they need to make a complete triangle, where the first bone, the second bone, and the target form the three verticies of the triangle. Because the algorithm works by making a triangle, it can only opperate on two bones. + This [SkeletonModification2D] uses an algorithm typically called TwoBoneIK. This algorithm works by leveraging the law of cosigns and the lengths of the bones to figure out what rotation the bones currently have, and what rotation they need to make a complete triangle, where the first bone, the second bone, and the target form the three vertices of the triangle. Because the algorithm works by making a triangle, it can only operate on two bones. TwoBoneIK is great for arms, legs, and really any joints that can be represented by just two bones that bend to reach a target. This solver is more lightweight than [SkeletonModification2DFABRIK], but gives similar, natural looking results. </description> <tutorials> </tutorials> <methods> <method name="get_joint_one_bone2d_node" qualifiers="const"> - <return type="NodePath"> - </return> + <return type="NodePath" /> <description> Returns the [Bone2D] node that is being used as the first bone in the TwoBoneIK modification. </description> </method> <method name="get_joint_one_bone_idx" qualifiers="const"> - <return type="int"> - </return> + <return type="int" /> <description> Returns the index of the [Bone2D] node that is being used as the first bone in the TwoBoneIK modification. </description> </method> <method name="get_joint_two_bone2d_node" qualifiers="const"> - <return type="NodePath"> - </return> + <return type="NodePath" /> <description> Returns the [Bone2D] node that is being used as the second bone in the TwoBoneIK modification. </description> </method> <method name="get_joint_two_bone_idx" qualifiers="const"> - <return type="int"> - </return> + <return type="int" /> <description> Returns the index of the [Bone2D] node that is being used as the second bone in the TwoBoneIK modification. </description> </method> <method name="set_joint_one_bone2d_node"> - <return type="void"> - </return> - <argument index="0" name="bone2d_node" type="NodePath"> - </argument> + <return type="void" /> + <argument index="0" name="bone2d_node" type="NodePath" /> <description> Sets the [Bone2D] node that is being used as the first bone in the TwoBoneIK modification. </description> </method> <method name="set_joint_one_bone_idx"> - <return type="void"> - </return> - <argument index="0" name="bone_idx" type="int"> - </argument> + <return type="void" /> + <argument index="0" name="bone_idx" type="int" /> <description> Sets the index of the [Bone2D] node that is being used as the first bone in the TwoBoneIK modification. </description> </method> <method name="set_joint_two_bone2d_node"> - <return type="void"> - </return> - <argument index="0" name="bone2d_node" type="NodePath"> - </argument> + <return type="void" /> + <argument index="0" name="bone2d_node" type="NodePath" /> <description> Sets the [Bone2D] node that is being used as the second bone in the TwoBoneIK modification. </description> </method> <method name="set_joint_two_bone_idx"> - <return type="void"> - </return> - <argument index="0" name="bone_idx" type="int"> - </argument> + <return type="void" /> + <argument index="0" name="bone_idx" type="int" /> <description> Sets the index of the [Bone2D] node that is being used as the second bone in the TwoBoneIK modification. </description> |