TriangleSplitter Class Reference

A class that splits a triangle list into two parts for building a tree. More...

#include <TriangleSplitter.h>

Inheritance diagram for TriangleSplitter:

Classes
struct	Range
	Helper struct to indicate triangle range before and after the split. More...
struct	Stats

Public Member Functions
	TriangleSplitter (const VertexList &inVertices, const IndexedTriangleList &inTriangles)
	Constructor. More...
virtual	~TriangleSplitter ()=default
	Virtual destructor. More...
virtual void	GetStats (Stats &outStats) const =0
	Get stats of splitter. More...
Range	GetInitialRange () const
	Range of triangles to start with. More...
virtual bool	Split (const Range &inTriangles, Range &outLeft, Range &outRight)=0
const VertexList &	GetVertices () const
	Get the list of vertices. More...
const IndexedTriangle &	GetTriangle (uint inIdx) const
	Get triangle by index. More...

Protected Member Functions
bool	SplitInternal (const Range &inTriangles, uint inDimension, float inSplit, Range &outLeft, Range &outRight)
	Helper function to split triangles based on dimension and split value. More...

Protected Attributes
const VertexList &	mVertices
	Vertices of the indexed triangles. More...
const IndexedTriangleList &	mTriangles
	Unsorted triangles. More...
Array< Float3 >	mCentroids
	Unsorted centroids of triangles. More...
Array< uint >	mSortedTriangleIdx
	Indices to sort triangles. More...

Detailed Description

A class that splits a triangle list into two parts for building a tree.

Constructor & Destructor Documentation

TriangleSplitter()

JPH_NAMESPACE_BEGIN TriangleSplitter::TriangleSplitter	(	const VertexList &	inVertices,
		const IndexedTriangleList &	inTriangles
	)

Constructor.

~TriangleSplitter()

virtual TriangleSplitter::~TriangleSplitter ( )

virtualdefault

Virtual destructor.

Member Function Documentation

GetInitialRange()

Range TriangleSplitter::GetInitialRange ( ) const

inline

Range of triangles to start with.

GetStats()

virtual void TriangleSplitter::GetStats ( Stats &  outStats ) const

pure virtual

Get stats of splitter.

Implemented in TriangleSplitterBinning, TriangleSplitterFixedLeafSize, TriangleSplitterLongestAxis, TriangleSplitterMean, and TriangleSplitterMorton.

GetTriangle()

const IndexedTriangle & TriangleSplitter::GetTriangle ( uint  inIdx ) const

inline

Get triangle by index.

GetVertices()

const VertexList & TriangleSplitter::GetVertices ( ) const

inline

Get the list of vertices.

Split()

virtual bool TriangleSplitter::Split ( const Range &  inTriangles, Range &  outLeft, Range &  outRight  )

pure virtual

Split triangles into two groups left and right, returns false if no split could be made

Parameters

inTriangles	The range of triangles (in mSortedTriangleIdx) to process
outLeft	On return this will contain the ranges for the left subpart. mSortedTriangleIdx may have been shuffled.
outRight	On return this will contain the ranges for the right subpart. mSortedTriangleIdx may have been shuffled.

Returns

Returns true when a split was found

Implemented in TriangleSplitterBinning, TriangleSplitterFixedLeafSize, TriangleSplitterLongestAxis, TriangleSplitterMean, and TriangleSplitterMorton.

SplitInternal()

bool TriangleSplitter::SplitInternal ( const Range &  inTriangles, uint  inDimension, float  inSplit, Range &  outLeft, Range &  outRight  )

protected

Helper function to split triangles based on dimension and split value.

Member Data Documentation

mCentroids

Array<Float3> TriangleSplitter::mCentroids

protected

Unsorted centroids of triangles.

mSortedTriangleIdx

Array<uint> TriangleSplitter::mSortedTriangleIdx

protected

Indices to sort triangles.

mTriangles

const IndexedTriangleList& TriangleSplitter::mTriangles

protected

Unsorted triangles.

mVertices

const VertexList& TriangleSplitter::mVertices

protected

Vertices of the indexed triangles.

---

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

• Jolt/TriangleSplitter/TriangleSplitter.h
• Jolt/TriangleSplitter/TriangleSplitter.cpp