1. Epic GamesDeveloper
  3. Sequencer

Sequencer

API > API/Editor

Filters

Classes

  Type Name Description
Public class FAcquiredResources Helper class that automates releasing of acquired resources  
Public struct FAddKeyOperation Temporary structure used for consistent add-key behavior for a set of display nodes Ultimately the operation will call ISequencerTrackEditor::ProcessKeyOperation for each track editor that needs to add keys.  
Public struct FAnimatedPropertyKey    
Public struct FBuildColumnWidgetParams    
Public struct FBuildEditWidgetParams Data structure containing information required to build an edit widget  
Public struct FCanKeyPropertyParams Parameters for determining if a property can be keyed.  
Public struct UStruct BlueprintType FColumnVisibilitySetting Struct for storing reorderable and hidden/visible outliner columns  
Public struct FContextMenuSuppressor    
Public struct FCreateBindingParams    
Public struct FExtendKeyMenuParams Utility struct representing a number of selected keys on a single channel  
Public struct FKeyAreaElement    
Public struct FKeyOperation Structure defining an opeartion that should add keys to a track  
Public struct FKeyPropertyParams Parameters for keying a property.  
Public struct FKeyPropertyResult Result of keying  
Public struct FKeySectionOperation Structure defining a section that needs to be keyed by specific channels  
Public class FLevelEditorSequencerBindingData    
Public class FLevelEditorSequencerIntegration    
Public struct FLevelEditorSequencerIntegrationOptions    
Public struct UStruct BlueprintType FMovieScenePasteBindingsParams Paste bindings params  
Public struct UStruct BlueprintType FMovieScenePasteFoldersParams Paste folders params  
Public struct UStruct BlueprintType FMovieScenePasteSectionsParams Paste sections params  
Public struct UStruct BlueprintType FMovieScenePasteTracksParams Paste tracks params  
Public struct FMovieSceneSequenceEditor    
Public class FMovieSceneTrackEditor Base class for handling key and section drawing and manipulation of a UMovieSceneTrack class.  
Public struct FObjectSchemaRelevancy    
Public class FPropertyChangedParams Parameters for the property changed callback.  
Public struct FSequencerChannelPaintArgs    
Public struct FSequencerClipboardPasteGroup Struct responsible for adding key areas to a group  
Public class FSequencerClipboardReconciler Class responsible for reconciling copied key-tracks to a set of paste destinations Reconciler should be populated with all pasted destinations (sets of keyareas grouped together), before reconciling and pasting the clipboard with the reconciled result.  
Public class FSequencerCommands    
Public class FSequencerCustomizationBuilder Class to pass to ISequencerCustomization for building a customization.  
Public struct FSequencerCustomizationInfo Class for specifying customizations to apply to a sequence editor.  
Public class FSequencerCustomizationManager Manager class for sequencer customizations.  
Public struct FSequencerDragDropParams    
Public struct FSequencerHostCapabilities Sequencer host functionality capabilities.  
Public struct FSequencerInitParams Sequencer initialization parameters.  
Public class FSequencerKeyCollection A collection of keys gathered recursively from a particular node or nodes  
Public struct FSequencerKeyCollectionSignature    
Public class FSequencerKeyStructGenerator Singleton class that is used to create, store and instantiate generated structs for editing single keys on channels  
Public class FSequencerObjectBindingDragDropOp    
Public struct FSequencerPasteEnvironment    
Public class FSequencerSection    
Public class FSequencerSectionPainter Class that wraps up common section painting functionality  
Public struct FSequencerSectionPropertyDetailsViewCustomizationParams Parameters for the callback used when a section wants to customize how its properties details context menu looks like.  
Public class FSequencerTimeSliderController A time slider controller for sequencer Draws and manages time data for a Sequencer  
Public class FSequencerTrackFilter    
Public class FSequencerTrackFilter_ClassType Helper template for building Sequencer track filters based on a track or object type  
Public class FSequencerTrackFilter_ComponentType Helper template for building Sequencer track filters based on a component  
Public struct FSequencerUtilities    
Public struct FSequencerViewParams Sequencer view parameters.  
Public class IKeyArea Interface that should be implemented for the UI portion of a key area within a section  
Public class IMovieRendererInterface    
Public class IObjectSchema    
Public class ISectionLayoutBuilder Builds an inner layout for a section  
Public class ISequencer Interface for sequencers.  
Public struct ISequencerChannelInterface Abstract interface that defines all sequencer interactions for any channel type Channels are stored internally as FMovieSceneChannel*, with this interface providing a common set of operations for all channels through a safe cast from the FMovieSceneChannel*.  
Public class ISequencerCustomization Class that can figure out what customizations to apply to a given sequence.  
Public class ISequencerEditorObjectBinding Interface for sequencer object bindings  
Public class ISequencerModule Interface for the Sequencer module.  
Public class ISequencerObjectChangeListener Listens for changes objects and calls delegates when those objects change  
Public class ISequencerPropertyKeyedStatusHandler    
Public class ISequencerSection Interface that should be implemented for the UI portion of a section  
Public class ISequencerTrackEditor Interface for sequencer track editors.  
Public struct TExtendKeyMenuParams Utility struct representing a number of selected keys on a single channel  
Public struct TSequencerChannelInterface Forward declaration for the default templated channel interface.  
Public struct TSequencerChannelInterfaceBase    
Public struct TSequencerChannelInterfaceCommon Templated channel interface that calls overloaded functions matching the necessary channel types.  
Public class UClass UMovieSceneKeyStructType Struct type that is generated from an FMovieSceneChannel type to create a single edit interface for a key/value pair  
Public class UClass Config perobjectconfig USequencerSettings Serializable options for sequencer.  
Public class UClass USequencerSettingsContainer Empty class used to house multiple named USequencerSettings  
Public class UClass Abstract USequencerTrackFilterExtension Override this class in order to make an additional track filter available in Sequencer.  

Typedefs

Name Description
FCanKeyProperty Delegate for whether a property can be keyed FFrameNumber - The time at which to add the key.
FOnActorsDrop A delegate that gets executed when an actor is dropped on the sequencer.
FOnAnimatablePropertyChanged  
FOnAssetsDrop A delegate that gets executed when an asset is dropped on the sequencer.
FOnBuildCustomContextMenuForGuid A delegate that is executed when menu object is clicked.
FOnClassesDrop A delegate that gets executed when a class is dropped on the sequencer.
FOnCreateEditorObjectBinding A delegate which will create an object binding handler.
FOnCreateOutlinerColumn A delegate which will create an outliner column
FOnCreateTrackEditor A delegate which will create an auto-key handler.
FOnCreateTrackModel A delegate which will create a track model.
FOnFoldersDrop A delegate that gets executed when a folder is dropped on the sequencer.
FOnGetAddMenuContent A delegate that is executed when adding menu content.
FOnGetContextMenuContent A delegate that is executed when adding menu content.
FOnGetSequencerCustomizationInstance  
FOnGetSequencerMenuExtender A delegate that returns an extender
FOnInitToolMenuContext A delegate that is executed when initializing tool menu context.
FOnKeyProperty Delegate for adding keys for a property FFrameNumber - The time at which to add the key.
FOnObjectPropertyChanged  
FOnPreSequencerInit A delegate that gets executed a sequencer is initialize and allow modification the initialization params.
FOnPropagateObjectChanges  
FOnSequencerCreated A delegate that gets executed then a sequencer is created
FOnSequencerPaste A delegate that customizes how the sequencer behaves when data is pasted into it
FOptionalOnDragDrop A delegate that gets executed when a drag/drop event happens on the sequencer.
FTrackFilterType  

Enums

  Type Name Description
Public enum UEnum EAllowEditsMode Defines allow edits mode.  
Public enum UEnum EAutoChangeMode Defines auto change modes.  
Public enum EFindKeyDirection Enumeration used to define how to search for keys  
Public enum EFindKeyType    
Public enum UEnum EKeyGroupMode Defines set key gruops mode.  
Public enum EMovieSceneDataChangeType Defines different types of movie scene data changes.  
Public enum ESequencerCommandBindings Enumerates types of UI Command bindings.  
Public enum ESequencerDropResult    
Public enum UEnum BlueprintType ESequencerLoopMode    
Public enum ESequencerPasteSupport    
Public enum ESequencerScrubberStyle Enum representing supported scrubber styles  
Public enum UEnum ESequencerSectionResizeMode Enumerates which edge is being resized  
Public enum UEnum ESequencerSpawnPosition    
Public enum UEnum ESequencerZoomPosition    
Public enum ESnapTimeMode Allowable snapping modes when setting global time  

Functions

  Type Name Description
Public function    
Public function UMovieSceneKeyStructType * Function overload used to create a new generated struct for the specified channel.
Public function void

PostConstructKeyInstance ( const TMovieSceneChannelHandle< ChannelType >& ChannelHandle,
FKeyHandle InHandle,
FStructOnScope* Struct
)

 Called to initialize a newly allocated key struct for editing.
Public function TOptional< FKeyHandle >

Sequencer::AddKeyForExternalValue ( ChannelType* InChannel,
const TMovieSceneExternalValue< ValueType >& InExternalValue,
FFrameNumber InTime,
ISequencer& InSequencer,
const FGuid& InObjectBindingID,
FTrackInstancePropertyBindings* InPropertyBindings
)

 Retrieve a channel's external value, and add it to the channel as a new key (or update an existing key with its value)
Public function FKeyHandle

Sequencer::AddOrUpdateKey ( ChannelType* InChannel,
UMovieSceneSection* InSectionToKey,
FFrameNumber InTime,
ISequencer& InSequencer,
const FGuid& InObjectBindingID,
FTrackInstancePropertyBindings* InPropertyBindings
)

 Add or update a key for this channel's current value
Public function FKeyHandle

Sequencer::AddOrUpdateKey ( ChannelType* InChannel,
UMovieSceneSection* SectionToKey,
const TMovieSceneExternalValue< ValueType >& InExternalValue,
FFrameNumber InTime,
ISequencer& InSequencer,
const FGuid& InObjectBindingID,
FTrackInstancePropertyBindings* InPropertyBindings
)

 Add or update a key for this channel's current value, using an external value if possible
Public function bool Check whether the specified channel can create a key editor widget that should be placed on the sequencer node tree
Public function void

Sequencer::CopyKeys ( ChannelType* InChannel,
const UMovieSceneSection* InSection,
FName KeyAreaName,
FMovieSceneClipboardBuilder& ClipboardBuilder,
TArrayView< const FKeyHandle > InHandles
)

 Copy the specified keys from a channel
Public function TSharedPtr< UE::Sequencer::FChannelModel >

Sequencer::CreateChannelModel ( const FMovieSceneChannelHandle& InChannelHandle,
FName InChannelName
)

 Create a new channel model for this type of channel
Public function TSharedPtr< UE::Sequencer::STrackAreaLaneView > Create a new channel view for this type of channel
Public function TSharedRef< SWidget >

Sequencer::CreateKeyEditor ( const FMovieSceneChannelHandle& InChannel,
UMovieSceneSection* InOwningSection,
const FGuid& InObjectBindingID,
TWeakPtr< FTrackInstancePropertyBindings > InPropertyBindings,
TWeakPtr< ISequencer > InSequencer
)

 Create a key editor widget for the specified channel with the channel's specialized editor data.
Public function FKeyHandle

Sequencer::EvaluateAndAddKey ( ChannelType* InChannel,
const TMovieSceneChannelData< ValueType >& InChannelData,
FFrameNumber InTime,
ISequencer& InSequencer,
ValueType InDefaultValue
)

 Add a key at the specified time (or update an existing key) with the channel's current value at that time
Public function void

Sequencer::ExtendKeyMenu ( FMenuBuilder& MenuBuilder,
TSharedPtr< FExtender > MenuExtender,
TArray< TExtendKeyMenuParams< ChannelType > >&& InChannels,
TWeakPtr< ISequencer > InSequencer
)

 Extend the specified selected key context menu
Public function void

Sequencer::ExtendSectionMenu ( FMenuBuilder& MenuBuilder,
TSharedPtr< FExtender > MenuExtender,
TArray< TMovieSceneChannelHandle< ChannelType > >&& Channels,
TArrayView< UMovieSceneSection*const > Sections,
TWeakPtr< ISequencer > InSequencer
)

 Extend the specified selected section context menu
Public function TSharedPtr< FStructOnScope >

Sequencer::GetKeyStruct ( const TMovieSceneChannelHandle< ChannelType >& ChannelHandle,
FKeyHandle KeyHandle
)

 Get a transient key structure that can be added to a details panel to enable editing of a single key
Public function void

Sequencer::PasteKeys ( ChannelType* InChannel,
UMovieSceneSection* Section,
const FMovieSceneClipboardKeyTrack& KeyTrack,
const FMovieSceneClipboardEnvironment& SrcEnvironment,
const FSequencerPasteEnvironment& DstEnvironment,
TArray< FKeyHandle >& OutPastedKeys
)

 Paste the clipboard contents onto a channel
Public function bool Whether this channel should draw a curve on its editor UI
Public function Static const FName  
Public function const FVector2D The size of each key
Public function const FName  
Public function const FName  

Variables

  Type Name Description
Public variable const float DefaultSectionGripSize  
Public variable const float DefaultSectionHeight  
Public variable const float SectionDragStartDistance How far the user has to drag the mouse before we consider the action dragging rather than a click

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page