Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

SkeletonModification2DFABRIK¶

Inherits: SkeletonModification2D < Resource < RefCounted < Object

A modification that uses FABRIK to manipulate a series of Bone2D nodes to reach a target.

Description¶

This SkeletonModification2D uses an algorithm called Forward And Backward Reaching Inverse Kinematics, or FABRIK, to rotate a bone chain so that it reaches a target.

FABRIK works by knowing the positions and lengths of a series of bones, typically called a "bone chain". It first starts by running a forward pass, which places the final bone at the target's position. Then all other bones are moved towards the tip bone, so they stay at the defined bone length away. Then a backwards pass is performed, where the root/first bone in the FABRIK chain is placed back at the origin. Then all other bones are moved so they stay at the defined bone length away. This positions the bone chain so that it reaches the target when possible, but all of the bones stay the correct length away from each other.

Because of how FABRIK works, it often gives more natural results than those seen in SkeletonModification2DCCDIK. FABRIK also supports angle constraints, which are fully taken into account when solving.

Note: The FABRIK modifier has fabrik_joints, which are the data objects that hold the data for each joint in the FABRIK chain. This is different from Bone2D nodes! FABRIK joints hold the data needed for each Bone2D in the bone chain used by FABRIK.

To help control how the FABRIK joints move, a magnet vector can be passed, which can nudge the bones in a certain direction prior to solving, giving a level of control over the final result.

Properties¶

int	fabrik_data_chain_length	`0`
NodePath	target_nodepath	`NodePath("")`

Methods¶

NodePath	get_fabrik_joint_bone2d_node ( int joint_idx ) const
int	get_fabrik_joint_bone_index ( int joint_idx ) const
Vector2	get_fabrik_joint_magnet_position ( int joint_idx ) const
bool	get_fabrik_joint_use_target_rotation ( int joint_idx ) const
void	set_fabrik_joint_bone2d_node ( int joint_idx, NodePath bone2d_nodepath )
void	set_fabrik_joint_bone_index ( int joint_idx, int bone_idx )
void	set_fabrik_joint_magnet_position ( int joint_idx, Vector2 magnet_position )
void	set_fabrik_joint_use_target_rotation ( int joint_idx, bool use_target_rotation )

Property Descriptions¶

int fabrik_data_chain_length = 0

void set_fabrik_data_chain_length ( int value )
int get_fabrik_data_chain_length ( )

The number of FABRIK joints in the FABRIK modification.

NodePath target_nodepath = NodePath("")

void set_target_node ( NodePath value )
NodePath get_target_node ( )

The NodePath to the node that is the target for the FABRIK modification. This node is what the FABRIK chain will attempt to rotate the bone chain to.