UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Public Attributes | List of all members
FAnimLegIKDefinition Struct Reference

#include <AnimNode_LegIK.h>

Public Member Functions

 FAnimLegIKDefinition ()
 

Public Attributes

FBoneReference IKFootBone
 
FBoneReference FKFootBone
 
int32 NumBonesInLimb
 
float MinRotationAngle
 
TEnumAsByte< EAxis::Type > FootBoneForwardAxis
 
TEnumAsByte< EAxis::Type > HingeRotationAxis
 
bool bEnableRotationLimit
 
bool bEnableKneeTwistCorrection
 
FName TwistOffsetCurveName
 

Detailed Description

Per foot definitions

Constructor & Destructor Documentation

◆ FAnimLegIKDefinition()

FAnimLegIKDefinition::FAnimLegIKDefinition ( )
inline

Member Data Documentation

◆ bEnableKneeTwistCorrection

bool FAnimLegIKDefinition::bEnableKneeTwistCorrection

Enable Knee Twist correction, by comparing Foot FK with Foot IK orientation.

◆ bEnableRotationLimit

bool FAnimLegIKDefinition::bEnableRotationLimit

If enabled, we prevent the leg from bending backwards and enforce a min compression angle

◆ FKFootBone

FBoneReference FAnimLegIKDefinition::FKFootBone

◆ FootBoneForwardAxis

TEnumAsByte<EAxis::Type> FAnimLegIKDefinition::FootBoneForwardAxis

Forward Axis for Foot bone.

◆ HingeRotationAxis

TEnumAsByte<EAxis::Type> FAnimLegIKDefinition::HingeRotationAxis

Hinge Bones Rotation Axis. This is essentially the plane normal for (hip - knee - foot).

◆ IKFootBone

FBoneReference FAnimLegIKDefinition::IKFootBone

◆ MinRotationAngle

float FAnimLegIKDefinition::MinRotationAngle

Only used if bEnableRotationLimit is enabled. Prevents the leg from folding onto itself, and forces at least this angle between Parent and Child bone.

◆ NumBonesInLimb

int32 FAnimLegIKDefinition::NumBonesInLimb

◆ TwistOffsetCurveName

FName FAnimLegIKDefinition::TwistOffsetCurveName

Name of the curve to use as the twist offset angle(in degrees). This is useful for injecting knee motion, while keeping the IK chain's goal/hand and root/hip locked in place. Reasonable values are usually between -+15 degrees, although this is depends on how far in/out the knee is in the original pose.

The documentation for this struct was generated from the following file: