1. Epic GamesDeveloper
  3. ISequencerChannelInterface

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

API > API/Editor > API/Editor/Sequencer

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

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Const FKeyHandle

AddOrUpdateKey_Raw ( FMovieSceneChannel* Channel,
UMovieSceneSection* SectionToKey,
const void* ExtendedEditorData,
FFrameNumber InTime,
ISequencer& InSequencer,
const FGuid& ObjectBindingID,
FTrackInstancePropertyBindings* PropertyBindings
)

 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 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* Section,
FName KeyAreaName,
FMovieSceneClipboardBuilder& ClipboardBuilder,
TArrayView< const FKeyHandle > KeyMask
)

 Copy all the keys specified in KeyMask to the specified clipboard
Public function Const TSharedPtr< UE::Sequencer::FChannelModel >

CreateChannelModel_Raw ( const FMovieSceneChannelHandle& InChannelHandle,
FName InChannelName
)

 Create a new channel model for this type of channel
Public function Const TSharedPtr< UE::Sequencer::STrackAreaLaneView > Create a new channel view for this type of channel
Public function Const TUniquePtr< FCurveModel > Create a new model for this channel that can be used on the curve editor interface
Public function Const TSharedRef< SWidget >

CreateKeyEditor_Raw ( const FMovieSceneChannelHandle& Channel,
UMovieSceneSection* Section,
const FGuid& InObjectBindingID,
TWeakPtr< FTrackInstancePropertyBindings > PropertyBindings,
TWeakPtr< ISequencer > Sequencer
)

 Create an editor on the sequencer node tree
Public function Const int32

DrawExtra_Raw ( FMovieSceneChannel* InChannel,
const UMovieSceneSection* InOwner,
const FSequencerChannelPaintArgs& PaintArgs,
int32 LayerId
)

 Draw additional content in addition to keys for a particular channel
Public function Const void

DrawKeys_Raw ( FMovieSceneChannel* Channel,
TArrayView< const FKeyHandle > InKeyHandles,
const UMovieSceneSection* InOwner,
TArrayView< FKeyDrawParams > OutKeyDrawParams
)

 Gather information on how to draw the specified keys
Public function Const void

ExtendKeyMenu_Raw ( FMenuBuilder& MenuBuilder,
TSharedPtr< FExtender > MenuExtender,
TArrayView< const FExtendKeyMenuParams > Parameters,
TWeakPtr< ISequencer > InSequencer
)

 Extend the key context menu
Public function Const void

ExtendSectionMenu_Raw ( FMenuBuilder& MenuBuilder,
TSharedPtr< FExtender > MenuExtender,
TArrayView< const FMovieSceneChannelHandle > Channels,
TArrayView< UMovieSceneSection*const > Sections,
TWeakPtr< ISequencer > InSequencer
)

 Extend the section context menu
Public function Const TSharedPtr< FStructOnScope > Get an editable key struct for the specified key
Public function Const void

PasteKeys_Raw ( FMovieSceneChannel* Channel,
UMovieSceneSection* Section,
const FMovieSceneClipboardKeyTrack& KeyTrack,
const FMovieSceneClipboardEnvironment& SrcEnvironment,
const FSequencerPasteEnvironment& DstEnvironment,
TArray< FKeyHandle >& OutPastedKeys
)

 Paste the specified key track into the specified channel
Public function Const bool Whether this channel should draw a curve on its editor UI
Public function Const bool Whether this channel supports curve models

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page