1. Epic GamesDeveloper
  3. Selection

Selection

Unreal Engine C++ API Reference > Plugins > ModelingComponents

Classes

  Type Name Description
Public class FBaseDynamicMeshSelector FBaseDynamicMeshSelector is an implementation of IGeometrySelector for a UDynamicMesh.  
Public class FBasicDynamicMeshSelectionTransformer BasicDynamicMeshSelectionTransformer is a basic Transformer implementation that can be used with a FBaseDynamicMeshSelector.  
Public class FBoundarySelector This class allows selection of mesh boundary loops.  
Public class FBoundaryTopologyProvider    
Public class FDynamicMeshComponentSelectorFactory FDynamicMeshComponentSelectorFactory constructs FDynamicMeshSelector instances for UDynamicMeshComponents  
Public class FDynamicMeshPolygroupTransformer IGeometrySelectionTransformer for Dynamic Mesh Polygroups, that does various types of soft deformation.  
Public class FDynamicMeshSelector FDynamicMeshSelector is an implementation of FBaseDynamicMeshSelector meant to be used with UDynamicMeshComponents.  
Public struct FGenericMeshSelection FGenericMeshSelection represents various types of selection on a Mesh.  
Public struct FGeometryIdentifier FGeometryIdentifier is used to represent a specific Geometry-containing object.  
Public class FGeometrySelectionDeltaChange FGeometrySelectionDeltaChange stores a Remove-then-Add change in a FGeometrySelection.  
Public struct FGeometrySelectionHandle FGeometrySelectionHandle stores a Selection and an Identifier for the geometry object that the Selection is defined relative to  
Public class FGeometrySelectionReplaceChange FGeometrySelectionReplaceChange stores a full replacement of a FGeometrySelection, ie full copies of the selection set before and after the change  
Public class FGroupTopologyProvider TopologyProvider using FGroupTopology  
Public class FGroupTopologySelector FGroupTopologySelector is a MeshTopologySelector subclass using an FGroupTopology to define groups, edges, and vertices  
Public struct FGroupTopologyUtils Additional functionality for operating on FGroupTopology  
Public class FMeshEdgesFromTriangleSubIndices Helper class that can store a list of edges as pairs of triangle IDs and {0,1,2} indices into the triangle edge triplet, because regular FDynamicMesh edge IDs may not stay the same across some mesh operations that preserve the vertex/triangle ID topology.  
Public class FMeshTopologySelectionMechanicSelectionChange    
Public class FMeshTopologySelector FMeshTopologySelector implements selection behavior for a subset of mesh elements.  
Public class FPersistentMeshSelectionChange FPersistentMeshSelectionChange stores a selection change, ie before-and-after states.  
Public class FSelectClickedAction BehaviorTarget to do world raycast selection from a click Currently used to click-select reference planes in the world  
Public struct FSelectionRenderHelper    
Public class FTopologyProvider FTopologyProvider provides selectable edge/group/corner information for FMeshTopologySelector to use.  
Public class IGeometrySelectionChange Base interface intended to be implemented by FToolCommandChange subclasses that represent changes to a FGeometrySelection.  
Public class IGeometrySelectionTransformer IGeometrySelectionTransformer is a transient object that is created by an IGeometrySelector to provide external code with a way to manipulate/transform an active Selection.  
Public class IGeometrySelector IGeometrySelector is a base API definition for, roughly, "an object that knows how to  
Public class IGeometrySelectorFactory Factory for a specific type of IGeometrySelector  
Public class UClass UBoundarySelectionMechanic    
Public class UClass deprecated UDEPRECATED_PersistentMeshSelection UPersistentMeshSelection is a UObject wrapper for a FGenericMeshSelection  
Public class UClass deprecated UDEPRECATED_PersistentMeshSelectionManager UDEPRECATED_PersistentMeshSelectionManager manages an active Mesh Selection.  
Public class UClass deprecated UDEPRECATED_PolygonSelectionMechanicProperties DEPRECATED: Use UMeshTopologySelectionMechanicProperties.  
Public class UClass Abstract UGeometrySelectionEditCommand UGeometrySelectionEditCommand is a command that edits geometry based on a selection.  
Public class UClass UGeometrySelectionEditCommandArguments Arguments for a UGeometrySelectionEditCommand  
Public class UClass UGeometrySelectionEditCommandResult    
Public class UClass UGeometrySelectionManager UGeometrySelectionManager provides the infrastructure for "Element Selection", ie geometric sub-elements of some geometry object like a Triangle Mesh.  
Public class UClass Abstract UMeshTopologySelectionMechanic Base class mechanic for selecting a subset of mesh elements (edge loops, groups, corners, etc.) Internally it relies on an FMeshTopologySelector to define which type of mesh topology is selectable.  
Public class UClass UMeshTopologySelectionMechanicProperties    
Public class UClass UPolygonSelectionMechanic UPolygonSelectionMechanic implements the interaction for selecting a set of faces/vertices/edges from a FGroupTopology.  

