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*.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Sequencer

Header

/Engine/Source/Editor/Sequencer/Public/ISequencerChannelInterface.h

Include

#include "ISequencerChannelInterface.h"

Syntax

struct ISequencerChannelInterface

Remarks

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*. Implementations are found in TSequencerChanelInterface which calls overloaded free functions for each channel.

Destructors

Functions

Name Description

Public function Const

FKeyHandle

 

AddOrUpdateKey_Raw

(
    FMovieSceneChannel* Channel,
    UMovieSceneSection* SectionToK...,
    const void* ExtendedEditorData,
    FFrameNumber InTime,
    ISequencer& InSequencer,
    const FGuid& ObjectBindingID,
    FTrackInstancePropertyBindings*...
)

Add (or update) a key to the specified channel using it's current value at that time, or some external value specified by the extended editor data

Public function Const

bool

 

CanCreateKeyEditor_Raw

(
    const FMovieSceneChannel* Chan...
)

Check whether an editor on the sequencer node tree can be created for the specified channel

Public function Const

void

 

CopyKeys_Raw

(
    FMovieSceneChannel* Channel,
    const UMovieSceneSection* Sect...,
    FName KeyAreaName,
    FMovieSceneClipboardBuilder& Clipb...,
    TArrayView< const FKeyHandle > KeyM...
)

Copy all the keys specified in KeyMask to the specified clipboard

Public function Const

TUniquePtr< ...

 

CreateCurveEditorModel_Raw

(
    const FMovieSceneChannelHandle& Ch...,
    UMovieSceneSection* OwningSect...,
    TSharedRef< ISequencer > InSequence...
)

Create a new model for this channel that can be used on the curve editor interface

Public function Const

TSharedRef< ...

 

CreateKeyEditor_Raw

(
    const FMovieSceneChannelHandle& Ch...,
    UMovieSceneSection* Section,
    const FGuid& InObjectBindingID,
    TWeakPtr< FTrackInstancePropertyBin...,
    TWeakPtr< ISequencer > Sequencer
)

Create an editor on the sequencer node tree

Public function Const

void

 

DrawKeys_Raw

(
    FMovieSceneChannel* Channel,
    TArrayView< const FKeyHandle > InKe...,
    const UMovieSceneSection* InOw...,
    TArrayView< FKeyDrawParams > OutKey...
)

Gather information on how to draw the specified keys

Public function Const

void

 

ExtendKeyMenu_Raw

(
    FMenuBuilder& MenuBuilder,
    TArrayView< const FExtendKeyMenuPar...,
    TWeakPtr< ISequencer > InSequencer
)

Extend the key context menu

Public function Const

void

 

ExtendSectionMenu_Raw

(
    FMenuBuilder& MenuBuilder,
    TArrayView< const FMovieSceneChanne...,
    TArrayView< UMovieSceneSection*...,
    TWeakPtr< ISequencer > InSequencer
)

Extend the section context menu

Public function Const

TSharedPtr< ...

 

GetKeyStruct_Raw

(
    FMovieSceneChannelHandle Channel,
    FKeyHandle KeyHandle
)

Get an editable key struct for the specified key

Public function Const

void

 

PasteKeys_Raw

(
    FMovieSceneChannel* Channel,
    UMovieSceneSection* Section,
    const FMovieSceneClipboardKeyTrack ...,
    const FMovieSceneClipboardEnvironme...,
    const FSequencerPasteEnvironment& ...,
    TArray< FKeyHandle >& OutPastedKey...
)

Paste the specified key track into the specified channel

Public function Const

bool

 

SupportsCurveEditorModels_Raw

(
    const FMovieSceneChannelHandle& In...
)

Whether this channel supports curve models

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss