1. Epic GamesDeveloper
  3. TSequencerChannelInterfaceCommon

TSequencerChannelInterfaceCommon

Templated channel interface that calls overloaded functions matching the necessary channel types.

Unreal Engine C++ API Reference > Editor > Sequencer

Inheritance Hierarchy

References

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

Syntax

template<typename ChannelType>  
struct TSequencerChannelInterfaceCommon : public ISequencerChannelInterface

Remarks

Templated channel interface that calls overloaded functions matching the necessary channel types. Designed this way to allow for specific customization of key-channel behavior without having to reimplement swathes of boilerplate. This base interface implements common functions that do not require extended editor data.

Behavior can be overridden for any channel type by declaring an overloaded function for the relevant channel type in the same namespace as the channel. For instance, to implement how to retrieve key times from a channel, implement the following function:

void GetKeyTimes(FMyChannelType* InChannel, TArrayView InHandles, TArrayView OutKeyTimes);

Overridden from ISequencerChannelInterface

  Type Name Description
Public function Virtual Const bool Check whether an editor on the sequencer node tree can be created for the specified channel
Public function Virtual Const void

CopyKeys_Raw ( FMovieSceneChannel* InChannel,
const UMovieSceneSection* Section,
FName KeyAreaName,
FMovieSceneClipboardBuilder& ClipboardBuilder,
TArrayView< const FKeyHandle > KeyMask
)

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

CreateChannelModel_Raw ( const FMovieSceneChannelHandle& InChannelHandle,
const UE::Sequencer::FSectionModel& InSection,
FName InChannelName
)

 Create a new channel model for this type of channel
Public function Virtual Const TSharedPtr< UE::Sequencer::STrackAreaLaneView > Create a new channel view for this type of channel
Public function Virtual Const TUniquePtr< FCurveModel > Create a new model for this channel that can be used on the curve editor interface
Public function Virtual Const TSharedRef< SWidget > Create an editor on the sequencer node tree
Public function Virtual 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 Virtual Const void

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

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

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

 Extend the key context menu
Public function Virtual Const void

ExtendSectionMenu_Raw ( FMenuBuilder& MenuBuilder,
TSharedPtr< FExtender > InMenuExtender,
TArrayView< const FMovieSceneChannelHandle > InChannels,
const TArray< TWeakObjectPtr< UMovieSceneSection > >& InWeakSections,
TWeakPtr< ISequencer > InWeakSequencer
)

 Extend the section context menu
Public function Virtual Const TSharedPtr< ISidebarChannelExtension >

ExtendSidebarMenu_Raw ( FMenuBuilder& MenuBuilder,
TSharedPtr< FExtender > InMenuExtender,
TArrayView< const FMovieSceneChannelHandle > InChannels,
const TArray< TWeakObjectPtr< UMovieSceneSection > >& InWeakSections,
TWeakPtr< ISequencer > InWeakSequencer
)

 Extend the section sidebar menu
Public function Virtual Const TSharedPtr< FStructOnScope >

GetKeyStruct_Raw ( FMovieSceneChannelHandle InChannel,
FKeyHandle KeyHandle
)

 Get an editable key struct for the specified key
Public function Virtual Const void

PasteKeys_Raw ( FMovieSceneChannel* InChannel,
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 Virtual Const bool Whether this channel should draw a curve on its editor UI
Public function Virtual 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