UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FAnimExtractContext Struct Reference

#include <AnimationAsset.h>

Public Member Functions

 FAnimExtractContext (float InCurrentTime, bool InbExtractRootMotion=false, FDeltaTimeRecord InDeltaTimeRecord={}, bool InbLooping=false)
 
 FAnimExtractContext (double InCurrentTime=0.0, bool InbExtractRootMotion=false, FDeltaTimeRecord InDeltaTimeRecord={}, bool InbLooping=false)
 
bool IsBoneRequired (int32 BoneIndex) const
 

Public Attributes

double CurrentTime
 
bool bExtractRootMotion
 
FDeltaTimeRecord DeltaTimeRecord
 
bool bLooping
 
TArray< FPoseCurvePoseCurves
 
TArray< boolBonesRequired
 
TOptional< EAnimInterpolationTypeInterpolationOverride
 

Detailed Description

Animation Extraction Context

Constructor & Destructor Documentation

◆ FAnimExtractContext() [1/2]

FAnimExtractContext::FAnimExtractContext ( float  InCurrentTime,
bool  InbExtractRootMotion = false,
FDeltaTimeRecord  InDeltaTimeRecord = {},
bool  InbLooping = false 
)
inline

◆ FAnimExtractContext() [2/2]

FAnimExtractContext::FAnimExtractContext ( double  InCurrentTime = 0.0,
bool  InbExtractRootMotion = false,
FDeltaTimeRecord  InDeltaTimeRecord = {},
bool  InbLooping = false 
)
inline

Member Function Documentation

◆ IsBoneRequired()

bool FAnimExtractContext::IsBoneRequired ( int32  BoneIndex) const
inline

Member Data Documentation

◆ bExtractRootMotion

bool FAnimExtractContext::bExtractRootMotion

Is root motion being extracted?

◆ bLooping

bool FAnimExtractContext::bLooping

Is the current animation asset marked as looping?

◆ BonesRequired

TArray<bool> FAnimExtractContext::BonesRequired

The BonesRequired array is a list of bool flags to determine if a bone is required to be retrieved. This is currently used by several animation nodes to optimize evaluation time.

◆ CurrentTime

double FAnimExtractContext::CurrentTime

Position in animation to extract pose from

◆ DeltaTimeRecord

FDeltaTimeRecord FAnimExtractContext::DeltaTimeRecord

Delta time range required for root motion extraction

◆ InterpolationOverride

TOptional<EAnimInterpolationType> FAnimExtractContext::InterpolationOverride

The optional interpolation mode override. If not set, it will simply use the interpolation mode provided by the asset. One example where this could be used is if you want to force sampling the animation with Step interpolation even when the animation sequence asset is set to Linear interpolation.

◆ PoseCurves

TArray<FPoseCurve> FAnimExtractContext::PoseCurves

Pose Curve Values to extract pose from pose assets. This is used by pose asset extraction


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