1. Epic GamesDeveloper
  3. UAnimSequence

UAnimSequence

API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/Animation

Inheritance Hierarchy

References

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

Syntax

UCLASS (Config=Engine, HideCategories=(UObject, Length), BlueprintType, MinimalAPI)  
class UAnimSequence : public UAnimSequenceBase

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere assetregistrysearchable TEnumAsByte< enum EAdditiveAnimationType > AdditiveAnimType Additive animation type.
Protected variable UProperty Category duplicatetransient, visibleanywhere TArray< FName > AnimationTrackNames This is name of RawAnimationData tracks for editoronly - if we lose skeleton, we'll need relink them
Public variable UProperty Category instanced, visibleanywhere TObjectPtr< class UAssetImportData > AssetImportData Importing data and options used for this mesh
Protected variable UProperty TMap< FAnimationAttributeIdentifier, FAttributeCurve > AttributeCurves  
Public variable UProperty TArray< FAnimSyncMarker > AuthoredSyncMarkers Authored Sync markers
Public variable UProperty Category, EditAnywhere 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.
Protected variable bool bBlockCompressionRequests  
Public variable UProperty Category, EditAnywhere uint32: 1 bDoNotOverrideCompression Do not attempt to override compression scheme when running CompressAnimations commandlet.
Public variable UProperty Category, EditAnywhere assetregistrysearchable bool bEnableRootMotion If this is on, it will allow extracting of root motion
Public variable UProperty Category, EditAnywhere bool bForceRootLock Force Root Bone Lock even if Root Motion is not enabled
Public variable UProperty Category, EditAnywhere, Meta TObjectPtr< class UAnimBoneCompressionSettings > BoneCompressionSettings The bone compression settings used to compress bones in this sequence.
Public variable UProperty bool bRootMotionSettingsCopiedFromMontage Have we copied root motion settings from an owning montage
Public variable UProperty Category, EditAnywhere assetregistrysearchable 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)
Public variable TAtomic< bool > bUseRawDataOnly Should we be always using our raw data (i.e is our compressed data stale)
Protected variable TMap< FIoHash, TPimplPtr< UE::Anim::FAnimationSequenceAsyncCacheTask > > CacheTasksByKeyHash  
Public variable UProperty int32 CompressCommandletVersion Saved version number with CompressAnimations commandlet. To help with doing it in multiple passes.
Public variable FCompressedAnimSequence CompressedData  
Public variable UProperty Category, EditAnywhere float CompressionErrorThresholdScale Set a scale for error threshold on compression.
Public variable UProperty Category, EditAnywhere, Meta TObjectPtr< class UAnimCurveCompressionSettings > CurveCompressionSettings The curve compression settings used to compress curves in this sequence.
Protected variable TMap< FIoHash, TUniquePtr< FCompressedAnimSequence > > DataByPlatformKeyHash  
Protected variable FIoHash DataKeyHash  
Public variable UProperty Meta assetregistrysearchable float ImportFileFramerate The DCC framerate of the imported file. UI information only, unit are Hz
Public variable UProperty Meta assetregistrysearchable int32 ImportResampleFramerate The resample framerate that was computed during import. UI information only, unit are Hz
Public variable UProperty Category, EditAnywhere assetregistrysearchable EAnimInterpolationType Interpolation This defines how values between keys are calculated
Public variable int32 MarkerDataUpdateCounter Track whether we have updated markers so cached data can be updated.
Protected variable UProperty int32 NumberOfKeys The number of keys expected within the individual (non-uniform) animation tracks.
Protected variable UProperty Category Transient duplicatetransient, visibleanywhere int32 NumberOfSampledFrames  
Protected variable UProperty Category Transient assetregistrysearchable, duplicatetransient, visibleanywhere int32 NumberOfSampledKeys  
Protected variable UProperty int32 NumFrames Contains the number of keys expected within the individual animation tracks.
Protected variable UProperty Category assetregistrysearchable, visibleanywhere FPerPlatformFrameRate PlatformTargetFrameRate  
Protected variable TArray< struct FRawAnimSequenceTrack > RawAnimationData  
Protected variable UProperty FGuid RawDataGuid Update this if the contents of RawAnimationData changes
Public variable UProperty Category, EditAnywhere int32 RefFrameIndex Additve reference frame if RefPoseType == AnimFrame
Public variable UProperty Category, EditAnywhere, Meta TObjectPtr< class UAnimSequence > RefPoseSeq Additive reference animation if it's relevant - i.e. AnimScaled or AnimFrame
Public variable UProperty Category, EditAnywhere, Meta TEnumAsByte< enum EAdditiveBasePoseType > RefPoseType Additive refrerence pose type. Refer above enum type
Public variable UProperty Category, EditAnywhere assetregistrysearchable FName RetargetSource Base pose to use when retargeting
Public variable UProperty Category, EditAnywhere, Meta assetregistrysearchable TSoftObjectPtr< USkeletalMesh > RetargetSourceAsset If RetargetSource is set to Default (None), this is asset for the base pose to use when retargeting.
Public variable UProperty TArray< FTransform > RetargetSourceAssetReferencePose When using RetargetSourceAsset, use the post stored here
Public variable UProperty Category, EditAnywhere TEnumAsByte< ERootMotionRootLock::Type > RootMotionRootLock Root Bone will be locked to that position when extracting root motion.
Protected variable UProperty FFrameRate SamplingFrameRate The frame rate at which the source animation is sampled.
Public variable UProperty Category, EditAnywhere EStripAnimDataOnDedicatedServerSettings StripAnimDataOnDedicatedServer Enum used to decide whether we should strip animation data on dedicated server
Protected variable UProperty FFrameRate TargetFrameRate  
Public variable TArray< FName > UniqueMarkerNames List of Unique marker names in this animation sequence
Public variable UProperty Category, EditAnywhere, Meta TObjectPtr< class UVariableFrameStrippingSettings > VariableFrameStrippingSettings  

