UTypedElementSelectionSet

A wrapper around an element list that ensures mutation goes via the selection interfaces, as well as providing some utilities for batching operations.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UTypedElementSelectionSet

References

Module	TypedElementRuntime
Header	/Engine/Source/Runtime/TypedElementRuntime/Public/Elements/Framework/TypedElementSelectionSet.h
Include	#include "Elements/Framework/TypedElementSelectionSet.h"

Syntax

class UTypedElementSelectionSet :
public UObject,
public TTypedElementInterfaceCustomizationRegistry< FTypedElementSelectionCustomization >

Remarks

A wrapper around an element list that ensures mutation goes via the selection interfaces, as well as providing some utilities for batching operations.

Variables

		Name	Description
	FOnPreChangeDyn...	OnPreSelectionChange	Delegate that is invoked whenever the underlying element list is potentially about to change.
	FOnChangeDynami...	OnSelectionChange	Delegate that is invoked whenever the underlying element list has been changed.

Constructors

	Name	Description
	UTypedElementSelectionSet()

Functions

	Name	Description
bool	AllowSelectionModifiers ( const FTypedElementHandle& InEleme... )	Test to see whether selection modifiers (Ctrl or Shift) are allowed while selecting this element.
bool	CanDeselectElement ( const FTypedElementHandle& InEleme..., const FTypedElementSelectionOptions... )	Test to see whether the given element can be deselected.
bool	CanSelectElement ( const FTypedElementHandle& InEleme..., const FTypedElementSelectionOptions... )	Test to see whether the given element can be selected.
bool	ClearSelection ( const FTypedElementSelectionOptions... )	Clear the current selection.
int32	CountSelectedElements ( const TSubclassOf< UInterface > InB... )	Count the number of selected elements, optionally filtering to elements that implement the given interface.
int32	CountSelectedObjects()	Count the number of selected objects.
int32	CountSelectedObjects ( const UClass* InRequiredClass )	Count the number of selected objects.
bool	DeselectElement ( const FTypedElementHandle& InEleme..., const FTypedElementSelectionOptions... )	Attempt to deselect the given element.
bool	DeselectElements ( FTypedElementListConstRef InElement..., const FTypedElementSelectionOptions... )	Attempt to deselect the given elements.
bool	DeselectElements ( TArrayView< const FTypedElementHand..., const FTypedElementSelectionOptions... )	Attempt to deselect the given elements.
bool	DeselectElements ( const TArray< FTypedElementHandle >..., const FTypedElementSelectionOptions... )	Attempt to deselect the given elements.
void	ForEachSelectedElement ( TFunctionRef< bool... )	Enumerate the selected elements that implement the given interface.
void	ForEachSelectedElementHandle ( TFunctionRef< bool..., const TSubclassOf< UInterface >& I... )	Enumerate the handle of every selected element, optionally filtering to elements that implement the given interface.
void	ForEachSelectedObject ( TFunctionRef< bool)> ..., const UClass InRequiredClass )	Enumerate the selected objects from the currently selected elements.
void	ForEachSelectedObject ( TFunctionRef< bool(RequiredClassTyp... )	Enumerate the selected objects from the currently selected elements.
TTypedElemen...	GetBottomSelectedElement ( TFunctionRef< bool... )	Get the last element that implement the given interface and pass the predicate.
TTypedElemen...	GetBottomSelectedElement()	Get the last selected element implementing the given interface.
RequiredClas...	GetBottomSelectedObject()	Get the last selected object of the given type.
UObject *...	GetBottomSelectedObject ( const UClass* InRequiredClass )	Get the last selected object of the given type.
FTypedElemen...	GetCurrentSelectionState()	Serializes the current selection set.
FTypedElemen...	GetElementList()	Get the underlying element list holding the selection state.
FTypedElemen...	GetNormalizedElementList ( FTypedElementListConstRef InElement..., const FTypedElementSelectionNormali... )	Get a normalized version of the given element list that can be used to perform operations like gizmo manipulation, deletion, copying, etc.
void	GetNormalizedElementList ( FTypedElementListConstRef InElement..., const FTypedElementSelectionNormali..., FTypedElementListRef OutNormalizedE... )	Get a normalized version of the given element list that can be used to perform operations like gizmo manipulation, deletion, copying, etc.
void	GetNormalizedSelection ( const FTypedElementSelectionNormali..., FTypedElementListRef OutNormalizedE... )	Get a normalized version of this selection set that can be used to perform operations like gizmo manipulation, deletion, copying, etc.
FTypedElemen...	GetNormalizedSelection ( const FTypedElementSelectionNormali... )	Get a normalized version of this selection set that can be used to perform operations like gizmo manipulation, deletion, copying, etc.
int32	GetNumSelectedElements()	Get the number of selected elements.
FTypedElemen...	GetScopedClearNewPendingChange()	Get a scoped object that when destroyed it clear a pending change notification without emitting the notification if it happened during its lifecycle.
void	GetSelectedElementHandles ( TArray< FTypedElementHandle, ArrayA..., const TSubclassOf< UInterface >& I... )	Get the handle of every selected element, optionally filtering to elements that implement the given interface.
TArray< FTyp...	GetSelectedElementHandles ( const TSubclassOf< UInterface > InB... )	Get the handle of every selected element, optionally filtering to elements that implement the given interface.
TArray< UObj...	GetSelectedObjects ( const UClass* InRequiredClass )	Get the array of selected objects from the currently selected elements.
TArray< Requ...	GetSelectedObjects()	Get the array of selected objects from the currently selected elements.
FTypedElemen...	GetSelectionElement ( const FTypedElementHandle& InEleme..., const ETypedElementSelectionMethod ... )	Given an element, return the element that should actually perform a selection operation.
TTypedElemen...	GetTopSelectedElement()	Get the first selected element implementing the given interface.
TTypedElemen...	GetTopSelectedElement ( TFunctionRef< bool... )	Get the first element that implement the given interface and pass the predicate A function that should return true when the element is desirable
RequiredClas...	GetTopSelectedObject()	Get the first selected object of the given type.
UObject *...	GetTopSelectedObject ( const UClass* InRequiredClass )	Get the first selected object of the given type.
bool	HasSelectedElements ( const TSubclassOf< UInterface > InB... )	Test whether there selected elements, optionally filtering to elements that implement the given interface.
bool	HasSelectedObjects()	Test whether there are any selected objects.
bool	HasSelectedObjects ( const UClass* InRequiredClass )	Test whether there are any selected objects.
bool	IsElementSelected ( const FTypedElementHandle& InEleme..., const FTypedElementIsSelectedOption... )	Test to see whether the given element is currently considered selected.
FTypedElemen...	Legacy_GetElementListSync()	Access the interface to allow external systems (such as USelection) to receive immediate sync notifications as the underlying element list is changed.
FTypedElemen...	Legacy_GetElementListSyncPtr()	Access the interface to allow external systems (such as USelection) to receive immediate sync notifications as the underlying element list is changed.
void	NotifyPendingChanges()	Invoke the delegate called whenever the underlying element list has been changed.
FOnChanged &	OnChanged()
FOnPreChange...	OnPreChange()
void	RestoreSelectionState ( const FTypedElementSelectionSetStat... )	Restores the selection set from the given state.
bool	SelectElement ( const FTypedElementHandle& InEleme..., const FTypedElementSelectionOptions... )	Attempt to select the given element.
bool	SelectElements ( const TArray< FTypedElementHandle >..., const FTypedElementSelectionOptions... )	Attempt to select the given elements.
bool	SelectElements ( TArrayView< const FTypedElementHand..., const FTypedElementSelectionOptions... )	Attempt to select the given elements.
bool	SelectElements ( FTypedElementListConstRef InElement..., const FTypedElementSelectionOptions... )	Attempt to select the given elements.
bool	SetSelection ( const TArray< FTypedElementHandle >..., const FTypedElementSelectionOptions... )	Attempt to make the selection the given elements.
bool	SetSelection ( FTypedElementListConstRef InElement..., const FTypedElementSelectionOptions... )	Attempt to make the selection the given elements.
bool	SetSelection ( TArrayView< const FTypedElementHand..., const FTypedElementSelectionOptions... )	Attempt to make the selection the given elements.

Overridden from UObject

	Name	Description
void	BeginDestroy()	Called before destroying the object.
bool	Modify ( bool bAlwaysMarkDirty )	That the object will be modified.
void	PostEditUndo()	Called after applying a transaction to the object.
void	PreEditUndo()	Called before applying a transaction to the object.
void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Classes

	Name	Description
	FOnChanged	Access the delegate that is invoked whenever the underlying element list has been changed.
	FOnChangeDynamic
	FOnPreChange	Access the delegate that is invoked whenever the underlying element list is potentially about to change.
	FOnPreChangeDynamic