Templated tree of axis-aligned bounding boxes (AABB) More...

Inheritance diagram for AABBTree< Type >:

Collaboration diagram for AABBTree< Type >:

Public Member Functions
	AABBTree ()
	Default construct. More...

	AABBTree (const UList< Type > &objects, const pointField &points, const bool equalBinSize=true, label maxLevel=3, label minBinSize=100)
	Construct from components. More...

const List< treeBoundBox > &	boundBoxes () const noexcept
	Return the bounding boxes making up the tree. More...

const List< labelList > &	addressing () const noexcept
	Return the contents addressing. More...

bool	pointInside (const point &pt) const
	Determine whether a point is inside the bounding boxes. More...

bool	overlaps (const boundBox &bbIn) const
	Determine whether a bounding box overlaps the tree bounding boxes. More...

void	writeOBJ (Ostream &os) const
	Write all tree boxes (leaves) in OBJ format. More...

Public Member Functions inherited from AABBTreeBase
	AABBTreeBase ()=default
	Default construct. More...

Protected Member Functions
void	writeOBJ (const bool leavesOnly, const bool writeLinesOnly, const treeBoundBox &bb, const label nodeI, const List< Pair< treeBoundBox >> &bbs, const List< Pair< label >> &nodes, label &vertI, Ostream &os) const
	Write OBJ for all bounding boxes. More...

void	createBoxes (const bool equalBinSize, const label level, const UList< Type > &objects, const pointField &points, const labelUList &objectIDs, const treeBoundBox &bb, const label nodeI, DynamicList< Pair< treeBoundBox >> &bbs, DynamicList< labelPair > &nodes, DynamicList< labelList > &addressing) const
	Create the bounding boxes by interrogating points. More...

Protected Attributes
label	maxLevel_
	Maximum tree level. More...

label	minLeafSize_
	Minimum points per leaf. More...

List< treeBoundBox >	boundBoxes_
	Bounding boxes making up the tree. More...

List< labelList >	addressing_
	Leaf addressing. More...

Friends
Istream &	operator>> (Istream &, AABBTree &)

Ostream &	operator (Ostream &, const AABBTree &)

Additional Inherited Members
Static Public Member Functions inherited from AABBTreeBase
static void	writeOBJ (Ostream &os, const treeBoundBox &bb, label &vertIndex, const bool writeLinesOnly=false)
	Write treeBoundBox in OBJ format. More...

Static Protected Attributes inherited from AABBTreeBase
static scalar	tolerance_ = 1e-4
	Relative tolerance. More...

Detailed Description

template<class Type>
class Foam::AABBTree< Type >

Templated tree of axis-aligned bounding boxes (AABB)

Designed to be templated on either faces or cells, the AABBTree will decompose the input into a tree of AABB's. The maximum number of tree levels and minimum number of objects per leaf are provided on construction, and the contents (addressing) is stored.

Source files

Definition at line 55 of file AABBTree.H.

Constructor & Destructor Documentation

◆ AABBTree() [1/2]

AABBTree ( )

Default construct.

Definition at line 270 of file AABBTree.C.

◆ AABBTree() [2/2]

AABBTree	(	const UList< Type > &	objects,
		const pointField &	points,
		const bool	equalBinSize = `true`,
		label	maxLevel = `3`,
		label	minBinSize = `100`
	)

Construct from components.

equalBinSize: divide into equal number of elements or equal span

Definition at line 281 of file AABBTree.C.

References DynamicList< T, SizeMin >::emplace_back(), UList< T >::empty(), Foam::endl(), forAll, Foam::identity(), boundBox::inflate(), Foam::Info, points, DynamicList< T, SizeMin >::push_back(), bitSet::set(), and UList< T >::size().

Here is the call graph for this function:

Member Function Documentation

◆ writeOBJ() [1/2]

void writeOBJ	(	const bool	leavesOnly,
		const bool	writeLinesOnly,
		const treeBoundBox &	bb,
		const label	nodeI,
		const List< Pair< treeBoundBox >> &	bbs,
		const List< Pair< label >> &	nodes,
		label &	vertI,
		Ostream &	os
	)		const

