TSelectionSetBase

Typed selection set for keeping track of an externally provided key type KeyType is what is stored within the selection set (ie, an FObjectKey, TWeakPtr or int32) MixinType is the type of the derived class.

API > API/Editor > API/Editor/SequencerCore > API/Editor/SequencerCore/MVVM > API/Editor/SequencerCore/MVVM/Selection

Inheritance Hierarchy

References

   
Module SequencerCore
Header /Engine/Source/Editor/SequencerCore/Public/MVVM/Selection/SequencerCoreSelectionIterators.h
Include #include "MVVM/Selection/SequencerCoreSelectionIterators.h"
Source /Engine/Source/Editor/SequencerCore/Public/MVVM/Selection/SequencerCoreSelectionTypes.h

Syntax

template<typename MixinType, typename KeyType>  
class TSelectionSetBase : public UE::Sequencer::FSelectionBase

Remarks

Typed selection set for keeping track of an externally provided key type KeyType is what is stored within the selection set (ie, an FObjectKey, TWeakPtr or int32) MixinType is the type of the derived class. This allows for compile-time injection of OnSelect/OnDeselect behavior without needing virtual function calls: bool OnSelectItem(const KeyType&){ return true; } void OnDeselectItem(const KeyType&){}

Example implementation: class FMySelection : TSelectionSetBase { public: // Both these functions are optional: bool OnSelectItem(uint32 In){ return In != 0; } void OnDeselectItem(uint32){} };

Iteration is supported for all types (weak ptrs are skipped and iterated as shared pointers): class FMySelection : TSelectionSetBase{}; FMySelection& Selection = ...; for (FViewModelPtr ViewModel : Selection) { //...; }

// Filtered iteration is also supported for TWeakViewModelPtr<> types: for (TViewModelPtr Outliner : Selection.Filter()) { // Only viewmodels that implement the IOutlinerExtension will be iterated }

Variables

  Type Name Description
Protected variable TSet< KeyType > SelectionSet  

Functions

  Type Name Description
Public function Const TSelectionSetIteratorState< KeyType >

begin ()

 Ranged-for iteration support. Do not use directly
Public function void

Deselect ( KeyType InKey
)

 Deselect an item
Public function void

Empty ()

 Empty this selection
Public function Const TSelectionSetIteratorState< KeyType >

end ()

  
Public function Const const TSet< KeyType > & Returns the underlying selection set (including potentially invalid items)
Public function Const bool

IsSelected ( KeyType InKey
)

 Check whether a given item is currently selected
Public function Const int32

Num ()

 Returns the number of selected items (including potentially invalid items)
Public function Static void

OnDeselectItem ( const KeyType&
)

  
Public function Static bool

OnSelectItem ( const KeyType&
)

 Fallback functions for use when derived classes do not implement them.
Public function void

RemoveByPredicate ( Filter&& InFilter
)

 * Remove all selected items that pass the specified filter
Public function void

ReplaceWith ( TSelectionSetBase< MixinType, KeyType >&& OtherSelection
)

 Replace this selection set with the contents from another
Public function void

Select ( KeyType InKey,
bool* OutNewlySelected
)

 Select a key, optionally supplying a boolean to receieve a value indicating whether it was already selected or not
Public function void

SelectRange ( RangeType Range,
bool* OutAnySelected
)

 Selects a range of keys, optionally supplying a boolean to receieve a value indicating whether any were newly selected or not

Overridden from FSelectionBase

  Type Name Description
Protected function Virtual void Abstract function for emptying this selection

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page