TSequencerChannelInterfaceCommon | Unreal Engine 5.7 Documentation

API > API/Editor > API/Editor/Sequencer

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);


Name	TSequencerChannelInterfaceCommon
Type	struct
Header File	/Engine/Source/Editor/Sequencer/Public/SequencerChannelInterface.h
Include Path	#include "SequencerChannelInterface.h"

Syntax

template<typename ChannelType>  
struct TSequencerChannelInterfaceCommon : public ISequencerChannelInterface

Implements Interfaces

ISequencerChannelInterface

Derived Classes

Functions

Public

Overridden from ISequencerChannelInterface

Name	Remarks	Include Path
virtual bool CanCreateKeyEditor_Raw ( const FMovieSceneChannel* InChannel ) const	Check whether an editor on the sequencer node tree can be created for the specified channel	SequencerChannelInterface.h
virtual void CopyKeys_Raw ( FMovieSceneChannel* InChannel, const UMovieSceneSection* Section, FName KeyAreaName, FMovieSceneClipboardBuilder& ClipboardBuilder, TArrayView< const FKeyHandle > KeyMask ) const	Copy all the keys specified in KeyMask to the specified clipboard	SequencerChannelInterface.h
virtual TSharedPtr< UE::Sequencer::FChannelModel > CreateChannelModel_Raw ( const FMovieSceneChannelHandle& InChannelHandle, const UE::Sequencer::FSectionModel& InSection, FName InChannelName ) const	Create a new channel model for this type of channel	SequencerChannelInterface.h
virtual TSharedPtr< UE::Sequencer::STrackAreaLaneView > CreateChannelView_Raw ( const FMovieSceneChannelHandle& InChannelHandle, TWeakPtr< UE::Sequencer::FChannelModel > InWeakModel, const UE::Sequencer::FCreateTrackLaneViewParams& Parameters ) const	Create a new channel view for this type of channel	SequencerChannelInterface.h
virtual TUniquePtr< FCurveModel > CreateCurveEditorModel_Raw ( const FMovieSceneChannelHandle& InChannel, const UE::Sequencer::FCreateCurveEditorModelParams& Params ) const	Create a new model for this channel that can be used on the curve editor interface	SequencerChannelInterface.h
virtual TSharedRef< SWidget > CreateKeyEditor_Raw ( const FMovieSceneChannelHandle& Channel, const UE::Sequencer::FCreateKeyEditorParams& Params ) const	Create an editor on the sequencer node tree	SequencerChannelInterface.h
virtual void DeleteKeys_Raw ( FMovieSceneChannel* InChannel, TArrayView< const FKeyHandle > InHandles, FFrameNumber InTime ) const	Delete the specified keys.	SequencerChannelInterface.h
virtual int32 DrawExtra_Raw ( FMovieSceneChannel* InChannel, const UMovieSceneSection* InOwner, const FSequencerChannelPaintArgs& PaintArgs, int32 LayerId ) const	Draw additional content in addition to keys for a particular channel	SequencerChannelInterface.h
virtual void DrawKeys_Raw ( FMovieSceneChannel* InChannel, TArrayView< const FKeyHandle > InKeyHandles, const UMovieSceneSection* InOwner, TArrayView< FKeyDrawParams > OutKeyDrawParams ) const	Gather information on how to draw the specified keys	SequencerChannelInterface.h
virtual void ExtendKeyMenu_Raw ( FMenuBuilder& MenuBuilder, TSharedPtr< FExtender > MenuExtender, TArrayView< const FExtendKeyMenuParams > ChannelsAndHandles, TWeakPtr< ISequencer > InSequencer ) const	Extend the key context menu	SequencerChannelInterface.h
virtual void ExtendSectionMenu_Raw ( FMenuBuilder& MenuBuilder, TSharedPtr< FExtender > InMenuExtender, TArrayView< const FMovieSceneChannelHandle > InChannels, const TArray< TWeakObjectPtr< UMovieSceneSection > >& InWeakSections, TWeakPtr< ISequencer > InWeakSequencer ) const	Extend the section context menu	SequencerChannelInterface.h
virtual TSharedPtr< ISidebarChannelExtension > ExtendSidebarMenu_Raw ( FMenuBuilder& MenuBuilder, TSharedPtr< FExtender > InMenuExtender, TArrayView< const FMovieSceneChannelHandle > InChannels, const TArray< TWeakObjectPtr< UMovieSceneSection > >& InWeakSections, TWeakPtr< ISequencer > InWeakSequencer ) const	Extend the section sidebar menu	SequencerChannelInterface.h
virtual EMovieSceneKeyInterpolation GetInterpolationMode_Raw ( FMovieSceneChannel* InChannel, FFrameNumber InTime, EMovieSceneKeyInterpolation InDefaultMode ) const	Retrieve the interpolation mode for this curve at the current time	SequencerChannelInterface.h
virtual TSharedPtr< FStructOnScope > GetKeyStruct_Raw ( FMovieSceneChannelHandle InChannel, FKeyHandle KeyHandle ) const	Get an editable key struct for the specified key	SequencerChannelInterface.h
virtual void PasteKeys_Raw ( FMovieSceneChannel* InChannel, UMovieSceneSection* Section, const FMovieSceneClipboardKeyTrack& KeyTrack, const FMovieSceneClipboardEnvironment& SrcEnvironment, const FSequencerPasteEnvironment& DstEnvironment, TArray< FKeyHandle >& OutPastedKeys ) const	Paste the specified key track into the specified channel	SequencerChannelInterface.h
virtual bool ShouldShowCurve_Raw ( const FMovieSceneChannel* Channel, UMovieSceneSection* InSection ) const	Whether this channel should draw a curve on its editor UI	SequencerChannelInterface.h
virtual bool SupportsCurveEditorModels_Raw ( const FMovieSceneChannelHandle& InChannel ) const	Whether this channel supports curve models	SequencerChannelInterface.h