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

#include <AnimNode_BlendSpaceGraphBase.h>

+ Inheritance diagram for FAnimNode_BlendSpaceGraphBase:

Public Member Functions

const UBlendSpaceGetBlendSpace () const
 
FVector GetPosition () const
 
FVector GetFilteredPosition () const
 
ANIMGRAPHRUNTIME_API void SnapToPosition (const FVector &NewPosition)
 
- 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
 

Protected Member Functions

ANIMGRAPHRUNTIME_API void UpdateInternal (const FAnimationUpdateContext &Context)
 
virtual ANIMGRAPHRUNTIME_API void Initialize_AnyThread (const FAnimationInitializeContext &Context) override
 
virtual ANIMGRAPHRUNTIME_API void CacheBones_AnyThread (const FAnimationCacheBonesContext &Context) override
 
virtual ANIMGRAPHRUNTIME_API void Update_AnyThread (const FAnimationUpdateContext &Context) override
 
virtual ANIMGRAPHRUNTIME_API void Evaluate_AnyThread (FPoseContext &Output) override
 
virtual ANIMGRAPHRUNTIME_API void GatherDebugData (FNodeDebugData &DebugData) override
 
- 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

float X = 0.0f
 
float Y = 0.0f
 
FName GroupName = NAME_None
 
TEnumAsByte< EAnimGroupRole::Type > GroupRole = EAnimGroupRole::CanBeLeader
 
TObjectPtr< const UBlendSpaceBlendSpace = nullptr
 
TArray< FPoseLinkSamplePoseLinks
 
FBlendFilter BlendFilter
 
TArray< FBlendSampleDataBlendSampleDataCache
 
int32 CachedTriangulationIndex = -1
 

Friends

class UAnimGraphNode_BlendSpaceGraphBase
 

Member Function Documentation

◆ CacheBones_AnyThread()

void FAnimNode_BlendSpaceGraphBase::CacheBones_AnyThread ( const FAnimationCacheBonesContext Context)
overrideprotectedvirtual

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.

◆ Evaluate_AnyThread()

void FAnimNode_BlendSpaceGraphBase::Evaluate_AnyThread ( FPoseContext Output)
overrideprotectedvirtual

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.

◆ GatherDebugData()

void FAnimNode_BlendSpaceGraphBase::GatherDebugData ( FNodeDebugData DebugData)
overrideprotectedvirtual

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.

◆ GetBlendSpace()

const UBlendSpace * FAnimNode_BlendSpaceGraphBase::GetBlendSpace ( ) const
inline

◆ GetFilteredPosition()

FVector FAnimNode_BlendSpaceGraphBase::GetFilteredPosition ( ) const
inline

◆ GetPosition()

FVector FAnimNode_BlendSpaceGraphBase::GetPosition ( ) const
inline

◆ Initialize_AnyThread()

void FAnimNode_BlendSpaceGraphBase::Initialize_AnyThread ( const FAnimationInitializeContext Context)
overrideprotectedvirtual

Called when the node first runs. If the node is inside a state machine or cached pose branch then this can be called multiple times. This can be called on any thread.

Parameters
ContextContext structure providing access to relevant data

Reimplemented from FAnimNode_Base.

◆ SnapToPosition()

void FAnimNode_BlendSpaceGraphBase::SnapToPosition ( const FVector NewPosition)

◆ Update_AnyThread()

void FAnimNode_BlendSpaceGraphBase::Update_AnyThread ( const FAnimationUpdateContext Context)
overrideprotectedvirtual

Called to update the state of the graph relative to this node. Generally this should configure any weights (etc.) that could affect the poses that will need to be evaluated. This function is what usually executes EvaluateGraphExposedInputs. This can be called on any thread.

Parameters
ContextContext structure providing access to relevant data

Reimplemented from FAnimNode_Base.

◆ UpdateInternal()

void FAnimNode_BlendSpaceGraphBase::UpdateInternal ( const FAnimationUpdateContext Context)
protected

Friends And Related Symbol Documentation

◆ UAnimGraphNode_BlendSpaceGraphBase

friend class UAnimGraphNode_BlendSpaceGraphBase
friend

Member Data Documentation

◆ BlendFilter

FBlendFilter FAnimNode_BlendSpaceGraphBase::BlendFilter
protected

◆ BlendSampleDataCache

TArray<FBlendSampleData> FAnimNode_BlendSpaceGraphBase::BlendSampleDataCache
protected

◆ BlendSpace

TObjectPtr<const UBlendSpace> FAnimNode_BlendSpaceGraphBase::BlendSpace = nullptr
protected

◆ CachedTriangulationIndex

int32 FAnimNode_BlendSpaceGraphBase::CachedTriangulationIndex = -1
protected

Previous position in the triangulation/segmentation

◆ GroupName

FName FAnimNode_BlendSpaceGraphBase::GroupName = NAME_None
protected

◆ GroupRole

TEnumAsByte<EAnimGroupRole::Type> FAnimNode_BlendSpaceGraphBase::GroupRole = EAnimGroupRole::CanBeLeader
protected

◆ SamplePoseLinks

TArray<FPoseLink> FAnimNode_BlendSpaceGraphBase::SamplePoseLinks
protected

◆ X

float FAnimNode_BlendSpaceGraphBase::X = 0.0f
protected

◆ Y

float FAnimNode_BlendSpaceGraphBase::Y = 0.0f
protected

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