1. Epic GamesDeveloper
  3. UAnimSequenceBase

UAnimSequenceBase

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

Inheritance Hierarchy

References

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

Syntax

UCLASS (Abstract, BlueprintType, MinimalAPI)  
class UAnimSequenceBase : public UAnimationAsset

Variables

  Type Name Description
Public variable UProperty TArray< FAnimNotifyTrack > AnimNotifyTracks If you change Notifies array, this will need to be rebuilt
Public variable UProperty Category, EditAnywhere bool bLoop The default looping behavior of this animation. Asset players can override this
Protected variable bool bPopulatingDataModel Flag set whenever the data-model is initially populated (during upgrade path)
Protected variable UProperty Category BlueprintReadOnly Transient duplicatetransient, visibleanywhere TScriptInterface< IAnimationDataController > Controller UAnimDataController instance set to operate on DataModel
Protected variable UProperty Category BlueprintReadOnly visibleanywhere TObjectPtr< UAnimDataModel > DataModel  
Protected variable UProperty Category BlueprintReadOnly visibleanywhere TScriptInterface< IAnimationDataModel > DataModelInterface IAnimationDataModel instance containing (source) animation data
Public variable UProperty TArray< struct FAnimNotifyEvent > Notifies Animation notifies, sorted by time (earliest notification first).
Protected variable UE::Anim::FAnimDataModelNotifyCollector NotifyCollector Helper object that keeps track of any controller brackets, and all unique notify types that are broadcasted during it
Public variable UProperty Category, EditAnywhere float RateScale Number for tweaking playback rate of this animation globally.
Protected variable UProperty FRawCurveTracks RawCurveData Raw uncompressed float curve data
Protected variable UProperty Category BlueprintReadOnly assetregistrysearchable, visibleanywhere float SequenceLength Length (in seconds) of this AnimSequence if played back with a speed of 1.0.

Constructors

  Type Name Description
Public function  

UAnimSequenceBase ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  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

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

  
Public function Virtual Const void

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

  
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
)

  
Protected function void Binds to DataModel its modification delegate
Public function Virtual Const EAnimEventTriggerOffsets::Type

CalculateOffsetForNotify ( float NotifyDisplayTime
)

 Calculates what (if any) offset should be applied to the trigger time of a notify given its display time
Public function Virtual Const bool  
Public function void Fix up any notifies that are positioned beyond the end of the sequence
Protected function void

CopyDataModel ( const TScriptInterface< IAnimationDataModel >& ModelToDuplicate
)

 Replaces the current DataModel, if any, with the provided one
Public function Static void

DeclareConstructClasses ( TArray< FTopLevelAssetPath >& OutConstructClasses,
const UClass* SpecificSubclass
)

  
Public function Virtual void

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

 To support anim sequence base to montage
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 float

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

  
Public function Virtual Const float

EvaluateCurveData ( FName CurveName,
float CurrentTime,
bool bForceUseRawData
)

  
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 uint8 *

FindArrayProperty ( const TCHAR* PropName,
FArrayProperty*& ArrayProperty,
int32 ArrayIndex
)

 Get a pointer to the data for a given array property item.
Public function uint8 *

FindNotifyPropertyData ( int32 NotifyIndex,
FArrayProperty*& ArrayProperty
)

 Get a pointer to the data for a given Anim Notify.
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 ( FCompactPose& OutPose,
FBlendedCurve& OutCurve,
const FAnimExtractContext& ExtractionContext
)

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

GetAnimationPose ( FAnimationPoseData& OutPoseData,
const FAnimExtractContext& ExtractionContext
)

  
Public function Const void

GetAnimNotifies ( const float& StartTime,
const float& DeltaTime,
FAnimNotifyContext& NotifyContext
)

 Retrieves AnimNotifies given a StartTime and a DeltaTime.
Public function Const void

GetAnimNotifies ( const float& StartTime,
const float& DeltaTime,
const bool bAllowLooping,
TArray< const FAnimNotifyEvent* >& OutActiveNotifies
)

 Retrieves AnimNotifies given a StartTime and a DeltaTime.
Public function Const void

GetAnimNotifies ( const float& StartTime,
const float& DeltaTime,
const bool bAllowLooping,
TArray< FAnimNotifyEventReference >& OutActiveNotifies
)

  
Public function Virtual Const void

GetAnimNotifiesFromDeltaPositions ( const float& PreviousPosition,
const float& CurrentPosition,
FAnimNotifyContext& NotifyContext
)

 Retrieves AnimNotifies between two time positions.
Public function Const void

GetAnimNotifiesFromDeltaPositions ( const float& PreviousPosition,
const float& CurrentPosition,
TArray< const FAnimNotifyEvent* >& OutActiveNotifies
)

 Retrieves AnimNotifies between two time positions.
Public function Virtual Const void

GetAnimNotifiesFromDeltaPositions ( const float& PreviousPosition,
const float& CurrentPosition,
TArray< FAnimNotifyEventReference >& OutActiveNotifies
)

  
Public function IAnimationDataController & Returns the transient UAnimDataController set to operate on DataModel
Public function Virtual Const const FRawCurveTracks &  
Public function Const IAnimationDataModel * Returns the IAnimationDataModel object embedded in this UAnimSequenceBase
Public function Const TScriptInterface< IAnimationDataModel > Returns the IAnimationDataModel as a script-interface, provides access to UObject and Interface
Public function Virtual Const bool  
Public function Virtual Const float

GetFirstMatchingPosFromMarkerSyncPos ( const FMarkerSyncAnimPosition& InMarkerSyncGroupPosition
)

  
Public function Virtual Const int32

GetFrameAtTime ( const float Time
)

 Get the frame number for the provided time
Public function Virtual Const void

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

  
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 Number of Keys
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 float

GetTimeAtFrame ( const int32 Frame
)

 Get the time at the given frame
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 ( FName CurveName,
bool bForceUseRawData
)

  
Public function Virtual Const bool

HasCurveData ( SmartName::UID_Type CurveUID,
bool bForceUseRawData
)

  
Public function Virtual Const bool  
Public function void  
Public function Const bool  
Public function Virtual Const bool Return true if anim notify is available
Public function Virtual Const bool  
Public function Virtual void  
Public function 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.
Protected function Virtual void  
Public function Virtual void Update cache data (notify tracks, sync markers)
Public function void Registers a delegate to be called after notification has changed
Public function void Remove all notifies
Public function bool

RemoveNotifies ( const TArray< FName >& NotifiesToRemove
)

 Remove the notifies specified
Public function void

RenameNotifies ( FName InOldName,
FName InNewName
)

 Renames all named notifies with InOldName to InNewName
Public function Const bool  
Public function void Sort the Notifies array by time, earliest first.
Public function Const void

TickByMarkerAsFollower ( FMarkerTickRecord& Instance,
FMarkerTickContext& MarkerContext,
float& CurrentTime,
float& OutPreviousTime,
const float MoveDelta,
const bool bLooping,
const UMirrorDataTable* MirrorTable
)

  
Public function Const void

TickByMarkerAsLeader ( FMarkerTickRecord& Instance,
FMarkerTickContext& MarkerContext,
float& CurrentTime,
float& OutPreviousTime,
const float MoveDelta,
const bool bLooping,
const UMirrorDataTable* MirrorTable
)

  
Public function void

UnregisterOnNotifyChanged ( void* Unregister
)

  
Protected function Const void Validates that DataModel contains a valid UAnimDataModel object

Overridden from UAnimationAsset

  Type Name Description
Public function Virtual Const float Returns the total play length of the montage, if played back with a speed of 1.0.
Protected function Virtual void  
Public function Virtual Const void Advances the asset player instance

Overridden from UObject

  Type Name Description
Public function Virtual Const void

GetAssetRegistryTags ( TArray< FAssetRegistryTag >& OutTags
)

  
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 void

GetResourceSizeEx ( FResourceSizeEx& CumulativeResourceSize
)

 Get the size of the object/resource for use in memory tools or to display to artists/LDs in the Editor This is the extended version which separates up the used memory into different memory regions (the actual definition of which may be platform specific).
Public function Virtual Const bool Called during async load to determine if PostLoad can be called on the loading thread.
Public function Virtual void  
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Typedefs

Name Description
FOnNotifyChanged  
FOnNotifyChangedMulticaster  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page