SkeletonModification2DFabrik

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

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

Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.

public SkeletonModification2DFabrik();

public int FabrikDataChainLength { get; set; }

public EntityPath TargetEntitypath { get; set; }

public int GetFabrikDataChainLength();

public EntityPath GetFabrikJointBone2DEntity(int jointIdx);

public int GetFabrikJointBoneIndex(int jointIdx);

public Vector2 GetFabrikJointMagnetPosition(int jointIdx);

public bool GetFabrikJointUseTargetRotation(int jointIdx);

public EntityPath GetTargetEntity();

public void SetFabrikDataChainLength(int length);

public void SetFabrikJointBone2DEntity(int jointIdx, EntityPath bone2DEntitypath);

public void SetFabrikJointBoneIndex(int jointIdx, int boneIdx);

public void SetFabrikJointMagnetPosition(int jointIdx, Vector2 magnetPosition);

public void SetFabrikJointUseTargetRotation(int jointIdx, bool useTargetRotation);

public void SetTargetEntity(EntityPath targetEntitypath);