geoalgo::AABox Class Reference

Representation of a 3D rectangular box which sides are aligned w/ coordinate axis. A representation of an Axis-Aligned-Boundary-Box, a simple & popular representation of
3D boundary box for collision detection. The concept was taken from the reference,
Real-Time-Collision-Detection (RTCD), and in particular Ch. 4.2 (page 77):
. More...

#include "GeoAABox.h"

Public Member Functions
	AABox ()
	Default constructor. More...
virtual	~AABox ()
	Default destructor. More...
	AABox (const double x_min, const double y_min, const double z_min, const double x_max, const double y_max, const double z_max)
	Alternative ctor (0) More...
	AABox (const Point_t &min, const Vector_t &max)
	Altenartive ctor (1) More...
const Point_t &	Min () const
	Minimum point getter. More...
const Point_t &	Max () const
	Maximum point getter. More...
void	Min (const double x, const double y, const double z)
	Minimum point setter. More...
void	Max (const double x, const double y, const double z)
	Maximum point setter. More...
bool	Contain (const Point_t &pt) const
	Test if a point is contained within the box. More...
template<class T , class U >
	AABox (const T &min, const U &max)
	Alternative ctor using template (3) More...

Protected Attributes
Point_t	_min
	Minimum point. More...
Point_t	_max
	Maximum point. More...

Detailed Description

Representation of a 3D rectangular box which sides are aligned w/ coordinate axis. A representation of an Axis-Aligned-Boundary-Box, a simple & popular representation of
3D boundary box for collision detection. The concept was taken from the reference,
Real-Time-Collision-Detection (RTCD), and in particular Ch. 4.2 (page 77):
.

Ref: http://realtimecollisiondetection.net

This class uses one of the simplest representation for AABox: "min-max" representation.
Though this method requires storing 6 floating point values, class attributes (i.e.
"min" and "max" points) store intuitive values for most UB analyzers. Also it simplifies
utility function implementations.

Definition at line 34 of file GeoAABox.h.

Constructor & Destructor Documentation

geoalgo::AABox::AABox

(

)

Default constructor.

Definition at line 8 of file GeoAABox.cxx.

Referenced by ~AABox().

    : _min(3)
    , _max(3)
  {}

virtual geoalgo::AABox::~AABox ( )

inlinevirtual

Default destructor.

Definition at line 42 of file GeoAABox.h.

References AABox(), Contain(), max, Max(), min, Min(), pt, x, x_max, x_min, y, and z.

{};

geoalgo::AABox::AABox	(	const double	x_min,
		const double	y_min,
		const double	z_min,
		const double	x_max,
		const double	y_max,
		const double	z_max
	)

Alternative ctor (0)

Definition at line 13 of file GeoAABox.cxx.

    : _min ( x_min, y_min, z_min )
    , _max ( x_max, y_max, z_max )
  {}

geoalgo::AABox::AABox	(	const Point_t &	min,
		const Vector_t &	max
	)

Altenartive ctor (1)

Definition at line 19 of file GeoAABox.cxx.

    : _min ( min )
    , _max ( max   )
  { 
    if(min.size()!=3 || max.size()!=3)
      throw GeoAlgoException("AABox ctor accepts only 3D Point!");
  }

template<class T , class U >

geoalgo::AABox::AABox ( const T &  min, const U &  max  )

inline

Alternative ctor using template (3)

Definition at line 71 of file GeoAABox.h.

      : AABox(Point_t(min), Point_t(max))
    {}

Member Function Documentation

bool geoalgo::AABox::Contain

(

const Point_t &

pt

)

const

Test if a point is contained within the box.

Definition at line 35 of file GeoAABox.cxx.

References _max, and _min.

Referenced by geoalgo::GeoAlgo::_SqDist_(), geoalgo::GeoAlgo::BoxOverlap(), and ~AABox().

                                             {
    return !( (pt[0] < _min[0] || _max[0] < pt[0]) || // point is outside X boundaries OR
              (pt[1] < _min[1] || _max[1] < pt[1]) || // point is outside Y boundaries OR
              (pt[2] < _min[2] || _max[2] < pt[2])    // point is outside Z boundaries
              );
  }

const Point_t & geoalgo::AABox::Max

(

)

const

Maximum point getter.

Definition at line 28 of file GeoAABox.cxx.

References _max.

Referenced by geoalgo::GeoAlgo::_ClosestPt_(), geoalgo::GeoAlgo::_SqDist_(), geoalgo::GeoObjCollection::Add(), geoalgo::GeoAlgo::Intersection(), and ~AABox().

{ return _max; }

void geoalgo::AABox::Max	(	const double	x,
		const double	y,
		const double	z
	)

Maximum point setter.

Definition at line 32 of file GeoAABox.cxx.

References _max, x, y, and z.

  { _max[0] = x; _max[1] = y; _max[2] = z; }

const Point_t & geoalgo::AABox::Min

(

)

const

Minimum point getter.

Definition at line 27 of file GeoAABox.cxx.

References _min.

Referenced by geoalgo::GeoAlgo::_ClosestPt_(), geoalgo::GeoAlgo::_SqDist_(), geoalgo::GeoObjCollection::Add(), geoalgo::GeoAlgo::ClosestPt(), geoalgo::GeoAlgo::Intersection(), geoalgo::GeoAlgo::SqDist(), and ~AABox().

{ return _min; }

void geoalgo::AABox::Min	(	const double	x,
		const double	y,
		const double	z
	)

Minimum point setter.

Definition at line 30 of file GeoAABox.cxx.

References _min, x, y, and z.

  { _min[0] = x; _min[1] = y; _min[2] = z; }

Member Data Documentation

Point_t geoalgo::AABox::_max

protected

Maximum point.

Definition at line 63 of file GeoAABox.h.

Referenced by Contain(), and Max().

Point_t geoalgo::AABox::_min

protected

Minimum point.

Definition at line 62 of file GeoAABox.h.

Referenced by Contain(), and Min().

---

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

• /cvmfs/larsoft.opensciencegrid.org/products/larcorealg/v07_03_00/source/larcorealg/GeoAlgo/GeoAABox.h
• /cvmfs/larsoft.opensciencegrid.org/products/larcorealg/v07_03_00/source/larcorealg/GeoAlgo/GeoAABox.cxx