1. Epic GamesDeveloper
  3. UTypedElementSelectionSet

UTypedElementSelectionSet

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

API > API/Runtime > API/Runtime/TypedElementRuntime

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

   
Name UTypedElementSelectionSet
Type class
Header File /Engine/Source/Runtime/TypedElementRuntime/Public/Elements/Framework/TypedElementSelectionSet.h
Include Path #include "Elements/Framework/TypedElementSelectionSet.h"

Syntax

UCLASS (Transient, BlueprintType, Meta=(DontUseGenericSpawnObject="True"), MinimalAPI)  
class UTypedElementSelectionSet :  
    public UObject ,  
    public TTypedElementInterfaceCustomizationRegistry< FTypedElementSelectionCustomization >

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UTypedElementSelectionSet()

   Elements/Framework/TypedElementSelectionSet.h  

Classes

Name Remarks
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  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
OnPreSelectionChange FOnPreChangeDynamic Delegate that is invoked whenever the underlying element list is potentially about to change. Elements/Framework/TypedElementSelectionSet.h
  • BlueprintAssignable
  • Category="TypedElementFramework|Selection"
OnSelectionChange FOnChangeDynamic Delegate that is invoked whenever the underlying element list has been changed. Elements/Framework/TypedElementSelectionSet.h
  • BlueprintAssignable
  • Category="TypedElementFramework|Selection"

Protected

Name Type Remarks Include Path Unreal Specifiers
bIsRestoringState bool Set when we are currently restoring the selection state (eg, from an undo/redo) Elements/Framework/TypedElementSelectionSet.h  
ElementList FTypedElementListPtr Underlying element list holding the selection state. Elements/Framework/TypedElementSelectionSet.h  
ListNameForTedsIntegration FName   Elements/Framework/TypedElementSelectionSet.h  
OnChangedDelegate FOnChanged Delegate that is invoked whenever the underlying element list has been changed. Elements/Framework/TypedElementSelectionSet.h  
OnPreChangeDelegate FOnPreChange Delegate that is invoked whenever the underlying element list is potentially about to change. Elements/Framework/TypedElementSelectionSet.h  
PendingUndoRedoState TUniquePtr< FTypedElementSelectionSetState > Set between a PreEditUndo->PostEditUndo call. Elements/Framework/TypedElementSelectionSet.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool AllowSelectionModifiers ( const FScriptTypedElementHandle& InElementHandle
) const

 Test to see whether selection modifiers (Ctrl or Shift) are allowed while selecting this element. Elements/Framework/TypedElementSelectionSet.h
  • BlueprintPure
  • Category="TypedElementFramework|Selection"

bool AllowSelectionModifiers ( const FTypedElementHandle& InElementHandle
) const

 Test to see whether selection modifiers (Ctrl or Shift) are allowed while selecting this element. Elements/Framework/TypedElementSelectionSet.h  

bool CanDeselectElement ( const FScriptTypedElementHandle& InElementHandle,
const FTypedElementSelectionOptions InSelectionOptions
) const

 Test to see whether the given element can be deselected. Elements/Framework/TypedElementSelectionSet.h
  • BlueprintPure
  • Category="TypedElementFramework|Selection"

bool CanDeselectElement ( const FTypedElementHandle& InElementHandle,
const FTypedElementSelectionOptions InSelectionOptions
) const

 Test to see whether the given element can be deselected. Elements/Framework/TypedElementSelectionSet.h  

bool CanSelectElement ( const FScriptTypedElementHandle& InElementHandle,
const FTypedElementSelectionOptions InSelectionOptions
) const

 Test to see whether the given element can be selected. Elements/Framework/TypedElementSelectionSet.h
  • BlueprintPure
  • Category="TypedElementFramework|Selection"

bool CanSelectElement ( const FTypedElementHandle& InElementHandle,
const FTypedElementSelectionOptions InSelectionOptions
) const

 Test to see whether the given element can be selected. Elements/Framework/TypedElementSelectionSet.h  

bool ClearSelection ( const FTypedElementSelectionOptions InSelectionOptions
)

 Clear the current selection. Elements/Framework/TypedElementSelectionSet.h
  • BlueprintCallable
  • Category="TypedElementFramework|Selection"

int32 CountSelectedElements ( const TSubclassOf< UInterface > InBaseInterfaceType
) const

 Count the number of selected elements, optionally filtering to elements that implement the given interface. Elements/Framework/TypedElementSelectionSet.h
  • BlueprintCallable
  • BlueprintPure=false
  • Category="TypedElementFramework|Selection"

int32 CountSelectedObjects ( const UClass* InRequiredClass
) const

 Count the number of selected objects. Elements/Framework/TypedElementSelectionSet.h
  • BlueprintCallable
  • BlueprintPure=false
  • Category="TypedElementFramework|Selection"
Count the number of selected objects. Elements/Framework/TypedElementSelectionSet.h  

bool DeselectElement ( const FTypedElementHandle& InElementHandle,
const FTypedElementSelectionOptions InSelectionOptions
)

 Attempt to deselect the given element. Elements/Framework/TypedElementSelectionSet.h  

bool DeselectElement ( const FScriptTypedElementHandle& InElementHandle,
const FTypedElementSelectionOptions InSelectionOptions
)

 Attempt to deselect the given element. Elements/Framework/TypedElementSelectionSet.h
  • BlueprintCallable
  • Category="TypedElementFramework|Selection"

bool DeselectElements ( FTypedElementListConstRef InElementList,
const FTypedElementSelectionOptions InSelectionOptions
)

   Elements/Framework/TypedElementSelectionSet.h  

bool DeselectElements ( const TArray< FTypedElementHandle >& InElementHandles,
const FTypedElementSelectionOptions InSelectionOptions
)

 Attempt to deselect the given elements. Elements/Framework/TypedElementSelectionSet.h  

bool DeselectElements ( TArrayView< const FTypedElementHandle > InElementHandles,
const FTypedElementSelectionOptions InSelectionOptions
)

   Elements/Framework/TypedElementSelectionSet.h  

bool DeselectElements ( const TArray< FScriptTypedElementHandle >& InElementHandles,
const FTypedElementSelectionOptions InSelectionOptions
)

 Attempt to deselect the given elements. Elements/Framework/TypedElementSelectionSet.h
  • BlueprintCallable
  • Category="TypedElementFramework|Selection"

void ForEachSelectedElement ( TFunctionRef< bool(const TTypedElement< BaseInterfaceType >&)> InCallback
) const

 Enumerate the selected elements that implement the given interface. Elements/Framework/TypedElementSelectionSet.h  

void ForEachSelectedElementHandle ( TFunctionRef< bool(const FTypedElementHandle&)> InCallback,
const TSubclassOf< UInterface >& InBaseInterfaceType
) const

 Enumerate the handle of every selected element, optionally filtering to elements that implement the given interface. Elements/Framework/TypedElementSelectionSet.h  

void ForEachSelectedObject ( TFunctionRef< bool(UObject*)> InCallback,
const UClass* InRequiredClass
) const

 Enumerate the selected objects from the currently selected elements. Elements/Framework/TypedElementSelectionSet.h  

void ForEachSelectedObject ( TFunctionRef< bool(RequiredClassType*)> InCallback
) const

 Enumerate the selected objects from the currently selected elements. Elements/Framework/TypedElementSelectionSet.h  

TTypedElement< BaseInterfaceType > GetBottomSelectedElement ()

 Get the last selected element implementing the given interface. Elements/Framework/TypedElementSelectionSet.h  

TTypedElement< BaseInterfaceType > GetBottomSelectedElement ( TFunctionRef< bool(const TTypedElement< BaseInterfaceType >&)> Predicate
) const

 Get the last element that implement the given interface and pass the predicate. Elements/Framework/TypedElementSelectionSet.h  

RequiredClassType * GetBottomSelectedObject ()

 Get the last selected object of the given type. Elements/Framework/TypedElementSelectionSet.h  

UObject * GetBottomSelectedObject ( const UClass* InRequiredClass
) const

 Get the last selected object of the given type. Elements/Framework/TypedElementSelectionSet.h
  • BlueprintPure
  • Category="TypedElementFramework|Selection"
Serializes the current selection set. Elements/Framework/TypedElementSelectionSet.h
  • BlueprintPure
  • Category="TypedElementFramework|Selection"

FTypedElementListConstRef GetElementList()

 Get the underlying element list holding the selection state. Elements/Framework/TypedElementSelectionSet.h  

FTypedElementListRef GetNormalizedElementList ( FTypedElementListConstRef InElementList,
const FTypedElementSelectionNormalizationOptions InNormalizationOptions
) const

 Get a normalized version of the given element list that can be used to perform operations like gizmo manipulation, deletion, copying, etc. Elements/Framework/TypedElementSelectionSet.h  

void GetNormalizedElementList ( FTypedElementListConstRef InElementList,
const FTypedElementSelectionNormalizationOptions& InNormalizationOptions,
FTypedElementListRef OutNormalizedElements
) const

   Elements/Framework/TypedElementSelectionSet.h  

void GetNormalizedSelection ( const FTypedElementSelectionNormalizationOptions& InNormalizationOptions,
FTypedElementListRef OutNormalizedElements
) const

   Elements/Framework/TypedElementSelectionSet.h  

FTypedElementListRef GetNormalizedSelection ( const FTypedElementSelectionNormalizationOptions InNormalizationOptions
) const

 Get a normalized version of this selection set that can be used to perform operations like gizmo manipulation, deletion, copying, etc. Elements/Framework/TypedElementSelectionSet.h  

int32 GetNumSelectedElements()

 Get the number of selected elements. Elements/Framework/TypedElementSelectionSet.h
  • BlueprintPure
  • Category="TypedElementFramework|Selection"

FTypedElementList::FScopedClearNewPendingChange GetScopedClearNewPendingChange()

 Get a scoped object that when destroyed it clear a pending change notification without emitting the notification if it happened during its lifecycle. Elements/Framework/TypedElementSelectionSet.h  

TArray< FTypedElementHandle > GetSelectedElementHandles ( const TSubclassOf< UInterface > InBaseInterfaceType
) const

 Get the handle of every selected element, optionally filtering to elements that implement the given interface. Elements/Framework/TypedElementSelectionSet.h  

void GetSelectedElementHandles ( TArray< FTypedElementHandle, ArrayAllocator >& OutArray,
const TSubclassOf< UInterface >& InBaseInterfaceType
) const

 Get the handle of every selected element, optionally filtering to elements that implement the given interface. Elements/Framework/TypedElementSelectionSet.h  

TArray< RequiredClassType * > GetSelectedObjects ()

 Get the array of selected objects from the currently selected elements. Elements/Framework/TypedElementSelectionSet.h  

TArray< UObject * > GetSelectedObjects ( const UClass* InRequiredClass
) const

 Get the array of selected objects from the currently selected elements. Elements/Framework/TypedElementSelectionSet.h
  • BlueprintCallable
  • BlueprintPure=false
  • Category="TypedElementFramework|Selection"

FTypedElementHandle GetSelectionElement ( const FTypedElementHandle& InElementHandle,
const ETypedElementSelectionMethod InSelectionMethod
) const

 Given an element, return the element that should actually perform a selection operation. Elements/Framework/TypedElementSelectionSet.h  
Given an element, return the element that should actually perform a selection operation. Elements/Framework/TypedElementSelectionSet.h
  • BlueprintPure
  • Category="TypedElementFramework|Selection"

TTypedElement< BaseInterfaceType > GetTopSelectedElement ( TFunctionRef< bool(const TTypedElement< BaseInterfaceType >&)> Predicate
) const

 Get the first element that implement the given interface and pass the predicate @Predicate A function that should return true when the element is desirable Elements/Framework/TypedElementSelectionSet.h  

TTypedElement< BaseInterfaceType > GetTopSelectedElement ()

 Get the first selected element implementing the given interface. Elements/Framework/TypedElementSelectionSet.h  

RequiredClassType * GetTopSelectedObject ()

 Get the first selected object of the given type. Elements/Framework/TypedElementSelectionSet.h  

UObject * GetTopSelectedObject ( const UClass* InRequiredClass
) const

 Get the first selected object of the given type. Elements/Framework/TypedElementSelectionSet.h
  • BlueprintPure
  • Category="TypedElementFramework|Selection"

bool HasSelectedElements ( const TSubclassOf< UInterface > InBaseInterfaceType
) const

 Test whether there selected elements, optionally filtering to elements that implement the given interface. Elements/Framework/TypedElementSelectionSet.h
  • BlueprintCallable
  • BlueprintPure=false
  • Category="TypedElementFramework|Selection"
Test whether there are any selected objects. Elements/Framework/TypedElementSelectionSet.h  

bool HasSelectedObjects ( const UClass* InRequiredClass
) const

 Test whether there are any selected objects. Elements/Framework/TypedElementSelectionSet.h
  • BlueprintCallable
  • BlueprintPure=false
  • Category="TypedElementFramework|Selection"

bool IsElementSelected ( const FTypedElementHandle& InElementHandle,
const FTypedElementIsSelectedOptions InSelectionOptions
) const

 Test to see whether the given element is currently considered selected. Elements/Framework/TypedElementSelectionSet.h  

bool IsElementSelected ( const FScriptTypedElementHandle& InElementHandle,
const FTypedElementIsSelectedOptions InSelectionOptions
) const

 Script Api Test to see whether the given element is currently considered selected. Elements/Framework/TypedElementSelectionSet.h
  • BlueprintPure
  • Category="TypedElementFramework|Selection"

TArray< FScriptTypedElementHandle > K2_GetSelectedElementHandles ( const TSubclassOf< UInterface > InBaseInterfaceType
) const

 Get the handle of every selected element, optionally filtering to elements that implement the given interface. Elements/Framework/TypedElementSelectionSet.h
  • BlueprintCallable
  • BlueprintPure=false
  • DisplayName="Get Selected Element Handles"
  • Category="TypedElementFramework|Selection"
  • Meta=(ScriptName="GetSelectedElementHandles")

FTypedElementList::FLegacySync & Legacy_GetElementListSync ()

 Access the interface to allow external systems (such as USelection) to receive immediate sync notifications as the underlying element list is changed. Elements/Framework/TypedElementSelectionSet.h  

FTypedElementList::FLegacySync * Legacy_GetElementListSyncPtr ()

 Access the interface to allow external systems (such as USelection) to receive immediate sync notifications as the underlying element list is changed. Elements/Framework/TypedElementSelectionSet.h  

void NotifyPendingChanges()

 Invoke the delegate called whenever the underlying element list has been changed. Elements/Framework/TypedElementSelectionSet.h  

FOnChanged & OnChanged()

   Elements/Framework/TypedElementSelectionSet.h  

FOnPreChange & OnPreChange()

   Elements/Framework/TypedElementSelectionSet.h  

void RestoreSelectionState ( const FTypedElementSelectionSetState& InSelectionState
)

 Restores the selection set from the given state. Elements/Framework/TypedElementSelectionSet.h
  • BlueprintCallable
  • Category="TypedElementFramework|Selection"

bool SelectElement ( const FTypedElementHandle& InElementHandle,
const FTypedElementSelectionOptions InSelectionOptions
)

 Attempt to select the given element. Elements/Framework/TypedElementSelectionSet.h  

bool SelectElement ( const FScriptTypedElementHandle& InElementHandle,
const FTypedElementSelectionOptions InSelectionOptions
)

 Attempt to select the given element. Elements/Framework/TypedElementSelectionSet.h
  • BlueprintCallable
  • Category="TypedElementFramework|Selection"

bool SelectElements ( FTypedElementListConstRef InElementList,
const FTypedElementSelectionOptions InSelectionOptions
)

   Elements/Framework/TypedElementSelectionSet.h  

bool SelectElements ( const TArray< FTypedElementHandle >& InElementHandles,
const FTypedElementSelectionOptions InSelectionOptions
)

 Attempt to select the given elements. Elements/Framework/TypedElementSelectionSet.h  

bool SelectElements ( TArrayView< const FTypedElementHandle > InElementHandles,
const FTypedElementSelectionOptions InSelectionOptions
)

   Elements/Framework/TypedElementSelectionSet.h  

bool SelectElements ( const TArray< FScriptTypedElementHandle >& InElementHandles,
const FTypedElementSelectionOptions InSelectionOptions
)

 Attempt to select the given elements. Elements/Framework/TypedElementSelectionSet.h
  • BlueprintCallable
  • Category="TypedElementFramework|Selection"

void SetNameForTedsIntegration ( const FName InNameForIntegration
)

 Sets the name to use for teds integration so that it can be reapplied on undo/redo Elements/Framework/TypedElementSelectionSet.h  

bool SetSelection ( TArrayView< const FTypedElementHandle > InElementHandles,
const FTypedElementSelectionOptions InSelectionOptions
)

   Elements/Framework/TypedElementSelectionSet.h  

bool SetSelection ( const TArray< FScriptTypedElementHandle >& InElementHandles,
const FTypedElementSelectionOptions InSelectionOptions
)

 Attempt to make the selection the given elements. Elements/Framework/TypedElementSelectionSet.h
  • BlueprintCallable
  • Category="TypedElementFramework|Selection"

bool SetSelection ( FTypedElementListConstRef InElementList,
const FTypedElementSelectionOptions InSelectionOptions
)

   Elements/Framework/TypedElementSelectionSet.h  

bool SetSelection ( const TArray< FTypedElementHandle >& InElementHandles,
const FTypedElementSelectionOptions InSelectionOptions
)

 Attempt to make the selection the given elements. Elements/Framework/TypedElementSelectionSet.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginDestroy()

   Elements/Framework/TypedElementSelectionSet.h  

virtual bool Modify ( bool bAlwaysMarkDirty
)

   Elements/Framework/TypedElementSelectionSet.h  

virtual void PostEditUndo()

   Elements/Framework/TypedElementSelectionSet.h  

virtual void PreEditUndo()

   Elements/Framework/TypedElementSelectionSet.h  

virtual void Serialize ( FArchive& Ar
)

   Elements/Framework/TypedElementSelectionSet.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page