1. Epic GamesDeveloper
  3. UAnimSequenceBase

UAnimSequenceBase

API > API/Runtime > API/Runtime/Engine

   
Name UAnimSequenceBase
Type class
Header File /Engine/Source/Runtime/Engine/Classes/Animation/AnimSequenceBase.h
Include Path #include "Animation/AnimSequenceBase.h"

Syntax

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

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UAnimSequenceBase ( const FObjectInitializer& ObjectInitializer
)

   Animation/AnimSequenceBase.h  

Typedefs

Name Type Remarks Include Path
FOnNotifyChanged FOnNotifyChangedMulticaster::FDelegate   Animation/AnimSequenceBase.h
FOnNotifyChangedMulticaster TMulticastDelegate_NoParams< void >   Animation/AnimSequenceBase.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AnimNotifyTracks TArray< FAnimNotifyTrack > If you change Notifies array, this will need to be rebuilt Animation/AnimSequenceBase.h  
bLoop bool The default looping behavior of this animation. Asset players can override this Animation/AnimSequenceBase.h
  • EditAnywhere
  • Category=Animation
Notifies TArray< struct FAnimNotifyEvent > Animation notifies, sorted by time (earliest notification first). Animation/AnimSequenceBase.h  
RateScale float Number for tweaking playback rate of this animation globally. Animation/AnimSequenceBase.h
  • EditAnywhere
  • Category=Animation

Protected

Name Type Remarks Include Path Unreal Specifiers
OnNotifyChanged FOnNotifyChangedMulticaster   Animation/AnimSequenceBase.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

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

   Animation/AnimSequenceBase.h  

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

   Animation/AnimSequenceBase.h  

virtual EAnimEventTriggerOffsets::Type CalculateOffsetForNotify ( float NotifyDisplayTime
) const

 Calculates what (if any) offset should be applied to the trigger time of a notify given its display time Animation/AnimSequenceBase.h  

virtual bool CanBeUsedInComposition()

   Animation/AnimSequenceBase.h  

void ClampNotifiesAtEndOfSequence()

 Fix up any notifies that are positioned beyond the end of the sequence Animation/AnimSequenceBase.h  

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

 To support anim sequence base to montage Animation/AnimSequenceBase.h  

virtual float EvaluateCurveData ( FName CurveName,
float CurrentTime,
bool bForceUseRawData
) const

   Animation/AnimSequenceBase.h  

virtual float EvaluateCurveData ( FName CurveName,
const FAnimExtractContext& AnimExtractContext,
bool bForceUseRawData
) const

   Animation/AnimSequenceBase.h  

virtual void EvaluateCurveData ( FBlendedCurve& OutCurve,
const FAnimExtractContext& AnimExtractContext,
bool bForceUseRawData
) const

   Animation/AnimSequenceBase.h  

virtual void EvaluateCurveData ( FBlendedCurve& OutCurve,
float CurrentTime,
bool bForceUseRawData
) const

 Evaluate curve data to Instance at the time of CurrentTime Animation/AnimSequenceBase.h  

virtual FTransform ExtractRootMotion ( float StartTime,
float DeltaTime,
bool bAllowLooping
) const

   Animation/AnimSequenceBase.h  

virtual FTransform ExtractRootMotion ( const FAnimExtractContext& ExtractionContext
) const

 Extract Root Motion transform from the animation. Animation/AnimSequenceBase.h  

virtual FTransform ExtractRootMotionFromRange ( double StartTime,
double EndTime,
const FAnimExtractContext& ExtractionContext
) const

 Extract Root Motion transform from a contiguous position range (no looping) Animation/AnimSequenceBase.h  

virtual FTransform ExtractRootMotionFromRange ( float StartTrackPosition,
float EndTrackPosition
) const

   Animation/AnimSequenceBase.h  

virtual FTransform ExtractRootTrackTransform ( const FAnimExtractContext& ExtractionContext,
const FBoneContainer* RequiredBones
) const

 Extract the transform from the root track for the given animation position. Animation/AnimSequenceBase.h  

virtual FTransform ExtractRootTrackTransform ( float Time,
const FBoneContainer* RequiredBones
) const

   Animation/AnimSequenceBase.h  

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

 Get a pointer to the data for a given array property item. Animation/AnimSequenceBase.h  

uint8 * FindNotifyPropertyData ( int32 NotifyIndex,
FArrayProperty*& ArrayProperty
)

 Get a pointer to the data for a given Anim Notify. Animation/AnimSequenceBase.h  

virtual EAdditiveAnimationType GetAdditiveAnimType()

 Default implementation, no additive Animation/AnimSequenceBase.h  

virtual UAnimSequence * GetAdditiveBasePose()

 Ideally this would be animsequcnebase, but we might have some issue with that. For now, just allow AnimSequence Animation/AnimSequenceBase.h  

virtual void GetAnimationPose ( FAnimationPoseData& OutPoseData,
const FAnimExtractContext& ExtractionContext
) const

 Get Bone Transform of the Time given, relative to Parent for all RequiredBones This returns different transform based on additive or not. Animation/AnimSequenceBase.h  

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

 Retrieves AnimNotifies given a StartTime and a DeltaTime. Animation/AnimSequenceBase.h  

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

 Retrieves AnimNotifies between two time positions. Animation/AnimSequenceBase.h  

IAnimationDataController & GetController()

 Returns the transient UAnimDataController set to operate on DataModel Animation/AnimSequenceBase.h  

virtual const FRawCurveTracks & GetCurveData()

   Animation/AnimSequenceBase.h  

IAnimationDataModel * GetDataModel()

 Returns the IAnimationDataModel object embedded in this UAnimSequenceBase Animation/AnimSequenceBase.h  

TScriptInterface< IAnimationDataModel > GetDataModelInterface()

 Returns the IAnimationDataModel as a script-interface, provides access to UObject and Interface Animation/AnimSequenceBase.h  

virtual bool GetEnableRootMotionSettingFromMontage()

   Animation/AnimSequenceBase.h  

virtual float GetFirstMatchingPosFromMarkerSyncPos ( const FMarkerSyncAnimPosition& InMarkerSyncGroupPosition
) const

   Animation/AnimSequenceBase.h  

virtual int32 GetFrameAtTime ( const float Time
) const

 Get the frame number for the provided time Animation/AnimSequenceBase.h  

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

   Animation/AnimSequenceBase.h  

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

   Animation/AnimSequenceBase.h  

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

   Animation/AnimSequenceBase.h  

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

   Animation/AnimSequenceBase.h  

virtual int32 GetNumberOfSampledKeys()

 Return the total number of keys sampled for this animation, including the T0 key Animation/AnimSequenceBase.h  

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

   Animation/AnimSequenceBase.h  

virtual FFrameRate GetSamplingFrameRate()

 Return rate at which the animation is sampled Animation/AnimSequenceBase.h  

virtual float GetTimeAtFrame ( const int32 Frame
) const

 Get the time at the given frame Animation/AnimSequenceBase.h  

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

   Animation/AnimSequenceBase.h  

virtual bool HasCurveData ( FName CurveName,
bool bForceUseRawData
) const

   Animation/AnimSequenceBase.h  

virtual bool HasRootMotion()

   Animation/AnimSequenceBase.h  

void InitializeNotifyTrack()

   Animation/AnimSequenceBase.h  

bool IsDataModelValid()

   Animation/AnimSequenceBase.h  

virtual bool IsNotifyAvailable()

 Return true if anim notify is available Animation/AnimSequenceBase.h  

virtual bool IsValidToPlay()

   Animation/AnimSequenceBase.h  

virtual void OnAnimModelLoaded()

   Animation/AnimSequenceBase.h  

void OnEndLoadPackage ( const FEndLoadPackageContext& Context
)

   Animation/AnimSequenceBase.h  

virtual void RefreshCacheData()

 Update cache data (notify tracks, sync markers) Animation/AnimSequenceBase.h  

void RegisterOnNotifyChanged ( const FOnNotifyChanged& Delegate
)

 Registers a delegate to be called after notification has changed Animation/AnimSequenceBase.h  

void RemoveNotifies ()

 Remove all notifies Animation/AnimSequenceBase.h  

bool RemoveNotifies ( const TArray< FName >& NotifiesToRemove
)

 Remove the notifies specified Animation/AnimSequenceBase.h  

void RenameNotifies ( FName InOldName,
FName InNewName
)

 Renames all named notifies with InOldName to InNewName Animation/AnimSequenceBase.h  

bool ShouldDataModelBeValid()

   Animation/AnimSequenceBase.h  

void SortNotifies()

 Sort the Notifies array by time, earliest first. Animation/AnimSequenceBase.h  

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

   Animation/AnimSequenceBase.h  

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

   Animation/AnimSequenceBase.h  

void UnregisterOnNotifyChanged ( FDelegateUserObject Unregister
)

   Animation/AnimSequenceBase.h  

Overridden from UAnimationAsset

Name Remarks Include Path Unreal Specifiers

virtual float GetPlayLength()

 Returns the total play length of the montage, if played back with a speed of 1.0. Animation/AnimSequenceBase.h  

virtual void TickAssetPlayer ( FAnimTickRecord& Instance,
FAnimNotifyQueue& NotifyQueue,
FAnimAssetTickContext& Context
) const

 Advances the asset player instance Animation/AnimSequenceBase.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void GetAssetRegistryTags ( FAssetRegistryTagsContext Context
) const

   Animation/AnimSequenceBase.h  

virtual void GetAssetRegistryTags ( TArray< FAssetRegistryTag >& OutTags
) const

   Animation/AnimSequenceBase.h  

virtual void GetResourceSizeEx ( FResourceSizeEx& CumulativeResourceSize
)

   Animation/AnimSequenceBase.h  

virtual bool IsPostLoadThreadSafe()

   Animation/AnimSequenceBase.h  

virtual void PostDuplicate ( EDuplicateMode::Type DuplicateMode
)

   Animation/AnimSequenceBase.h  

virtual void PostLoad()

   Animation/AnimSequenceBase.h  

virtual void Serialize ( FArchive& Ar
)

   Animation/AnimSequenceBase.h  

Protected

Name Remarks Include Path Unreal Specifiers

void BindToModelModificationEvent()

 Binds to DataModel its modification delegate Animation/AnimSequenceBase.h  

void CopyDataModel ( const TScriptInterface< IAnimationDataModel >& ModelToDuplicate
)

 Replaces the current DataModel, if any, with the provided one Animation/AnimSequenceBase.h  

virtual void OnModelModified ( const EAnimDataModelNotifyType& NotifyType,
IAnimationDataModel* Model,
const FAnimDataModelNotifPayload& Payload
)

 Callback registered to UAnimDatModel::GetModifiedEvent for the embedded object Animation/AnimSequenceBase.h  

virtual void PopulateModel ()

 Populates the UAnimDataModel object according to any pre-existing data. Animation/AnimSequenceBase.h  

virtual void PopulateWithExistingModel ( TScriptInterface< IAnimationDataModel > ExistingDataModel
)

   Animation/AnimSequenceBase.h  

void ValidateModel()

 Validates that DataModel contains a valid UAnimDataModel object Animation/AnimSequenceBase.h  

Overridden from UAnimationAsset

Name Remarks Include Path Unreal Specifiers

virtual void RefreshParentAssetData()

   Animation/AnimSequenceBase.h  

Static

Name Remarks Include Path Unreal Specifiers

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

   Animation/AnimSequenceBase.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page