UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Protected Member Functions | List of all members
ITypedElementSelectionInterface Class Reference

#include <TypedElementSelectionInterface.h>

+ Inheritance diagram for ITypedElementSelectionInterface:

Public Member Functions

virtual TYPEDELEMENTRUNTIME_API bool IsElementSelected (const FTypedElementHandle &InElementHandle, const FTypedElementListConstPtr &SelectionSetPtr, const FTypedElementIsSelectedOptions &InSelectionOptions)
 
virtual bool CanSelectElement (const FTypedElementHandle &InElementHandle, const FTypedElementSelectionOptions &InSelectionOptions)
 
virtual bool CanDeselectElement (const FTypedElementHandle &InElementHandle, const FTypedElementSelectionOptions &InSelectionOptions)
 
virtual TYPEDELEMENTRUNTIME_API bool SelectElement (const FTypedElementHandle &InElementHandle, const FTypedElementListPtr &InSelectionSet, const FTypedElementSelectionOptions &InSelectionOptions)
 
virtual TYPEDELEMENTRUNTIME_API bool DeselectElement (const FTypedElementHandle &InElementHandle, const FTypedElementListPtr &InSelectionSet, const FTypedElementSelectionOptions &InSelectionOptions)
 
virtual bool AllowSelectionModifiers (const FTypedElementHandle &InElementHandle, const FTypedElementListConstPtr &InSelectionSet)
 
virtual FTypedElementHandle GetSelectionElement (const FTypedElementHandle &InElementHandle, const FTypedElementListConstPtr &InCurrentSelection, const ETypedElementSelectionMethod InSelectionMethod)
 
virtual bool ShouldPreventTransactions (const FTypedElementHandle &InElementHandle)
 
TUniquePtr< ITypedElementTransactedElement > CreateTransactedElement (const FTypedElementHandle &InElementHandle)
 
TUniquePtr< ITypedElementTransactedElement > CreateTransactedElement (const FTypedHandleTypeId InTypeId)
 
virtual TYPEDELEMENTRUNTIME_API bool IsElementSelected (const FScriptTypedElementHandle &InElementHandle, const FScriptTypedElementListProxy InSelectionSet, const FTypedElementIsSelectedOptions &InSelectionOptions)
 
virtual TYPEDELEMENTRUNTIME_API bool CanSelectElement (const FScriptTypedElementHandle &InElementHandle, const FTypedElementSelectionOptions &InSelectionOptions)
 
virtual TYPEDELEMENTRUNTIME_API bool CanDeselectElement (const FScriptTypedElementHandle &InElementHandle, const FTypedElementSelectionOptions &InSelectionOptions)
 
virtual TYPEDELEMENTRUNTIME_API bool SelectElement (const FScriptTypedElementHandle &InElementHandle, FScriptTypedElementListProxy InSelectionSet, const FTypedElementSelectionOptions &InSelectionOptions)
 
virtual TYPEDELEMENTRUNTIME_API bool DeselectElement (const FScriptTypedElementHandle &InElementHandle, FScriptTypedElementListProxy InSelectionSet, const FTypedElementSelectionOptions &InSelectionOptions)
 
virtual TYPEDELEMENTRUNTIME_API bool AllowSelectionModifiers (const FScriptTypedElementHandle &InElementHandle, const FScriptTypedElementListProxy InSelectionSet)
 
virtual TYPEDELEMENTRUNTIME_API FScriptTypedElementHandle GetSelectionElement (const FScriptTypedElementHandle &InElementHandle, const FScriptTypedElementListProxy InCurrentSelection, const ETypedElementSelectionMethod InSelectionMethod)
 

Protected Member Functions

virtual TUniquePtr< ITypedElementTransactedElement > CreateTransactedElementImpl ()
 

Member Function Documentation

◆ AllowSelectionModifiers() [1/2]

bool ITypedElementSelectionInterface::AllowSelectionModifiers ( const FScriptTypedElementHandle &  InElementHandle,
const FScriptTypedElementListProxy  InSelectionSet 
)
virtual

Test to see whether selection modifiers (Ctrl or Shift) are allowed while selecting this element.

◆ AllowSelectionModifiers() [2/2]

virtual bool ITypedElementSelectionInterface::AllowSelectionModifiers ( const FTypedElementHandle &  InElementHandle,
const FTypedElementListConstPtr &  InSelectionSet 
)
inlinevirtual

Test to see whether selection modifiers (Ctrl or Shift) are allowed while selecting this element.

◆ CanDeselectElement() [1/2]

bool ITypedElementSelectionInterface::CanDeselectElement ( const FScriptTypedElementHandle &  InElementHandle,
const FTypedElementSelectionOptions &  InSelectionOptions 
)
virtual

Test to see whether the given element can be deselected.

◆ CanDeselectElement() [2/2]

virtual bool ITypedElementSelectionInterface::CanDeselectElement ( const FTypedElementHandle &  InElementHandle,
const FTypedElementSelectionOptions &  InSelectionOptions 
)
inlinevirtual

