Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Engine > Animation > UAnimSequence

Light Theme

Dark Theme

UAnimSequence

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UAnimationAsset

UAnimSequenceBase

UAnimSequence

References

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

Syntax

class UAnimSequence : public UAnimSequenceBase

Variables

	Name	Description
TEnumAsByte< en...	AdditiveAnimType	Additive animation type.
TObjectPtr< cla...	AssetImportData	Importing data and options used for this mesh
TMap< FAnimatio...	AttributeCurves
TArray< FAnimSy...	AuthoredSyncMarkers	Authored Sync markers
bool	bAllowFrameStripping	Allow frame stripping to be performed on this animation if the platform requests it Can be disabled if animation has high frequency movements that are being lost.
bool	bBlockCompressionRequests
uint32: 1	bDoNotOverrideCompression	Do not attempt to override compression scheme when running CompressAnimations commandlet.
bool	bEnableRootMotion	If this is on, it will allow extracting of root motion
bool	bForceRootLock	Force Root Bone Lock even if Root Motion is not enabled
TObjectPtr< cla...	BoneCompressionSettings	The bone compression settings used to compress bones in this sequence.
bool	bRootMotionSettingsCopiedFromMontage	Have we copied root motion settings from an owning montage
bool	bUseNormalizedRootMotionScale	If this is on, it will use a normalized scale value for the root motion extracted: FVector(1.0, 1.0, 1.0)
TMap< FIoHash, ...	CacheTasksByKeyHash
int32	CompressCommandletVersion	Saved version number with CompressAnimations commandlet. To help with doing it in multiple passes.
FCompressedAnim...	CompressedData
float	CompressionErrorThresholdScale	Set a scale for error threshold on compression.
TObjectPtr< cla...	CurveCompressionSettings	The curve compression settings used to compress curves in this sequence.
TMap< FIoHash, ...	DataByPlatformKeyHash
FIoHash	DataKeyHash
float	ImportFileFramerate	The DCC framerate of the imported file. UI information only, unit are Hz
int32	ImportResampleFramerate	The resample framerate that was computed during import. UI information only, unit are Hz
EAnimInterpolat...	Interpolation	This defines how values between keys are calculated
int32	MarkerDataUpdateCounter	Track whether we have updated markers so cached data can be updated.
int32	NumberOfSampledFrames
int32	NumberOfSampledKeys
FPerPlatformFra...	PlatformTargetFrameRate
int32	RefFrameIndex	Additve reference frame if RefPoseType == AnimFrame
TObjectPtr< cla...	RefPoseSeq	Additive reference animation if it's relevant - i.e. AnimScaled or AnimFrame
TEnumAsByte< en...	RefPoseType	Additive refrerence pose type. Refer above enum type
FName	RetargetSource	Base pose to use when retargeting
TSoftObjectPtr<...	RetargetSourceAsset	If RetargetSource is set to Default (None), this is asset for the base pose to use when retargeting.
TArray< FTransf...	RetargetSourceAssetReferencePose	When using RetargetSourceAsset, use the post stored here
TEnumAsByte< ER...	RootMotionRootLock	Root Bone will be locked to that position when extracting root motion.
FFrameRate	TargetFrameRate
TArray< FName >	UniqueMarkerNames	List of Unique marker names in this animation sequence

Constructors

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

Functions

	Name	Description
void	AddKeyToSequence ( float Time, const FName& BoneName, const FTransform& AdditiveTransfor... )	Add Key to Transform Curves
void	AddReferencedObjects ( UObject* This, FReferenceCollector& Collector )
FIoHash	BeginCacheDerivedData ( const ITargetPlatform* TargetP... )
void	BeginCacheDerivedDataForCurrentPlatform()
FCompressedA...	CacheDerivedData ( const ITargetPlatform* TargetP... )	Synchronous caching of compressed animation data for provided target platform.
void	CacheDerivedDataForCurrentPlatform()
void	CalculateNumberOfSampledKeys()
bool	CanBakeAdditive()	Is this animation valid for baking into additive.
void	ClearCompressedBoneData()
void	ClearCompressedCurveData()
bool	CreateAnimation ( UAnimSequence* Sequence )	Create Animation Sequence from the given animation
bool	CreateAnimation ( USkeletalMeshComponent* MeshCo... )	Create Animation Sequence from the Mesh Component's current bone transform
bool	CreateAnimation ( USkeletalMesh* Mesh )	Create Animation Sequence from Reference Pose of the Mesh
FIoHash	CreateDerivedDataKeyHash ( const ITargetPlatform* TargetP... )
void	DeleteBoneAnimationData()
void	DeleteDeprecatedRawAnimationData()
void	DeleteNotifyTrackData()
bool	DoesNeedRecompress()	Return true if compressed data is out of date / missing and so animation needs to use raw data
bool	DoesSequenceContainZeroScale()	Test whether at any point we will scale a bone to 0 (needed for validating additive anims)
void	EndCacheDerivedData ( const FIoHash& KeyHash )
void	EnsureValidRawDataGuid()
void	EvaluateAttributes ( FAnimationPoseData& OutAnimationPo..., const FAnimExtractContext& Extract..., bool bUseRawData )
uint8 *	FindSyncMarkerPropertyData ( int32 SyncMarkerIndex, FArrayProperty*& ArrayProperty )	Get a pointer to the data for a given Anim Notify.
void	FinishAsyncTasks()
void	FlagDependentAnimationsAsRawDataOnly()	Helper function to allow us to notify animations that depend on us that they need to update.
int32	GetApproxBoneCompressedSize()
int32	GetApproxCompressedSize()
int64	GetApproxRawSize()
void	GetBonePose ( FAnimationPoseData& OutAnimationPo..., const FAnimExtractContext& Extract..., bool bForceUseRawData )	Get Bone Transform of the Time given, relative to Parent for all RequiredBones This returns different transform based on additive or not.
void	GetBoneTransform ( FTransform& OutAtom, FSkeletonPoseBoneIndex BoneIndex, double Time, bool bUseRawData )
void	GetBoneTransform ( FTransform& OutAtom, FSkeletonPoseBoneIndex BoneIndex, FAnimSequenceDecompressionContext&..., bool bUseRawData )	Get Bone Transform of the Time given, relative to Parent for the Track Given
const TArray...	GetCompressedCurveNames()
const TArray...	GetCompressedTrackToSkeletonMapTable()
float	GetCurrentTimeFromMarkers ( FMarkerPair& PrevMarker, FMarkerPair& NextMarker, float PositionBetweenMarkers )	Advancing based on markers.
const TArray...	GetRetargetTransforms()
FName	GetRetargetTransformsSourceName()
FFrameRate	GetTargetSamplingFrameRate ( const ITargetPlatform* InPlatf... )
int32	GetUncompressedRawSize()
bool	IsAsyncTaskComplete()
bool	IsCompiling()
bool	IsCompressedDataValid()
bool	IsCurveCompressedDataValid()
void	MoveAttributesToModel()
bool	PollCacheDerivedData ( const FIoHash& KeyHash )
void	RefreshSyncMarkerDataFromAuthored()	Refresh sync marker data
void	Reschedule ( FQueuedThreadPool* InThreadPoo..., EQueuedWorkPriority InPriority )
void	ResetAnimation()	Resets Bone Animation, Curve data and Notify tracks
void	RetargetBoneTransform ( FTransform& BoneTransform, const int32 SkeletonBoneIndex, const FCompactPoseBoneIndex& BoneI..., const FBoneContainer& RequiredBone..., const bool bIsBakedAdditive )	Retarget a single bone transform, to apply right after extraction.
void	SerializeCompressedData ( FArchive& Ar, bool bDDCData )	Write the compressed data to the supplied FArchive.
void	SortSyncMarkers()	Sort the sync markers array by time, earliest first.
void	SynchronousAnimatedBoneAttributesCompression()
bool	TryCancelAsyncTasks()
void	UpdateCompressedCurveName ( SmartName::UID_Type CurveUID, const FSmartName& NewCurveName )
void	UpdateDependentStreamingAnimations()	Helper function to allow us to update streaming animations that depend on us with our data when we are updated.
bool	UseRawDataForPoseExtraction ( const FBoneContainer& RequiredBone... )
void	ValidateCurrentPosition ( const FMarkerSyncAnimPosition& Pos..., bool bPlayingForwards, bool bLooping, float& CurrentTime, FMarkerPair& PreviousMarker, FMarkerPair& NextMarker, const UMirrorDataTable* Mirror... )	Take a set of marker positions and validates them against a requested start position, updating them as desired
void	WaitOnExistingCompression ( const bool bWantResults )

Overridden from UAnimSequenceBase

	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	EnableRootMotionSettingFromMontage ( bool bInEnableRootMotion, const ERootMotionRootLock::Type InR... )	To support anim sequence base to all montages
float	EvaluateCurveData ( SmartName::UID_Type CurveUID, float CurrentTime, bool bForceUseRawData )	Evaluate curve data to Instance at the time of CurrentTime
void	EvaluateCurveData ( FBlendedCurve& OutCurve, float CurrentTime, bool bForceUseRawData )	Evaluate curve data to Instance at the time of CurrentTime
FTransform	ExtractRootMotion ( float StartTime, float DeltaTime, bool bAllowLooping )	Extract Root Motion transform from the animation.
FTransform	ExtractRootMotionFromRange ( float StartTrackPosition, float EndTrackPosition )	Extract Root Motion transform from a contiguous position range (no looping)
FTransform	ExtractRootTrackTransform ( float Time, const FBoneContainer* Required... )	Extract the transform from the root track for the given animation position.
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& OutAnimationPo..., const FAnimExtractContext& Extract... )	Begin Transform related functions.
float	GetFirstMatchingPosFromMarkerSyncPos ( const FMarkerSyncAnimPosition& InM... )
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 )
FFrameRate	GetSamplingFrameRate()	Return rate at which the animation is sampled
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()
bool	IsValidToPlay()	Add validation check to see if it's being ready to play or not
void	OnAnimModelLoaded()
void	OnModelModified ( const EAnimDataModelNotifyType& No..., IAnimationDataModel* 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)

Overridden from UAnimationAsset

	Name	Description
bool	GetAllAnimationSequencesReferred ( TArray< UAnimationAsset* >& A..., bool bRecursive )	Retrieve all animations that are used by this asset
int32	GetMarkerUpdateCounter()
TArray< FNam...	GetUniqueMarkerNames()	Return a list of unique marker names for blending compatibility
bool	IsValidAdditive()	Return true if this is valid additive animation false otherwise
void	OnSetSkeleton ( USkeleton* NewSkeleton )
void	ReplaceReferredAnimations ( const TMap< UAnimationAsset*, ... )	Replace this assets references to other animations based on ReplacementMap

Overridden from UObject

	Name	Description
void	BeginCacheForCookedPlatformData ( const ITargetPlatform* TargetP... )	Starts caching of platform specific data for the target platform Called when cooking before serialization so that object can prepare platform specific data Not called during normal loading of objects
void	BeginDestroy()	Called before destroying the object.
void	ClearAllCachedCookedPlatformData()	Clear all cached cooked platform data
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
void	GetPreloadDependencies ( TArray< UObject* >& OutDeps )	Called during cooking.
bool	IsCachedCookedPlatformDataLoaded ( const ITargetPlatform* TargetP... )	Have we finished loading all the cooked platform data for the target platforms requested in BeginCacheForCookedPlatformData
bool	IsReadyForFinishDestroy()	Called to check if the object is ready for FinishDestroy.
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
void	PostInitProperties()	Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.
void	PreSave ( FObjectPreSaveContext SaveContext )	Presave function.
void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.
void	WillNeverCacheCookedPlatformDataAgain()	All caching has finished for this object (all IsCachedCookedPlatformDataLoaded functions have finished for all platforms)

Deprecated Variables

	Name	Description
TArray< FName >	AnimationTrackNames	Animation track names has been deprecated see FBoneAnimationTrack::Name
bool	bUseRawDataOnly	bUseRawDataOnly public access will be deprecated
int32	NumberOfKeys	NumberOfKeys is deprecated see UAnimDataModel::GetNumberOfKeys for the number of source data keys, or GetNumberOfSampledKeys for the target keys
int32	NumFrames	NumFrames is deprecated see UAnimDataModel::GetNumberOfFrames for the number of source data frames, or GetNumberOfSampledKeys for the target keys
TArray< struct ...	RawAnimationData	RawAnimationData has been deprecated see FBoneAnimationTrack::InternalTrackData
FGuid	RawDataGuid	RawDataGuid has been deprecated see GenerateGuidFromModel instead
FFrameRate	SamplingFrameRate	SamplingFrameRate is deprecated see UAnimDataModel::GetFrameRate for the source frame rate, or GetSamplingFrameRate for the target frame rate instead
FString	SourceFilePath_DEPRECATED	Path to the resource used to construct this skeletal mesh
FString	SourceFileTimestamp_DEPRECATED	Date/Time-stamp of the file from the last import
TArray< struct ...	SourceRawAnimationData_DEPRECATED	Source RawAnimationData.

Deprecated Functions

	Name	Description
