Defines axis aligned bounding box (AABB) based on BVH vectors. More...

#include <BVH_Box.hxx>

Inheritance diagram for BVH_Box< T, N >:

Public Types
typedef BVH::VectorType< T, N >::Type	BVH_VecNt

Public Member Functions
	BVH_Box ()
	Creates uninitialized bounding box.

	BVH_Box (const BVH_VecNt &thePoint)
	Creates bounding box of given point.

	BVH_Box (const BVH_VecNt &theMinPoint, const BVH_VecNt &theMaxPoint)
	Creates bounding box from corner points.

void	Clear ()
	Clears bounding box.

Standard_Boolean	IsValid () const
	Is bounding box valid?

void	Add (const BVH_VecNt &thePoint)
	Appends new point to the bounding box.

void	Combine (const BVH_Box &theBox)
	Combines bounding box with another one.

const BVH_VecNt &	CornerMin () const
	Returns minimum point of bounding box.

const BVH_VecNt &	CornerMax () const
	Returns maximum point of bounding box.

BVH_VecNt &	CornerMin ()
	Returns minimum point of bounding box.

BVH_VecNt &	CornerMax ()
	Returns maximum point of bounding box.

T	Area () const
	Returns surface area of bounding box. If the box is degenerated into line, returns the perimeter instead.

BVH_VecNt	Size () const
	Returns diagonal of bounding box.

BVH_VecNt	Center () const
	Returns center of bounding box.

T	Center (const Standard_Integer theAxis) const
	Returns center of bounding box along the given axis.

void	DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const
	Dumps the content of me into the stream.

Standard_Boolean	InitFromJson (const Standard_SStream &theSStream, Standard_Integer &theStreamPos)
	Inits the content of me from the stream.

Standard_Boolean	IsOut (const BVH_Box< T, N > &theOther) const
	Checks if the Box is out of the other box.

Standard_Boolean	IsOut (const BVH_VecNt &theMinPoint, const BVH_VecNt &theMaxPoint) const
	Checks if the Box is out of the other box defined by two points.

Standard_Boolean	Contains (const BVH_Box< T, N > &theOther, Standard_Boolean &hasOverlap) const
	Checks if the Box fully contains the other box.

Standard_Boolean	Contains (const BVH_VecNt &theMinPoint, const BVH_VecNt &theMaxPoint, Standard_Boolean &hasOverlap) const
	Checks if the Box is fully contains the other box.

Standard_Boolean	IsOut (const BVH_VecNt &thePoint) const
	Checks if the Point is out of the box.

Protected Attributes
BVH_VecNt	myMinPoint
	Minimum point of bounding box.

BVH_VecNt	myMaxPoint
	Maximum point of bounding box.

Standard_Boolean	myIsInited
	Is bounding box initialized?

Detailed Description

template<class T, int N>
class BVH_Box< T, N >

Defines axis aligned bounding box (AABB) based on BVH vectors.

Template Parameters

T	Numeric data type
N	Vector dimension

Member Typedef Documentation

◆ BVH_VecNt

template<class T , int N>

BVH::VectorType<T,N>::Type BVH_Box< T, N >::BVH_VecNt

Constructor & Destructor Documentation

◆ BVH_Box() [1/3]

template<class T , int N>

BVH_Box< T, N >::BVH_Box ( )

inline

Creates uninitialized bounding box.

◆ BVH_Box() [2/3]

template<class T , int N>

BVH_Box< T, N >::BVH_Box ( const BVH_VecNt & thePoint )

inline

Creates bounding box of given point.

◆ BVH_Box() [3/3]

template<class T , int N>

BVH_Box< T, N >::BVH_Box	(	const BVH_VecNt &	theMinPoint,
		const BVH_VecNt &	theMaxPoint )

inline

Creates bounding box from corner points.

Member Function Documentation

◆ Add()

template<class T , int N>

void BVH_Box< T, N >::Add ( const BVH_VecNt & thePoint )

inline

Appends new point to the bounding box.

◆ Area()

template<class T , int N>

T BVH_Box< T, N >::Area ( ) const

Returns surface area of bounding box. If the box is degenerated into line, returns the perimeter instead.

◆ Center() [1/2]

template<class T , int N>

BVH_VecNt BVH_Box< T, N >::Center ( ) const

inline

Returns center of bounding box.

◆ Center() [2/2]

template<class T , int N>

T BVH_Box< T, N >::Center ( const Standard_Integer theAxis ) const

Returns center of bounding box along the given axis.

