Sequencer

Windows
MacOS
Linux

Classes

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

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

FContextMenuSuppressor

Public struct

FExtendKeyMenuParams

Utility struct representing a number of selected keys on a single channel

Public struct

FKeyAreaElement

Public struct

FKeyDrawParams

Structure defining how a key should be drawn

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

FMovieSceneSequenceEditor

Public class

FMovieSceneTrackEditor

Base class for handling key and section drawing and manipulation of a UMovieSceneTrack class.

Public class

FPropertyChangedParams

Parameters for the property changed callback.

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

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

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

ISequencerEditTool

Interface for edit tools in Sequencer.

Public class

ISequencerEditToolDragOperation

Interface for drag and drop operations that are handled by edit tools in Sequencer.

Public struct

ISequencerHotspot

A sequencer hotspot is used to identify specific areas on the sequencer track area

Public struct

ISequencerInputHandler

Common base-class for objects that handle input in the sequencer.

Public class

ISequencerModule

Interface for the Sequencer module.

Public class

ISequencerObjectChangeListener

Listens for changes objects and calls delegates when those objects change

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

UMovieSceneKeyStructType

Struct type that is generated from an FMovieSceneChannel type to create a single edit interface for a key/value pair

Public class

USequencerExportTask

Contains data for a group of assets to import

Public class

USequencerSettings

Serializable options for sequencer.

Public class

USequencerSettingsContainer

Empty class used to house multiple named USequencerSettings

Public class

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.

FKeyAreaArray

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.

FOnCreateTrackEditor

A delegate which will create an auto-key handler.

FOnGetAddMenuContent

A delegate that is executed when adding menu content.

FOnGetSequencerCustomizationInstance

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

FOptionalOnDragDrop

A delegate that gets executed when a drag/drop event happens on the sequencer.

FTrackFilterType

Enums

Name

Description

Public enum

EAllowEditsMode

Defines allow edits mode.

Public enum

EAutoChangeMode

Defines auto change modes.

Public enum

EFindKeyDirection

Enumeration used to define how to search for keys

Public enum

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

ESequencerHotspot

Public enum

ESequencerLoopMode

Public enum

ESequencerScrubberStyle

Enum representing supported scrubber styles

Public enum

ESequencerSectionResizeMode

Enumerates which edge is being resized

Public enum

ESequencerSpawnPosition

Public enum

ESequencerZoomPosition

Public enum

ESnapTimeMode

Allowable snapping modes when setting global time

Functions

Name Description

Public function

UMovieSceneK ...

 

InstanceGeneratedStruct

(
    void * Channel,
    FSequencerKeyStructGenerator * ...
)

Function overload used to create a new generated struct for the specified channel.

Public function

void

 

PostConstructKeyInstance

(
    const TMovieSceneChannelHandle < Cha...,
    FKeyHandle InHandle,
    FStructOnScope * Struct
)

Called to initialize a newly allocated key struct for editing.

Public function

TOptional < F ...

 

Sequencer::AddKeyForExternalValue

(
    ChannelType* InChannel,
    const TMovieSceneExternalValue < Val...,
    FFrameNumber InTime,
    ISequencer & InSequencer,
    const FGuid & InObjectBindingID,
    FTrackInstancePropertyBindings *...
)

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 * InSectionT...,
    FFrameNumber InTime,
    ISequencer & InSequencer,
    const FGuid & InObjectBindingID,
    FTrackInstancePropertyBindings *...
)

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

Public function

FKeyHandle

 

Sequencer::AddOrUpdateKey

(
    ChannelType* InChannel,
    UMovieSceneSection * SectionToK...,
    const TMovieSceneExternalValue < Val...,
    FFrameNumber InTime,
    ISequencer & InSequencer,
    const FGuid & InObjectBindingID,
    FTrackInstancePropertyBindings *...
)

Add or update a key for this channel's current value, using an external value if possible

Public function

bool

 

Sequencer::CanCreateKeyEditor

(
    const FMovieSceneChannel * InCh...
)

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 * InSe...,
    FName KeyAreaName,
    FMovieSceneClipboardBuilder & Clipb...,
    TArrayView < const FKeyHandle > InHa...
)

Copy the specified keys from a channel

Public function

TSharedRef < ...

 

Sequencer::CreateKeyEditor

(
    const FMovieSceneChannelHandle & In...,
    UMovieSceneSection * InOwningSe...,
    const FGuid & InObjectBindingID,
    TWeakPtr < FTrackInstancePropertyBin ...,
    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 < Value...,
    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,
    TArray < TExtendKeyMenuParams < Chann...,
    TWeakPtr < ISequencer > InSequencer
)

Extend the specified selected key context menu

Public function

void

 

Sequencer::ExtendSectionMenu

(
    FMenuBuilder & MenuBuilder,
    TArray < TMovieSceneChannelHandle < C...,
    TArrayView < UMovieSceneSection *...,
    TWeakPtr < ISequencer > InSequencer
)

Extend the specified selected section context menu

Public function

TSharedPtr < ...

 

Sequencer::GetKeyStruct

(
    const TMovieSceneChannelHandle < Cha...,
    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 ...,
    const FMovieSceneClipboardEnvironme ...,
    const FSequencerPasteEnvironment & ...,
    TArray < FKeyHandle >& OutPastedKey...
)

Paste the clipboard contents onto a channel

Public function Static

const FName

 

SequencerMenuExtensionPoints::AddTrackMenu_PropertiesSection

(
    "AddTrackMenu_PropertiesSection"
)

Public function

const FVecto ...

 

SequencerSectionConstants::KeySize

(
    12. 0f,
    12. 0f
)

The size of each key

Public function

const FName

 

SequencerSectionConstants::SelectionColorName

(
    "SelectionColor"
)

Public function

const FName

 

SequencerSectionConstants::SelectionInactiveColorName

(
    "SelectionColorInactive"
)

Variables

Name Description

Public variable

const float

 

DefaultSectionGripSize

Public variable

const float

 

DefaultSectionHeight

Public variable

FExtendKeyMenuP ...

 

OnInitializeDetailsPanel

Public variable

const float

 

SectionDragStartDistance

How far the user has to drag the mouse before we consider the action dragging rather than a click

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback