1. Epic GamesDeveloper
  3. Selections

Selections

API > API/Plugins > API/Plugins/DynamicMesh

Classes

  Type Name Description
Public struct FGeometrySelection FGeometrySelection represents a subset of geometric elements of a larger object, for example a Mesh (currently the only use case).  
Public struct FGeometrySelectionBounds 3D Bounding information for a FGeometrySelection  
Public struct FGeometrySelectionDelta FGeometrySelectionDelta represents a change to the set of elements in a FGeometrySelection.  
Public class FGeometrySelectionEditor FGeometrySelectionEditor is a utility/helper class used for modifying a FGeometrySelection.  
Public struct FGeometrySelectionElements 3D Geometry representing a FGeometrySelection, for example suitable for passing to rendering code, etc  
Public struct FGeometrySelectionHitQueryConfig FGeometrySelectionHitQueryConfig defines the desired settings for a "hit query" on selected meshes/objects.  
Public class FGeometrySelectionPreview FGeometrySelectionPreview is a combined FGeometrySelection and FGeometrySelectionEditor.  
Public struct FGeometrySelectionUpdateConfig FGeometrySelectionUpdateConfig is passed to various Selection Editing functions/classes to indicate what type of change should be applied to a FGeometrySelection (based on additional parameters, generally)  
Public struct FGeometrySelectionUpdateResult    
Public struct FGeoSelectionID FGeoSelectionID provides a pair of 32-bit unsigned integers that can be packed into a 64-bit unsigned integer for use with FGeometrySelection.  
Public class FQuadGridPatch FQuadGridPatch represents a set of quads, formed by pairs of triangles, arranged in a 2D grid pattern.  

Enums

  Type Name Description
Public enum UE::Geometry::EGeometryElementType Type of selected Elements in a FGeometrySelection  
Public enum UE::Geometry::EGeometrySelectionChangeType Type of change, relative to a FGeometrySelection  
Public enum UE::Geometry::EGeometrySelectionCombineModes Copyright Epic Games, Inc. All Rights Reserved.  
Public enum UE::Geometry::EGeometryTopologyType Type of selected Topology in a FGeometrySelection.  

Functions

  Type Name Description
Public function bool Test if SelectionA and SelectionB are the same selection.
Public function bool Combine the elements of SelectionA and SelectionB using the provided CombineMode, and store the result in SelectionA.
Public function bool Convert a MeshSelection with Polygroup topology type to a FGroupTopologySelection
Public function bool

UE::Geometry::ConvertSelection ( const UE::Geometry::FDynamicMesh3& Mesh,
const FGroupTopology* GroupTopology,
const FGeometrySelection& FromSelectionIn,
FGeometrySelection& ToSelectionOut
)

 Convert Selection from one type to another, based on geometry/topology types in FromSelectionIn and ToSelectionOut.
Public function bool

UE::Geometry::ConvertTriangleSelectionToOverlaySelection ( const UE::Geometry::FDynamicMesh3& Mesh,
const FGeometrySelection& MeshSelection,
TSet< int >& TrianglesOut,
TSet< int >& VerticesOut
)

 Convert the given MeshSelection to a list of Triangles and Vertices into the Mesh, which can be used to represent a selection of overlay elements.
Public function bool

UE::Geometry::EnumeratePolygroupSelectionElements ( const FGeometrySelection& MeshSelection,
const UE::Geometry::FDynamicMesh3& Mesh,
const FGroupTopology* GroupTopology,
TFunctionRef< void(int32, const FVector3d&)> VertexFunc,
TFunctionRef< void(int32, const FSegment3d&)> EdgeFunc,
TFunctionRef< void(int32, const FTriangle3d&)> TriangleFunc,
const FTransform* ApplyTransform,
bool bMapFacesToEdgeLoops
)

 Call VertexFunc/EdgeFunc/TriangleFunc for the mesh vertices/edges/triangles identified by MeshSelection, where MeshSelection has polygroup topology referring to the provided GroupTopology Since a MeshSelection only stores vertices, edges, or triangles, but not combined, only one of these functions will be invoked during a call to this function.
Public function bool Call TriangleFunc for each mesh TriangleID included in MeshSelection, where MeshSelection has polygroup topology.
Public function bool

UE::Geometry::EnumeratePolygroupSelectionVertices ( const FGeometrySelection& GroupSelection,
const UE::Geometry::FDynamicMesh3& Mesh,
const FGroupTopology* GroupTopology,
const FTransform& ApplyTransform,
TFunctionRef< void(uint64, const FVector3d&)> VertexFunc
)

 Call VertexFunc for each selected Mesh element (vertex/edge/tri) in the set of polygroup faces/edges/corners specified by GroupSelection (relative to GroupTopology parameter) ApplyTransform will be applied to Vertex Positions before calling VertexFunc
Public function bool

UE::Geometry::EnumerateSelectionTriangles ( const FGeometrySelection& MeshSelection,
const UE::Geometry::FDynamicMesh3& Mesh,
TFunctionRef< void(int32)> TriangleFunc,
const UE::Geometry::FPolygroupSet* UseGroupSet
)

 Call TriangleFunc for each mesh TriangleID included in MeshSelection.
Public function bool

UE::Geometry::EnumerateTriangleSelectionElements ( const FGeometrySelection& MeshSelection,
const UE::Geometry::FDynamicMesh3& Mesh,
TFunctionRef< void(int32, const FVector3d&)> VertexFunc,
TFunctionRef< void(int32, const FSegment3d&)> EdgeFunc,
TFunctionRef< void(int32, const FTriangle3d&)> TriangleFunc,
const FTransform* ApplyTransform,
bool bMapFacesToEdgeLoops
)

 Call VertexFunc/EdgeFunc/TriangleFunc for the vertices/edges/triangles identified by MeshSelection.
Public function bool

UE::Geometry::EnumerateTriangleSelectionTriangles ( const FGeometrySelection& MeshSelection,
const UE::Geometry::FDynamicMesh3& Mesh,
TFunctionRef< void(int32)> TriangleFunc
)

 Call TriangleFunc for each mesh TriangleID included in MeshSelection.
Public function bool

UE::Geometry::EnumerateTriangleSelectionVertices ( const FGeometrySelection& MeshSelection,
const UE::Geometry::FDynamicMesh3& Mesh,
const FTransform& ApplyTransform,
TFunctionRef< void(uint64, const FVector3d&)> VertexFunc
)

 Call VertexFunc for each selected Mesh element (vertex/edge/tri) in MeshSelection.
Public function bool

UE::Geometry::FindInSelectionByTopologyID ( const FGeometrySelection& GeometrySelection,
uint32 TopologyID,
uint64& FoundValue
)

 Assuming that the uint64 values in the GeometrySelection are encoded FGeoSelectionID's, find the item that has a matching TopologyID, ignoring the GeometryID.
Public function bool

UE::Geometry::GetSelectionBoundaryCorners ( const UE::Geometry::FDynamicMesh3& Mesh,
const UE::Geometry::FGroupTopology* GroupTopology,
const UE::Geometry::FGeometrySelection& ReferenceSelection,
TSet< int32 >& BorderCornerIDsOut,
TSet< int32 >& CurCornerIDsOut
)

 Given a EGeometryTopologyType::Polygroup selection, return the corner IDs of the polygroup corners on the boundary of the selection.
Public function bool

UE::Geometry::GetSelectionBoundaryVertices ( const UE::Geometry::FDynamicMesh3& Mesh,
const UE::Geometry::FGroupTopology* GroupTopology,
const UE::Geometry::FGeometrySelection& ReferenceSelection,
TSet< int32 >& BorderVidsOut,
TSet< int32 >& CurVerticesOut
)

 Given a selection, return the vertex IDs of the vertices on the boundary of this selection.
Public function bool

UE::Geometry::GetTriangleSelectionFrame ( const FGeometrySelection& MeshSelection,
const UE::Geometry::FDynamicMesh3& Mesh,
FFrame3d& SelectionFrameOut
)

 Compute a 3D Frame suitable for use as a 3D transform gizmo position/orientation for the given MeshSelection
Public function bool

UE::Geometry::InitializeSelectionFromTriangles ( const UE::Geometry::FDynamicMesh3& Mesh,
const FGroupTopology* GroupTopology,
TArrayView< const int > Triangles,
FGeometrySelection& SelectionOut
)

 Convert Triangle IDs to target Selection type
Public function bool

UE::Geometry::MakeBoundaryConnectedSelection ( const UE::Geometry::FDynamicMesh3& Mesh,
const FGroupTopology* GroupTopology,
const FGeometrySelection& ReferenceSelection,
TFunctionRef< bool(FGeoSelectionID)> SelectionIDPredicate,
FGeometrySelection& BoundaryConnectedSelection
)

 Create a selection of the elements adjacent to the "Border" of the given ReferenceSelection and return in BoundaryConnectedSelection.
Public function bool

UE::Geometry::MakeSelectAllConnectedSelection ( const UE::Geometry::FDynamicMesh3& Mesh,
const FGroupTopology* GroupTopology,
const FGeometrySelection& ReferenceSelection,
TFunctionRef< bool(FGeoSelectionID)> SelectionIDPredicate,
TFunctionRef< bool(FGeoSelectionID A, FGeoSelectionID B)> IsConnectedPredicate,
FGeometrySelection& AllConnectedSelection
)

 Expand the input ReferenceSelection to include all "connected" elements and return in AllConnectedSelection.
Public function bool

UE::Geometry::MakeSelectAllSelection ( const UE::Geometry::FDynamicMesh3& Mesh,
const FGroupTopology* GroupTopology,
TFunctionRef< bool(FGeoSelectionID)> SelectionIDPredicate,
FGeometrySelection& AllSelection
)

 Select all elements of the provided Mesh and GroupTopology that pass the provided SelectionIDPredicate, and store in the output AllSelection.
Public function void

UE::Geometry::UpdateGroupSelectionViaRaycast ( const FColliderMesh* ColliderMesh,
const FGroupTopology* GroupTopology,
FGeometrySelectionEditor* Editor,
const FRay3d& LocalRay,
const FGeometrySelectionUpdateConfig& UpdateConfig,
FGeometrySelectionUpdateResult& ResultOut
)

 Update a FGeometrySelection (via the Editor) of mesh polygroup faces/edges/corners, based on a raycast
Public function bool Update a FGeometrySelection (via the Editor)
Public function void

UE::Geometry::UpdateTriangleSelectionViaRaycast ( const FColliderMesh* ColliderMesh,
FGeometrySelectionEditor* Editor,
const FRay3d& LocalRay,
const FGeometrySelectionUpdateConfig& UpdateConfig,
FGeometrySelectionUpdateResult& ResultOut
)

 Update a FGeometrySelection (via the Editor) of mesh vertices/edges/triangles based on a raycast

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page