◆ Clear()

template<class T , int N>

void BVH_Box< T, N >::Clear ( )

inline

Clears bounding box.

◆ Combine()

template<class T , int N>

void BVH_Box< T, N >::Combine ( const BVH_Box< T, N > & theBox )

Combines bounding box with another one.

◆ Contains() [1/2]

template<class T , int N>

Standard_Boolean BVH_Box< T, N >::Contains	(	const BVH_Box< T, N > &	theOther,
		Standard_Boolean &	hasOverlap ) const

inline

Checks if the Box fully contains the other box.

◆ Contains() [2/2]

template<class T , int N>

Standard_Boolean BVH_Box< T, N >::Contains	(	const BVH_VecNt &	theMinPoint,
		const BVH_VecNt &	theMaxPoint,
		Standard_Boolean &	hasOverlap ) const

inline

Checks if the Box is fully contains the other box.

◆ CornerMax() [1/2]

template<class T , int N>

BVH_VecNt & BVH_Box< T, N >::CornerMax ( )

inline

Returns maximum point of bounding box.

◆ CornerMax() [2/2]

template<class T , int N>

const BVH_VecNt & BVH_Box< T, N >::CornerMax ( ) const

inline

Returns maximum point of bounding box.

◆ CornerMin() [1/2]

template<class T , int N>

BVH_VecNt & BVH_Box< T, N >::CornerMin ( )

inline

Returns minimum point of bounding box.

◆ CornerMin() [2/2]

template<class T , int N>

const BVH_VecNt & BVH_Box< T, N >::CornerMin ( ) const

inline

Returns minimum point of bounding box.

◆ DumpJson()

template<class T , int N>

void BVH_Box< T, N >::DumpJson	(	Standard_OStream &	theOStream,
		Standard_Integer	theDepth = -1 ) const

inline

Dumps the content of me into the stream.

◆ InitFromJson()

template<class T , int N>

Standard_Boolean BVH_Box< T, N >::InitFromJson	(	const Standard_SStream &	theSStream,
		Standard_Integer &	theStreamPos )

inline

Inits the content of me from the stream.

◆ IsOut() [1/3]

template<class T , int N>

Standard_Boolean BVH_Box< T, N >::IsOut ( const BVH_Box< T, N > & theOther ) const

inline

Checks if the Box is out of the other box.

◆ IsOut() [2/3]

template<class T , int N>

Standard_Boolean BVH_Box< T, N >::IsOut	(	const BVH_VecNt &	theMinPoint,
		const BVH_VecNt &	theMaxPoint ) const

inline

Checks if the Box is out of the other box defined by two points.

◆ IsOut() [3/3]

template<class T , int N>

Standard_Boolean BVH_Box< T, N >::IsOut ( const BVH_VecNt & thePoint ) const

inline

Checks if the Point is out of the box.

◆ IsValid()

template<class T , int N>

Standard_Boolean BVH_Box< T, N >::IsValid ( ) const

inline

Is bounding box valid?

◆ Size()

template<class T , int N>

BVH_VecNt BVH_Box< T, N >::Size ( ) const

inline

Returns diagonal of bounding box.

Field Documentation

◆ myIsInited

template<class T , int N>

Standard_Boolean BVH_Box< T, N >::myIsInited

protected

Is bounding box initialized?

◆ myMaxPoint

template<class T , int N>

BVH_VecNt BVH_Box< T, N >::myMaxPoint

protected

Maximum point of bounding box.

◆ myMinPoint

template<class T , int N>

BVH_VecNt BVH_Box< T, N >::myMinPoint

protected

Minimum point of bounding box.

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

BVH_Box.hxx

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ BVH_VecNt

Constructor & Destructor Documentation

◆ BVH_Box() [1/3]

◆ BVH_Box() [2/3]

◆ BVH_Box() [3/3]

Member Function Documentation

◆ Add()

◆ Area()

◆ Center() [1/2]

◆ Center() [2/2]

◆ Clear()

◆ Combine()

◆ Contains() [1/2]

◆ Contains() [2/2]

◆ CornerMax() [1/2]

◆ CornerMax() [2/2]

◆ CornerMin() [1/2]

◆ CornerMin() [2/2]

◆ DumpJson()

◆ InitFromJson()

◆ IsOut() [1/3]

◆ IsOut() [2/3]

◆ IsOut() [3/3]

◆ IsValid()

◆ Size()

Field Documentation

◆ myIsInited

◆ myMaxPoint

◆ myMinPoint