Constructors

  Type Name Description
Public function  

UAnimSequence ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function UFunction BlueprintCallable, Category, Meta void

AddBoneFloatCustomAttribute ( const FName& BoneName,
const FName& AttributeName,
const TArray< float >& TimeKeys,
const TArray< float >& ValueKeys
)

  
Public function UFunction BlueprintCallable, Category, Meta void

AddBoneIntegerCustomAttribute ( const FName& BoneName,
const FName& AttributeName,
const TArray< float >& TimeKeys,
const TArray< int32 >& ValueKeys
)

  
Public function UFunction BlueprintCallable, Category, Meta void

AddBoneStringCustomAttribute ( const FName& BoneName,
const FName& AttributeName,
const TArray< float >& TimeKeys,
const TArray< FString >& ValueKeys
)

  
Public function void

AddKeyToSequence ( float Time,
const FName& BoneName,
const FTransform& AdditiveTransform
)

 Add Key to Transform Curves
Public function Static void  
Public function void

ApplyCompressedData ( const FString& DataCacheKeySuffix,
const bool bPerformFrameStripping,
const TArray< uint8 >& Data
)

  
Public function Const void

BakeOutAdditiveIntoRawData ( TArray< FRawAnimSequenceTrack >& NewRawTracks,
TArray< FName >& NewAnimationTrackNames,
TArray< FTrackToSkeletonMap >& NewTrackToSkeletonMapTable,
TArray< FFloatCurve >& NewCurveTracks,
TArray< FRawAnimSequenceTrack >& AdditiveBaseAnimationData
)

 Bakes out the additive version of this animation into the raw data.
Public function void

BakeOutVirtualBoneTracks ( TArray< FRawAnimSequenceTrack >& NewRawTracks,
TArray< FName >& NewAnimationTrackNames,
TArray< FTrackToSkeletonMap >& NewTrackToSkeletonMapTable
)

 Bakes out track data for the skeletons virtual bones into the raw data
Public function void

BakeTrackCurvesToRawAnimationTracks ( TArray< FRawAnimSequenceTrack >& NewRawTracks,
TArray< FName >& NewTrackNames,
TArray< FTrackToSkeletonMap >& NewTrackToSkeletonMapTable
)

  
Protected function FIoHash

BeginCacheDerivedData ( const ITargetPlatform* TargetPlatform
)

  
Public function void  
Public function FCompressedAnimSequence &

CacheDerivedData ( const ITargetPlatform* TargetPlatform
)

 Synchronous caching of compressed animation data for provided target platform.
Public function void  
Protected function void  
Public function Const bool Is this animation valid for baking into additive.
Protected function Virtual Const bool Returns whether or not evaluation of the raw (source) animation data is possible according to whether or not the (editor only) data has been stripped
Protected function void  
Protected function void  
Protected function void  
Public function UFunction BlueprintCallable, Category void Resets the retarget source asset.
Public function bool Create Animation Sequence from the given animation
Public function bool Create Animation Sequence from the Mesh Component's current bone transform
Public function bool Create Animation Sequence from Reference Pose of the Mesh
Protected function FIoHash

CreateDerivedDataKeyHash ( const ITargetPlatform* TargetPlatform
)

  
Protected function void  
Protected function void  
Public function void  
Public function Const bool Return true if compressed data is out of date / missing and so animation needs to use raw data
Public function Const bool Test whether at any point we will scale a bone to 0 (needed for validating additive anims)
Protected function void

EndCacheDerivedData ( const FIoHash& KeyHash
)

  
Protected function void  
Public function Const void

EvaluateAttributes ( FAnimationPoseData& OutAnimationPoseData,
const FAnimExtractContext& ExtractionContext,
bool bUseRawData
)

  
Public function uint8 *

FindSyncMarkerPropertyData ( int32 SyncMarkerIndex,
FArrayProperty*& ArrayProperty
)

 Get a pointer to the data for a given Anim Notify.
Protected function void  
Public function Const void Helper function to allow us to notify animations that depend on us that they need to update.
Public function Const FGuid Generate a GUID from a hash of our own raw data
Public function Const void

GetAdditiveBasePose ( FCompactPose& OutPose,
FBlendedCurve& OutCurve,
const FAnimExtractContext& ExtractionContext
)

 Get Bone Transform of the base (reference) pose of the additive animation for the Time given, relative to Parent for all RequiredBones
Public function Const void

GetAdditiveBasePose ( FAnimationPoseData& OutAnimationPoseData,
const FAnimExtractContext& ExtractionContext
)

  
Public function Const int32  
Public function Const int32  
Public function Const int64  
Public function Const void

GetBonePose ( FCompactPose& OutPose,
FBlendedCurve& OutCurve,
const FAnimExtractContext& ExtractionContext,
bool bForceUseRawData
)

 Get Bone Transform of the animation for the Time given, relative to Parent for all RequiredBones
Public function Const void

GetBonePose ( FAnimationPoseData& OutAnimationPoseData,
const FAnimExtractContext& ExtractionContext,
bool bForceUseRawData
)

 Get Bone Transform of the Time given, relative to Parent for all RequiredBones This returns different transform based on additive or not.
Public function Const void

GetBonePose_Additive ( FCompactPose& OutPose,
FBlendedCurve& OutCurve,
const FAnimExtractContext& ExtractionContext
)

 Get Bone Transform of the additive animation for the Time given, relative to Parent for all RequiredBones
Public function Const void

GetBonePose_Additive ( FAnimationPoseData& OutAnimationPoseData,
const FAnimExtractContext& ExtractionContext
)

  
Public function Const void

GetBoneTransform ( FTransform& OutAtom,
FSkeletonPoseBoneIndex BoneIndex,
FAnimSequenceDecompressionContext& DecompContext,
bool bUseRawData
)

 Get Bone Transform of the Time given, relative to Parent for the Track Given
Public function Const void

GetBoneTransform ( FTransform& OutAtom,
int32 TrackIndex,
float Time,
bool bUseRawData
)

  
Public function Const void

