#include <AnimNode_SequencePlayer.h>

Inheritance diagram for FAnimNode_SequencePlayerBase:

Public Member Functions
virtual ENGINE_API float	GetCurrentAssetTime () const override

virtual ENGINE_API float	GetCurrentAssetTimePlayRateAdjusted () const override

virtual ENGINE_API float	GetCurrentAssetLength () const override

virtual UAnimationAsset *	GetAnimAsset () const override

virtual ENGINE_API void	Initialize_AnyThread (const FAnimationInitializeContext &Context) override

virtual ENGINE_API void	CacheBones_AnyThread (const FAnimationCacheBonesContext &Context) override

virtual ENGINE_API void	UpdateAssetPlayer (const FAnimationUpdateContext &Context) override

virtual ENGINE_API void	Evaluate_AnyThread (FPoseContext &Output) override

virtual ENGINE_API void	GatherDebugData (FNodeDebugData &DebugData) override

ENGINE_API float	GetTimeFromEnd (float CurrentNodeTime) const

ENGINE_API float	GetEffectiveStartPosition (const FAnimationBaseContext &Context) const

virtual UAnimSequenceBase *	GetSequence () const

virtual bool	GetLoopAnimation () 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 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 FDeltaTimeRecord *	GetDeltaTimeRecord () 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 FExposedValueHandler &	GetEvaluateGraphExposedInputs () const

void	SetExposedValueHandler (const FExposedValueHandler *Handler)

int32	GetNodeIndex () const

const IAnimClassInterface *	GetAnimClassInterface () const

Protected Member Functions
virtual bool	SetSequence (UAnimSequenceBase *InSequence)

virtual bool	SetLoopAnimation (bool bInLoopAnimation)

virtual float	GetPlayRateBasis () const

virtual float	GetPlayRate () const

virtual const FInputScaleBiasClampConstants &	GetPlayRateScaleBiasClampConstants () const

virtual float	GetStartPosition () const

virtual bool	GetStartFromMatchingPose () const

virtual bool	SetStartPosition (float InStartPosition)

virtual bool	SetPlayRate (float InPlayRate)

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
FInputScaleBiasClampState	PlayRateScaleBiasClampState

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_SequencePlayerBase::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_SequencePlayerBase::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_SequencePlayerBase::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.

◆ GetAnimAsset()

virtual UAnimationAsset * FAnimNode_SequencePlayerBase::GetAnimAsset ( ) const

inlineoverridevirtual

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

Reimplemented from FAnimNode_AssetPlayerRelevancyBase.

◆ GetCurrentAssetLength()

float FAnimNode_SequencePlayerBase::GetCurrentAssetLength ( ) const

overridevirtual

Reimplemented from FAnimNode_AssetPlayerRelevancyBase.

◆ GetCurrentAssetTime()

float FAnimNode_SequencePlayerBase::GetCurrentAssetTime ( ) const

overridevirtual

Reimplemented from FAnimNode_AssetPlayerRelevancyBase.

◆ GetCurrentAssetTimePlayRateAdjusted()

float FAnimNode_SequencePlayerBase::GetCurrentAssetTimePlayRateAdjusted ( ) const

overridevirtual

Reimplemented from FAnimNode_AssetPlayerBase.

◆ GetEffectiveStartPosition()

float FAnimNode_SequencePlayerBase::GetEffectiveStartPosition ( const FAnimationBaseContext & Context ) const

◆ GetLoopAnimation()

virtual bool FAnimNode_SequencePlayerBase::GetLoopAnimation ( ) const

inlinefinalvirtual

◆ GetPlayRate()

virtual float FAnimNode_SequencePlayerBase::GetPlayRate ( ) const

inlineprotectedvirtual

Reimplemented in FAnimNode_SequencePlayer, and FAnimNode_SequencePlayer_Standalone.

◆ GetPlayRateBasis()

virtual float FAnimNode_SequencePlayerBase::GetPlayRateBasis ( ) const

inlineprotectedvirtual

Reimplemented in FAnimNode_SequencePlayer, and FAnimNode_SequencePlayer_Standalone.

◆ GetPlayRateScaleBiasClampConstants()

virtual const FInputScaleBiasClampConstants & FAnimNode_SequencePlayerBase::GetPlayRateScaleBiasClampConstants ( ) const

inlineprotectedvirtual

Reimplemented in FAnimNode_SequencePlayer, and FAnimNode_SequencePlayer_Standalone.

◆ GetSequence()

virtual UAnimSequenceBase * FAnimNode_SequencePlayerBase::GetSequence ( ) const

inlinevirtual

Reimplemented in FAnimNode_SequencePlayer, and FAnimNode_SequencePlayer_Standalone.

◆ GetStartFromMatchingPose()

virtual bool FAnimNode_SequencePlayerBase::GetStartFromMatchingPose ( ) const

inlineprotectedvirtual

Reimplemented in FAnimNode_SequencePlayer, and FAnimNode_SequencePlayer_Standalone.

◆ GetStartPosition()

virtual float FAnimNode_SequencePlayerBase::GetStartPosition ( ) const

inlineprotectedvirtual

Reimplemented in FAnimNode_SequencePlayer, and FAnimNode_SequencePlayer_Standalone.

◆ GetTimeFromEnd()

float FAnimNode_SequencePlayerBase::GetTimeFromEnd ( float CurrentNodeTime ) const

◆ Initialize_AnyThread()

void FAnimNode_SequencePlayerBase::Initialize_AnyThread ( const FAnimationInitializeContext & Context )

overridevirtual

Initialize function for setup purposes

Reimplemented from FAnimNode_AssetPlayerBase.

◆ SetLoopAnimation()

virtual bool FAnimNode_SequencePlayerBase::SetLoopAnimation ( bool bInLoopAnimation )

inlineprotectedvirtual

Reimplemented in FAnimNode_SequencePlayer, and FAnimNode_SequencePlayer_Standalone.

◆ SetPlayRate()

virtual bool FAnimNode_SequencePlayerBase::SetPlayRate ( float InPlayRate )

inlineprotectedvirtual

Reimplemented in FAnimNode_SequencePlayer, and FAnimNode_SequencePlayer_Standalone.

◆ SetSequence()

virtual bool FAnimNode_SequencePlayerBase::SetSequence ( UAnimSequenceBase * InSequence )

inlineprotectedvirtual

Reimplemented in FAnimNode_SequencePlayer, and FAnimNode_SequencePlayer_Standalone.

◆ SetStartPosition()

virtual bool FAnimNode_SequencePlayerBase::SetStartPosition ( float InStartPosition )

inlineprotectedvirtual

Reimplemented in FAnimNode_SequencePlayer, and FAnimNode_SequencePlayer_Standalone.

◆ UpdateAssetPlayer()

void FAnimNode_SequencePlayerBase::UpdateAssetPlayer ( const FAnimationUpdateContext & Context )

overridevirtual

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

Reimplemented from FAnimNode_AssetPlayerBase.

Member Data Documentation

◆ PlayRateScaleBiasClampState

FInputScaleBiasClampState FAnimNode_SequencePlayerBase::PlayRateScaleBiasClampState

protected

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

Engine/Source/Runtime/Engine/Classes/Animation/AnimNode_SequencePlayer.h
Engine/Source/Runtime/Engine/Private/Animation/AnimNode_SequencePlayer.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Member Function Documentation

◆ CacheBones_AnyThread()

◆ Evaluate_AnyThread()

◆ GatherDebugData()

◆ GetAnimAsset()

◆ GetCurrentAssetLength()

◆ GetCurrentAssetTime()

◆ GetCurrentAssetTimePlayRateAdjusted()

◆ GetEffectiveStartPosition()

◆ GetLoopAnimation()

◆ GetPlayRate()

◆ GetPlayRateBasis()

◆ GetPlayRateScaleBiasClampConstants()

◆ GetSequence()

◆ GetStartFromMatchingPose()

◆ GetStartPosition()

◆ GetTimeFromEnd()

◆ Initialize_AnyThread()

◆ SetLoopAnimation()

◆ SetPlayRate()

◆ SetSequence()

◆ SetStartPosition()

◆ UpdateAssetPlayer()

Member Data Documentation

◆ PlayRateScaleBiasClampState