RealDocs

UBlendSpace::GetAnimationPose

function Engine Since 5.0
#include "Animation/BlendSpace.h"
Access: public Specifiers: const

Description

Extracts a blended pose into OutAnimationPoseData by evaluating each sample in BlendSampleDataCache and combining them according to their weights.

Caveats & Gotchas

  • BlendSampleDataCache must already be populated with valid weights (e.g. via the internal sample-update pipeline driven by TickAssetPlayer) — this function only blends, it doesn't compute sample weights.
  • Supersedes two older overloads (a raw FCompactPose/FBlendedCurve version, and a pre-extraction-context FAnimationPoseData version) deprecated as of 4.26 and 5.0 respectively.
  • There's also an overload taking TArrayView<FPoseLink> and an FPoseContext, used when the blend space feeds directly into an anim graph pose-link array.

Signature

void GetAnimationPose(TArray<FBlendSampleData>& BlendSampleDataCache, const FAnimExtractContext& ExtractionContext, FAnimationPoseData& OutAnimationPoseData) const

Parameters

Name Type Description Default
BlendSampleDataCache TArray<FBlendSampleData>& Populated sample weights/times to blend together.
ExtractionContext const FAnimExtractContext& Context controlling how the pose is extracted (e.g. root motion, curve extraction).
OutAnimationPoseData FAnimationPoseData& Receives the resulting blended pose, curves, and attributes.

Return Type

void

Example

Extracting a pose from cached sample data C++
FAnimationPoseData PoseData(OutPose, OutCurve, OutAttributes);
BlendSpaceAsset->GetAnimationPose(BlendSampleDataCache, ExtractionContext, PoseData);

Version History

Introduced in: 5.0

Version Status Notes
5.6 stable

Feedback

Was this helpful?

Suggest an edit

Select a field above to begin editing.