GetBoneTransform ( FTransform& OutAtom,
FSkeletonPoseBoneIndex BoneIndex,
double Time,
bool bUseRawData,
TOptional< EAnimInterpolationType > InterpolationOverride
)

 Get Bone Transform of the Time given, relative to Parent for the Track Given
Public function Const const TArray< FAnimCompressedCurveIndexedName > &  
Public function Const const TArray< struct FSmartName > &  
Public function Const const TArray< FTrackToSkeletonMap > &  
Public function Const float

GetCurrentTimeFromMarkers ( FMarkerPair& PrevMarker,
FMarkerPair& NextMarker,
float PositionBetweenMarkers
)

 Advancing based on markers.
Public function Const FString

GetDDCCacheKeySuffix ( const bool bPerformStripping,
const ITargetPlatform* TargetPlatform
)

  
Public function Const FGuid Return this animations guid for the raw data
Public function Const UFunction BlueprintPure, Category const TSoftObjectPtr< USkeletalMesh > & Returns the retarget source asset soft object pointer.
Public function Const const TArray< FTransform > &  
Public function Const FName  
Public function Const int32 Get Skeleton Bone Index from Track Index for compressed data
Public function Const FFrameRate  
Public function Const int64  
Protected function Const bool  
Protected function Const bool  
Public function Const bool  
Public function Const bool  
Protected function void  
Public function Const bool Should we be always using our raw data (i.e is our compressed data stale)
Protected function Const bool

PollCacheDerivedData ( const FIoHash& KeyHash
)

  
Protected function void  
Public function void Refresh sync marker data
Public function UFunction BlueprintCallable, Category, Meta void  
Public function UFunction BlueprintCallable, Category, Meta void  
Public function UFunction BlueprintCallable, Category, Meta void

RemoveCustomAttribute ( const FName& BoneName,
const FName& AttributeName
)

  
Public function bool

RemoveSyncMarkers ( const TArray< FName >& MarkersToRemove
)

 Remove all markers with the specified names
Public function bool

RenameSyncMarkers ( FName InOldName,
FName InNewName
)

 Rename the markers with the specified name
Public function void  
Public function void  
Public function PRAGMA_ENABLE_DEPRECATION_WARNINGS void

RequestSyncAnimRecompression ( bool bOutput
)

  
Protected function Const void  
Protected function void

Reschedule ( FQueuedThreadPool* InThreadPool,
EQueuedWorkPriority InPriority
)

  
Public function void Resets Bone Animation, Curve data and Notify tracks
Public function Const void

RetargetBoneTransform ( FTransform& BoneTransform,
const int32 SkeletonBoneIndex,
const FCompactPoseBoneIndex& BoneIndex,
const FBoneContainer& RequiredBones,
const bool bIsBakedAdditive
)

 Retarget a single bone transform, to apply right after extraction.
Protected function void

SerializeCompressedData ( FArchive& Ar,
bool bDDCData
)

 Write the compressed data to the supplied FArchive.
Public function UFunction BlueprintCallable, Category void

SetRetargetSourceAsset ( USkeletalMesh* InRetargetSourceAsset
)

 Assigns the passed skeletal mesh to the retarget source.
Public function void

SetUseRawDataOnly ( bool bInUseRawDataOnly
)

  
Public function Const bool

ShouldPerformStripping ( const bool bPerformFrameStripping,
const bool bPerformStrippingOnOddFramedAnims
)

 Get compressed data for this UAnimSequence. May be built directly or pulled from DDC.
Public function void Sort the sync markers array by time, earliest first.
Protected function void  
Public function Const void Performs multiple evaluations of the animation as a test of compressed data validatity
Protected function bool  
Protected function void

UpdateCompressedCurveName ( const FName& OldCurveName,
const FName& NewCurveName
)

  
Protected function void

UpdateCompressedCurveName ( SmartName::UID_Type CurveUID,
const FSmartName& NewCurveName
)

  
Public function Const void Helper function to allow us to update streaming animations that depend on us with our data when we are updated.
Public function UFunction BlueprintCallable, Category void Update the retarget data pose from the source, if it exist, else clears the retarget data pose saved in RetargetSourceAssetReferencePose.
Public function Const bool