void	AddBoneFloatCustomAttribute ( const FName& BoneName, const FName& AttributeName, const TArray< float >& TimeKeys, const TArray< float >& ValueKeys )	AddBoneCustomAttribute has been deprecated see UAnimDataController::AddAttribute
void	AddBoneIntegerCustomAttribute ( const FName& BoneName, const FName& AttributeName, const TArray< float >& TimeKeys, const TArray< int32 >& ValueKeys )	AddBoneCustomAttribute has been deprecated see UAnimDataController::AddAttribute
void	AddBoneStringCustomAttribute ( const FName& BoneName, const FName& AttributeName, const TArray< float >& TimeKeys, const TArray< FString >& ValueKeys )	AddBoneStringCustomAttribute has been deprecated see UAnimDataController::AddAttribute
void	ApplyCompressedData ( const FString& DataCacheKeySuffix, const bool bPerformFrameStripping, const TArray< uint8 >& Data )	ApplyCompressedData has been deprecated
void	BakeOutAdditiveIntoRawData ( TArray< FRawAnimSequenceTrack >& N..., TArray< FName >& NewAnimationTrack..., TArray< FTrackToSkeletonMap >& New..., TArray< FFloatCurve >& NewCurveTra..., TArray< FRawAnimSequenceTrack >& A... )	BakeOutAdditiveIntoRawData has been deprecated, this behaviour has moved to FCompressibleAnimData
void	BakeOutVirtualBoneTracks ( TArray< FRawAnimSequenceTrack >& N..., TArray< FName >& NewAnimationTrack..., TArray< FTrackToSkeletonMap >& New... )	BakeOutVirtualBoneTracks has been deprecated
void	BakeTrackCurvesToRawAnimationTracks ( TArray< FRawAnimSequenceTrack >& N..., TArray< FName >& NewTrackNames, TArray< FTrackToSkeletonMap >& New... )	BakeTrackCurvesToRawAnimationTracks has been deprecated
void	ClearResampledAnimationTrackData()	ClearResampledAnimationTrackData has been deprecated
FGuid	GenerateGuidFromRawData()	GenerateGuidFromRawData has been deprecated use IAnimationDataModel::GenerateGuid instead
void	GetAdditiveBasePose ( FCompactPose& OutPose, FBlendedCurve& OutCurve, const FAnimExtractContext& Extract... )	Use other GetAdditiveBasePose signature
void	GetAdditiveBasePose ( FAnimationPoseData& OutAnimationPo..., const FAnimExtractContext& Extract... )	Use other GetAdditiveBasePose signature
void	GetBonePose ( FCompactPose& OutPose, FBlendedCurve& OutCurve, const FAnimExtractContext& Extract..., bool bForceUseRawData )	Use other GetBonePose signature
void	GetBonePose_Additive ( FAnimationPoseData& OutAnimationPo..., const FAnimExtractContext& Extract... )	Use other GetBonePose_Additive signature
void	GetBonePose_Additive ( FCompactPose& OutPose, FBlendedCurve& OutCurve, const FAnimExtractContext& Extract... )	Use other GetBonePose_Additive signature
void	GetBoneTransform ( FTransform& OutAtom, int32 TrackIndex, float Time, bool bUseRawData )	Use other GetBoneTransform signature using double and skeleton index
FString	GetDDCCacheKeySuffix ( const bool bPerformStripping, const ITargetPlatform* TargetP... )	GetDDCCacheKeySuffix has been deprecated use CreateDerivedDataKeyHash instead
FMarkerSyncA...	GetMarkerSyncPositionfromMarkerIndicies ( int32 PrevMarker, int32 NextMarker, float CurrentTime )	Use other GetMarkerSyncPositionfromMarkerIndicies signature
FGuid	GetRawDataGuid()	GetRawDataGuid has been deprecated use GenerateGuidFromModel instead
int32	GetSkeletonIndexFromCompressedDataTrackIndex ( const int32 TrackIndex )	GetSkeletonIndexFromCompressedDataTrackIndex has been deprecated
bool	OnlyUseRawData()	OnlyUseRawData has been deprecated
PRAGMA_DISAB...	PreSave ( const ITargetPlatform* TargetP... )	Use version that takes FObjectPreSaveContext instead.
void	RecompressAnimationData()	RecompressAnimationData has been deprecated
void	RemoveAllCustomAttributes()	RemoveAllCustomAttributes has been deprecated see UAnimDataController::RemoveAllAttributes
void	RemoveAllCustomAttributesForBone ( const FName& BoneName )	RemoveAllCustomAttributesForBone has been deprecated see UAnimDataController::RemoveAllAttributesForBone
void	RemoveCustomAttribute ( const FName& BoneName, const FName& AttributeName )	RemoveCustomAttribute has been deprecated see UAnimDataController::RemoveAttribute
void	RequestAnimCompression ( PRAGMA_DISABLE_DEPRECATION_WARNINGS... )	RequestAnimCompression has been deprecated use BeginCacheDerivedData or CacheDerivedData instead
void	RequestAsyncAnimRecompression ( bool bOutput )	RequestSyncAnimRecompression has been deprecated use BeginCacheDerivedData instead
void	RequestSyncAnimRecompression ( bool bOutput )	RequestSyncAnimRecompression has been deprecated use CacheDerivedData instead
void	ResampleAnimationTrackData()	ResampleAnimationTrackData has been deprecated
void	SetUseRawDataOnly ( bool bInUseRawDataOnly )	SetUseRawDataOnly has been deprecated
bool	ShouldPerformStripping ( const bool bPerformFrameStripping, const bool bPerformStrippingOnOddFr... )	Public access to ShouldPerformStripping has been deprecated
void	TestEvalauteAnimation()	TestEvalauteAnimation has been deprecated

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Cancel