A SkeletonModifier3D to apply inertial wavering to bone chains.
This SkeletonModifier3D can be used to wiggle hair, cloth, and tails. This modifier behaves differently from PhysicalBoneSimulator3D as it attempts to return the original pose after modification.
If you setup set_root_bone() and set_end_bone(), it is treated as one bone chain. Note that it does not support a branched chain like Y-shaped chains.
When a bone chain is created, an array is generated from the bones that exist in between and listed in the joint list.
Several properties can be applied to each joint, such as set_joint_stiffness(), set_joint_drag(), and set_joint_gravity().
For simplicity, you can set values to all joints at the same time by using a Curve. If you want to specify detailed values individually, set set_individual_config() to true.
For physical simulation, SpringBoneSimulator3D can have children as self-standing collisions that are not related to PhysicsServer3D, see also SpringBoneCollision3D.
Warning: A scaled SpringBoneSimulator3D will likely not behave as expected. Make sure that the parent Skeleton3D and its bones are not scaled.
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).
The constant force that always affected bones. It is equal to the result when the parent Skeleton3D moves at this speed in the opposite direction.
This is useful for effects such as wind and anti-gravity.
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, which increases performance slightly, but position changes in the bone pose made before processing this SpringBoneSimulator3D are ignored.
Returns true if all child SpringBoneCollision3Ds are contained in the collision list at index in the settings.
Clears all collisions from the collision list at index in the settings when are_all_child_collisions_enabled() is false.
Clears all exclude collisions from the collision list at index in the settings when are_all_child_collisions_enabled() is true.
Returns the collision count of the bone chain's collision list when are_all_child_collisions_enabled() is false.
Returns the node path of the SpringBoneCollision3D at collision in the bone chain's collision list when are_all_child_collisions_enabled() is false.
Returns the tail direction of the end bone of the bone chain when is_end_bone_extended() is true.
Returns the end bone tail length of the bone chain when is_end_bone_extended() is true.
Returns the exclude collision count of the bone chain's exclude collision list when are_all_child_collisions_enabled() is true.
Returns the node path of the SpringBoneCollision3D at collision in the bone chain's exclude collision list when are_all_child_collisions_enabled() is true.
Returns the rotation axis vector for the specified joint in the bone chain. This vector represents the axis around which the joint can rotate. It is determined based on the rotation axis set for the joint.
If get_joint_rotation_axis() is SkeletonModifier3D.ROTATION_AXIS_ALL, this method returns Vector3(0, 0, 0).
Returns the rotation axis vector of the bone chain. This vector represents the axis around which the bone chain can rotate. It is determined based on the rotation axis set for the bone chain.
If get_rotation_axis() is SkeletonModifier3D.ROTATION_AXIS_ALL, this method returns Vector3(0, 0, 0).
Resets a simulating state with respect to the current bone pose.
It is useful to prevent the simulation result getting violent. For example, calling this immediately after a call to AnimationPlayer.play() without a fading, or within the previous SkeletonModifier3D.modification_processed signal if it's condition changes significantly.
Sets what the center originates from in the bone chain.
Bone movement is calculated based on the difference in relative distance between center and bone in the previous and next frames.
For example, if the parent Skeleton3D is used as the center, the bones are considered to have not moved if the Skeleton3D moves in the world.
In this case, only a change in the bone pose is considered to be a bone movement.
Sets the number of collisions in the collision list at index in the settings when are_all_child_collisions_enabled() is false.
Sets the node path of the SpringBoneCollision3D at collision in the bone chain's collision list when are_all_child_collisions_enabled() is false.
Sets the drag force of the bone chain. The greater the value, the more suppressed the wiggling.
The value is scaled by set_drag_damping_curve() and cached in each joint setting in the joint list.
If enabled is true, all child SpringBoneCollision3Ds are colliding and set_exclude_collision_path() is enabled as an exclusion list at index in the settings.
If enabled is false, you need to manually register all valid collisions with set_collision_path().
Sets the end bone tail direction of the bone chain when is_end_bone_extended() is true.
Sets the end bone tail length of the bone chain when is_end_bone_extended() is true.
Sets the end bone name of the bone chain.
Note: End bone must be the root bone or a child of the root bone. If they are the same, the tail must be extended by set_extend_end_bone() to jiggle the bone.
Sets the number of exclude collisions in the exclude collision list at index in the settings when are_all_child_collisions_enabled() is true.
Sets the node path of the SpringBoneCollision3D at collision in the bone chain's exclude collision list when are_all_child_collisions_enabled() is true.
If enabled is true, the end bone is extended to have a tail.
The extended tail config is allocated to the last element in the joint list. In other words, if you set enabled to false, the config of the last element in the joint list has no effect in the simulated result.
Sets the gravity amount of the bone chain. This value is not an acceleration, but a constant velocity of movement in set_gravity_direction().
If gravity is not 0, the modified pose will not return to the original pose since it is always affected by gravity.
The value is scaled by set_gravity_damping_curve() and cached in each joint setting in the joint list.
Sets the gravity direction of the bone chain. This value is internally normalized and then multiplied by set_gravity().
The value is cached in each joint setting in the joint list.
Sets the drag force at joint in the bone chain's joint list when is_config_individual() is true.
Sets the gravity amount at joint in the bone chain's joint list when is_config_individual() is true.
Sets the gravity direction at joint in the bone chain's joint list when is_config_individual() is true.
Sets the joint radius at joint in the bone chain's joint list when is_config_individual() is true.
Sets the rotation axis at joint in the bone chain's joint list when is_config_individual() is true.
The axes are based on the reference pose's space, if axis is SkeletonModifier3D.ROTATION_AXIS_CUSTOM, you can specify any axis.
In here, the reference pose is the bone pose immediately before the simulation.
Note: The rotation axis and the forward vector shouldn't be colinear to avoid unintended rotation since SpringBoneSimulator3D does not factor in twisting forces.
Sets the rotation axis vector for the specified joint in the bone chain.
This vector is normalized by an internal process and represents the axis around which the bone chain can rotate.
If the vector length is 0, it is considered synonymous with SkeletonModifier3D.ROTATION_AXIS_ALL.
Sets the stiffness force at joint in the bone chain's joint list when is_config_individual() is true.
Sets the joint radius of the bone chain. It is used to move and slide with the SpringBoneCollision3D in the collision list.
The value is scaled by set_radius_damping_curve() and cached in each joint setting in the joint list.
Sets the rotation axis of the bone chain. If set to a specific axis, it acts like a hinge joint. The value is cached in each joint setting in the joint list.
The axes are based on the reference pose's space, if axis is SkeletonModifier3D.ROTATION_AXIS_CUSTOM, you can specify any axis.
In here, the reference pose is the bone pose immediately before the simulation.
Note: The rotation axis vector and the forward vector shouldn't be colinear to avoid unintended rotation since SpringBoneSimulator3D does not factor in twisting forces.
Sets the rotation axis vector of the bone chain. The value is cached in each joint setting in the joint list.
This vector is normalized by an internal process and represents the axis around which the bone chain can rotate.
If the vector length is 0, it is considered synonymous with SkeletonModifier3D.ROTATION_AXIS_ALL.
Sets the stiffness force of the bone chain. The greater the value, the faster it recovers to its initial pose.
If stiffness is 0, the modified pose will not return to the original pose.
The value is scaled by set_stiffness_damping_curve() and cached in each joint setting in the joint list.
CENTER_FROM_WORLD_ORIGIN = 0The world origin is defined as center.
CENTER_FROM_NODE = 1The Node3D specified by set_center_node() is defined as center.
If Node3D is not found, the parent Skeleton3D is treated as center.
CENTER_FROM_BONE = 2The bone pose origin of the parent Skeleton3D specified by set_center_bone() is defined as center.
If Node3D is not found, the parent Skeleton3D is treated as center.