FSequencerBaker

[FSequencerBaker](API\Editor\MovieSceneTools\FSequencerBaker)

API > API/Editor > API/Editor/MovieSceneTools

FSequencerBaker

Main object that Bakes within ISequencer, using Sequencer evaluation over the range. It keeps track of track signatures for each recorder to seek if they need to get baked when we switch over to using the baked track

   
Name FSequencerBaker
Type class
Header File /Engine/Source/Editor/MovieSceneTools/Public/Baker/SequencerBaker.h
Include Path #include "Baker/SequencerBaker.h"

Syntax

class FSequencerBaker :  
    public UE::AIE::ISequencerBaker ,  
    public FTickableEditorObject ,  
    public TSharedFromThis< FSequencerBaker >

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FSequencerBaker()

   Baker/SequencerBaker.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FSequencerBaker()

   Baker/SequencerBaker.h  

Structs

Name Remarks
FBakeInterval Internal struct to set up time range based upon sequencer frame range
FSignedObjectChanges  
FSignedObjectState Internal objects that contains a movie scene signed object(track) last guid and the bakers that reference we keep of these guids and if the LastValidMovieSceneGuid changes we see which of these track guids have changed.

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
OnAddBakeRecorder FOnAddBakeRecorder Public delegates folks can subscribe for when recorders are added or removed Baker/SequencerBaker.h  
OnRemoveBakeRecorder FOnRemoveBakeRecorder   Baker/SequencerBaker.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
BakeHelpers TArray< IMovieSceneToolsAnimationBakeHelper * > Cached items during the bake Baker/SequencerBaker.h  
BakeInterval FBakeInterval   Baker/SequencerBaker.h  
BakingRecorders TSet< TSharedPtr< ISequencerBakeRecorder > > Recorders that are baking. Baker/SequencerBaker.h  
bIsBaking bool   Baker/SequencerBaker.h  
bNeedsBaking bool Functions used during the Bake Baker/SequencerBaker.h  
LastBakedRecorders TArray< TSharedPtr< ISequencerBakeRecorder > >   Baker/SequencerBaker.h  
LastValidMovieSceneGuid FGuid   Baker/SequencerBaker.h  
LocalToRootTransform FMovieSceneInverseSequenceTransform   Baker/SequencerBaker.h  
OnActivateSequenceChangedHandle FDelegateHandle   Baker/SequencerBaker.h  
OnMovieSceneBindingsChangedHandle FDelegateHandle   Baker/SequencerBaker.h  
OnPreNavigateToSequenceChangedHandle FDelegateHandle   Baker/SequencerBaker.h  
RecorderOptions FRecorderOptions Contains full set of options e.g. if one anim sequence has delay frame others will also Baker/SequencerBaker.h  
Recorders TMap< uint32, TSharedPtr< ISequencerBakeRecorder > > Registered Recorders uses hash as key Baker/SequencerBaker.h  
SignedObjectsToTrack FSignedObjectChanges Tracked objecs for guid changes Baker/SequencerBaker.h  
SkeletalMeshCompsTick TSet< TWeakObjectPtr< USkeletalMeshComponent > > Skel meshes to tick that comes from the recorders Baker/SequencerBaker.h  
WeakSequencer TWeakPtr< ISequencer > Sequencer and it's interval to bake Baker/SequencerBaker.h  
World UWorld * This is cached during set of functions Baker/SequencerBaker.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddAllRecordersToBake()

 Add all existing recorders to get baked Baker/SequencerBaker.h  

void AddExtraRecordersToBake ( const TArray< TSharedPtr< ISequencerBakeRecorder > >& InExtraRecorders
)

 Add extra recorders to get baked just once on next bake Baker/SequencerBaker.h  

bool AddRecorderToBake ( TSharedPtr< ISequencerBakeRecorder >& InRecorder
)

 This adds that recorder that was already added to be baked on next bake time Baker/SequencerBaker.h  

void AddSignedObjectsToTrack ( TArray< TWeakObjectPtr< UMovieSceneSignedObject > >& InSignedObjects,
TSharedPtr< ISequencerBakeRecorder >& Owner
)

   Baker/SequencerBaker.h  

void AddSkelMeshCompsToTick ( TArray< USkeletalMeshComponent* >& InSkelMeshCompArray
)

   Baker/SequencerBaker.h  

void BakeFullRange()

 Bake everything and will remove recorders from bake queue Baker/SequencerBaker.h  

TSharedPtr< ISequencerBakeRecorder > * FindRecorder ( Args&&... InArgs
)

 Finds the recorder by it's signature of arguments Baker/SequencerBaker.h  

TWeakPtr< ISequencer > GetWeakSequencer()

   Baker/SequencerBaker.h  

void IgnoreLastChange()

 Ignore the last change, used mostly for when we isolate the tracks we don't want to trigger a re-baking Baker/SequencerBaker.h  

void Initialize ( TSharedPtr< ISequencer >& InSequencer
)

   Baker/SequencerBaker.h  

void IsolateRecorderWithGuid ( FGuid InGuid,
bool bIsolate
)

   Baker/SequencerBaker.h  

void Release()

   Baker/SequencerBaker.h  

void RemoveSignedObjectsFromTrack ( TArray< TWeakObjectPtr< UMovieSceneSignedObject > >& InSignedObjects,
TSharedPtr< ISequencerBakeRecorder >& Owner
)

   Baker/SequencerBaker.h  

Public Virtual

Overridden from ISequencerBaker

Name Remarks Include Path Unreal Specifiers

virtual void AddRecorder ( TSharedPtr< ISequencerBakeRecorder >& InRecorder,
const UE::AIE::ISequencerBaker::FRecorderOptions& InOptions
)

   Baker/SequencerBaker.h  

virtual void CancelBake()

   Baker/SequencerBaker.h  

virtual UE::AIE::FBakeTimeRange GetTimeRange()

   Baker/SequencerBaker.h  

virtual bool IsBakeRunning ( TOptional< float >& OutPercentageDone
)

   Baker/SequencerBaker.h  

virtual void RemoveRecorder ( TSharedPtr< ISequencerBakeRecorder >& InRecorder
)

   Baker/SequencerBaker.h  

Overridden from FTickableObjectBase

Name Remarks Include Path Unreal Specifiers

virtual TStatId GetStatId()

   Baker/SequencerBaker.h  

virtual ETickableTickType GetTickableTickType()

   Baker/SequencerBaker.h  

virtual void Tick ( float DeltaTime
)

   Baker/SequencerBaker.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page