BoundingBox Class Reference

Bounding box defined by minimum and maximum coordinates. More...

#include <BoundingBox.hpp>

Inherited by BoundingBox.

Public Member Functions
	BoundingBox ()
	BoundingBox (const RealVector &min, const RealVector &max)
	Constructor using RealVector. More...
	BoundingBox (const std::vector< Real > &min, const std::vector< Real > &max)
	Constructor using std::vector<Real> More...
void	define (const BoundingBox &other)
	Define bounding box with other bounding box. More...
void	define (const RealVector &min, const RealVector &max)
	Define bounding box with RealVectors. More...
void	define (const std::vector< Real > &min, const std::vector< Real > &max)
	Define bounding box with std::vector<Real> More...
void	extend (const RealVector &point)
	Extend BoundingBox, given a point. More...
void	make_global ()
	Expand bounding box to encompass all processors. More...
bool	contains (const RealVector &coordinate) const
	Check if coordinate falls inside the bounding box. More...
const RealVector &	min () const
	minimum coordinates, defining one corner of the bounding box More...
const RealVector &	max () const
	maximum coordinates, defining one corner of the bounding box More...
RealVector &	min ()
	minimum coordinates, defining one corner of the bounding box More...
RealVector &	max ()
	maximum coordinates, defining one corner of the bounding box More...
Uint	dim () const
	dimension of the bounding box More...

Static Public Member Functions
static std::string	type_name ()
	Gets the Class name. More...

Private Attributes
RealVector	m_bounding_min
	minimum coordinates More...
RealVector	m_bounding_max
	maximum coordinates More...

Detailed Description

Bounding box defined by minimum and maximum coordinates.

Author

Willem Deconinck

Definition at line 24 of file BoundingBox.hpp.

Constructor & Destructor Documentation

BoundingBox

(

)

Definition at line 23 of file BoundingBox.cpp.

BoundingBox	(	const RealVector &	min,
		const RealVector &	max
	)

Constructor using RealVector.

Definition at line 29 of file BoundingBox.cpp.

BoundingBox	(	const std::vector< Real > &	min,
		const std::vector< Real > &	max
	)

Constructor using std::vector<Real>

Definition at line 39 of file BoundingBox.cpp.

Member Function Documentation

bool contains

(

const RealVector &

coordinate

)

const

Check if coordinate falls inside the bounding box.

Definition at line 114 of file BoundingBox.cpp.

void define

(

const BoundingBox &

other

)

Define bounding box with other bounding box.

Definition at line 49 of file BoundingBox.cpp.

void define	(	const RealVector &	min,
		const RealVector &	max
	)

Define bounding box with RealVectors.

Definition at line 56 of file BoundingBox.cpp.

void define	(	const std::vector< Real > &	min,
		const std::vector< Real > &	max
	)

Define bounding box with std::vector<Real>

Definition at line 66 of file BoundingBox.cpp.

Uint dim ( ) const

inline

dimension of the bounding box

Definition at line 73 of file BoundingBox.hpp.

void extend

(

const RealVector &

point

)

Extend BoundingBox, given a point.

Definition at line 76 of file BoundingBox.cpp.

void make_global

(

)

Expand bounding box to encompass all processors.

Note

This function must be called on all processors

Definition at line 94 of file BoundingBox.cpp.

const RealVector& max ( ) const

inline

maximum coordinates, defining one corner of the bounding box

Definition at line 64 of file BoundingBox.hpp.

RealVector& max ( )

inline

maximum coordinates, defining one corner of the bounding box

Definition at line 70 of file BoundingBox.hpp.

const RealVector& min ( ) const

inline

minimum coordinates, defining one corner of the bounding box

Definition at line 61 of file BoundingBox.hpp.

RealVector& min ( )

inline

minimum coordinates, defining one corner of the bounding box

Definition at line 67 of file BoundingBox.hpp.

static std::string type_name ( )

inlinestatic

Gets the Class name.

Definition at line 29 of file BoundingBox.hpp.

Member Data Documentation

RealVector m_bounding_max

private

maximum coordinates

Definition at line 78 of file BoundingBox.hpp.

RealVector m_bounding_min

private

minimum coordinates

Definition at line 77 of file BoundingBox.hpp.

---

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

• cf3/math/BoundingBox.hpp
• cf3/math/BoundingBox.cpp