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

#include <AnimNode_BlendSpaceEvaluator.h>

+ Inheritance diagram for FAnimNode_BlendSpaceEvaluator:

Public Member Functions

ANIMGRAPHRUNTIME_API FAnimNode_BlendSpaceEvaluator ()
 
virtual ANIMGRAPHRUNTIME_API void UpdateAssetPlayer (const FAnimationUpdateContext &Context) override
 
virtual ANIMGRAPHRUNTIME_API void GatherDebugData (FNodeDebugData &DebugData) override
 
virtual ANIMGRAPHRUNTIME_API float GetPlayRate () const override
 
virtual bool ShouldTeleportToTime () const override
 
virtual bool IsEvaluator () const override
 
- Public Member Functions inherited from FAnimNode_BlendSpacePlayer
virtual ANIMGRAPHRUNTIME_API FName GetGroupName () const override
 
virtual ANIMGRAPHRUNTIME_API EAnimGroupRole::Type GetGroupRole () const override
 
virtual ANIMGRAPHRUNTIME_API bool GetOverridePositionWhenJoiningSyncGroupAsLeader () const override
 
virtual ANIMGRAPHRUNTIME_API EAnimSyncMethod GetGroupMethod () const override
 
virtual ANIMGRAPHRUNTIME_API bool GetIgnoreForRelevancyTest () const override
 
virtual ANIMGRAPHRUNTIME_API bool IsLooping () const override
 
virtual ANIMGRAPHRUNTIME_API bool SetGroupName (FName InGroupName) override
 
virtual ANIMGRAPHRUNTIME_API bool SetGroupRole (EAnimGroupRole::Type InRole) override
 
virtual ANIMGRAPHRUNTIME_API bool SetOverridePositionWhenJoiningSyncGroupAsLeader (bool InOverridePositionWhenJoiningSyncGroupAsLeader) override
 
virtual ANIMGRAPHRUNTIME_API bool SetGroupMethod (EAnimSyncMethod InMethod) override
 
virtual ANIMGRAPHRUNTIME_API bool SetIgnoreForRelevancyTest (bool bInIgnoreForRelevancyTest) override
 
virtual ANIMGRAPHRUNTIME_API UBlendSpace * GetBlendSpace () const override
 
virtual ANIMGRAPHRUNTIME_API FVector GetPosition () const override
 
virtual ANIMGRAPHRUNTIME_API float GetStartPosition () const override
 
virtual ANIMGRAPHRUNTIME_API bool ShouldResetPlayTimeWhenBlendSpaceChanges () const override
 
virtual ANIMGRAPHRUNTIME_API bool SetResetPlayTimeWhenBlendSpaceChanges (bool bReset) override
 
virtual ANIMGRAPHRUNTIME_API bool SetBlendSpace (UBlendSpace *InBlendSpace) override
 
virtual ANIMGRAPHRUNTIME_API bool SetPosition (FVector InPosition) override
 
virtual ANIMGRAPHRUNTIME_API bool SetPlayRate (float InPlayRate) override
 
virtual ANIMGRAPHRUNTIME_API bool SetLoop (bool bInLoop) override
 
- Public Member Functions inherited from FAnimNode_BlendSpacePlayerBase
virtual ANIMGRAPHRUNTIME_API float GetCurrentAssetTime () const override
 
virtual ANIMGRAPHRUNTIME_API float GetCurrentAssetTimePlayRateAdjusted () const override
 
virtual ANIMGRAPHRUNTIME_API float GetCurrentAssetLength () const override
 
virtual ANIMGRAPHRUNTIME_API UAnimationAsset * GetAnimAsset () const override
 
virtual ANIMGRAPHRUNTIME_API void Initialize_AnyThread (const FAnimationInitializeContext &Context) override
 
virtual ANIMGRAPHRUNTIME_API void CacheBones_AnyThread (const FAnimationCacheBonesContext &Context) override
 
virtual ANIMGRAPHRUNTIME_API void Evaluate_AnyThread (FPoseContext &Output) override
 
ANIMGRAPHRUNTIME_API float GetTimeFromEnd (float CurrentTime) const
 
FVector GetFilteredPosition () const
 
ANIMGRAPHRUNTIME_API void SnapToPosition (const FVector &NewPosition)
 
virtual bool GetLoop () const final
 
- Public Member Functions inherited from FAnimNode_AssetPlayerBase
 FAnimNode_AssetPlayerBase ()=default
 
virtual ENGINE_API void Update_AnyThread (const FAnimationUpdateContext &Context) final override
 
ENGINE_API void CreateTickRecordForNode (const FAnimationUpdateContext &Context, UAnimSequenceBase *Sequence, bool bLooping, float PlayRate, bool bIsEvaluator)
 
virtual ENGINE_API float GetAccumulatedTime () const override
 
virtual ENGINE_API void SetAccumulatedTime (float NewTime) override
 
virtual ENGINE_API float GetCachedBlendWeight () const override
 
virtual ENGINE_API void ClearCachedBlendWeight () override
 
virtual ENGINE_API const FDeltaTimeRecord * GetDeltaTimeRecord () const override
 
- Public Member Functions inherited from FAnimNode_Base
virtual ENGINE_API void EvaluateComponentSpace_AnyThread (FComponentSpacePoseContext &Output)
 
virtual bool CanUpdateInWorkerThread () const
 
virtual bool HasPreUpdate () const
 
virtual void PreUpdate (const UAnimInstance *InAnimInstance)
 
virtual bool NeedsDynamicReset () const
 
virtual ENGINE_API void ResetDynamics (ETeleportType InTeleportType)
 
virtual void PostCompile (const class USkeleton *InSkeleton)
 
virtual bool NeedsOnInitializeAnimInstance () const
 
virtual ~FAnimNode_Base ()
 
virtual void ResetDynamics ()
 
virtual bool WantsSkippedUpdates () const
 
virtual void OnUpdatesSkipped (TArrayView< const FAnimationUpdateContext * > SkippedUpdateContexts)
 
virtual void OverrideAsset (class UAnimationAsset *NewAsset)
 
ENGINE_API const FExposedValueHandler & GetEvaluateGraphExposedInputs () const
 
void SetExposedValueHandler (const FExposedValueHandler *Handler)
 
int32 GetNodeIndex () const
 
const IAnimClassInterface * GetAnimClassInterface () const
 

Public Attributes

float NormalizedTime
 
bool bTeleportToNormalizedTime = true
 
- Public Attributes inherited from FAnimNode_BlendSpacePlayerBase
virtual UBlendSpace * GetBlendSpace () const PURE_VIRTUAL(FAnimNode_BlendSpacePlayerBase
 
virtual FVector GetPosition () const PURE_VIRTUAL(FAnimNode_BlendSpacePlayerBase
 
virtual float GetStartPosition () const PURE_VIRTUAL(FAnimNode_BlendSpacePlayerBase
 
virtual float GetPlayRate () const PURE_VIRTUAL(FAnimNode_BlendSpacePlayerBase
 
virtual bool ShouldResetPlayTimeWhenBlendSpaceChanges () const PURE_VIRTUAL(FAnimNode_BlendSpacePlayerBase
 
virtual bool SetResetPlayTimeWhenBlendSpaceChanges (bool bReset) PURE_VIRTUAL(FAnimNode_BlendSpacePlayerBase
 
virtual bool SetBlendSpace (UBlendSpace *InBlendSpace) PURE_VIRTUAL(FAnimNode_BlendSpacePlayerBase
 
virtual bool SetPosition (FVector InPosition) PURE_VIRTUAL(FAnimNode_BlendSpacePlayerBase
 
virtual bool SetPlayRate (float InPlayRate) PURE_VIRTUAL(FAnimNode_BlendSpacePlayerBase
 
virtual bool SetLoop (bool bInLoop) PURE_VIRTUAL(FAnimNode_BlendSpacePlayerBase
 

Additional Inherited Members

- Protected Member Functions inherited from FAnimNode_BlendSpacePlayerBase
ANIMGRAPHRUNTIME_API void UpdateInternal (const FAnimationUpdateContext &Context)
 
- Protected Member Functions inherited from FAnimNode_AssetPlayerBase
ENGINE_API UE::Anim::FAnimSyncParams GetSyncParams (bool bRequestedInertialization) const
 
- Protected Member Functions inherited from FAnimNode_Base
template<typename DataType >
const DataType & GetData (UE::Anim::FNodeDataId InId, const UObject *InObject=nullptr) const
 
template<typename DataType >
DataType * GetInstanceDataPtr (UE::Anim::FNodeDataId InId, UObject *InObject=nullptr)
 
ENGINE_API bool IsLODEnabled (FAnimInstanceProxy *AnimInstanceProxy)
 
virtual int32 GetLODThreshold () const
 
virtual ENGINE_API void OnInitializeAnimInstance (const FAnimInstanceProxy *InProxy, const UAnimInstance *InAnimInstance)
 
- Protected Attributes inherited from FAnimNode_BlendSpacePlayerBase
FBlendFilter BlendFilter
 
TArray< FBlendSampleData > BlendSampleDataCache
 
int32 CachedTriangulationIndex = -1
 
TObjectPtr< UBlendSpace > PreviousBlendSpace = nullptr
 
- Protected Attributes inherited from FAnimNode_AssetPlayerBase
FMarkerTickRecord MarkerTickRecord
 
float BlendWeight = 0.0f
 
float InternalTimeAccumulator = 0.0f
 
FDeltaTimeRecord DeltaTimeRecord
 
bool bHasBeenFullWeight = false
 

Constructor & Destructor Documentation

◆ FAnimNode_BlendSpaceEvaluator()

FAnimNode_BlendSpaceEvaluator::FAnimNode_BlendSpaceEvaluator ( )

Member Function Documentation

◆ GatherDebugData()

void FAnimNode_BlendSpaceEvaluator::GatherDebugData ( FNodeDebugData &  DebugData)
overridevirtual

Called to gather on-screen debug data. This is called on the game thread.

Parameters
DebugDataDebug data structure used to output any relevant data

Reimplemented from FAnimNode_BlendSpacePlayerBase.

◆ GetPlayRate()

float FAnimNode_BlendSpaceEvaluator::GetPlayRate ( ) const
overridevirtual

Reimplemented from FAnimNode_BlendSpacePlayer.

◆ IsEvaluator()

virtual bool FAnimNode_BlendSpaceEvaluator::IsEvaluator ( ) const
inlineoverridevirtual

Reimplemented from FAnimNode_BlendSpacePlayerBase.

◆ ShouldTeleportToTime()

virtual bool FAnimNode_BlendSpaceEvaluator::ShouldTeleportToTime ( ) const
inlineoverridevirtual

Reimplemented from FAnimNode_BlendSpacePlayerBase.

◆ UpdateAssetPlayer()

void FAnimNode_BlendSpaceEvaluator::UpdateAssetPlayer ( const FAnimationUpdateContext &  Context)
overridevirtual

Update method for the asset player, to be implemented by derived classes

Reimplemented from FAnimNode_BlendSpacePlayerBase.

Member Data Documentation

◆ bTeleportToNormalizedTime

bool FAnimNode_BlendSpaceEvaluator::bTeleportToNormalizedTime = true

If true, teleport to normalized time, does NOT advance time (does not trigger notifies, does not extract Root Motion, etc.). If false, will advance time (will trigger notifies, extract root motion if applicable, etc).

◆ NormalizedTime

float FAnimNode_BlendSpaceEvaluator::NormalizedTime

Normalized time between [0,1]. The actual length of a blendspace is dynamic based on the coordinate, so it is exposed as a normalized value. Note that treating this as a "time" value that increases (and wraps) will not result in the same output as you would get from using a BlendSpace player. The output events may not be as expected, and synchronization will sometimes be discontinuous if the leader/follower animations change as a result of changing the blend weights (even if that is done smoothly).

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