Navigation
API > API/Editor > API/Editor/Sequencer
Outliner model for a single decoration on a track or section. One instance is created per visible decoration (IMovieSceneChannelDecoration or IMovieSceneSectionProviderDecoration). For section-provider decorations, section models are hosted directly in the track area and channel items appear as outliner children. For channel decorations, FChannelGroupOutlinerModel instances are direct outliner children.
| Name | FDecorationOutlinerModel |
| Type | class |
| Header File | /Engine/Source/Editor/Sequencer/Public/MVVM/ViewModels/DecorationOutlinerModel.h |
| Include Path | #include "MVVM/ViewModels/DecorationOutlinerModel.h" |
Syntax
class FDecorationOutlinerModel :
public UE::Sequencer::FOutlinerItemModel ,
public UE::Sequencer::ISectionOwnerExtension ,
public ITrackAreaExtension,
public ILockableExtension,
public IDeletableExtension,
public UE::Sequencer::ITopLevelChannelHolderExtension ,
public IMutableExtension,
public IDeactivatableExtension
Inheritance Hierarchy
- BaseType → TOutlinerModelMixin → FOutlinerItemModel → FDecorationOutlinerModel
Implements Interfaces
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FDecorationOutlinerModel() |
MVVM/ViewModels/DecorationOutlinerModel.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| InDecoration | UMovieSceneDecorationContainerObject UObject * | MVVM/ViewModels/DecorationOutlinerModel.h | ||
| InDecorationContainer | UMovieSceneDecorationContainerObject * | MVVM/ViewModels/DecorationOutlinerModel.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bDecorationSignatureChanged | bool | MVVM/ViewModels/DecorationOutlinerModel.h | ||
| ChannelDecorationProxy | TSharedPtr< FMovieSceneChannelProxy > | Channel proxy for IMovieSceneChannelDecoration. Stored to keep channel handles valid. | MVVM/ViewModels/DecorationOutlinerModel.h | |
| DecorationSignature | FGuid | MVVM/ViewModels/DecorationOutlinerModel.h | ||
| DecoratorList | FViewModelListHead | Outliner children: channel groups for both section-provider and channel decorations. | MVVM/ViewModels/DecorationOutlinerModel.h | |
| SectionModelList | FViewModelListHead | Section models for section-provider decorations. Used for the track area display. | MVVM/ViewModels/DecorationOutlinerModel.h | |
| SignatureChangedHandle | FDelegateHandle | Handle for this decoration's on signature changed delegate. | MVVM/ViewModels/DecorationOutlinerModel.h | |
| TrackEditor | TSharedPtr< ISequencerTrackEditor > | MVVM/ViewModels/DecorationOutlinerModel.h | ||
| TrackedSectionChildModels | TArray< TWeakPtr< FViewModel > > | Tracks models (channel and category) added to section models so they can be removed during cleanup. | MVVM/ViewModels/DecorationOutlinerModel.h | |
| WeakDecoration | TWeakObjectPtr< UObject > | The specific decoration this model represents. | MVVM/ViewModels/DecorationOutlinerModel.h | |
| WeakDecorationContainer | TWeakObjectPtr< UMovieSceneDecorationContainerObject > | MVVM/ViewModels/DecorationOutlinerModel.h | ||
| WeakParentTrack | TWeakObjectPtr< UMovieSceneTrack > | MVVM/ViewModels/DecorationOutlinerModel.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TSharedRef< SWidget > BuildAddDecorationSubMenu
(
TSharedPtr< FEditorViewModel > EditorViewModel |
MVVM/ViewModels/DecorationOutlinerModel.h | ||
UObject * GetDecoration() |
Get the decoration object this model represents. Used for sidebar property display. | MVVM/ViewModels/DecorationOutlinerModel.h | |
TWeakObjectPtr< UMovieSceneDecorationContainerObject > GetDecorationContainer() |
MVVM/ViewModels/DecorationOutlinerModel.h | ||
bool NeedsReconstruct() |
Returns true if the decoration's state has changed since the last OnConstruct. | MVVM/ViewModels/DecorationOutlinerModel.h | |
void OnDecorationSignatureChanged() |
FViewModel Interface | MVVM/ViewModels/DecorationOutlinerModel.h | |
UE_SEQUENCER_DECLARE_CASTABLE_API
(
FDecorationOutlinerModel |
MVVM/ViewModels/DecorationOutlinerModel.h |
Public Virtual
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool CanDelete
(
FText* OutErrorMessage |
IDeletableExtension | MVVM/ViewModels/DecorationOutlinerModel.h | |
virtual TSharedPtr< SWidget > CreateOutlinerViewForColumn
(
const FCreateOutlinerViewParams& InParams, |
MVVM/ViewModels/DecorationOutlinerModel.h | ||
virtual void Delete() |
MVVM/ViewModels/DecorationOutlinerModel.h | ||
virtual const FSlateBrush * GetIconBrush() |
MVVM/ViewModels/DecorationOutlinerModel.h | ||
virtual FText GetLabel() |
MVVM/ViewModels/DecorationOutlinerModel.h | ||
virtual ELockableLockState GetLockState() |
ILockableExtension | MVVM/ViewModels/DecorationOutlinerModel.h | |
virtual FOutlinerSizing GetOutlinerSizing() |
IOutlinerExtension | MVVM/ViewModels/DecorationOutlinerModel.h | |
virtual FViewModelVariantIterator GetTopLevelChildTrackAreaModels() |
MVVM/ViewModels/DecorationOutlinerModel.h | ||
virtual FViewModelVariantIterator GetTrackAreaModelList() |
MVVM/ViewModels/DecorationOutlinerModel.h | ||
virtual FTrackAreaParameters GetTrackAreaParameters() |
ITrackAreaExtension | MVVM/ViewModels/DecorationOutlinerModel.h | |
virtual bool IsDeactivated() |
IDeactivatableExtension | MVVM/ViewModels/DecorationOutlinerModel.h | |
virtual bool IsDimmed() |
IOutlinerExtension | MVVM/ViewModels/DecorationOutlinerModel.h | |
virtual bool IsMuted() |
IMutableExtension | MVVM/ViewModels/DecorationOutlinerModel.h | |
virtual void OnConstruct() |
MVVM/ViewModels/DecorationOutlinerModel.h | ||
virtual void SetIsDeactivated
(
bool bInIsDeactivated |
MVVM/ViewModels/DecorationOutlinerModel.h | ||
virtual void SetIsLocked
(
bool bIsLocked |
MVVM/ViewModels/DecorationOutlinerModel.h | ||
virtual void SetIsMuted
(
bool bIsMuted |
MVVM/ViewModels/DecorationOutlinerModel.h |
Overridden from FOutlinerItemModelMixin
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void BuildContextMenu
(
FMenuBuilder& MenuBuilder |
FOutlinerItemModel | MVVM/ViewModels/DecorationOutlinerModel.h | |
virtual void BuildSidebarMenu
(
FMenuBuilder& MenuBuilder |
MVVM/ViewModels/DecorationOutlinerModel.h |
Overridden from ISectionOwnerExtension
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FViewModelChildren GetSectionModels() |
ISectionOwnerExtension | MVVM/ViewModels/DecorationOutlinerModel.h |
Overridden from ITopLevelChannelHolderExtension
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FViewModelChildren GetTopLevelChannels() |
ITopLevelChannelHolderExtension | MVVM/ViewModels/DecorationOutlinerModel.h |