1. Epic GamesDeveloper
  3. TConvexHull3

TConvexHull3

Calculate the Convex Hull of a 3D point set as a Triangle Mesh

API > API/Runtime > API/Runtime/GeometryCore > API/Runtime/GeometryCore/CompGeom

References

   
Module GeometryCore
Header /Engine/Source/Runtime/GeometryCore/Public/CompGeom/ConvexHull3.h
Include #include "CompGeom/ConvexHull3.h"

Syntax

template<typename RealType>  
class TConvexHull3

Remarks

Calculate the Convex Hull of a 3D point set as a Triangle Mesh

Variables

  Type Name Description
Public variable bool bSaveTriangleNeighbors Whether neighbors for the hull triangles should be computed/saved.
Protected variable int32 Dimension  
Protected variable TArray< FIndex3i > Hull  
Protected variable TArray< FIndex3i > HullNeighbors We can optionally also return the hull triangle adjacencies.
Protected variable TLine3< RealType > Line  
Protected variable int NumHullPoints  
Protected variable TPlane3< RealType > Plane  
Public variable FProgressCancel * Progress Set this to be able to cancel running operation
Public variable TConvexHullSimplificationSettings< RealType > SimplificationSettings Settings controlling whether and how to generate a simpler hull.

Functions

  Type Name Description
Public function Static double

ComputeVolume ( const TArrayView< const TVector< RealType > > Vertices
)

 Helper to compute the a convex hull and return only its volume. If the hull cannot be constructed, a volume of 0 will be returned.
Public function void

Empty ()

 Empty any previously-computed convex hull data.
Public function Const TArray< THalfspace3< RealType > >

GetAsHalfspaces ( TFunctionRef< VectorType(int32)> GetPointFunc
)

 Convert an already-computed convex hull into a halfspace representation Following the logic of ContainmentQueries3.h, all halfspaces are oriented "outwards," so a point is inside the convex hull if it is outside of all halfspaces in the array
Public function Const TArray< THalfspace3< RealType > >

GetAsHalfspaces ( TArrayView< const VectorType > Points
)

 Convert an already-computed convex hull into a halfspace representation Following the logic of ContainmentQueries3.h, all halfspaces are oriented "outwards," so a point is inside the convex hull if it is outside of all halfspaces in the array
Public function Const int Number of dimensions spanned by the input points.
Public function Const void

GetFaces ( TFunctionRef< void(TArray< int32 >&, TVector< RealType >)> PolygonFunc,
TFunctionRef< TVector< RealType >(int32)> GetPointFunc
)

 Get faces of the convex hull as convex polygons, merging faces that are exactly coplanar
Public function Const TLine3< RealType > const &

GetLine ()

  
Public function Const int  
Public function Const TPlane3< RealType > const &  
Public function Const void

GetSimplifiedFaces ( TArray< FPolygonFace >& OutPolygons,
TFunctionRef< TVector< RealType >(int32)> GetPointFunc,
RealType FaceAngleToleranceInDegrees,
RealType PlaneDistanceTolerance,
TArray< TVector< RealType > >* OutPolygonNormals
)

 Get faces of the convex hull as convex polygons, simplifying the hull by merging near-coplanar faces and only keeping vertices that are on the corner of at least three merged faces
Public function Const void

GetSimplifiedFaces ( TFunctionRef< void(TArray< int32 >&, TVector< RealType >)> PolygonFunc,
TFunctionRef< TVector< RealType >(int32)> GetPointFunc,
RealType FaceAngleToleranceInDegrees,
RealType PlaneDistanceTolerance
)

 Get faces of the convex hull as convex polygons, simplifying the hull by merging near-coplanar faces and only keeping vertices that are on the corner of at least three merged faces
Public function Const TArray< FIndex3i > const & Only valid if bSaveTriangleNeighbors was true when Solve() was called
Public function void

GetTriangles ( TFunctionRef< void(FIndex3i)> TriangleFunc
)

 Call TriangleFunc for each triangle of the Convex Hull.
Public function Const TArray< FIndex3i > const &  
Public function Const bool  
Public function TArray< FIndex3i > &&  
Public function bool

Solve ( int32 NumPoints,
TFunctionRef< TVector< RealType >(int32)> GetPointFunc
)

  
Public function bool

Solve ( int32 NumPoints,
TFunctionRef< TVector< RealType >(int32)> GetPointFunc,
TFunctionRef< bool(int32)> FilterFunc
)

 Generate convex hull as long as input is not degenerate If input is degenerate, this will return false, and caller can call GetDimension() to determine whether the points were coplanar, collinear, or all the same point
Public function bool

Solve ( TArrayView< const VectorType > Points,
TFunctionRef< bool(int32)> FilterFunc
)

 Generate convex hull as long as input is not degenerate If input is degenerate, this will return false, and caller can call GetDimension() to determine whether the points were collinear, or all the same point
Public function bool

Solve ( TArrayView< const VectorType > Points
)

 Default FilterFunc version of the above Solve(); workaround for clang bug https://bugs.llvm.org/show_bug.cgi?id=25333
Public function Static void

WalkBorder ( const TArray< FIndex3i >& Triangles,
const TArray< FIndex3i >& TriangleNeighbors,
TFunctionRef< bool(int32)> InGroupFunc,
int32 StartIdx,
TArray< int32 >& OutBorderVertexIndices
)

 Useful helper for walking the border of a convex region, or of a QHull horizon.

Typedefs

Name Description
FPolygonFace Polygon face array type: A nested array with inline allocator per face, optimizing for the case where most faces have less than 8 vertices.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page