1. Epic GamesDeveloper
  3. ISequencer

ISequencer

Interface for sequencers.

Unreal Engine C++ API Reference > Editor > Sequencer

Inheritance Hierarchy

References

   
Module Sequencer
Header /Engine/Source/Editor/Sequencer/Public/ISequencer.h
Include #include "ISequencer.h"

Syntax

class ISequencer :  
    public IMovieScenePlayer,  
    public TSharedFromThis< ISequencer >

Remarks

Interface for sequencers.

Variables

  Type Name Description
Protected variable FOnCameraAddedToSequencer CameraAddedToSequencer  
Protected variable FOnGetCanRecord GetCanRecord  
Protected variable FOnGetIsBindingVisible GetIsBindingVisible  
Protected variable FOnGetIsRecording GetIsRecording  
Protected variable FOnGetIsTrackVisible GetIsTrackVisible  
Protected variable FOnGetPlaybackSpeeds GetPlaybackSpeeds  
Protected variable FOnInitializeDetailsPanel InitializeDetailsPanelEvent  

Functions

  Type Name Description
Public function TArray< FGuid >

AddActors ( const TArray< TWeakObjectPtr< AActor > >& InActors,
bool bSelectActors
)

 Add actors as possessable objects to sequencer.
Public function void Adds a movie scene as a section inside the current movie scene
Public function Const bool

CanKeyProperty ( FCanKeyPropertyParams CanKeyPropertyParams
)

  
Public function void

Close ()

 Close the sequencer.
Public function TArray< FGuid > Convert the Possessable to a Spawnable. Returns an array of Spawnable Id's
Public function FGuid

CreateBinding ( UObject& InObject,
const FString& InName
)

 Create a new binding for the specified object
Public function void Empties the current selection.
Public function void Puts sequencer in a silent state (whereby it will not redraw viewports, or attempt to update external state besides the sequence itself)
Public function void Leaves a silent state (see above)
Public function void Called when the external selection has changed in such a way that sequencer should re-synchronize its selection states
Public function TArrayView< TWeakObjectPtr<> >

FindObjectsInCurrentSequence ( const FGuid& InObjectBinding
)

  
Public function UObject *

FindSpawnedObjectOrTemplate ( const FGuid& BindingId
)

 Attempt to find a spawned object in the currently focused movie scene, or the template object for the specified binding ID, if possible
Public function Const UMovieSceneSubSection * Attempt to locate the sub section that relates to the specified sequence ID.
Public function void Focuses a sub-movie scene (MovieScene within a MovieScene) in the sequencer.
Public function void Forcefully reevaluate the sequence immediately
Public function Const EAllowEditsMode  
Public function Const EAutoChangeMode  
Public function Const bool Gets whether or not property track defaults will be automatically set when adding tracks.
Public function Virtual void

GetCameraObjectBindings ( TArray< FGuid >& OutBindingIDs
)

 Gets the list of bindings for camera objects.
Public function Const TSharedPtr< FUICommandList >

GetCommandBindings ( ESequencerCommandBindings Type
)

  
Public function FOnCurveDisplayChanged & Gets a multicast delegate when the curve edtior associated with this sequencer has it's selection change.
Public function Virtual Const bool  
Public function FText

GetDisplayName ( FGuid InBinding
)

 Get the Display Name of the Object Binding Track.
Public function Const FFrameRate Get the display rate of the currently focused sequence
Public function Const UMovieSceneSequence *  
Public function Const FMovieSceneSequenceTransform  
Public function Const FMovieSceneSequenceIDRef  
Public function Const FFrameRate Get the tick resolution of the currently focused sequence
Public function Const FQualifiedFrameTime Gets the global time.
Public function FGuid

GetHandleToObject ( UObject* Object,
bool bCreateHandleIfMissing,
const FName& CreatedFolderName
)

 Gets a handle to runtime information about the object being manipulated by a movie scene
Public function Const bool  
Public function Const EKeyGroupMode  
Public function Const EMovieSceneKeyInterpolation  
Public function void

GetKeysFromSelection ( TUniquePtr< FSequencerKeyCollection >& KeyCollection,
float DuplicateThresoldTime
)

 Get all the keys for the current sequencer selection
Public function Const FFrameTime Get the last evaluated time, which may be different form the current local time
Public function Const uint32  
Public function Const FQualifiedFrameTime Gets the current time of the time slider relative to the currently focused movie scene
Public function Const TArray< FMovieSceneMarkedFrame >  
Public function Const TSharedRef< INumericTypeInterface< double > >  
Public function ISequencerObjectChangeListener &  
Public function Const float  
Public function Const FFrameRate Get the display rate of the currently root sequence
Public function Const UMovieSceneSequence *  
Public function Const FMovieSceneSequenceIDRef  
Public function Const FFrameRate Get the tick resolution of the currently root sequence
Public function void

GetSelectedFolders ( TArray< UMovieSceneFolder* >& OutSelectedFolders
)

 Gets the currently selected folders.
Public function void

GetSelectedKeyAreas ( TArray< const IKeyArea* >& OutSelectedKeyAreas,
bool bIncludeSelectedKeys
)

 Gets the currently selected key areas.
Public function void

GetSelectedObjects ( TArray< FGuid >& OutSelectedObjects
)

 Gets the currently selected Object Guids
Public function void

GetSelectedSections ( TArray< UMovieSceneSection* >& OutSelectedSections
)

 Gets the currently selected sections.
Public function void

GetSelectedTracks ( TArray< UMovieSceneTrack* >& OutSelectedTracks
)

 Gets the currently selected tracks.
Public function FOnSelectionChangedObjectGuids & Gets a multicast delegate with an array of FGuid of bound objects which is called when the outliner node selection changes.
Public function FOnSelectionChangedSections & Gets a multicast delegate with an array of UMovieSceneSections which is called when the outliner node selection changes.
Public function FOnSelectionChangedTracks & Gets a multicast delegate with an array of UMovieSceneTracks which is called when the outliner node selection changes.
Public function Const TRange< FFrameNumber > Get the selection range.
Public function Const USequencerSettings * Getter for sequencer settings
Public function Const TSharedRef< SWidget >  
Public function Const const TArray< FMovieSceneSequenceID > &  
Public function Const TSharedPtr< IToolkitHost > Returns the Toolkit hosting the sequencer instance, if any
Public function Const TSharedPtr< class ITimeSlider > Get the top time slider from the main widget.
Public function TSharedPtr< ISequencerTrackEditor > Retrieve or create a track editor for the specified track
Public function Const TArray< FText > Gets all the available track filter names
Public function Const TSharedPtr< UE::Sequencer::FSequencerEditorViewModel > Retrieve the top level view model for this sequence
Public function Virtual Const FAnimatedRange  
Public function Virtual Const bool  
Public function Const bool Checks whether we're in silent mode or not
Public function Virtual Const bool Gets whether perspective viewport hijacking is enabled.
Public function Virtual Const bool Gets whether perspective viewport hijacking is enabled.
Public function Const bool Whether the sequence is read-only
Public function Const bool

IsTrackFilterEnabled ( const FText& InTrackFilterName
)

 Gets whether the specified track filter is on/off
Public function void

KeyProperty ( FKeyPropertyParams KeyPropertyParams
)

  
Public function FGuid

MakeNewSpawnable ( UObject& SourceObject,
UActorFactory* ActorFactory,
bool bSetupDefaults
)

 Attempts to add a new spawnable to the MovieScene for the specified object (asset, class or actor instance)
Public function TSharedRef< SWidget >

MakeTimeRange ( const TSharedRef< SWidget >& InnerContent,
bool bShowWorkingRange,
bool bShowViewRange,
bool bShowPlaybackRange
)

 Create a widget containing the spinboxes for setting the working and playback range
Public function TSharedRef< SWidget >

MakeTransportControls ( bool bExtended
)

  
Public function void

NotifyMovieSceneDataChanged ( EMovieSceneDataChangeType DataChangeType
)

  
Protected function void  
Public function Const void Specify that an object was implicitly added.
Public function Const void Specify that an object was implicitly removed.
Public function ISequencer::FOnActivateSequence TBaseMulticastDelegate_OneParam  
Public function FOnActorAddedToSequencer &  
Public function void

OnAddTrack ( const TWeakObjectPtr< UMovieSceneTrack >& InTrack,
const FGuid& ObjectBinding
)

 Should be called after adding a track to the MovieScene.
Public function FOnBeginScrubbingEvent & Gets a multicast delegate which is executed whenever the user begins scrubbing.
Public function FOnCameraAddedToSequencer &  
Public function ISequencer::FOnCameraCut TBaseMulticastDelegate_TwoParams  
Public function FOnChannelChanged & Gets a multicast delegate which is executed whenever a channel is changed by Sequencer.
Public function FOnCloseEvent &  
Public function FOnEndScrubbingEvent & Gets a multicast delegate which is executed whenever the user stops scrubbing.
Public function FOnGetCanRecord &  
Public function FOnGetIsBindingVisible &  
Public function FOnGetIsRecording &  
Public function FOnGetIsTrackVisible &  
Public function FOnGlobalTimeChanged & Gets a multicast delegate which is executed whenever the global time changes.
Public function ISequencer::FOnInitializeDetailsPanel TBaseMulticastDelegate_TwoParams  
Public function FOnMovieSceneBindingsChanged & Gets a multicast delegate which is executed whenever the movie scene bindings are changed.
Public function FOnMovieSceneBindingsPasted & Gets a multicast delegate which is executed whenever bindings are pasted.
Public function FOnMovieSceneDataChanged & Gets a multicast delegate which is executed whenever the movie scene data is changed.
Public function FReply

OnPlay ( bool bTogglePlay
)

 Play or toggle playback at the specified play rate
Public function FOnPlayEvent & Gets a multicast delegate which is executed whenever the user begins playing the sequence.
Public function ISequencer::FOnPostSave TBaseMulticastDelegate_OneParam  
Public function ISequencer::FOnPreSave TBaseMulticastDelegate_OneParam  
Public function FOnRecordEvent & Gets a multicast delegate which is executed whenever the user toggles recording.
Public function FOnStopEvent & Gets a multicast delegate which is executed whenever the user stops playing the sequence.
Public function FOnTreeViewChanged & Gets a multicast delegate which is executed whenever the sequencer tree view changes, like when an object is added, or filtered from the view
Public function void

Pause ()

 Pause playback
Public function void Play from the current time to the requested time
Public function void

PopToSequenceInstance ( FMovieSceneSequenceIDRef SequenceID
)

 Pops the current focused movie scene from the stack.
Public function Virtual void Recreate any associated Curve Editor
Public function void Refresh the sequencer tree view
Public function Const void Render movie for a section.
Public function void Forcefully reevaluate the sequence on the next frame
Public function void Invalidate cached data so that it will be reevaluated on the next frame
Public function void Reset the timing manager to the clock source specified by the root movie scene
Public function void Resets sequencer with a new animation
Public function void Restores the speed to 1.
Public function void

SelectByChannels ( UMovieSceneSection* Section,
TArrayView< const FMovieSceneChannelHandle > InChannels,
bool bSelectParentInstead,
bool bSelect
)

 Selects the nodes that relate to the specified channels
Public function void

SelectByChannels ( UMovieSceneSection* Section,
const TArray< FName >& InChannelNames,
bool bSelectParentInstead,
bool bSelect
)

 Selects the nodes that relate to the specified channels
Public function void

SelectByNthCategoryNode ( UMovieSceneSection* Section,
int Index,
bool bSelect
)

 Selects nodes by the nth category node under a section
Public function void

SelectByPropertyPaths ( const TArray< FString >& InPropertyPaths
)

 Selects property tracks by property path
Public function void Selects a folder
Public function void

SelectObject ( FGuid ObjectBinding
)

 Selects an object by GUID
