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

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.

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

Syntax

struct ISequencerChannelInterface

Derived Classes

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~ISequencerChannelInterface()

   ISequencerChannelInterface.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

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

 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 ISequencerChannelInterface.h  

bool CanCreateKeyEditor_Raw ( const FMovieSceneChannel* Channel
) const

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

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

 Copy all the keys specified in KeyMask to the specified clipboard ISequencerChannelInterface.h  

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 ISequencerChannelInterface.h  

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 ISequencerChannelInterface.h  

TUniquePtr< FCurveModel > CreateCurveEditorModel_Raw ( const FMovieSceneChannelHandle& Channel,
const UE::Sequencer::FCreateCurveEditorModelParams& Params
) const

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

TSharedRef< SWidget > CreateKeyEditor_Raw ( const FMovieSceneChannelHandle& Channel,
const UE::Sequencer::FCreateKeyEditorParams& Params
) const

 Create an editor on the sequencer node tree ISequencerChannelInterface.h  

void DeleteKeys_Raw ( FMovieSceneChannel* Channel,
TArrayView< const FKeyHandle > InHandles,
FFrameNumber InTime
) const

 Delete the specified keys. ISequencerChannelInterface.h  

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 ISequencerChannelInterface.h  

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

 Gather information on how to draw the specified keys ISequencerChannelInterface.h  

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

 Extend the key context menu ISequencerChannelInterface.h  

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

 Extend the section context menu ISequencerChannelInterface.h  

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 ISequencerChannelInterface.h  

virtual EMovieSceneKeyInterpolation GetInterpolationMode_Raw ( FMovieSceneChannel* InChannel,
FFrameNumber InTime,
EMovieSceneKeyInterpolation InDefaultMode
) const

 Retrieve the interpolation mode for this curve at the current time ISequencerChannelInterface.h  

TSharedPtr< FStructOnScope > GetKeyStruct_Raw ( FMovieSceneChannelHandle Channel,
FKeyHandle KeyHandle
) const

 Get an editable key struct for the specified key ISequencerChannelInterface.h  

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

 Paste the specified key track into the specified channel ISequencerChannelInterface.h  

bool ShouldShowCurve_Raw ( const FMovieSceneChannel* Channel,
UMovieSceneSection* InSection
) const

 Whether this channel should draw a curve on its editor UI ISequencerChannelInterface.h  

bool SupportsCurveEditorModels_Raw ( const FMovieSceneChannelHandle& InChannel
) const

 Whether this channel supports curve models ISequencerChannelInterface.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page