Navigation
API > API/Plugins > API/Plugins/DynamicMesh
FGeometrySelectionEditor is a utility/helper class used for modifying a FGeometrySelection. The various functions can be used to add or remove to the Selection, while also tracking what changed, returned via FGeometrySelectionDelta structs.
In some cases (eg Polygroup selections on faces and edges), only the TopologyIDs are unique, and the same TopologyID may be paired with an arbitrary TriangleID/EdgeID. FGeometrySelection is currently not aware of this distinction, however it means when (for example) adding to a selection, a new uint64 ID should only be added if the TopologyID is unique, ie the ElementID bit should be ignored. FGeometrySelectionEditor can do this, by enabling TopologyIDFiltering in the various setup/config functions.
Note, however, this means that FGeometrySelectionEditor.IsSelected() must be used to determine whether an ID is selected, rather than Selection.Contains()
| Name | FGeometrySelectionEditor |
| Type | class |
| Header File | /Engine/Plugins/Runtime/GeometryProcessing/Source/DynamicMesh/Public/Selections/GeometrySelection.h |
| Include Path | #include "Selections/GeometrySelection.h" |
Syntax
class FGeometrySelectionEditor
Derived Classes
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void ClearSelection
(
FGeometrySelectionDelta& DeltaOut |
Clear the Target Selection and return change information in DeltaOut | Selections/GeometrySelection.h | |
bool Deselect
(
const ListType& List, |
Remove the items in the List from the Target Selection and return change information in DeltaOut | Selections/GeometrySelection.h | |
EGeometryElementType GetElementType() |
Selections/GeometrySelection.h | ||
bool GetIsTopologyIDFilteringEnabled() |
Selections/GeometrySelection.h | ||
const FGeometrySelectionHitQueryConfig & GetQueryConfig() |
Selections/GeometrySelection.h | ||
const FGeometrySelection & GetSelection() |
Access the Selection object this Editor is modifying | Selections/GeometrySelection.h | |
EGeometryTopologyType GetTopologyType() |
Selections/GeometrySelection.h | ||
void Initialize
(
FGeometrySelection* TargetSelectionIn, |
Initialize the Editor with the given Selection. | Selections/GeometrySelection.h | |
void Initialize
(
FGeometrySelection* TargetSelectionIn, |
Initialize the Editor with the given Selection. | Selections/GeometrySelection.h | |
bool IsSelected
(
uint64 ID |
Selections/GeometrySelection.h | ||
bool RemoveFromSelection
(
uint64 ID |
Remove ID from Selection | Selections/GeometrySelection.h | |
bool Replace
(
const FGeometrySelection& NewSelection, |
Replace the current set of selected items with those in the NewSelection, and return change information in DeltaOut | Selections/GeometrySelection.h | |
bool Select
(
uint64 ID |
Add the items to the Target Selection | Selections/GeometrySelection.h | |
bool Select
(
const ListType& List, |
Add the items in the List to the Target Selection and return change information in DeltaOut | Selections/GeometrySelection.h | |
void UpdateQueryConfig
(
const FGeometrySelectionHitQueryConfig& NewConfig, |
Update the active QueryConfig for this SelectionEditor. | Selections/GeometrySelection.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
uint64 RemapToExistingTopologyID
(
uint64 ID, |
Selections/GeometrySelection.h |