Public function void Selects a section
Public function void Selects a track
Public function void

SetAllowEditsMode ( EAllowEditsMode AllowEditsMode
)

 Sets where edits are allowed
Public function void

SetAutoChangeMode ( EAutoChangeMode AutoChangeMode
)

 SSets the current auto-change mode.
Public function void

SetClampRange ( TRange< double > NewClampRange
)

 Set the clamp range
Public function void

SetDisplayName ( FGuid InBinding,
const FText& InDisplayName
)

 Set the Display Name of the Object Binding Track.
Public function void

SetGlobalTime ( FFrameTime Time,
bool bEvaluate
)

 Set the global time directly, without performing any auto-scroll, snapping or other adjustments to the supplied time
Public function void

SetInfiniteKeyAreas ( bool bInfiniteKeyAreas
)

 Set infinite key area default
Public function void

SetKeyGroupMode ( EKeyGroupMode Mode
)

 Sets which channels are keyed when a channel is keyed
Public function void

SetKeyInterpolation ( EMovieSceneKeyInterpolation
)

 Set default key interpolation
Public function void

SetLocalTime ( FFrameTime Time,
ESnapTimeMode SnapTimeMode,
bool bEvaluate
)

 Sets the cursor position relative to the currently focused sequence
Public function void

SetLocalTimeDirectly ( FFrameTime NewTime,
bool bEvaluate
)

 Set the current local time directly, with no other snapping, scrolling or manipulation
Public function void Sets whether perspective viewport camera cutting is enabled.
Public function void Sets whether perspective viewport hijacking is enabled.
Public function void

SetPlaybackSpeed ( float InPlaybackSpeed
)

  
Public function void Set the selection range's end position to the requested time.
Public function void Set the selection range's start position to the requested time.
Public function void Setter for sequencer settings
Public function Virtual void

SetShowCurveEditor ( bool bInShowCurveEditor
)

 Whether to show the curve editor or not
Public function void

SetTrackFilterEnabled ( const FText& InTrackFilterName,
bool bEnabled
)

 Sets the specified track filter to be on or off
Public function void

SetViewRange ( TRange< double > NewViewRange,
EViewRangeInterpolation Interpolation
)

 Set the view range, growing the working range to accomodate, if necessary
Public function void

SnapSequencerTime ( FFrameTime& InOutScrubTime
)

 Modify the Sequencer time by any snap settings
Public function void Snaps to the closest available speed to the current one.
Public function void

SuppressAutoEvaluation ( UMovieSceneSequence* Sequence,
const FGuid& InSignature
)

 Suppresses automatic evaluation the specified sequence and signature are the only difference that would prompt a re-evaluation
Public function void Throb key or section selection
Public function void  
Public function void  

Classes

  Type Name Description
Public class FOnActivateSequence    
Public class FOnCameraCut    
Public class FOnInitializeDetailsPanel    
Public class FOnPostSave    
Public class FOnPreSave    

Typedefs

Name Description
FOnActorAddedToSequencer  
FOnBeginScrubbingEvent  
FOnCameraAddedToSequencer A delegate which will can be used in response to a camera being added to the sequence.
FOnChannelChanged  
FOnCloseEvent  
FOnCurveDisplayChanged  
FOnEndScrubbingEvent  
FOnGetCanRecord A delegate which will determine whether a recording is possible
FOnGetIsBindingVisible A delegate which will determine whether a binding should be visible in the tree.
FOnGetIsRecording A delegate which will determine whether there is a recording in progress
FOnGetIsTrackVisible A delegate which will determine whether a track should be visible in the tree.
FOnGetPlaybackSpeeds  
FOnGlobalTimeChanged  
FOnMovieSceneBindingsChanged  
FOnMovieSceneBindingsPasted  
FOnMovieSceneDataChanged  
FOnPlayEvent  
FOnRecordEvent  
FOnSelectionChangedObjectGuids  
FOnSelectionChangedSections  
FOnSelectionChangedTracks  
FOnStopEvent  
FOnTreeViewChanged  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page