UseRawDataForPoseExtraction ( const FBoneContainer& RequiredBones
)

  
Public function Const void

ValidateCurrentPosition ( const FMarkerSyncAnimPosition& Position,
bool bPlayingForwards,
bool bLooping,
float& CurrentTime,
FMarkerPair& PreviousMarker,
FMarkerPair& NextMarker,
const UMirrorDataTable* MirrorTable
)

 Take a set of marker positions and validates them against a requested start position, updating them as desired
Protected function bool

WaitForAsyncTasks ( float TimeLimitSeconds
)

  
Public function void

WaitOnExistingCompression ( const bool bWantResults
)

  

Overridden from UAnimSequenceBase

  Type Name Description
Public function Virtual Const void

AdvanceMarkerPhaseAsFollower ( const FMarkerTickContext& Context,
float DeltaRemaining,
bool bLooping,
float& CurrentTime,
FMarkerPair& PreviousMarker,
FMarkerPair& NextMarker,
const UMirrorDataTable* MirrorTable
)

  
Public function Virtual Const void

AdvanceMarkerPhaseAsLeader ( bool bLooping,
float MoveDelta,
const TArray< FName >& ValidMarkerNames,
float& CurrentTime,
FMarkerPair& PrevMarker,
FMarkerPair& NextMarker,
TArray< FPassedMarker >& MarkersPassed,
const UMirrorDataTable* MirrorTable
)

  
Public function Virtual void

EnableRootMotionSettingFromMontage ( bool bInEnableRootMotion,
const ERootMotionRootLock::Type InRootMotionRootLock
)

 To support anim sequence base to all montages
Public function Virtual Const float

EvaluateCurveData ( FName CurveName,
float CurrentTime,
bool bForceUseRawData
)

  
Public function Virtual Const float

EvaluateCurveData ( SmartName::UID_Type CurveUID,
float CurrentTime,
bool bForceUseRawData
)

  
Public function Virtual Const void

EvaluateCurveData ( FBlendedCurve& OutCurve,
float CurrentTime,
bool bForceUseRawData
)

 Evaluate curve data to Instance at the time of CurrentTime
Public function Virtual Const FTransform

ExtractRootMotion ( float StartTime,
float DeltaTime,
bool bAllowLooping
)

 Extract Root Motion transform from the animation.
Public function Virtual Const FTransform

ExtractRootMotionFromRange ( float StartTrackPosition,
float EndTrackPosition
)

 Extract Root Motion transform from a contiguous position range (no looping)
Public function Virtual Const FTransform

ExtractRootTrackTransform ( float Time,
const FBoneContainer* RequiredBones
)

 Extract the transform from the root track for the given animation position.
Public function Virtual Const EAdditiveAnimationType Default implementation, no additive
Public function Virtual Const UAnimSequence * Ideally this would be animsequcnebase, but we might have some issue with that. For now, just allow AnimSequence
Public function Virtual Const void

GetAnimationPose ( FAnimationPoseData& OutAnimationPoseData,
const FAnimExtractContext& ExtractionContext
)

 Begin Transform related functions.
Public function Virtual Const bool  
Public function Virtual Const float

GetFirstMatchingPosFromMarkerSyncPos ( const FMarkerSyncAnimPosition& InMarkerSyncGroupPosition
)

  
Public function Virtual Const void

GetMarkerIndicesForPosition ( const FMarkerSyncAnimPosition& SyncPosition,
bool bLooping,
FMarkerPair& OutPrevMarker,
FMarkerPair& OutNextMarker,
float& CurrentTime,
const UMirrorDataTable* MirrorTable
)

  
Public function Virtual Const void

GetMarkerIndicesForTime ( float CurrentTime,
bool bLooping,
const TArray< FName >& ValidMarkerNames,
FMarkerPair& OutPrevMarker,
FMarkerPair& OutNextMarker
)

  
Public function Virtual Const FMarkerSyncAnimPosition

