BoneTwistDisperser3D

public bool MutableBoneAxes { get; set; }

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.

public int SettingCount { get; set; }

The number of settings.

public void ClearSettings();

Clears all settings.

public Curve GetDampingCurve(int index);

Returns the damping curve when BoneTwistDisperser3D.GetDisperseMode is BoneTwistDisperser3D.DisperseMode.Custom.

public BoneTwistDisperser3D.DisperseMode GetDisperseMode(int index);

Returns whether to use automatic amount assignment or to allow manual assignment.

public int GetEndBone(int index);

Returns the end bone index of the bone chain.

public SkeletonModifier3D.BoneDirection GetEndBoneDirection(int index);

Returns the tail direction of the end bone of the bone chain when BoneTwistDisperser3D.IsEndBoneExtended is true.

public string GetEndBoneName(int index);

Returns the end bone name of the bone chain.

public int GetJointBone(int index, int joint);

Returns the bone index at joint in the bone chain's joint list.

public string GetJointBoneName(int index, int joint);

Returns the bone name at joint in the bone chain's joint list.

public int GetJointCount(int index);

Returns the joint count of the bone chain's joint list.

public float GetJointTwistAmount(int index, int joint);

Returns the twist amount at joint in the bone chain's joint list when BoneTwistDisperser3D.GetDisperseMode is BoneTwistDisperser3D.DisperseMode.Custom.

public int GetReferenceBone(int index);

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 BoneTwistDisperser3D.IsEndBoneExtended.

public string GetReferenceBoneName(int index);

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 BoneTwistDisperser3D.IsEndBoneExtended.

public int GetRootBone(int index);

Returns the root bone index of the bone chain.

public string GetRootBoneName(int index);

Returns the root bone name of the bone chain.

public Quaternion GetTwistFrom(int index);

Returns the rotation to an arbitrary state before twisting for the current bone pose to extract the twist when BoneTwistDisperser3D.IsTwistFromRest is false.

public float GetWeightPosition(int index);

Returns the position at which to divide the segment between joints for weight assignment when BoneTwistDisperser3D.GetDisperseMode is BoneTwistDisperser3D.DisperseMode.Weighted.

public bool IsEndBoneExtended(int index);

Returns true if the end bone is extended to have a tail.

public bool IsTwistFromRest(int index);

Returns true if extracting the twist amount from the difference between the bone rest and the current bone pose.

public void SetDampingCurve(int index, Curve curve);

Sets the damping curve when BoneTwistDisperser3D.GetDisperseMode is BoneTwistDisperser3D.DisperseMode.Custom.

public void SetDisperseMode(int index, BoneTwistDisperser3D.DisperseMode disperseMode);

Sets whether to use automatic amount assignment or to allow manual assignment.

public void SetEndBone(int index, int bone);

Sets the end bone index of the bone chain.

public void SetEndBoneDirection(int index, SkeletonModifier3D.BoneDirection boneDirection);

Sets the end bone tail direction of the bone chain when BoneTwistDisperser3D.IsEndBoneExtended is true.

public void SetEndBoneName(int index, string boneName);

Sets the end bone name of the bone chain. Note: The end bone must be a child of the root bone.

public void SetExtendEndBone(int index, bool enabled);

If enabled is true, the end bone is extended to have a tail. If enabled is false, BoneTwistDisperser3D.GetReferenceBone becomes a parent of the end bone and it uses the vector to the end bone as a twist axis.

public void SetJointTwistAmount(int index, int joint, float twistAmount);

Sets the twist amount at joint in the bone chain's joint list when BoneTwistDisperser3D.GetDisperseMode is BoneTwistDisperser3D.DisperseMode.Custom.

public void SetRootBone(int index, int bone);

Sets the root bone index of the bone chain.

public void SetRootBoneName(int index, string boneName);

Sets the root bone name of the bone chain.

public void SetTwistFrom(int index, Quaternion from);

Sets the rotation to an arbitrary state before twisting for the current bone pose to extract the twist when BoneTwistDisperser3D.IsTwistFromRest is false. In other words, by calling BoneTwistDisperser3D.SetTwistFrom by SkeletonModifier3D.ModificationProcessed of a specific SkeletonModifier3D, you can extract only the twists generated by modifiers processed after that but before this BoneTwistDisperser3D.

public void SetTwistFromRest(int index, bool enabled);

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 BoneTwistDisperser3D.GetTwistFrom and the current bone pose. See also BoneTwistDisperser3D.SetTwistFrom.

public void SetWeightPosition(int index, float weightPosition);

Sets the position at which to divide the segment between joints for weight assignment when BoneTwistDisperser3D.GetDisperseMode is BoneTwistDisperser3D.DisperseMode.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.