Test to see whether the given element can be deselected.

◆ CanSelectElement() [1/2]

bool ITypedElementSelectionInterface::CanSelectElement ( const FScriptTypedElementHandle &  InElementHandle,
const FTypedElementSelectionOptions &  InSelectionOptions 
)
virtual

Test to see whether the given element can be selected.

◆ CanSelectElement() [2/2]

virtual bool ITypedElementSelectionInterface::CanSelectElement ( const FTypedElementHandle &  InElementHandle,
const FTypedElementSelectionOptions &  InSelectionOptions 
)
inlinevirtual

Test to see whether the given element can be selected.

◆ CreateTransactedElement() [1/2]

TUniquePtr< ITypedElementTransactedElement > ITypedElementSelectionInterface::CreateTransactedElement ( const FTypedElementHandle &  InElementHandle)
inline

Create a transacted element instance that can be used to save the given element for undo/redo.

◆ CreateTransactedElement() [2/2]

TUniquePtr< ITypedElementTransactedElement > ITypedElementSelectionInterface::CreateTransactedElement ( const FTypedHandleTypeId  InTypeId)
inline

Create a transacted element instance that can be used to load an element previously saved for undo/redo.

◆ CreateTransactedElementImpl()

virtual TUniquePtr< ITypedElementTransactedElement > ITypedElementSelectionInterface::CreateTransactedElementImpl ( )
inlineprotectedvirtual

Create a transacted element instance that can be used to save/load elements of the implementation type for undo/redo.

Note
The instance returned from this function must have either SetElement or SetElementType called on it prior to being used.

◆ DeselectElement() [1/2]

bool ITypedElementSelectionInterface::DeselectElement ( const FScriptTypedElementHandle &  InElementHandle,
FScriptTypedElementListProxy  InSelectionSet,
const FTypedElementSelectionOptions &  InSelectionOptions 
)
virtual

Attempt to deselect the given element.

Returns
True if the selection was changed, false otherwise.

◆ DeselectElement() [2/2]

bool ITypedElementSelectionInterface::DeselectElement ( const FTypedElementHandle &  InElementHandle,
const FTypedElementListPtr &  InSelectionSet,
const FTypedElementSelectionOptions &  InSelectionOptions 
)
virtual

Attempt to deselect the given element.

Returns
True if the selection was changed, false otherwise.

Reimplemented in USMInstanceElementSelectionInterface.

◆ GetSelectionElement() [1/2]

FScriptTypedElementHandle ITypedElementSelectionInterface::GetSelectionElement ( const FScriptTypedElementHandle &  InElementHandle,
const FScriptTypedElementListProxy  InCurrentSelection,
const ETypedElementSelectionMethod  InSelectionMethod 
)
virtual

Given an element, return the element that should actually perform a selection operation.

◆ GetSelectionElement() [2/2]

virtual FTypedElementHandle ITypedElementSelectionInterface::GetSelectionElement ( const FTypedElementHandle &  InElementHandle,
const FTypedElementListConstPtr &  InCurrentSelection,
const ETypedElementSelectionMethod  InSelectionMethod 
)
inlinevirtual

Given an element, return the element that should actually perform a selection operation.

◆ IsElementSelected() [1/2]

bool ITypedElementSelectionInterface::IsElementSelected ( const FScriptTypedElementHandle &  InElementHandle,
const FScriptTypedElementListProxy  InSelectionSet,
const FTypedElementIsSelectedOptions &  InSelectionOptions 
)
virtual

Script Api Test to see whether the given element is currently considered selected.

◆ IsElementSelected() [2/2]

bool ITypedElementSelectionInterface::IsElementSelected ( const FTypedElementHandle &  InElementHandle,
const FTypedElementListConstPtr &  SelectionSetPtr,
const FTypedElementIsSelectedOptions &  InSelectionOptions 
)
virtual

Test to see whether the given element is currently considered selected.

◆ SelectElement() [1/2]

bool ITypedElementSelectionInterface::SelectElement ( const FScriptTypedElementHandle &  InElementHandle,
FScriptTypedElementListProxy  InSelectionSet,
const FTypedElementSelectionOptions &  InSelectionOptions 
)
virtual

Attempt to select the given element.

Returns
True if the selection was changed, false otherwise.

◆ SelectElement() [2/2]

bool ITypedElementSelectionInterface::SelectElement ( const FTypedElementHandle &  InElementHandle,
const FTypedElementListPtr &  InSelectionSet,
const FTypedElementSelectionOptions &  InSelectionOptions 
)
virtual

Attempt to select the given element.

Returns
True if the selection was changed, false otherwise.

Reimplemented in USMInstanceElementSelectionInterface.

◆ ShouldPreventTransactions()

virtual bool ITypedElementSelectionInterface::ShouldPreventTransactions ( const FTypedElementHandle &  InElementHandle)
inlinevirtual

Test to see whether the given element prevents the selection set state from being transacted for undo/redo (eg, if the element belongs to a PIE instance).

The documentation for this class was generated from the following files: