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

#include <AnimNode_BlendSpacePlayer.h>

+ Inheritance diagram for FAnimNode_BlendSpacePlayerBase:

Public Member Functions

virtual ANIMGRAPHRUNTIME_API float GetCurrentAssetTime () const override
 
virtual ANIMGRAPHRUNTIME_API float GetCurrentAssetTimePlayRateAdjusted () const override
 
virtual ANIMGRAPHRUNTIME_API float GetCurrentAssetLength () const override
 
virtual ANIMGRAPHRUNTIME_API UAnimationAssetGetAnimAsset () 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 UpdateAssetPlayer (const FAnimationUpdateContext &Context) override
 
virtual ANIMGRAPHRUNTIME_API void Evaluate_AnyThread (FPoseContext &Output) override
 
virtual ANIMGRAPHRUNTIME_API void GatherDebugData (FNodeDebugData &DebugData) override
 
ANIMGRAPHRUNTIME_API float GetTimeFromEnd (float CurrentTime) const
 
FVector GetFilteredPosition () const
 
ANIMGRAPHRUNTIME_API void SnapToPosition (const FVector &NewPosition)
 
virtual bool GetLoop () const final
 
virtual bool ShouldTeleportToTime () const
 
virtual bool IsEvaluator () const
 
- 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 FName GetGroupName () const
 
virtual EAnimGroupRole::Type GetGroupRole () const
 
virtual EAnimSyncMethod GetGroupMethod () const
 
virtual bool GetOverridePositionWhenJoiningSyncGroupAsLeader () const
 
virtual bool SetGroupName (FName InGroupName)
 
virtual bool SetGroupRole (EAnimGroupRole::Type InRole)
 
virtual bool SetGroupMethod (EAnimSyncMethod InMethod)
 
virtual bool SetOverridePositionWhenJoiningSyncGroupAsLeader (bool InOverridePositionWhenJoiningSyncGroupAsLeader)
 
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 FDeltaTimeRecordGetDeltaTimeRecord () const override
 
- Public Member Functions inherited from FAnimNode_AssetPlayerRelevancyBase
virtual ENGINE_API bool IsLooping () const
 
virtual ENGINE_API bool GetIgnoreForRelevancyTest () const
 
virtual ENGINE_API bool SetIgnoreForRelevancyTest (bool bInIgnoreForRelevancyTest)
 
- 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 FExposedValueHandlerGetEvaluateGraphExposedInputs () const
 
void SetExposedValueHandler (const FExposedValueHandler *Handler)
 
int32 GetNodeIndex () const
 
const IAnimClassInterfaceGetAnimClassInterface () const
 

Public Attributes

virtual UBlendSpaceGetBlendSpace () 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
 

Protected Member Functions

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

FBlendFilter BlendFilter
 
TArray< FBlendSampleDataBlendSampleDataCache
 
int32 CachedTriangulationIndex = -1
 
TObjectPtr< UBlendSpacePreviousBlendSpace = nullptr
 
- Protected Attributes inherited from FAnimNode_AssetPlayerBase
FMarkerTickRecord MarkerTickRecord
 
float BlendWeight = 0.0f
 
float InternalTimeAccumulator = 0.0f
 
FDeltaTimeRecord DeltaTimeRecord
 
bool bHasBeenFullWeight = false
 

Member Function Documentation

◆ CacheBones_AnyThread()

void FAnimNode_BlendSpacePlayerBase::CacheBones_AnyThread ( const FAnimationCacheBonesContext Context)
overridevirtual

Called to cache any bones that this node needs to track (e.g. in a FBoneReference). This is usually called at startup when LOD switches occur. This can be called on any thread.

Parameters
ContextContext structure providing access to relevant data

Reimplemented from FAnimNode_Base.

Reimplemented in FAnimNode_AimOffsetLookAt, and FAnimNode_RotationOffsetBlendSpace.

◆ Evaluate_AnyThread()

void FAnimNode_BlendSpacePlayerBase::Evaluate_AnyThread ( FPoseContext Output)
overridevirtual

Called to evaluate local-space bones transforms according to the weights set up in Update(). You should implement either Evaluate or EvaluateComponentSpace, but not both of these. This can be called on any thread.

Parameters
OutputOutput structure to write pose or curve data to. Also provides access to relevant data as a context.

Reimplemented from FAnimNode_Base.

Reimplemented in FAnimNode_AimOffsetLookAt, and FAnimNode_RotationOffsetBlendSpace.

◆ GatherDebugData()

void FAnimNode_BlendSpacePlayerBase::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_Base.

Reimplemented in FAnimNode_AimOffsetLookAt, FAnimNode_BlendSpaceEvaluator, and FAnimNode_RotationOffsetBlendSpace.

◆ GetAnimAsset()

UAnimationAsset * FAnimNode_BlendSpacePlayerBase::GetAnimAsset ( ) const
overridevirtual

Get the animation asset associated with the node, derived classes should implement this

Reimplemented from FAnimNode_AssetPlayerRelevancyBase.

◆ GetCurrentAssetLength()

float FAnimNode_BlendSpacePlayerBase::GetCurrentAssetLength ( ) const
overridevirtual

◆ GetCurrentAssetTime()

float FAnimNode_BlendSpacePlayerBase::GetCurrentAssetTime ( ) const
overridevirtual

◆ GetCurrentAssetTimePlayRateAdjusted()

float FAnimNode_BlendSpacePlayerBase::GetCurrentAssetTimePlayRateAdjusted ( ) const
overridevirtual

Reimplemented from FAnimNode_AssetPlayerBase.

◆ GetFilteredPosition()

FVector FAnimNode_BlendSpacePlayerBase::GetFilteredPosition ( ) const
inline

◆ GetLoop()

virtual bool FAnimNode_BlendSpacePlayerBase::GetLoop ( ) const
inlinefinalvirtual

◆ GetTimeFromEnd()

float FAnimNode_BlendSpacePlayerBase::GetTimeFromEnd ( float  CurrentTime) const

◆ Initialize_AnyThread()

void FAnimNode_BlendSpacePlayerBase::Initialize_AnyThread ( const FAnimationInitializeContext Context)
overridevirtual

Initialize function for setup purposes

Reimplemented from FAnimNode_AssetPlayerBase.

Reimplemented in FAnimNode_AimOffsetLookAt, and FAnimNode_RotationOffsetBlendSpace.

◆ IsEvaluator()

virtual bool FAnimNode_BlendSpacePlayerBase::IsEvaluator ( ) const
inlinevirtual

Reimplemented in FAnimNode_BlendSpaceEvaluator.

◆ ShouldTeleportToTime()

virtual bool FAnimNode_BlendSpacePlayerBase::ShouldTeleportToTime ( ) const
inlinevirtual

Reimplemented in FAnimNode_BlendSpaceEvaluator.

◆ SnapToPosition()

void FAnimNode_BlendSpacePlayerBase::SnapToPosition ( const FVector NewPosition)

◆ UpdateAssetPlayer()

void FAnimNode_BlendSpacePlayerBase::UpdateAssetPlayer ( const FAnimationUpdateContext Context)
overridevirtual

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

Reimplemented from FAnimNode_AssetPlayerBase.

Reimplemented in FAnimNode_AimOffsetLookAt, FAnimNode_BlendSpaceEvaluator, and FAnimNode_RotationOffsetBlendSpace.

◆ UpdateInternal()

void FAnimNode_BlendSpacePlayerBase::UpdateInternal ( const FAnimationUpdateContext Context)
protected

Member Data Documentation

◆ BlendFilter

FBlendFilter FAnimNode_BlendSpacePlayerBase::BlendFilter
protected

◆ BlendSampleDataCache

TArray<FBlendSampleData> FAnimNode_BlendSpacePlayerBase::BlendSampleDataCache
protected

◆ CachedTriangulationIndex

int32 FAnimNode_BlendSpacePlayerBase::CachedTriangulationIndex = -1
protected

Previous position in the triangulation/segmentation

◆ GetBlendSpace

virtual UBlendSpace* FAnimNode_BlendSpacePlayerBase::GetBlendSpace() const PURE_VIRTUAL(FAnimNode_BlendSpacePlayerBase

◆ GetPlayRate

virtual float FAnimNode_BlendSpacePlayerBase::GetPlayRate() const PURE_VIRTUAL(FAnimNode_BlendSpacePlayerBase

◆ GetPosition

virtual FVector FAnimNode_BlendSpacePlayerBase::GetPosition() const PURE_VIRTUAL(FAnimNode_BlendSpacePlayerBase

◆ GetStartPosition

virtual float FAnimNode_BlendSpacePlayerBase::GetStartPosition() const PURE_VIRTUAL(FAnimNode_BlendSpacePlayerBase

◆ PreviousBlendSpace

TObjectPtr<UBlendSpace> FAnimNode_BlendSpacePlayerBase::PreviousBlendSpace = nullptr
protected

◆ SetBlendSpace

virtual bool FAnimNode_BlendSpacePlayerBase::SetBlendSpace(UBlendSpace *InBlendSpace) PURE_VIRTUAL(FAnimNode_BlendSpacePlayerBase

◆ SetLoop

virtual bool FAnimNode_BlendSpacePlayerBase::SetLoop(bool bInLoop) PURE_VIRTUAL(FAnimNode_BlendSpacePlayerBase

◆ SetPlayRate

virtual bool FAnimNode_BlendSpacePlayerBase::SetPlayRate(float InPlayRate) PURE_VIRTUAL(FAnimNode_BlendSpacePlayerBase

◆ SetPosition

virtual bool FAnimNode_BlendSpacePlayerBase::SetPosition(FVector InPosition) PURE_VIRTUAL(FAnimNode_BlendSpacePlayerBase

◆ SetResetPlayTimeWhenBlendSpaceChanges

virtual bool FAnimNode_BlendSpacePlayerBase::SetResetPlayTimeWhenBlendSpaceChanges(bool bReset) PURE_VIRTUAL(FAnimNode_BlendSpacePlayerBase

◆ ShouldResetPlayTimeWhenBlendSpaceChanges

virtual bool FAnimNode_BlendSpacePlayerBase::ShouldResetPlayTimeWhenBlendSpaceChanges() const PURE_VIRTUAL(FAnimNode_BlendSpacePlayerBase

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