BoneTwistDisperser3D
继承： SkeletonModifier3D < Node3D < Node < Object
将子骨骼的扭转传播并分散到其父骨骼上的节点。
描述
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.
属性
|
||
|
方法
枚举
enum DisperseMode: 🔗
DisperseMode DISPERSE_MODE_EVEN = 0
分配数值，使其从 0.0 到 1.0 单调递增，并确保所有权重相等。例如，如果有五个关节，从根骨骼开始的数值将依次为 0.2、0.4、0.6、0.8 和 1.0。
DisperseMode DISPERSE_MODE_WEIGHTED = 1
Assign 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().
DisperseMode DISPERSE_MODE_CUSTOM = 2
You 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.
属性说明
bool mutable_bone_axes = true 🔗
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.
设置的数量。
方法说明
void clear_settings() 🔗
清空所有设置。
Curve get_damping_curve(index: int) const 🔗
Returns the damping curve when get_disperse_mode() is DISPERSE_MODE_CUSTOM.
DisperseMode get_disperse_mode(index: int) const 🔗
Returns whether to use automatic amount assignment or to allow manual assignment.
int get_end_bone(index: int) const 🔗
返回骨骼链末尾骨骼的索引。
BoneDirection get_end_bone_direction(index: int) const 🔗
Returns the tail direction of the end bone of the bone chain when is_end_bone_extended() is true.
String get_end_bone_name(index: int) const 🔗
返回骨骼链末尾骨骼的名称。
int get_joint_bone(index: int, joint: int) const 🔗
返回骨骼链关节列表中位于 joint 的骨骼的索引。
String get_joint_bone_name(index: int, joint: int) const 🔗
返回骨骼链关节列表中位于 joint 的骨骼的名称。
int get_joint_count(index: int) const 🔗
返回骨骼链关节列表中的关节数量。
float get_joint_twist_amount(index: int, joint: int) const 🔗
Returns the twist amount at joint in the bone chain's joint list when get_disperse_mode() is DISPERSE_MODE_CUSTOM.
int get_reference_bone(index: int) const 🔗
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().
String get_reference_bone_name(index: int) const 🔗
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().
int get_root_bone(index: int) const 🔗
返回骨骼链根骨骼的索引。
String get_root_bone_name(index: int) const 🔗
返回骨骼链根骨骼的名称。
Quaternion get_twist_from(index: int) const 🔗
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.
float get_weight_position(index: int) const 🔗
Returns the position at which to divide the segment between joints for weight assignment when get_disperse_mode() is DISPERSE_MODE_WEIGHTED.
bool is_end_bone_extended(index: int) const 🔗
Returns true if the end bone is extended to have a tail.
bool is_twist_from_rest(index: int) const 🔗
Returns true if extracting the twist amount from the difference between the bone rest and the current bone pose.
void set_damping_curve(index: int, curve: Curve) 🔗
Sets the damping curve when get_disperse_mode() is DISPERSE_MODE_CUSTOM.
void set_disperse_mode(index: int, disperse_mode: DisperseMode) 🔗
Sets whether to use automatic amount assignment or to allow manual assignment.
void set_end_bone(index: int, bone: int) 🔗
设置骨骼链中末端骨骼的索引。
void set_end_bone_direction(index: int, bone_direction: BoneDirection) 🔗
当 is_end_bone_extended() 为 true 时，设置骨骼链中末端骨骼的尾部方向。
void set_end_bone_name(index: int, bone_name: String) 🔗
Sets the end bone name of the bone chain.
Note: The end bone must be a child of the root bone.
void set_extend_end_bone(index: int, enabled: bool) 🔗
如果 enabled 为 true，则会延伸末端骨骼形成尾部。
如果 enabled 为 false，则 get_reference_bone() 会成为末端骨骼的父骨骼，并使用到末端骨骼的向量作为扭转轴。
void set_joint_twist_amount(index: int, joint: int, twist_amount: float) 🔗
Sets the twist amount at joint in the bone chain's joint list when get_disperse_mode() is DISPERSE_MODE_CUSTOM.
void set_root_bone(index: int, bone: int) 🔗
设置骨骼链中根骨骼的索引。
void set_root_bone_name(index: int, bone_name: String) 🔗
设置骨骼链中根骨骼的名称。
void set_twist_from(index: int, from: Quaternion) 🔗
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.
void set_twist_from_rest(index: int, enabled: bool) 🔗
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().
void set_weight_position(index: int, weight_position: float) 🔗
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.