SkeletonIK3D¶
A node used to rotate all bones of a Skeleton3D bone chain a way that places the end bone at a desired 3D position.
Description¶
SkeletonIK3D is used to rotate all bones of a Skeleton3D bone chain a way that places the end bone at a desired 3D position. A typical scenario for IK in games is to place a character's feet on the ground or a character's hands on a currently held object. SkeletonIK uses FabrikInverseKinematic internally to solve the bone chain and applies the results to the Skeleton3D bones_global_pose_override
property for all affected bones in the chain. If fully applied, this overwrites any bone transform from Animations or bone custom poses set by users. The applied amount can be controlled with the interpolation property.
# Apply IK effect automatically on every new frame (not the current)
skeleton_ik_node.start()
# Apply IK effect only on the current frame
skeleton_ik_node.start(true)
# Stop IK effect and reset bones_global_pose_override on Skeleton
skeleton_ik_node.stop()
# Apply full IK effect
skeleton_ik_node.set_interpolation(1.0)
# Apply half IK effect
skeleton_ik_node.set_interpolation(0.5)
# Apply zero IK effect (a value at or below 0.01 also removes bones_global_pose_override on Skeleton)
skeleton_ik_node.set_interpolation(0.0)
Deprecated. This class is deprecated, and might be removed in a future release.
Tutorials¶
Properties¶
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
Methods¶
get_parent_skeleton ( ) const |
|
is_running ( ) |
|
void |
|
void |
stop ( ) |
Property Descriptions¶
float interpolation = 1.0
Interpolation value for how much the IK results are applied to the current skeleton bone chain. A value of 1.0
will overwrite all skeleton bone transforms completely while a value of 0.0
will visually disable the SkeletonIK. A value at or below 0.01
also calls Skeleton3D.clear_bones_global_pose_override.
Vector3 magnet = Vector3(0, 0, 0)
Secondary target position (first is target property or target_node) for the IK chain. Use magnet position (pole target) to control the bending of the IK chain. Only works if the bone chain has more than 2 bones. The middle chain bone position will be linearly interpolated with the magnet position.
int max_iterations = 10
Number of iteration loops used by the IK solver to produce more accurate (and elegant) bone chain results.
float min_distance = 0.01
The minimum distance between bone and goal target. If the distance is below this value, the IK solver stops further iterations.
bool override_tip_basis = true
If true
overwrites the rotation of the tip bone with the rotation of the target (or target_node if defined).
StringName root_bone = &""