1. Epic GamesDeveloper
  3. FViewModel

FViewModel

Base class for a sequencer data model.

API > API/Editor > API/Editor/SequencerCore > API/Editor/SequencerCore/MVVM > API/Editor/SequencerCore/MVVM/ViewModels

Inheritance Hierarchy

References

   
Module SequencerCore
Header /Engine/Source/Editor/SequencerCore/Public/MVVM/ViewModels/ViewModel.h
Include #include "MVVM/ViewModels/ViewModel.h"

Syntax

class FViewModel :  
    public UE::Sequencer::ICastable,  
    public TSharedFromThis< FViewModel >,  
    public UE::Sequencer::FDynamicExtensionContainer

Remarks

Base class for a sequencer data model. This might wrap an underlying UObject, or be a purely logical construct for the sequencer UI.

WARNING: most of the casting and hierarchy related methods are not safe to call from a sub-class' constructor because they rely on shared-pointers to be available for `this_.

Variables

  Type Name Description
Public variable FAutoRegisterTypeTable AutoRegisterTypeTable  
Public variable static::UE::Sequencer::TAutoRegisterViewModelTypeID< FViewModel > ID  

Constructors

  Type Name Description
Public function   Builds a new data model
Public function  

FViewModel ( const FViewModel&
)

  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function T &

AddDynamicExtension ( const TViewModelTypeID< T >& TypeID,
InArgTypes&&... Args
)

 Adds a dynamic extension to this data model
Public function T &

AddDynamicExtension ( InArgTypes&&... Args
)

 Adds a dynamic extension to this data model
Public function Const TViewModelPtr< T > Gets the parent data model
Public function TViewModelPtr< T > Casts this data model to an extension, or to a child class implementation
Public function Const TViewModelPtr< const T > Casts this data model to an extension, or to a child class implementation
Public function TSharedPtr< T > Casts this data model to an extension, or to a child class implementation
Public function Const TSharedPtr< const T > Casts this data model to an extension, or to a child class implementation
Public function void Unlinks the head of the children list
Public function Const TViewModelPtr< T >

FindAncestorOfType ( bool bIncludeThis
)

 Finds the first ancestor view model that implements the given type.
Public function Const FViewModelPtr

FindAncestorOfType ( FViewModelTypeID Type,
bool bIncludeThis
)

 Finds a parent data model of a given type among the ancestry of this data model.
Public function Const FViewModelPtr

FindAncestorOfTypes ( TArrayView< const FViewModelTypeID > Types,
bool bIncludeThis
)

 Finds a parent data model that supports all the given interface types among the ancestry of this data model.
Public function TOptional< FViewModelChildren > Retrieve the first child list that matches the specified type (if any)
Public function Const FParentModelIterator

GetAncestors ( bool bIncludeThis
)

 Iterates over the ancestry of this data model.
Public function Const TParentModelIterator< T >

GetAncestorsOfType ( bool bIncludeThis
)

 Iterates over all ancestors of a given time along the ancestry of this data model.
Public function FViewModelChildren Retrieve the first child list that matches the specified type. Asserts on failure.
Public function Const FViewModelListIterator Gets an iterator for the data model's default children list
Protected function FViewModelChildren Retrieve the children for the specified child list head
Public function Const TViewModelListIterator< T > Gets children of a given type from the view-model's children lists, or the specified list
Public function Const FParentFirstChildIterator

GetDescendants ( bool bIncludeThis,
EViewModelListType InFilter
)

 Gets all children and their descendants in the hierarchy below this data model.
Public function Const void Gets all children and descendants of a given type in the hierarchy below this data model.
Public function Const TParentFirstChildIterator< T >

GetDescendantsOfType ( bool bIncludeThis,
EViewModelListType InFilter
)

 Gets all children and descendants of a given type in the hierarchy below this data model.
Public function Const int32 Gets the hierarchical depth of this data model, i.e. the number of levels to the top-most parent.
Public function Const TSharedPtr< FViewModel > Gets the next sibling of this data model in the children list it belongs to
Public function Const FViewModelPtr Gets the parent data model
Public function Const TSharedPtr< FViewModel > Gets the next sibling of this data model in the children list it belongs to
Public function Const FViewModelPtr

GetRoot ()

 Returns the root model of the hierarchy, i.e. the parent model that has no parent
Public function Const TSharedPtr< FSharedViewModelData >  
Public function Const bool Returns whether this model has any children in any of its child lists
Public function Const bool  
Protected function void Chain a new children list to the existing children lists
Public function Static void  
Public function void Remove this model from its parent
Public function void  

Operators

  Type Name Description
Public function FViewModel &

operator= ( const FViewModel&
)

  

Enums

  Type Name Description
Private enum ESetParentResult    

Typedefs

Name Description
Implements  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page