JPL::ConvexHullBuilder< Vec3Type > Class Template Reference

#include <JPLSpatial/Geometry/ConvexHullBuilder.h>

Classes
class	Edge
	Class that holds the information of an edge. More...
class	Face
	Class that holds the information of one face. More...

Public Types
enum class	EResult {   Success , MaxVerticesReached , TooFewPoints , TooFewFaces ,   Degenerate }
	Result enum that indicates how the hull got created. More...
using	ConflictList = Array< int >
using	Positions = std::span< const Vec3 >
using	Faces = Array< Face * >

Public Member Functions
	ConvexHullBuilder (Positions inPositions)
	~ConvexHullBuilder ()
EResult	Initialize (int inMaxVertices, float inTolerance, const char *&outError)
int	GetNumVerticesUsed () const
	Returns the amount of vertices that are currently used by the hull.
bool	ContainsFace (const Array< int > &inIndices) const
	Returns true if the hull contains a polygon with inIndices (counter clockwise indices in mPositions)
const Faces &	GetFaces () const
	Access to the created faces. Memory is owned by the convex hull builder.
template<class Vec3i >
void	GetTriangles (Array< Vec3i > &outTris)

Detailed Description

template<CVec3 Vec3Type>
class JPL::ConvexHullBuilder< Vec3Type >

Class to generate convex hull from a list of points, suitable for generating speaker mesh for VBAP.

Note: This is a slightly modified version of ConvexHullBuilder from JoltPhysics library

Member Typedef Documentation

ConflictList

template<CVec3 Vec3Type>

using JPL::ConvexHullBuilder< Vec3Type >::ConflictList = Array<int>

Faces

template<CVec3 Vec3Type>

using JPL::ConvexHullBuilder< Vec3Type >::Faces = Array<Face*>

Positions

template<CVec3 Vec3Type>

using JPL::ConvexHullBuilder< Vec3Type >::Positions = std::span<const Vec3>

Member Enumeration Documentation

EResult

template<CVec3 Vec3Type>

enum class JPL::ConvexHullBuilder::EResult

strong

Result enum that indicates how the hull got created.

Enumerator
Success	Hull building finished successfully.
MaxVerticesReached	Hull building finished successfully, but the desired accuracy was not reached because the max vertices limit was reached.
TooFewPoints	Too few points to create a hull.
TooFewFaces	Too few faces in the created hull (signifies precision errors during building)
Degenerate	Degenerate hull detected.

Constructor & Destructor Documentation

ConvexHullBuilder()

template<CVec3 Vec3Type>

JPL::ConvexHullBuilder< Vec3Type >::ConvexHullBuilder ( Positions  inPositions )

inline

~ConvexHullBuilder()

template<CVec3 Vec3Type>

JPL::ConvexHullBuilder< Vec3Type >::~ConvexHullBuilder ( )

inline

Member Function Documentation

ContainsFace()

template<CVec3 Vec3Type>

bool JPL::ConvexHullBuilder< Vec3Type >::ContainsFace ( const Array< int > &  inIndices ) const

inline

Returns true if the hull contains a polygon with inIndices (counter clockwise indices in mPositions)

GetFaces()

template<CVec3 Vec3Type>

const Faces & JPL::ConvexHullBuilder< Vec3Type >::GetFaces ( ) const

inline

Access to the created faces. Memory is owned by the convex hull builder.

GetNumVerticesUsed()

template<CVec3 Vec3Type>

int JPL::ConvexHullBuilder< Vec3Type >::GetNumVerticesUsed ( ) const

inline

Returns the amount of vertices that are currently used by the hull.

GetTriangles()

template<CVec3 Vec3Type>

template<class Vec3i >

void JPL::ConvexHullBuilder< Vec3Type >::GetTriangles ( Array< Vec3i > &  outTris )

inline

Get triangle indices for all faces in the hull. Note: any faces that are polygons will be triangulated.

Initialize()

template<CVec3 Vec3Type>

ConvexHullBuilder< Vec3Type >::EResult JPL::ConvexHullBuilder< Vec3Type >::Initialize ( int  inMaxVertices, float  inTolerance, const char *&  outError  )

inline

Takes all positions as provided by the constructor and use them to build a hull Any points that are closer to the hull than inTolerance will be discarded

Parameters

inMaxVertices	Max vertices to allow in the hull. Specify INT_MAX if there is no limit.
inTolerance	Max distance that a point is allowed to be outside of the hull
outError	Error message when building fails

Returns

Status code that reports if the hull was created or not

Coplanar hull is invalid for 3D VBAP

---

The documentation for this class was generated from the following file:

• JPLSpatial/Geometry/ConvexHullBuilder.h