GetMarkerSyncPositionfromMarkerIndicies ( int32 PrevMarker,
int32 NextMarker,
float CurrentTime
)

  
Public function Virtual Const FMarkerSyncAnimPosition

GetMarkerSyncPositionFromMarkerIndicies ( int32 PrevMarker,
int32 NextMarker,
float CurrentTime,
const UMirrorDataTable* MirrorTable
)

  
Public function Virtual Const float

GetNextMatchingPosFromMarkerSyncPos ( const FMarkerSyncAnimPosition& InMarkerSyncGroupPosition,
const float& StartingPosition
)

  
Public function Virtual Const int32 Return the total number of keys sampled for this animation, including the T0 key
Public function Virtual Const float

GetPrevMatchingPosFromMarkerSyncPos ( const FMarkerSyncAnimPosition& InMarkerSyncGroupPosition,
const float& StartingPosition
)

  
Public function Virtual Const FFrameRate Return rate at which the animation is sampled
Public function Virtual Const void

HandleAssetPlayerTickedInternal ( FAnimAssetTickContext& Context,
const float PreviousTime,
const float MoveDelta,
const FAnimTickRecord& Instance,
FAnimNotifyQueue& NotifyQueue
)

  
Public function Virtual Const bool

HasCurveData ( SmartName::UID_Type CurveUID,
bool bForceUseRawData
)

  
Public function Virtual Const bool

HasCurveData ( FName CurveName,
bool bForceUseRawData
)

  
Public function Virtual Const bool  
Public function Virtual Const bool Add validation check to see if it's being ready to play or not
Protected function Virtual void  
Protected function Virtual void Callback registered to UAnimDatModel::GetModifiedEvent for the embedded object
Protected function Virtual void Populates the UAnimDataModel object according to any pre-existing data.
Public function Virtual void Update cache data (notify tracks, sync markers)

Overridden from UAnimationAsset

  Type Name Description
Public function Virtual bool

GetAllAnimationSequencesReferred ( TArray< UAnimationAsset* >& AnimationSequences,
bool bRecursive
)

 Retrieve all animations that are used by this asset
Public function Virtual Const int32  
Public function Virtual TArray< FName > * Return a list of unique marker names for blending compatibility
Public function Virtual Const bool Return true if this is valid additive animation false otherwise
Public function Virtual void

OnSetSkeleton ( USkeleton* NewSkeleton
)

  
Public function Virtual void Replace this assets references to other animations based on ReplacementMap

Overridden from UObject

  Type Name Description
Public function Virtual void 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
Public function Virtual void Called before destroying the object.
Public function Virtual void Clear all cached cooked platform data
Public function Virtual Const void 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
Public function Virtual Const void

GetAssetRegistryTags ( TArray< FAssetRegistryTag >& OutTags
)

  
Public function Virtual void Called during cooking.
Public function Virtual bool Have we finished loading all the cooked platform data for the target platforms requested in BeginCacheForCookedPlatformData
Public function Virtual Const EDataValidationResult Generic function to validate objects during changelist validations, etc.
Public function Virtual bool Called to check if the object is ready for FinishDestroy.
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual PRAGMA_ENABLE_DEPRECATION_WARNINGS void

PreSave ( FObjectPreSaveContext ObjectSaveContext
)

 Presave function.
Public function Virtual PRAGMA_DISABLE_DEPRECATION_WARNINGS void

PreSave ( const ITargetPlatform* TargetPlatform
)

  
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.
Public function Virtual void All caching has finished for this object (all IsCachedCookedPlatformDataLoaded functions have finished for all platforms)

Deprecated Variables

  Type Name Description
Public variable UProperty FString SourceFilePath_DEPRECATED Path to the resource used to construct this skeletal mesh
Public variable UProperty FString SourceFileTimestamp_DEPRECATED Date/Time-stamp of the file from the last import
Protected variable TArray< struct FRawAnimSequenceTrack > SourceRawAnimationData_DEPRECATED Source RawAnimationData.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page