Navigation
API > API/Editor > API/Editor/SequencerCore
This represents to root view-model for a sequencer-like editor.
This view-model assumes that the editor includes at least an outliner area and a track area. Other panels in the editor can be added to the list of panels.
The data being edited is represented by a root view-model which doesn't change: if the editor needs to edit a different piece of data, this should change inside the root view-model, and call the necessary code to refresh the entire view-model hierarchy. Note that this root view-model is not parented under the editor view-model.
| Name | FEditorViewModel |
| Type | class |
| Header File | /Engine/Source/Editor/SequencerCore/Public/MVVM/ViewModels/EditorViewModel.h |
| Include Path | #include "MVVM/ViewModels/EditorViewModel.h" |
Syntax
class FEditorViewModel : public UE::Sequencer::FViewModel
Inheritance Hierarchy
- FDynamicExtensionContainer → FViewModel → FEditorViewModel
- FSharedFromThisBase → TSharedFromThis → FViewModel → FEditorViewModel
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FEditorViewModel() |
Builds a new editor view model. | MVVM/ViewModels/EditorViewModel.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FEditorViewModel() |
Destroys this editor view model. | MVVM/ViewModels/EditorViewModel.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| Implements | ::UE::Sequencer::TImplements< FViewModel > | MVVM/ViewModels/EditorViewModel.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AutoRegisterTypeTable | ::UE::Sequencer::ICastable::FAutoRegisterTypeTable | MVVM/ViewModels/EditorViewModel.h | ||
| ID | ::UE::Sequencer::TAutoRegisterViewModelTypeID< FEditorViewModel > | MVVM/ViewModels/EditorViewModel.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Outliner | TSharedPtr< FOutlinerViewModel > | Cached pointer to the outliner panel view-model | MVVM/ViewModels/EditorViewModel.h | |
| PanelList | FViewModelListHead | List of panel view-models for this editor | MVVM/ViewModels/EditorViewModel.h | |
| RootDataModel | TSharedPtr< FViewModel > | The root view-model for the data being edited | MVVM/ViewModels/EditorViewModel.h | |
| ScriptingLayer | TStrongObjectPtr< USequencerScriptingLayer > | Cached pointer to the scripting layer class | MVVM/ViewModels/EditorViewModel.h | |
| Selection | TSharedPtr< FSequencerCoreSelection > | Cached pointer to the selection class | MVVM/ViewModels/EditorViewModel.h | |
| TrackArea | TSharedPtr< FTrackAreaViewModel > | Cached pointer to the track area panel view-model | MVVM/ViewModels/EditorViewModel.h | |
| ViewDensity | FViewDensityInfo | This editor's current view density defining how condensed the elements appear | MVVM/ViewModels/EditorViewModel.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FViewModelChildren GetEditorPanels() |
Gets the editor panels' view models. | MVVM/ViewModels/EditorViewModel.h | |
TSharedPtr< FOutlinerViewModel > GetOutliner() |
Gets the outliner view-model. | MVVM/ViewModels/EditorViewModel.h | |
FViewModelPtr GetRootModel() |
Gets the root view-model of the sequence being edited. | MVVM/ViewModels/EditorViewModel.h | |
USequencerScriptingLayer * GetScriptingLayer() |
Gets the scripting layer | MVVM/ViewModels/EditorViewModel.h | |
TSharedPtr< FSequencerCoreSelection > GetSelection() |
Gets the selection class | MVVM/ViewModels/EditorViewModel.h | |
TSharedPtr< FTrackAreaViewModel > GetTrackArea() |
Gets the track area view-model. | MVVM/ViewModels/EditorViewModel.h | |
FViewDensityInfo GetViewDensity() |
Returns the current view density for this editor | MVVM/ViewModels/EditorViewModel.h | |
void InitializeEditor() |
Initializes the outliner and track-area for this editor. | MVVM/ViewModels/EditorViewModel.h | |
bool IsEditable() |
Returns the inverse of read-only - useful for direct bindings to IsEnabled for widgets | MVVM/ViewModels/EditorViewModel.h | |
virtual bool IsReadOnly() |
Returns whether this editor is currently read-only | MVVM/ViewModels/EditorViewModel.h | |
void SetViewDensity
(
const FViewDensityInfo& InViewDensity |
Returns the current view density for this editor | MVVM/ViewModels/EditorViewModel.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual TSharedPtr< FOutlinerViewModel > CreateOutlinerImpl() |
Creates the outliner for this editor. | MVVM/ViewModels/EditorViewModel.h | |
virtual TSharedPtr< FViewModel > CreateRootModelImpl() |
Creates the root data model for this editor. | MVVM/ViewModels/EditorViewModel.h | |
virtual USequencerScriptingLayer * CreateScriptingLayerImpl() |
Creates the scripting layer class for this editor. | MVVM/ViewModels/EditorViewModel.h | |
virtual TSharedPtr< FSequencerCoreSelection > CreateSelectionImpl() |
Creates the selection class for this editor. | MVVM/ViewModels/EditorViewModel.h | |
virtual TSharedPtr< FTrackAreaViewModel > CreateTrackAreaImpl() |
Creates the track-area for this editor. | MVVM/ViewModels/EditorViewModel.h | |
virtual void InitializeEditorImpl() |
Creates any other panels for this editor. | MVVM/ViewModels/EditorViewModel.h | |
virtual void PreInitializeEditorImpl() |
Initializes this view model before panels and root models are created | MVVM/ViewModels/EditorViewModel.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static EViewModelListType GetEditorPanelType() |
Children type for editor panels | MVVM/ViewModels/EditorViewModel.h | |
static void RegisterTypeID() |
MVVM/ViewModels/EditorViewModel.h |