protected

Write OBJ for all bounding boxes.

Definition at line 29 of file AABBTree.C.

References os(), and Foam::meshTools::writeOBJ().

Here is the call graph for this function:

◆ createBoxes()

void createBoxes	(	const bool	equalBinSize,
		const label	level,
		const UList< Type > &	objects,
		const pointField &	points,
		const labelUList &	objectIDs,
		const treeBoundBox &	bb,
		const label	nodeI,
		DynamicList< Pair< treeBoundBox >> &	bbs,
		DynamicList< labelPair > &	nodes,
		DynamicList< labelList > &	addressing
	)		const

protected

Create the bounding boxes by interrogating points.

Definition at line 76 of file AABBTree.C.

References boundBox::add(), Foam::component(), DynamicList< T, SizeMin >::emplace_back(), boundBox::inflate(), boundBox::maxDir(), boundBox::min(), points, DynamicList< T, SizeMin >::push_back(), UList< T >::size(), Foam::sort(), and boundBox::span().

Here is the call graph for this function:

◆ boundBoxes()

const List<treeBoundBox>& boundBoxes ( ) const

inlinenoexcept

Return the bounding boxes making up the tree.

Definition at line 209 of file AABBTree.H.

References AABBTree< Type >::boundBoxes_.

◆ addressing()

const List<labelList>& addressing ( ) const

inlinenoexcept

Return the contents addressing.

Definition at line 217 of file AABBTree.H.

References AABBTree< Type >::addressing_.

◆ pointInside()

bool pointInside ( const point & pt ) const

Determine whether a point is inside the bounding boxes.

Definition at line 403 of file AABBTree.C.

References treeBoundBox::contains().

Here is the call graph for this function:

◆ overlaps()

bool overlaps ( const boundBox & bbIn ) const

Determine whether a bounding box overlaps the tree bounding boxes.

Definition at line 418 of file AABBTree.C.

References treeBoundBox::overlaps().

Here is the call graph for this function:

◆ writeOBJ() [2/2]

void writeOBJ ( Ostream & os ) const

Write all tree boxes (leaves) in OBJ format.

Definition at line 390 of file AABBTree.C.

References os(), and AABBTreeBase::writeOBJ().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ operator>>

Istream& operator>>	(	Istream &	,
		AABBTree< Type > &
	)

friend

◆ operator

Ostream& operator	(	Ostream &	,
		const AABBTree< Type > &
	)

friend

Member Data Documentation

◆ maxLevel_

label maxLevel_

protected

Maximum tree level.

Definition at line 124 of file AABBTree.H.

◆ minLeafSize_

label minLeafSize_

protected

Minimum points per leaf.

Definition at line 129 of file AABBTree.H.

◆ boundBoxes_

List<treeBoundBox> boundBoxes_

protected

Bounding boxes making up the tree.

Definition at line 134 of file AABBTree.H.

Referenced by AABBTree< Type >::boundBoxes().

◆ addressing_

List<labelList> addressing_

protected

Leaf addressing.

Definition at line 139 of file AABBTree.H.

Referenced by AABBTree< Type >::addressing().

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

src/OpenFOAM/algorithms/AABBTree/AABBTree.H
src/OpenFOAM/algorithms/AABBTree/AABBTree.C

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

template<class Type> class Foam::AABBTree< Type >

Constructor & Destructor Documentation

◆ AABBTree() [1/2]

◆ AABBTree() [2/2]

Member Function Documentation

◆ writeOBJ() [1/2]

◆ createBoxes()

◆ boundBoxes()

◆ addressing()

◆ pointInside()

◆ overlaps()

◆ writeOBJ() [2/2]

Friends And Related Function Documentation

◆ operator>>

◆ operator

Member Data Documentation

◆ maxLevel_

◆ minLeafSize_

◆ boundBoxes_

◆ addressing_

template<class Type>
class Foam::AABBTree< Type >