A node that propagates and disperses the child bone's twist to the parent bones.
This BoneTwistDisperser3D allows for smooth twist interpolation between multiple bones by dispersing the end bone's twist to the parents. This only changes the twist without changing the global position of each joint.
This is useful for smoothly twisting bones in combination with CopyTransformModifier3D and IK.
Note: If an extracted twist is greater than 180 degrees, flipping occurs. This is similar to ConvertTransformModifier3D.
Note: Most methods in this class take an index parameter. This parameter specifies which setting list entry to return if the IK has multiple entries (e.g. settings/<index>/root_bone_name).
If true, the solver retrieves the bone axis from the bone pose every frame.
If false, the solver retrieves the bone axis from the bone rest and caches it.
Returns the damping curve when get_disperse_mode() is DISPERSE_MODE_CUSTOM.
Returns the tail direction of the end bone of the bone chain when is_end_bone_extended() is true.
Returns the twist amount at joint in the bone chain's joint list when get_disperse_mode() is DISPERSE_MODE_CUSTOM.
Returns the reference bone to extract twist of the setting at index.
This bone is either the end of the chain or its parent, depending on is_end_bone_extended().
Returns the reference bone name to extract twist of the setting at index.
This bone is either the end of the chain or its parent, depending on is_end_bone_extended().
Returns the rotation to an arbitrary state before twisting for the current bone pose to extract the twist when is_twist_from_rest() is false.
Returns the position at which to divide the segment between joints for weight assignment when get_disperse_mode() is DISPERSE_MODE_WEIGHTED.
Returns true if extracting the twist amount from the difference between the bone rest and the current bone pose.
Sets the damping curve when get_disperse_mode() is DISPERSE_MODE_CUSTOM.
Sets the end bone tail direction of the bone chain when is_end_bone_extended() is true.
If enabled is true, the end bone is extended to have a tail.
If enabled is false, get_reference_bone() becomes a parent of the end bone and it uses the vector to the end bone as a twist axis.
Sets the twist amount at joint in the bone chain's joint list when get_disperse_mode() is DISPERSE_MODE_CUSTOM.
Sets the rotation to an arbitrary state before twisting for the current bone pose to extract the twist when is_twist_from_rest() is false.
In other words, by calling set_twist_from() by SkeletonModifier3D.modification_processed of a specific SkeletonModifier3D, you can extract only the twists generated by modifiers processed after that but before this BoneTwistDisperser3D.
If enabled is true, it extracts the twist amount from the difference between the bone rest and the current bone pose.
If enabled is false, it extracts the twist amount from the difference between get_twist_from() and the current bone pose. See also set_twist_from().
Sets the position at which to divide the segment between joints for weight assignment when get_disperse_mode() is DISPERSE_MODE_WEIGHTED.
For example, when weight_position is 0.5, if two bone segments with a length of 1.0 exist between three joints, weights are assigned to each joint from root to end at ratios of 0.5, 1.0, and 0.5. Then amounts become 0.25, 0.75, and 1.0 respectively.
DISPERSE_MODE_EVEN = 0Assign amounts so that they monotonically increase from 0.0 to 1.0, ensuring all weights are equal. For example, with five joints, the amounts would be 0.2, 0.4, 0.6, 0.8, and 1.0 starting from the root bone.
DISPERSE_MODE_WEIGHTED = 1Assign amounts so that they monotonically increase from 0.0 to 1.0, based on the length of the bones between joint segments. See also set_weight_position().
DISPERSE_MODE_CUSTOM = 2You can assign arbitrary amounts to the joint list. See also set_joint_twist_amount().
When is_end_bone_extended() is false, a child of the reference bone exists solely to determine the twist axis, so its custom amount has absolutely no effect at all.