unreal.TypedElementSelectionSetLibrary
¶
- class unreal.TypedElementSelectionSetLibrary(outer: Object | None = None, name: Name | str = 'None')¶
Bases:
Object
Library of functions for the scripting of Typed Elements that use both a selection set and a element list
Note: These functions should only be used for scripting purposes only as they come at higher performance cost then their non script implementation
C++ Source:
Module: TypedElementRuntime
File: TypedElementSelectionSetLibrary.h
- classmethod deselect_elements_from_list(selection_set, element_list, selection_options) bool ¶
Attempt to deselect the given elements.
- Parameters:
selection_set (TypedElementSelectionSet) –
element_list (TypedElementList) –
selection_options (TypedElementSelectionOptions) –
- Returns:
True if the selection was changed, false otherwise.
- Return type:
- classmethod get_normalized_element_list(selection_set, element_list, normalization_options) TypedElementList ¶
Get a normalized version of the given element list that can be used to perform operations like gizmo manipulation, deletion, copying, etc. This will do things like expand out groups, and resolve any parent<->child elements so that duplication operations aren’t performed on both the parent and the child.
- Parameters:
selection_set (TypedElementSelectionSet) –
element_list (TypedElementList) –
normalization_options (TypedElementSelectionNormalizationOptions) –
- Return type:
- classmethod get_normalized_selection(selection_set, normalization_options) TypedElementList ¶
Get a normalized version of this selection set that can be used to perform operations like gizmo manipulation, deletion, copying, etc. This will do things like expand out groups, and resolve any parent<->child elements so that duplication operations aren’t performed on both the parent and the child.
- Parameters:
selection_set (TypedElementSelectionSet) –
normalization_options (TypedElementSelectionNormalizationOptions) –
- Return type:
- classmethod select_elements_from_list(selection_set, element_list, selection_options) bool ¶
Attempt to select the given elements.
- Parameters:
selection_set (TypedElementSelectionSet) –
element_list (TypedElementList) –
selection_options (TypedElementSelectionOptions) –
- Returns:
True if the selection was changed, false otherwise.
- Return type:
- classmethod set_selection_from_list(selection_set, element_list, selection_options) bool ¶
Attempt to make the selection the given elements. note: Equivalent to calling ClearSelection then SelectElements, but happens in a single batch.
- Parameters:
selection_set (TypedElementSelectionSet) –
element_list (TypedElementList) –
selection_options (TypedElementSelectionOptions) –
- Returns:
True if the selection was changed, false otherwise.
- Return type: