1. Epic GamesDeveloper
  3. FGeometrySelectionEditor

FGeometrySelectionEditor

[FGeometrySelectionEditor](API\Plugins\DynamicMesh\Selections\FGeometrySelectionEditor) is a utility/helper class used for modifying a [FGeometrySelection](API\Plugins\DynamicMesh\Selections\FGeometrySelection).

API > API/Plugins > API/Plugins/DynamicMesh > API/Plugins/DynamicMesh/Selections

Inheritance Hierarchy

References

   
Module DynamicMesh
Header /Engine/Plugins/Runtime/GeometryProcessing/Source/DynamicMesh/Public/Selections/GeometrySelection.h
Include #include "Selections/GeometrySelection.h"

Syntax

class FGeometrySelectionEditor

Remarks

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()

Variables

  Type Name Description
Protected variable bool bEnableTopologyIDFiltering  
Protected variable FGeometrySelectionHitQueryConfig QueryConfig  
Protected variable FGeometrySelection * TargetSelection  

Functions

  Type Name Description
Public function void Clear the Target Selection and return change information in DeltaOut
Public function bool

Deselect ( const ListType& List,
FGeometrySelectionDelta& DeltaOut
)

 Remove the items in the List from the Target Selection and return change information in DeltaOut
Public function Const EGeometryElementType  
Public function Const bool  
Public function Const const FGeometrySelectionHitQueryConfig &  
Public function Const const FGeometrySelection & Access the Selection object this Editor is modifying
Public function Const EGeometryTopologyType  
Public function void

Initialize ( FGeometrySelection* TargetSelectionIn,
bool bEnableTopologyIDFiltering
)

 Initialize the Editor with the given Selection.
Public function void

Initialize ( FGeometrySelection* TargetSelectionIn,
const FGeometrySelectionHitQueryConfig& QueryConfigIn,
bool bEnableTopologyIDFiltering
)

 Initialize the Editor with the given Selection.
Public function Const bool

IsSelected ( uint64 ID
)

  
Protected function Const uint64

RemapToExistingTopologyID ( uint64 ID,
bool& bFoundOut
)

  
Public function bool

RemoveFromSelection ( uint64 ID
)

 Remove ID from Selection
Public function bool

Replace ( const FGeometrySelection& NewSelection,
FGeometrySelectionDelta& DeltaOut
)

 Replace the current set of selected items with those in the NewSelection, and return change information in DeltaOut
Public function bool

Select ( uint64 ID
)

 Add the items to the Target Selection
Public function bool

Select ( const ListType& List,
FGeometrySelectionDelta& DeltaOut
)

 Add the items in the List to the Target Selection and return change information in DeltaOut
Public function void

UpdateQueryConfig ( const FGeometrySelectionHitQueryConfig& NewConfig,
bool bEnableTopologyIDFilteringIn
)

 Update the active QueryConfig for this SelectionEditor.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page