Functions

  Type Name Description
Public function bool

ToolSelectionUtil::AccumulateSelectionElements ( UE::Geometry::FGeometrySelectionElements& Elements,
const UE::Geometry::FGeometrySelection& Selection,
const UE::Geometry::FDynamicMesh3& SourceMesh,
const UE::Geometry::FGroupTopology* Topology,
const FTransform* ApplyTransform,
bool bMapFacesToEdges
)

 Add the geometry selection elements corresponding to the given Selection to Elements.
Public function void Render the given Elements using FPrimitiveDrawInterface
Public function void Change the active selection to the given Actors, via given ToolManager.
Public function void Change the active selection to the given Actor, via given ToolManager. Replaces existing selection.
Public function void PersistentMeshSelection and related functions are deprecated. ClearActiveToolSelection no longer has any effect.
Public function FAxisAlignedBox3d

UE::Geometry::ComputeBoundsFromTriangleROI ( const FDynamicMesh3& Mesh,
const TArray< int32 >& TriangleROI,
const FTransform3d* Transform
)

 Computes the axis aligned bounding box from a given triangle region of interest, useful to compute a DepthBias
Public function FAxisAlignedBox3d

UE::Geometry::ComputeBoundsFromVertexROI ( const FDynamicMesh3& Mesh,
const TArray< int32 >& VertexROI,
const FTransform3d* Transform
)

 Computes the axis aligned bounding box from a given vertex region of interest, useful to compute a DepthBias
Public function bool UE::Geometry::DeregisterPersistentMeshSelectionManager is deprecated
Public function UDEPRECATED_PersistentMeshSelectionManager * UE::Geometry::FindPersistentMeshSelectionManager is deprecated
Public function bool Find an available FGeometrySelection for the given ToolTarget (via the UGeometrySelectionManager in the ContextObjectStore)
Public function bool Given a FToolBuilderState, find an available FGeometrySelection for the given ToolTarget (via the UGeometrySelectionManager in the ContextObjectStore)
Public function const UDEPRECATED_PersistentMeshSelection * PersistentMeshSelection and related functions are deprecated. GetCurrentToolInputSelection now returns nullptr.
Public function FIndex2i

UE::Geometry::GetGroupEdgeRepresentativeVerts ( const FGroupTopology& TopologyIn,
int GroupEdgeID,
const FCompactMaps& CompactMaps
)

 Utility functions for group topology manipulation.
Public function FIndex2i

UE::Geometry::GetGroupEdgeRepresentativeVerts ( const FGroupTopology& TopologyIn,
int GroupEdgeID
)

 Returns a pair of vertex ID's that are representative of a group edge, to be able to identify a selected group edge independently of a group topology object.
Public function bool PersistentMeshSelection and related functions are deprecated. GetStoredSelectionAsTriangles now always returns an empty TrianglesOut list.
Public function bool  
Public function void

UE::Geometry::InitializeGeometrySelectionVisualization ( UPreviewGeometry* PreviewGeom,
UGeometrySelectionVisualizationProperties* Settings,
const FDynamicMesh3& SourceMesh,
const FGeometrySelection& Selection,
const FGroupTopology* GroupTopology,
const FGeometrySelection* TriangleVertexSelection,
const TArray< int >* TriangleROI,
const FTransform* ApplyTransform
)

 Initialize the geometry selection preview geometry. Call this in your tool Setup function
Public function bool UE::Geometry::RegisterPersistentMeshSelectionManager is deprecated
Public function bool Allow a Tool to return an "output" FGeometrySelection for the given ToolTarget (presumably on Tool Shutdown) Target must be an "active" selection target in the current UGeometrySelectionManager.
Public function bool PersistentMeshSelection and related functions are deprecated. SetToolOutputSelection is now ignored.
Public function void Update the geometry selection preview geometry according to Settings.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page