diff options
Diffstat (limited to 'doc/classes/SkeletonModification3DCCDIK.xml')
| -rw-r--r-- | doc/classes/SkeletonModification3DCCDIK.xml | 76 |
1 files changed, 37 insertions, 39 deletions
diff --git a/doc/classes/SkeletonModification3DCCDIK.xml b/doc/classes/SkeletonModification3DCCDIK.xml index aa7ddad56e..207896776f 100644 --- a/doc/classes/SkeletonModification3DCCDIK.xml +++ b/doc/classes/SkeletonModification3DCCDIK.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="SkeletonModification3DCCDIK" inherits="SkeletonModification3D" version="4.0"> +<class name="SkeletonModification3DCCDIK" inherits="SkeletonModification3D" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> A modification that uses CCDIK to manipulate a series of bones to reach a target. </brief_description> <description> - This [SkeletonModification3D] uses an algorithm called [b]C[/b]yclic [b]C[/b]oordinate [b]D[/b]escent [b]I[/b]nverse [b]K[/b]inematics, or CCDIK, to maniuplate a chain of bones in a Skeleton so it reaches a defined target. + This [SkeletonModification3D] uses an algorithm called Cyclic Coordinate Descent Inverse Kinematics, or CCDIK, to manipulate a chain of bones in a Skeleton so it reaches a defined target. CCDIK works by rotating a set of bones, typically called a "bone chain", on a single axis. Each bone is rotated to face the target from the tip (by default), which over a chain of bones allow it to rotate properly to reach the target. Because the bones only rotate on a single axis, CCDIK [i]can[/i] look more robotic than other IK solvers. [b]Note:[/b] The CCDIK modifier has [code]ccdik_joints[/code], which are the data objects that hold the data for each joint in the CCDIK chain. This is different from a bone! CCDIK joints hold the data needed for each bone in the bone chain used by CCDIK. CCDIK also fully supports angle constraints, allowing for more control over how a solution is met. @@ -14,108 +14,108 @@ <methods> <method name="get_ccdik_joint_bone_index" qualifiers="const"> <return type="int" /> - <argument index="0" name="joint_idx" type="int" /> + <param index="0" name="joint_idx" type="int" /> <description> - Returns the bone index of the bone assigned to the CCDIK joint at [code]joint_idx[/code]. + Returns the bone index of the bone assigned to the CCDIK joint at [param joint_idx]. </description> </method> <method name="get_ccdik_joint_bone_name" qualifiers="const"> <return type="String" /> - <argument index="0" name="joint_idx" type="int" /> + <param index="0" name="joint_idx" type="int" /> <description> - Returns the name of the bone that is assigned to the CCDIK joint at [code]joint_idx[/code]. + Returns the name of the bone that is assigned to the CCDIK joint at [param joint_idx]. </description> </method> <method name="get_ccdik_joint_ccdik_axis" qualifiers="const"> <return type="int" /> - <argument index="0" name="joint_idx" type="int" /> + <param index="0" name="joint_idx" type="int" /> <description> - Returns the integer representing the joint axis of the CCDIK joint at [code]joint_idx[/code]. + Returns the integer representing the joint axis of the CCDIK joint at [param joint_idx]. </description> </method> <method name="get_ccdik_joint_constraint_angle_max" qualifiers="const"> <return type="float" /> - <argument index="0" name="joint_idx" type="int" /> + <param index="0" name="joint_idx" type="int" /> <description> - Returns the maximum angle constraint for the joint at [code]joint_idx[/code]. [b]Note:[/b] This angle is in degrees! + Returns the maximum angle constraint for the joint at [param joint_idx]. [b]Note:[/b] This angle is in degrees! </description> </method> <method name="get_ccdik_joint_constraint_angle_min" qualifiers="const"> <return type="float" /> - <argument index="0" name="joint_idx" type="int" /> + <param index="0" name="joint_idx" type="int" /> <description> - Returns the minimum angle constraint for the joint at [code]joint_idx[/code]. [b]Note:[/b] This angle is in degrees! + Returns the minimum angle constraint for the joint at [param joint_idx]. [b]Note:[/b] This angle is in degrees! </description> </method> <method name="get_ccdik_joint_constraint_invert" qualifiers="const"> <return type="bool" /> - <argument index="0" name="joint_idx" type="int" /> + <param index="0" name="joint_idx" type="int" /> <description> - Returns whether the CCDIK joint at [code]joint_idx[/code] uses an inverted joint constraint. See [method set_ccdik_joint_constraint_invert] for details. + Returns whether the CCDIK joint at [param joint_idx] uses an inverted joint constraint. See [method set_ccdik_joint_constraint_invert] for details. </description> </method> <method name="get_ccdik_joint_enable_joint_constraint" qualifiers="const"> <return type="bool" /> - <argument index="0" name="joint_idx" type="int" /> + <param index="0" name="joint_idx" type="int" /> <description> - Enables angle constraints to the CCDIK joint at [code]joint_idx[/code]. + Enables angle constraints to the CCDIK joint at [param joint_idx]. </description> </method> <method name="set_ccdik_joint_bone_index"> <return type="void" /> - <argument index="0" name="joint_idx" type="int" /> - <argument index="1" name="bone_index" type="int" /> + <param index="0" name="joint_idx" type="int" /> + <param index="1" name="bone_index" type="int" /> <description> - Sets the bone index, [code]bone_index[/code], of the CCDIK joint at [code]joint_idx[/code]. When possible, this will also update the [code]bone_name[/code] of the CCDIK joint based on data provided by the linked skeleton. + Sets the bone index, [param bone_index], of the CCDIK joint at [param joint_idx]. When possible, this will also update the [code]bone_name[/code] of the CCDIK joint based on data provided by the linked skeleton. </description> </method> <method name="set_ccdik_joint_bone_name"> <return type="void" /> - <argument index="0" name="joint_idx" type="int" /> - <argument index="1" name="bone_name" type="String" /> + <param index="0" name="joint_idx" type="int" /> + <param index="1" name="bone_name" type="String" /> <description> - Sets the bone name, [code]bone_name[/code], of the CCDIK joint at [code]joint_idx[/code]. When possible, this will also update the [code]bone_index[/code] of the CCDIK joint based on data provided by the linked skeleton. + Sets the bone name, [param bone_name], of the CCDIK joint at [param joint_idx]. When possible, this will also update the [code]bone_index[/code] of the CCDIK joint based on data provided by the linked skeleton. </description> </method> <method name="set_ccdik_joint_ccdik_axis"> <return type="void" /> - <argument index="0" name="joint_idx" type="int" /> - <argument index="1" name="axis" type="int" /> + <param index="0" name="joint_idx" type="int" /> + <param index="1" name="axis" type="int" /> <description> - Sets the joint axis of the CCDIK joint at [code]joint_idx[/code] to the passed-in joint axis, [code]axis[/code]. + Sets the joint axis of the CCDIK joint at [param joint_idx] to the passed-in joint axis, [param axis]. </description> </method> <method name="set_ccdik_joint_constraint_angle_max"> <return type="void" /> - <argument index="0" name="joint_idx" type="int" /> - <argument index="1" name="max_angle" type="float" /> + <param index="0" name="joint_idx" type="int" /> + <param index="1" name="max_angle" type="float" /> <description> - Sets the maximum angle constraint for the joint at [code]joint_idx[/code]. [b]Note:[/b] This angle must be in radians! + Sets the maximum angle constraint for the joint at [param joint_idx]. [b]Note:[/b] This angle must be in radians! </description> </method> <method name="set_ccdik_joint_constraint_angle_min"> <return type="void" /> - <argument index="0" name="joint_idx" type="int" /> - <argument index="1" name="min_angle" type="float" /> + <param index="0" name="joint_idx" type="int" /> + <param index="1" name="min_angle" type="float" /> <description> - Sets the minimum angle constraint for the joint at [code]joint_idx[/code]. [b]Note:[/b] This angle must be in radians! + Sets the minimum angle constraint for the joint at [param joint_idx]. [b]Note:[/b] This angle must be in radians! </description> </method> <method name="set_ccdik_joint_constraint_invert"> <return type="void" /> - <argument index="0" name="joint_idx" type="int" /> - <argument index="1" name="invert" type="bool" /> + <param index="0" name="joint_idx" type="int" /> + <param index="1" name="invert" type="bool" /> <description> - Sets whether the CCDIK joint at [code]joint_idx[/code] uses an inverted joint constraint. + Sets whether the CCDIK joint at [param joint_idx] uses an inverted joint constraint. An inverted joint constraint only constraints the CCDIK joint to the angles [i]outside of[/i] the inputted minimum and maximum angles. For this reason, it is referred to as an inverted joint constraint, as it constraints the joint to the outside of the inputted values. </description> </method> <method name="set_ccdik_joint_enable_joint_constraint"> <return type="void" /> - <argument index="0" name="joint_idx" type="int" /> - <argument index="1" name="enable" type="bool" /> + <param index="0" name="joint_idx" type="int" /> + <param index="1" name="enable" type="bool" /> <description> - Sets whether joint constraints are enabled for the CCDIK joint at [code]joint_idx[/code]. + Sets whether joint constraints are enabled for the CCDIK joint at [param joint_idx]. </description> </method> </methods> @@ -133,6 +133,4 @@ The end position of the CCDIK chain. Typically, this should be a child of a [BoneAttachment3D] node attached to the final bone in the CCDIK chain, where the child node is offset so it is at the end of the final bone. </member> </members> - <constants> - </constants> </class> |