FAnimNode_AssetPlayerBase Struct Reference

#include <AnimNode_AssetPlayerBase.h>

Inheritance diagram for FAnimNode_AssetPlayerBase:

Public Member Functions
	FAnimNode_AssetPlayerBase ()=default
virtual ENGINE_API void	Initialize_AnyThread (const FAnimationInitializeContext &Context) override
virtual ENGINE_API void	Update_AnyThread (const FAnimationUpdateContext &Context) final override
virtual void	UpdateAssetPlayer (const FAnimationUpdateContext &Context)
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 float	GetCurrentAssetTimePlayRateAdjusted () const override
virtual ENGINE_API const FDeltaTimeRecord *	GetDeltaTimeRecord () const override
Public Member Functions inherited from FAnimNode_AssetPlayerRelevancyBase
virtual ENGINE_API class UAnimationAsset *	GetAnimAsset () const
virtual ENGINE_API float	GetCurrentAssetLength () const
virtual ENGINE_API float	GetCurrentAssetTime () const
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	CacheBones_AnyThread (const FAnimationCacheBonesContext &Context)
virtual ENGINE_API void	Evaluate_AnyThread (FPoseContext &Output)
virtual ENGINE_API void	EvaluateComponentSpace_AnyThread (FComponentSpacePoseContext &Output)
virtual void	GatherDebugData (FNodeDebugData &DebugData)
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
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
FMarkerTickRecord	MarkerTickRecord
float	BlendWeight = 0.0f
float	InternalTimeAccumulator = 0.0f
FDeltaTimeRecord	DeltaTimeRecord
bool	bHasBeenFullWeight = false

Friends
class	UAnimGraphNode_AssetPlayerBase

Constructor & Destructor Documentation

FAnimNode_AssetPlayerBase()

FAnimNode_AssetPlayerBase::FAnimNode_AssetPlayerBase ( )

default

Member Function Documentation

ClearCachedBlendWeight()

void FAnimNode_AssetPlayerBase::ClearCachedBlendWeight ( )

overridevirtual

Set the cached blendweight to zero

Reimplemented from FAnimNode_AssetPlayerRelevancyBase.

CreateTickRecordForNode()

void FAnimNode_AssetPlayerBase::CreateTickRecordForNode	(	const FAnimationUpdateContext &	Context,
		UAnimSequenceBase *	Sequence,
		bool	bLooping,
		float	PlayRate,
		bool	bIsEvaluator
	)

GetAccumulatedTime()

float FAnimNode_AssetPlayerBase::GetAccumulatedTime ( ) const

overridevirtual

Get the currently referenced time within the asset player node

Reimplemented from FAnimNode_AssetPlayerRelevancyBase.

Reimplemented in FAnimNode_PoseHandler, and FAnimNode_SequenceEvaluatorBase.

GetCachedBlendWeight()

float FAnimNode_AssetPlayerBase::GetCachedBlendWeight ( ) const

overridevirtual

Get the last encountered blend weight for this node

Reimplemented from FAnimNode_AssetPlayerRelevancyBase.

GetCurrentAssetTimePlayRateAdjusted()

float FAnimNode_AssetPlayerBase::GetCurrentAssetTimePlayRateAdjusted ( ) const

overridevirtual

Reimplemented from FAnimNode_AssetPlayerRelevancyBase.

Reimplemented in FAnimNode_BlendSpacePlayerBase, and FAnimNode_SequencePlayerBase.

GetDeltaTimeRecord()

const FDeltaTimeRecord * FAnimNode_AssetPlayerBase::GetDeltaTimeRecord ( ) const

overridevirtual

Get the delta time record owned by this asset player (or null)

Reimplemented from FAnimNode_AssetPlayerRelevancyBase.

GetGroupMethod()

virtual EAnimSyncMethod FAnimNode_AssetPlayerBase::GetGroupMethod ( ) const

inlinevirtual

Reimplemented in FAnimNode_BlendSpacePlayer, FAnimNode_BlendSpacePlayer_Standalone, FAnimNode_SequenceEvaluator, FAnimNode_SequenceEvaluator_Standalone, FAnimNode_SequencePlayer, and FAnimNode_SequencePlayer_Standalone.

GetGroupName()

virtual FName FAnimNode_AssetPlayerBase::GetGroupName ( ) const

inlinevirtual

Reimplemented in FAnimNode_BlendSpacePlayer, FAnimNode_BlendSpacePlayer_Standalone, FAnimNode_SequenceEvaluator, FAnimNode_SequenceEvaluator_Standalone, FAnimNode_SequencePlayer, and FAnimNode_SequencePlayer_Standalone.

GetGroupRole()

virtual EAnimGroupRole::Type FAnimNode_AssetPlayerBase::GetGroupRole ( ) const

inlinevirtual

Reimplemented in FAnimNode_BlendSpacePlayer, FAnimNode_BlendSpacePlayer_Standalone, FAnimNode_SequenceEvaluator, FAnimNode_SequenceEvaluator_Standalone, FAnimNode_SequencePlayer, and FAnimNode_SequencePlayer_Standalone.

GetOverridePositionWhenJoiningSyncGroupAsLeader()

virtual bool FAnimNode_AssetPlayerBase::GetOverridePositionWhenJoiningSyncGroupAsLeader ( ) const

inlinevirtual

Reimplemented in FAnimNode_BlendSpacePlayer, FAnimNode_BlendSpacePlayer_Standalone, FAnimNode_SequencePlayer, and FAnimNode_SequencePlayer_Standalone.

GetSyncParams()

UE::Anim::FAnimSyncParams FAnimNode_AssetPlayerBase::GetSyncParams ( bool  bRequestedInertialization ) const

protected

Get sync parameters for the tick record produced by this asset player

Initialize_AnyThread()

void FAnimNode_AssetPlayerBase::Initialize_AnyThread ( const FAnimationInitializeContext &  Context )

overridevirtual

Initialize function for setup purposes

Reimplemented from FAnimNode_Base.

Reimplemented in FAnimNode_AimOffsetLookAt, FAnimNode_BlendSpacePlayerBase, FAnimNode_PoseBlendNode, FAnimNode_PoseByName, FAnimNode_PoseDriver, FAnimNode_PoseHandler, FAnimNode_RotationOffsetBlendSpace, FAnimNode_SequenceEvaluatorBase, and FAnimNode_SequencePlayerBase.

SetAccumulatedTime()

void FAnimNode_AssetPlayerBase::SetAccumulatedTime ( float  NewTime )

overridevirtual

Override the currently accumulated time

Reimplemented from FAnimNode_AssetPlayerRelevancyBase.

Reimplemented in FAnimNode_PoseHandler, and FAnimNode_SequenceEvaluatorBase.

SetGroupMethod()

virtual bool FAnimNode_AssetPlayerBase::SetGroupMethod ( EAnimSyncMethod  InMethod )

inlinevirtual

Reimplemented in FAnimNode_BlendSpacePlayer, FAnimNode_BlendSpacePlayer_Standalone, FAnimNode_SequenceEvaluator, FAnimNode_SequenceEvaluator_Standalone, FAnimNode_SequencePlayer, and FAnimNode_SequencePlayer_Standalone.

SetGroupName()

virtual bool FAnimNode_AssetPlayerBase::SetGroupName ( FName  InGroupName )

inlinevirtual

Reimplemented in FAnimNode_BlendSpacePlayer, FAnimNode_BlendSpacePlayer_Standalone, FAnimNode_SequenceEvaluator, FAnimNode_SequenceEvaluator_Standalone, FAnimNode_SequencePlayer, and FAnimNode_SequencePlayer_Standalone.

SetGroupRole()

virtual bool FAnimNode_AssetPlayerBase::SetGroupRole ( EAnimGroupRole::Type  InRole )

inlinevirtual

Reimplemented in FAnimNode_BlendSpacePlayer, FAnimNode_BlendSpacePlayer_Standalone, FAnimNode_SequenceEvaluator, FAnimNode_SequenceEvaluator_Standalone, FAnimNode_SequencePlayer, and FAnimNode_SequencePlayer_Standalone.

SetOverridePositionWhenJoiningSyncGroupAsLeader()

virtual bool FAnimNode_AssetPlayerBase::SetOverridePositionWhenJoiningSyncGroupAsLeader ( bool  InOverridePositionWhenJoiningSyncGroupAsLeader )

inlinevirtual

Reimplemented in FAnimNode_BlendSpacePlayer, FAnimNode_BlendSpacePlayer_Standalone, FAnimNode_SequencePlayer, and FAnimNode_SequencePlayer_Standalone.

Update_AnyThread()

void FAnimNode_AssetPlayerBase::Update_AnyThread ( const FAnimationUpdateContext &  Context )

finaloverridevirtual

Update the node, marked final so we can always handle blendweight caching. Derived classes should implement UpdateAssetPlayer

Reimplemented from FAnimNode_Base.

UpdateAssetPlayer()

virtual void FAnimNode_AssetPlayerBase::UpdateAssetPlayer ( const FAnimationUpdateContext &  Context )

inlinevirtual

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

Reimplemented in FAnimNode_AimOffsetLookAt, FAnimNode_BlendSpaceEvaluator, FAnimNode_BlendSpacePlayerBase, FAnimNode_PoseBlendNode, FAnimNode_PoseByName, FAnimNode_PoseDriver, FAnimNode_PoseHandler, FAnimNode_RotationOffsetBlendSpace, FAnimNode_SequenceEvaluatorBase, and FAnimNode_SequencePlayerBase.

Friends And Related Symbol Documentation

UAnimGraphNode_AssetPlayerBase

friend class UAnimGraphNode_AssetPlayerBase

friend

Member Data Documentation

bHasBeenFullWeight

bool FAnimNode_AssetPlayerBase::bHasBeenFullWeight = false

protected

Track whether we have been full weight previously. Reset when we reach 0 weight

BlendWeight

float FAnimNode_AssetPlayerBase::BlendWeight = 0.0f

protected

Last encountered blendweight for this node

DeltaTimeRecord

FDeltaTimeRecord FAnimNode_AssetPlayerBase::DeltaTimeRecord

protected

Previous frame InternalTimeAccumulator value and effective delta time leading into the current frame

InternalTimeAccumulator

float FAnimNode_AssetPlayerBase::InternalTimeAccumulator = 0.0f

protected

Accumulated time used to reference the asset in this node

MarkerTickRecord

FMarkerTickRecord FAnimNode_AssetPlayerBase::MarkerTickRecord

protected

Store data about current marker position when using marker based syncing

---

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

• Engine/Source/Runtime/Engine/Classes/Animation/AnimNode_AssetPlayerBase.h
• Engine/Source/Runtime/Engine/Private/Animation/AnimNode_AssetPlayerBase.cpp