FAnimNode_BlendListBase Struct Reference

#include <AnimNode_BlendListBase.h>

Inheritance diagram for FAnimNode_BlendListBase:

Classes
struct	FBlendData

Public Member Functions
PRAGMA_DISABLE_DEPRECATION_WARNINGS	FAnimNode_BlendListBase ()=default
	~FAnimNode_BlendListBase ()=default
	FAnimNode_BlendListBase (const FAnimNode_BlendListBase &)=default
	FAnimNode_BlendListBase (FAnimNode_BlendListBase &&)=default
FAnimNode_BlendListBase &	operator= (const FAnimNode_BlendListBase &)=default
FAnimNode_BlendListBase &	operator= (FAnimNode_BlendListBase &&)=default
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
ANIMGRAPHRUNTIME_API const TArray< float > &	GetBlendTimes () const
ANIMGRAPHRUNTIME_API EBlendListTransitionType	GetTransitionType () const
ANIMGRAPHRUNTIME_API EAlphaBlendOption	GetBlendType () const
ANIMGRAPHRUNTIME_API bool	GetResetChildOnActivation () const
ANIMGRAPHRUNTIME_API EBlendListChildUpdateMode	GetChildUpdateMode () const
ANIMGRAPHRUNTIME_API UCurveFloat *	GetCustomBlendCurve () const
virtual ANIMGRAPHRUNTIME_API UBlendProfile *	GetBlendProfile () const
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

Protected Member Functions
virtual int32	GetActiveChildIndex ()
virtual FString	GetNodeName (FNodeDebugData &DebugData)
ANIMGRAPHRUNTIME_API void	Initialize ()
void	InitializePerBoneData ()
void	SetCurrentBlendProfile (UBlendProfile *NewBlendProfile)
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
TArray< FPoseLink >	BlendPose
TArray< FBlendData >	PerBlendData
TArray< FBlendSampleData >	PerBoneSampleData
int32	LastActiveChildIndex = 0
UBlendProfile *	CurrentBlendProfile = nullptr

Friends
class	UAnimGraphNode_BlendListBase
class	UBlendListBaseLibrary

Constructor & Destructor Documentation

FAnimNode_BlendListBase() [1/3]

PRAGMA_DISABLE_DEPRECATION_WARNINGS FAnimNode_BlendListBase::FAnimNode_BlendListBase ( )

default

~FAnimNode_BlendListBase()

FAnimNode_BlendListBase::~FAnimNode_BlendListBase ( )

default

FAnimNode_BlendListBase() [2/3]

FAnimNode_BlendListBase::FAnimNode_BlendListBase ( const FAnimNode_BlendListBase &  )

default

FAnimNode_BlendListBase() [3/3]

FAnimNode_BlendListBase::FAnimNode_BlendListBase ( FAnimNode_BlendListBase &&  )

default

Member Function Documentation

CacheBones_AnyThread()

void FAnimNode_BlendListBase::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

Context

Context structure providing access to relevant data

Reimplemented from FAnimNode_Base.

Evaluate_AnyThread()

void FAnimNode_BlendListBase::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

Output

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

Reimplemented from FAnimNode_Base.

GatherDebugData()

void FAnimNode_BlendListBase::GatherDebugData ( FNodeDebugData &  DebugData )

overridevirtual

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

Parameters

DebugData

Debug data structure used to output any relevant data

Reimplemented from FAnimNode_Base.

GetActiveChildIndex()

virtual int32 FAnimNode_BlendListBase::GetActiveChildIndex ( )

inlineprotectedvirtual

Reimplemented in FAnimNode_BlendListByBool, FAnimNode_BlendListByEnum, and FAnimNode_BlendListByInt.

GetBlendProfile()

UBlendProfile * FAnimNode_BlendListBase::GetBlendProfile ( ) const

virtual

Reimplemented in FAnimNode_BlendListByBool.

GetBlendTimes()

const TArray< float > & FAnimNode_BlendListBase::GetBlendTimes

(

)

const

GetBlendType()

EAlphaBlendOption FAnimNode_BlendListBase::GetBlendType

(

)

const

GetChildUpdateMode()

PRAGMA_ENABLE_DEPRECATION_WARNINGS EBlendListChildUpdateMode FAnimNode_BlendListBase::GetChildUpdateMode

(

)

const

Get the child update mode.

GetCustomBlendCurve()

UCurveFloat * FAnimNode_BlendListBase::GetCustomBlendCurve

(

)

const

GetNodeName()

virtual FString FAnimNode_BlendListBase::GetNodeName ( FNodeDebugData &  DebugData )

inlineprotectedvirtual

Reimplemented in FAnimNode_BlendListByBool, FAnimNode_BlendListByEnum, and FAnimNode_BlendListByInt.

GetResetChildOnActivation()

PRAGMA_DISABLE_DEPRECATION_WARNINGS bool FAnimNode_BlendListBase::GetResetChildOnActivation

(

)

const

Get whether to reinitialize the child pose when re-activated. For example, when active child changes

GetTransitionType()

EBlendListTransitionType FAnimNode_BlendListBase::GetTransitionType

(

)

const

Initialize()

void FAnimNode_BlendListBase::Initialize ( )

protected

Initialize_AnyThread()

void FAnimNode_BlendListBase::Initialize_AnyThread ( const FAnimationInitializeContext &  Context )

overridevirtual

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

Context

Context structure providing access to relevant data

Reimplemented from FAnimNode_Base.

InitializePerBoneData()

void FAnimNode_BlendListBase::InitializePerBoneData ( )

protected

operator=() [1/2]

FAnimNode_BlendListBase & FAnimNode_BlendListBase::operator= ( const FAnimNode_BlendListBase &  )

default

operator=() [2/2]

FAnimNode_BlendListBase & FAnimNode_BlendListBase::operator= ( FAnimNode_BlendListBase &&  )

default

SetCurrentBlendProfile()

void FAnimNode_BlendListBase::SetCurrentBlendProfile ( UBlendProfile *  NewBlendProfile )

protected

Update_AnyThread()

void FAnimNode_BlendListBase::Update_AnyThread ( const FAnimationUpdateContext &  Context )

overridevirtual

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

Context

Context structure providing access to relevant data

Reimplemented from FAnimNode_Base.

Friends And Related Symbol Documentation

UAnimGraphNode_BlendListBase

friend class UAnimGraphNode_BlendListBase

friend

UBlendListBaseLibrary

friend class UBlendListBaseLibrary

friend

Member Data Documentation

BlendPose

TArray<FPoseLink> FAnimNode_BlendListBase::BlendPose

protected

CurrentBlendProfile

UBlendProfile* FAnimNode_BlendListBase::CurrentBlendProfile = nullptr

protected

LastActiveChildIndex

int32 FAnimNode_BlendListBase::LastActiveChildIndex = 0

protected

PerBlendData

TArray<FBlendData> FAnimNode_BlendListBase::PerBlendData

protected

PerBoneSampleData

TArray<FBlendSampleData> FAnimNode_BlendListBase::PerBoneSampleData

protected

---

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

• Engine/Source/Runtime/AnimGraphRuntime/Public/AnimNodes/AnimNode_BlendListBase.h
• Engine/Source/Runtime/AnimGraphRuntime/Private/AnimNodes/AnimNode_BlendListBase.cpp