ISequencerDecorationEditor

Editor-side counterpart for section decorations.

API > API/Editor > API/Editor/Sequencer

Editor-side counterpart for section decorations. Created per-Sequencer via FOnCreateDecorationEditor factories registered through ISequencerModule, so each FSequencer instance owns its own decoration editors and ticks them directly (mirroring ISequencerTrackEditor).

Decoration editors create section interfaces for decorations that provide their own sections (via IMovieSceneSectionProviderDecoration), add entries to section context menus, and provide custom key editor and keyframe widgets for decoration channels.

Example registration in an editor module's StartupModule():

class FMyDecorationEditor : public ISequencerDecorationEditor { virtual UClass* GetDecorationClass() const override { return UMyDecoration::StaticClass(); } virtual TSharedPtr MakeSectionInterface(...) override { return MakeShared(...); } };

ISequencerModule& Module = FModuleManager::LoadModuleChecked("Sequencer"); Module.RegisterDecorationEditor(FOnCreateDecorationEditor::CreateLambda( { return MakeShared(InSequencer); }));

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

Syntax

class ISequencerDecorationEditor

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~ISequencerDecorationEditor()

   ISequencerDecorationEditor.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

UClass * GetDecorationClass()

 Get the decoration class this editor handles. Used to match decorations to their editors. ISequencerDecorationEditor.h  

Public Virtual

Name Remarks Include Path Unreal Specifiers

virtual FKeyHandle AddOrUpdateKey ( UObject& Decoration,
UMovieSceneSection& Section,
FMovieSceneChannelHandle ChannelHandle,
FFrameNumber Time,
const FGuid& ObjectBindingID,
ISequencer& InSequencer
)

 Add or update a key on a decoration-owned channel. ISequencerDecorationEditor.h  

virtual void BuildSectionContextMenu ( FMenuBuilder& MenuBuilder,
UMovieSceneSection& Section,
UObject& Decoration,
const FGuid& ObjectBinding,
TWeakPtr< ISequencer > Sequencer
)

 Add entries to the section's right-click context menu on behalf of this decoration. ISequencerDecorationEditor.h  

virtual TSharedPtr< SWidget > CreateKeyEditor ( UObject& Decoration,
UMovieSceneSection& Section,
FMovieSceneChannelHandle ChannelHandle,
TWeakPtr< ISequencer > Sequencer,
const FGuid& ObjectBindingID
)

 Optionally create a custom key editor widget for one of this decoration's channels. ISequencerDecorationEditor.h  

virtual TSharedPtr< SWidget > CreateKeyFrameWidget ( UObject& Decoration,
UMovieSceneSection& Section,
FMovieSceneChannelHandle ChannelHandle,
TWeakPtr< ISequencer > Sequencer,
const FGuid& ObjectBindingID,
TSharedPtr< UE::Sequencer::FViewModel > ChannelGroupModel
)

 Optionally create a custom widget for the KeyFrame outliner column (the "add key" button) for one of this decoration's channels. ISequencerDecorationEditor.h  

virtual TSharedPtr< SWidget > CreateOutlinerWidget ( UObject& Decoration,
TWeakPtr< ISequencer > Sequencer
)

 Create a custom widget for the decoration's outliner row (e.g. an asset picker dropdown). ISequencerDecorationEditor.h  

virtual const FSlateBrush * GetIconBrush()

   ISequencerDecorationEditor.h  

virtual FSlateIcon GetMenuIcon()

   ISequencerDecorationEditor.h  

virtual TSharedPtr< ISequencerSection > MakeSectionInterface ( UMovieSceneSection& Section,
UMovieSceneTrack& OwningTrack,
FGuid ObjectBinding
)

 Create a section interface for a section provided by this decoration. ISequencerDecorationEditor.h  

virtual void OnSectionInterfaceCreated ( UMovieSceneSection& Section,
UObject& Decoration,
TWeakPtr< ISequencer > Sequencer
)

 Called when a section model is first created for a section that has this decoration. ISequencerDecorationEditor.h  

virtual void Tick ( float DeltaTime
)

 Called once per Sequencer tick on every registered decoration editor. ISequencerDecorationEditor.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page