Navigation
API > API/Editor > API/Editor/SequencerCore
Core selection class that manages multiple different selection sets through FSelectionBase.
Implementers of this class should create a derived type that defines each of its selection sets by calling AddSelectionSet in its constructor. This enables a central implementation for event suppression and broadcast.
| Name | FSequencerCoreSelection |
| Type | class |
| Header File | /Engine/Source/Editor/SequencerCore/Public/MVVM/Selection/SequencerCoreSelection.h |
| Include Path | #include "MVVM/Selection/SequencerCoreSelection.h" |
Syntax
class FSequencerCoreSelection : public TSharedFromThis< FSequencerCoreSelection >
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → FSequencerCoreSelection
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FSequencerCoreSelection() |
Protected constructor - to be implemented by a derived class | MVVM/Selection/SequencerCoreSelection.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FSequencerCoreSelection() |
MVVM/Selection/SequencerCoreSelection.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| OnChanged | FSimpleMulticastDelegate | Event that is broadcast when any selection state inside this class has changed & after all scoped suppressors have been destroyed | MVVM/Selection/SequencerCoreSelection.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bTriggeringSelectionEvents | bool | Boolean to guard against re-entrancy when triggering selection events | MVVM/Selection/SequencerCoreSelection.h | |
| FSelectionBase | friend | MVVM/Selection/SequencerCoreSelection.h | ||
| FSelectionEventSuppressor | friend | MVVM/Selection/SequencerCoreSelection.h | ||
| ScopedSuppressionCount | int32 | The number of outstanding scoped event suppression objects. | MVVM/Selection/SequencerCoreSelection.h | |
| SelectionSets | TArray< FSelectionBase * > | Array of registered selection sets (contained in a derived type), registerd thorugh AddSelectionSet | MVVM/Selection/SequencerCoreSelection.h | |
| SerialNumber | uint32 | A monotonically increasing integer that changes whenever anything within this selection is changed | MVVM/Selection/SequencerCoreSelection.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Empty() |
Empty all the selection states within this selection class | MVVM/Selection/SequencerCoreSelection.h | |
virtual TSharedPtr< FOutlinerSelection > GetOutlinerSelection () |
MVVM/Selection/SequencerCoreSelection.h | ||
virtual TSharedPtr< const FOutlinerSelection > GetOutlinerSelection () |
MVVM/Selection/SequencerCoreSelection.h | ||
uint32 GetSerialNumber() |
Retrieve the serial number that identifies this selection's state. | MVVM/Selection/SequencerCoreSelection.h | |
bool IsTriggeringSelectionChangedEvents() |
Check whether this selection is currently broadcasting its selection changed events | MVVM/Selection/SequencerCoreSelection.h | |
FSelectionEventSuppressor SuppressEvents() |
Retrieve a scoped object that will suppress selection events for the duration of its lifetime on the stack | MVVM/Selection/SequencerCoreSelection.h | |
| Retrieve a scoped object that will suppress selection events for the duration of its lifetime. | MVVM/Selection/SequencerCoreSelection.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddSelectionSet
(
FSelectionBase* InSelection |
Add a selection set to this class - selection set should be a member of the derived implementation of this class so as to ensure its lifetime matches this owner | MVVM/Selection/SequencerCoreSelection.h |