UAnimSequenceBase

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UAnimationAsset

UAnimSequenceBase

UAnimCompositeBase

	UAnimComposite
	UAnimMontage

UAnimSequence

UAnimStreamable

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Classes/Animation/AnimSequenceBase.h
Include	#include "Animation/AnimSequenceBase.h"

Syntax

class UAnimSequenceBase : public UAnimationAsset

Variables

	Name	Description
TArray< FAnimNo...	AnimNotifyTracks	If you change Notifies array, this will need to be rebuilt
bool	bPopulatingDataModel	Flag set whenever the data-model is initially populated (during upgrade path)
TScriptInterfac...	Controller	UAnimDataController instance set to operate on DataModel
TObjectPtr< UAn...	DataModel	UAnimDataModel instance containing source animation data
TArray< struct ...	Notifies	Animation notifies, sorted by time (earliest notification first).
UE::Anim::FAnim...	NotifyCollector	Helper object that keeps track of any controller brackets, and all unique notify types that are broadcasted during it
float	RateScale	Number for tweaking playback rate of this animation globally.

Constructors

	Name	Description
	UAnimSequenceBase ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
void	AdvanceMarkerPhaseAsFollower ( const FMarkerTickContext& Context, float DeltaRemaining, bool bLooping, float& CurrentTime, FMarkerPair& PreviousMarker, FMarkerPair& NextMarker, const UMirrorDataTable* Mirror... )
void	AdvanceMarkerPhaseAsLeader ( bool bLooping, float MoveDelta, const TArray< FName >& ValidMarker..., float& CurrentTime, FMarkerPair& PrevMarker, FMarkerPair& NextMarker, TArray< FPassedMarker >& MarkersPa..., const UMirrorDataTable* Mirror... )
void	BindToModelModificationEvent()	Binds to DataModel its modification delegate
EAnimEventTr...	CalculateOffsetForNotify ( float NotifyDisplayTime )	Calculates what (if any) offset should be applied to the trigger time of a notify given its display time
bool	CanBeUsedInComposition()
void	ClampNotifiesAtEndOfSequence()	Fix up any notifies that are positioned beyond the end of the sequence
void	CopyDataModel ( const UAnimDataModel* ModelToD... )	Replaces the current DataModel, if any, with the provided one
void	EnableRootMotionSettingFromMontage ( bool bInEnableRootMotion, const ERootMotionRootLock::Type InR... )	To support anim sequence base to montage
void	EvaluateCurveData ( FBlendedCurve& OutCurve, float CurrentTime, bool bForceUseRawData )	Evaluate curve data to Instance at the time of CurrentTime
float	EvaluateCurveData ( SmartName::UID_Type CurveUID, float CurrentTime, bool bForceUseRawData )	Evaluate curve data to Instance at the time of CurrentTime
uint8 *	FindArrayProperty ( const TCHAR* PropName, FArrayProperty*& ArrayProperty, int32 ArrayIndex )	Get a pointer to the data for a given array property item.
uint8 *	FindNotifyPropertyData ( int32 NotifyIndex, FArrayProperty*& ArrayProperty )	Get a pointer to the data for a given Anim Notify.
EAdditiveAni...	GetAdditiveAnimType()	Default implementation, no additive
UAnimSequenc...	GetAdditiveBasePose()	Ideally this would be animsequcnebase, but we might have some issue with that. For now, just allow AnimSequence
void	GetAnimationPose ( FAnimationPoseData& OutPoseData, const FAnimExtractContext& Extract... )
void	GetAnimNotifies ( const float& StartTime, const float& DeltaTime, FAnimNotifyContext& NotifyContext )	Retrieves AnimNotifies given a StartTime and a DeltaTime.
void	GetAnimNotifiesFromDeltaPositions ( const float& PreviousPosition, const float& CurrentPosition, FAnimNotifyContext& NotifyContext )	Retrieves AnimNotifies between two time positions.
IAnimationDa...	GetController()	Returns the transient UAnimDataController set to operate on DataModel
const FRawCu...	GetCurveData()
UAnimDataMod...	GetDataModel()	Returns the UAnimDataModel object embedded in this UAnimSequenceBase
float	GetFirstMatchingPosFromMarkerSyncPos ( const FMarkerSyncAnimPosition& InM... )
int32	GetFrameAtTime ( const float Time )	Get the frame number for the provided time
void	GetMarkerIndicesForPosition ( const FMarkerSyncAnimPosition& Syn..., bool bLooping, FMarkerPair& OutPrevMarker, FMarkerPair& OutNextMarker, float& CurrentTime, const UMirrorDataTable* Mirror... )
void	GetMarkerIndicesForTime ( float CurrentTime, bool bLooping, const TArray< FName >& ValidMarker..., FMarkerPair& OutPrevMarker, FMarkerPair& OutNextMarker )
FMarkerSyncA...	GetMarkerSyncPositionFromMarkerIndicies ( int32 PrevMarker, int32 NextMarker, float CurrentTime, const UMirrorDataTable* Mirror... )
float	GetNextMatchingPosFromMarkerSyncPos ( const FMarkerSyncAnimPosition& InM..., const float& StartingPosition )
int32	GetNumberOfSampledKeys()	Return the total number of keys sampled for this animation, including the T0 key
float	GetPrevMatchingPosFromMarkerSyncPos ( const FMarkerSyncAnimPosition& InM..., const float& StartingPosition )
const FFrame...	GetSamplingFrameRate()	Return rate at which the animation is sampled
float	GetTimeAtFrame ( const int32 Frame )	Get the time at the given frame
void	HandleAssetPlayerTickedInternal ( FAnimAssetTickContext& Context, const float PreviousTime, const float MoveDelta, const FAnimTickRecord& Instance, FAnimNotifyQueue& NotifyQueue )
bool	HasCurveData ( SmartName::UID_Type CurveUID, bool bForceUseRawData )
bool	HasRootMotion()
void	InitializeNotifyTrack()
bool	IsDataModelValid()
bool	IsNotifyAvailable()	Return true if anim notify is available
bool	IsValidToPlay()
void	OnModelModified ( const EAnimDataModelNotifyType& No..., UAnimDataModel* Model, const FAnimDataModelNotifPayload& ... )	Callback registered to UAnimDatModel::GetModifiedEvent for the embedded object
void	PopulateModel()	Populates the UAnimDataModel object according to any pre-existing data.
void	RefreshCacheData()	Update cache data (notify tracks, sync markers)
void	RegisterOnNotifyChanged ( const FOnNotifyChanged& Delegate )	Registers a delegate to be called after notification has changed
bool	RemoveNotifies ( const TArray< FName >& NotifiesToR... )	Remove the notifies specified
bool	ShouldDataModelBeValid()
void	SortNotifies()	Sort the Notifies array by time, earliest first.
void	TickByMarkerAsFollower ( FMarkerTickRecord& Instance, FMarkerTickContext& MarkerContext, float& CurrentTime, float& OutPreviousTime, const float MoveDelta, const bool bLooping, const UMirrorDataTable* Mirror... )
void	TickByMarkerAsLeader ( FMarkerTickRecord& Instance, FMarkerTickContext& MarkerContext, float& CurrentTime, float& OutPreviousTime, const float MoveDelta, const bool bLooping, const UMirrorDataTable* Mirror... )
void	UnregisterOnNotifyChanged ( void* Unregister )
void	ValidateModel()	Validates that DataModel contains a valid UAnimDataModel object
void	VerifyCurveNames ( USkeleton& Skeleton, const FName& NameContainer, TArray< DataType >& CurveList )

Overridden from UAnimationAsset

	Name	Description
float	GetPlayLength()	Returns the total play length of the montage, if played back with a speed of 1.0.
void	RefreshParentAssetData()
void	RemapTracksToNewSkeleton ( USkeleton* NewSkeleton, bool bConvertSpaces )
void	TickAssetPlayer ( FAnimTickRecord& Instance, FAnimNotifyQueue& NotifyQueue, FAnimAssetTickContext& Context )	Advances the asset player instance

Overridden from UObject

	Name	Description
void	GetAssetRegistryTags ( TArray< FAssetRegistryTag >& OutTa... )	Gathers a list of asset registry searchable tags which are name/value pairs with some type information This only needs to be implemented for asset objects
bool	IsPostLoadThreadSafe()	Called during async load to determine if PostLoad can be called on the loading thread.
void	PostDuplicate ( EDuplicateMode::Type DuplicateMode )
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.
void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Typedefs

Name	Description
FOnAnimCurvesChanged
FOnAnimTrackCurvesChanged
FOnNotifyChanged
FOnNotifyChangedMulticaster

Deprecated Variables

		Name	Description
	FRawCurveTracks	RawCurveData	Public access to RawCurveData is deprecated, see UAnimDataModel for source data or use GetCurveData for runtime instead
	float	SequenceLength	Public access to SequenceLength is deprecated, use GetPlayLength or UAnimDataController::SetPlayLength instead

Deprecated Functions

	Name	Description
void	AdvanceMarkerPhaseAsFollower ( const FMarkerTickContext& Context, float DeltaRemaining, bool bLooping, float& CurrentTime, FMarkerPair& PreviousMarker, FMarkerPair& NextMarker )	Use other AdvanceMarkerPhaseAsFollower signature
void	AdvanceMarkerPhaseAsLeader ( bool bLooping, float MoveDelta, const TArray< FName >& ValidMarker..., float& CurrentTime, FMarkerPair& PrevMarker, FMarkerPair& NextMarker, TArray< FPassedMarker >& MarkersPa... )	Use other AdvanceMarkerPhaseAsLeader signature
void	GetAnimationPose ( FCompactPose& OutPose, FBlendedCurve& OutCurve, const FAnimExtractContext& Extract... )	Use other GetAnimationPose signature
void	GetAnimNotifies ( const float& StartTime, const float& DeltaTime, const bool bAllowLooping, TArray< FAnimNotifyEventReference >... )	Use the other GetAnimNotifies that takes FAnimNotifyContext instead
void	GetAnimNotifies ( const float& StartTime, const float& DeltaTime, const bool bAllowLooping, TArray< const FAnimNotifyEvent*... )	Use the GetAnimNotifies that takes FAnimNotifyEventReferences instead
void	GetAnimNotifiesFromDeltaPositions ( const float& PreviousPosition, const float& CurrentPosition, TArray< FAnimNotifyEventReference >... )	Use the other GetAnimNotifiesFromDeltaPositions that takes FAnimNotifyContext instead
void	GetAnimNotifiesFromDeltaPositions ( const float& PreviousPosition, const float& CurrentPosition, TArray< const FAnimNotifyEvent*... )	Use the GetAnimNotifiesFromDeltaPositions that takes FAnimNotifyEventReferences instead
void	GetMarkerIndicesForPosition ( const FMarkerSyncAnimPosition& Syn..., bool bLooping, FMarkerPair& OutPrevMarker, FMarkerPair& OutNextMarker, float& CurrentTime )	Use other GetMarkerIndicesForPosition signature
FMarkerSyncA...	GetMarkerSyncPositionfromMarkerIndicies ( int32 PrevMarker, int32 NextMarker, float CurrentTime )	Use other GetMarkerSyncPositionfromMarkerIndicies signature
int32	GetNumberOfFrames()	Use GetNumberOfSampledKeys instead
void	MarkRawDataAsModified ( bool bForceNewRawDatGuid )	MarkRawDataAsModified has been deprecated, any (Raw Data) modification should be applied using the UAnimDataController API instead. This will handle updating the GUID instead.
void	RefreshCurveData()	Updating of any relevent Curve data is now handled through the UAnimDataModel notifies
void	RegisterOnAnimCurvesChanged ( const FOnAnimCurvesChanged& Delega... )	Functionality has been deprecated, register to UAnimDataModel::GetModifiedEvent instead
void	RegisterOnAnimTrackCurvesChanged ( const FOnAnimTrackCurvesChanged& D... )	Functionality has been deprecated, register to UAnimDataModel::GetModifiedEvent instead
void	SetSequenceLength ( float NewLength )	SetSequenceLength is deprecated use UAnimDataController::SetPlayLength instead
void	UnregisterOnAnimCurvesChanged ( void* Unregister )	Functionality has been deprecated, register to UAnimDataModel::GetModifiedEvent instead
void	UnregisterOnAnimTrackCurvesChanged ( void* Unregister )	Functionality has been deprecated, register to UAnimDataModel::GetModifiedEvent instead