UKismetAnimationLibrary::K2_TwoBoneIK

Computes the transform for two bones using inverse kinematics.

Windows
MacOS
Linux

References

Module

AnimGraphRuntime

Header

/Engine/Source/Runtime/AnimGraphRuntime/Public/KismetAnimationLibrary.h

Include

#include "KismetAnimationLibrary.h"

Source

/Engine/Source/Runtime/AnimGraphRuntime/Private/KismetAnimationLibrary.cpp

Syntax

static void K2_TwoBoneIK
(
    const FVector & RootPos,
    const FVector & JointPos,
    const FVector & EndPos,
    const FVector & JointTarget,
    const FVector & Effector,
    FVector & OutJointPos,
    FVector & OutEndPos,
    bool bAllowStretching,
    float StartStretchRatio,
    float MaxStretchScale
)

Remarks

Computes the transform for two bones using inverse kinematics.

Parameters

Parameter

Description

RootPos

The input root position of the two bone chain

JointPos

The input center (elbow) position of the two bone chain

EndPos

The input end (wrist) position of the two bone chain

JointTarget

The IK target for the write to reach

Effector

The position of the target effector for the IK Chain.

OutJointPos

The resulting position for the center (elbow)

OutEndPos

The resulting position for the end (wrist)

bAllowStretching

If set to true the bones are allowed to stretch

StartStretchRatio

The ratio at which the bones should start to stretch. The higher the value, the later the stretching wil start.

MaxStretchScale

The maximum multiplier for the stretch to reach.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss