FCommonAnimationTrackEditor

Tools for animation tracks

API > API/Editor > API/Editor/MovieSceneTools

Tools for animation tracks

   
Name FCommonAnimationTrackEditor
Type class
Header File /Engine/Source/Editor/MovieSceneTools/Public/TrackEditors/CommonAnimationTrackEditor.h
Include Path #include "TrackEditors/CommonAnimationTrackEditor.h"

Syntax

class FCommonAnimationTrackEditor :  
    public FMovieSceneTrackEditor,  
    public FGCObject

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

FCommonAnimationTrackEditor ( TSharedRef< ISequencer > InSequencer
)

 Constructor TrackEditors/CommonAnimationTrackEditor.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FCommonAnimationTrackEditor()

 Virtual destructor. TrackEditors/CommonAnimationTrackEditor.h  

Constants

Name Type Remarks Include Path
NumberActive int32 Keeps track of how many skeletal animation track editors we have* TrackEditors/CommonAnimationTrackEditor.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

void CreateLinkedAnimationSequence ( USkeletalMeshComponent* SkelMeshComp,
USkeleton* Skeleton,
FGuid Binding,
bool bCreateSoftLink
)

 Create a linked animation sequence for the binding. Used by linked anim track providers. TrackEditors/CommonAnimationTrackEditor.h  

UMovieSceneSkeletalAnimationTrack * FindEmptyAnimationTrack ( FGuid BindingID
)

 Find an empty skeletal animation track on the binding. Used by linked anim track providers. TrackEditors/CommonAnimationTrackEditor.h  

Public Virtual

Name Remarks Include Path Unreal Specifiers

virtual void BuildObjectBindingColumnWidgets ( TFunctionRef< TSharedRef< SHorizontalBox >()> GetEditBox,
const UE::Sequencer::TViewModelPtr< UE::Sequencer::FObjectBindingModel >& ObjectBinding,
const UE::Sequencer::FCreateOutlinerViewParams& InParams,
const FName& InColumnName
)

   TrackEditors/CommonAnimationTrackEditor.h  

virtual void BuildObjectBindingContextMenu ( FMenuBuilder& MenuBuilder,
const TArray< FGuid >& ObjectBindings,
const UClass* ObjectClass
)

   TrackEditors/CommonAnimationTrackEditor.h  

virtual void BuildObjectBindingTrackMenu ( FMenuBuilder& MenuBuilder,
const TArray< FGuid >& ObjectBindings,
const UClass* ObjectClass
)

   TrackEditors/CommonAnimationTrackEditor.h  

virtual TSharedPtr< SWidget > BuildOutlinerEditWidget ( const FGuid& ObjectBinding,
UMovieSceneTrack* Track,
const FBuildEditWidgetParams& Params
)

   TrackEditors/CommonAnimationTrackEditor.h  

virtual FText GetDisplayName()

   TrackEditors/CommonAnimationTrackEditor.h  

virtual bool HandleAssetAdded ( UObject* Asset,
const FGuid& TargetObjectGuid
)

   TrackEditors/CommonAnimationTrackEditor.h  

virtual TSharedRef< ISequencerSection > MakeSectionInterface ( UMovieSceneSection& SectionObject,
UMovieSceneTrack& Track,
FGuid ObjectBinding
)

   TrackEditors/CommonAnimationTrackEditor.h  

virtual bool OnAllowDrop ( const FDragDropEvent& DragDropEvent,
FSequencerDragDropParams& DragDropParams
)

   TrackEditors/CommonAnimationTrackEditor.h  

virtual FReply OnDrop ( const FDragDropEvent& DragDropEvent,
const FSequencerDragDropParams& DragDropParams
)

   TrackEditors/CommonAnimationTrackEditor.h  

virtual void OnInitialize()

   TrackEditors/CommonAnimationTrackEditor.h  

virtual void OnRelease()

   TrackEditors/CommonAnimationTrackEditor.h  

Overridden from FGCObject

Name Remarks Include Path Unreal Specifiers

virtual void AddReferencedObjects ( FReferenceCollector& Collector
)

   TrackEditors/CommonAnimationTrackEditor.h  

virtual FString GetReferencerName()

   TrackEditors/CommonAnimationTrackEditor.h  

Protected

Name Remarks Include Path Unreal Specifiers

void AddAnimationSubMenu ( FMenuBuilder& MenuBuilder,
TArray< FGuid > ObjectBindings,
USkeleton* Skeleton,
UMovieSceneTrack* Track,
int32 RowIndex
)

   TrackEditors/CommonAnimationTrackEditor.h  

FKeyPropertyResult AddKeyInternal ( FFrameNumber KeyTime,
UObject* Object,
UAnimSequenceBase* AnimSequence,
UMovieSceneTrack* Track,
int32 RowIndex
)

 Delegate for AnimatablePropertyChanged in AddKey TrackEditors/CommonAnimationTrackEditor.h  

TSharedRef< SWidget > BuildAddAnimationSubMenu ( FGuid ObjectBinding,
USkeleton* Skeleton,
UE::Sequencer::TWeakViewModelPtr< UE::Sequencer::FViewModel > WeakViewModel
)

 Animation sub menu TrackEditors/CommonAnimationTrackEditor.h  

TSharedRef< SWidget > BuildAnimationSubMenu ( FGuid ObjectBinding,
USkeleton* Skeleton,
UMovieSceneTrack* Track
)

   TrackEditors/CommonAnimationTrackEditor.h  

bool CanCreatePoseAsset ( FGuid InObjectBinding
) const

   TrackEditors/CommonAnimationTrackEditor.h  

bool CanDeleteLinkedAnimSequence ( FGuid Binding
)

 Whether a linked AnimSequence exists for the given binding TrackEditors/CommonAnimationTrackEditor.h  

bool CanOpenLinkedAnimSequence ( FGuid Binding
)

 Can Open the linked Anim Sequence TrackEditors/CommonAnimationTrackEditor.h  

bool CanOpenLinkedAnimSequences ( TArray< FGuid > Bindings
)

 If we can open a linked anim sequence on any binding TrackEditors/CommonAnimationTrackEditor.h  

void ConstructObjectBindingTrackMenu ( FMenuBuilder& MenuBuilder,
TArray< FGuid > ObjectBindings
)

 Construct the binding menu TrackEditors/CommonAnimationTrackEditor.h  

bool CreateAnimationSequence ( const TArray< UObject* > NewAssets,
USkeletalMeshComponent* SkelMeshComp,
FGuid Binding,
bool bCreateSoftLink
)

 Callback to Creae the Animation Asset after getting the name TrackEditors/CommonAnimationTrackEditor.h  

bool CreatePoseAsset ( const TArray< UObject* > NewAssets,
FGuid InObjectBinding
)

 Was part of the thesection but should be at the track level since it takes the final blended result at the current time, not the section instance value TrackEditors/CommonAnimationTrackEditor.h  

bool FilterAnimSequences ( const FAssetData& AssetData,
USkeleton* Skeleton
)

 Filter only compatible skeletons TrackEditors/CommonAnimationTrackEditor.h  
  TrackEditors/CommonAnimationTrackEditor.h  

void HandleCreateAnimationSequence ( USkeletalMeshComponent* SkelMeshComp,
USkeleton* Skeleton,
FGuid Binding,
bool bCeateSoftLink
)

 Callback to Create the Animation Asset, pop open the dialog TrackEditors/CommonAnimationTrackEditor.h  

void HandleCreatePoseAsset ( FGuid InObjectBinding
)

   TrackEditors/CommonAnimationTrackEditor.h  

void HandleDeleteLinkedAnimSequence ( FGuid Binding
)

 Resolve the linked AnimSequence for the given binding and unlink it from the LevelSequence TrackEditors/CommonAnimationTrackEditor.h  

void HandleRemoveAutoBake ( TArray< FGuid > Bindings
)

 Remove all auto-baked linked sequences and the linked anim track for each binding TrackEditors/CommonAnimationTrackEditor.h  

bool HasAutoBakedLinkedTracks ( TArray< FGuid > Bindings
)

 Whether any binding has a linked track with bAutoBake == true TrackEditors/CommonAnimationTrackEditor.h  

bool HasNoLinkedTracks ( TArray< FGuid > Bindings
)

 If we can isolate baked anim tracks since they exists TrackEditors/CommonAnimationTrackEditor.h  

void OnAnimationAssetEnterPressed ( const TArray< FAssetData >& AssetData,
TArray< FGuid > ObjectBindings,
UMovieSceneTrack* Track,
int32 RowIndex
)

 Animation asset enter pressed TrackEditors/CommonAnimationTrackEditor.h  

void OnAnimationAssetSelected ( const FAssetData& AssetData,
TArray< FGuid > ObjectBindings,
UMovieSceneTrack* Track,
int32 RowIndex
)

 Animation asset selected TrackEditors/CommonAnimationTrackEditor.h  

void OnSequencerDataChanged ( EMovieSceneDataChangeType DataChangeType
)

   TrackEditors/CommonAnimationTrackEditor.h  

void OnSequencerSaved ( ISequencer& InSequence
)

   TrackEditors/CommonAnimationTrackEditor.h  

void OpenLinkedAnimSequence ( FGuid Binding
)

 Open the linked Anim Sequence TrackEditors/CommonAnimationTrackEditor.h  

bool ShouldFilterAsset ( const FAssetData& AssetData
)

 Animation sub menu filter function TrackEditors/CommonAnimationTrackEditor.h  

Protected Virtual

Name Remarks Include Path Unreal Specifiers
Whether to activate FSkeletalAnimationTrackEditMode for skeleton/trail visualization. TrackEditors/CommonAnimationTrackEditor.h  

Static

Name Remarks Include Path Unreal Specifiers

static bool AcquireAllBoundSkeletalMeshObjectsFromObjectGuid ( const FGuid& Guid,
TSharedPtr< ISequencer > SequencerPtr,
TArray< USkeletalMeshComponent* >& OutSkelMeshComponents,
TArray< FGuid >& OutBindingIds
)

   TrackEditors/CommonAnimationTrackEditor.h  

static USkeletalMeshComponent * AcquireSkeletalMeshFromObjectGuid ( const FGuid& Guid,
TSharedPtr< ISequencer > SequencerPtr
)

   TrackEditors/CommonAnimationTrackEditor.h  

static USkeleton * AcquireSkeletonFromObjectGuid ( const FGuid& Guid,
TSharedPtr< ISequencer > SequencerPtr
)

   TrackEditors/CommonAnimationTrackEditor.h  

static void ConfigureAutoBake ( const TWeakPtr< ISequencer >& InSequencer,
TArray< FGuid > Bindings
)

 Set up auto-bake recorders for any linked anim sequences on the given bindings. TrackEditors/CommonAnimationTrackEditor.h  

static bool DeleteLinkedAnimTrackForBinding ( const TWeakPtr< ISequencer >& InSequencer,
FGuid BindingID,
bool bOnlyAutoBaked
)

 Remove linked AnimSequence link(s) and the LinkedAnimTrack for the given binding. TrackEditors/CommonAnimationTrackEditor.h  

static IMovieSceneLinkedAnimTrackProvider * FindProviderForBinding ( const TWeakPtr< ISequencer >& InSequencer,
FGuid BindingID
)

 Find the first linked anim track provider that can handle this binding. TrackEditors/CommonAnimationTrackEditor.h  

static TArray< FLevelSequenceAnimSequenceLinkItem * > GetLinkedAnimSequences ( const TWeakPtr< ISequencer >& InSequencer,
FGuid Binding
)

   TrackEditors/CommonAnimationTrackEditor.h  

static UMovieSceneTrack * GetOrCreateLinkedAnimTrack ( const TWeakPtr< ISequencer >& InSequencer,
FGuid BindingID
)

 Find or create the linked animation track for the given binding. TrackEditors/CommonAnimationTrackEditor.h  

static bool IsolateLinkedAnimTrack ( const TWeakPtr< ISequencer >& InSequencer,
FGuid BindingID,
bool bIsolate
)

 Isolate the linked anim track by muting other tracks here, return true if items were changed TrackEditors/CommonAnimationTrackEditor.h  

static bool IsolateLinkedAnimTracks ( const TWeakPtr< ISequencer >& InSequencer,
TArray< FGuid > Bindings,
bool bIsolate
)

 If bIsolate is true it will activate any linked and autobaked anim tracks, and deactivate control rig or non linked anim tracks, if false does opposite TrackEditors/CommonAnimationTrackEditor.h  

static bool UnlinkLinkedAnimSequence ( UAnimSequence* AnimSequence
)

 Remove the bidirectional link between an AnimSequence and its owning LevelSequence. TrackEditors/CommonAnimationTrackEditor.h  

static void UpdateLinkedAnimSectionRange ( const TWeakPtr< ISequencer >& InSequencer,
FGuid BindingID
)

 Update linked anim sections ranges after bake in case playback range changed TrackEditors/CommonAnimationTrackEditor.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page