BALL::TBox3< T > Class Template Reference
[Generic three-dimensional box.]

#include <BALL/MATHS/box3.h>

Inheritance diagram for BALL::TBox3< T >:

Public Member Functions
Constructors and Destructors

	TBox3 ()
	TBox3 (const TBox3 &box)
	TBox3 (const TVector3< T > &point, const TVector3< T > &right_vector=TVector3< T >((T) 0,(T) 1,(T) 0), const TVector3< T > &height_vector=TVector3< T >((T)-1,(T) 0,(T) 0), const T &depth=1)
virtual	~TBox3 ()
virtual void	clear ()
Assignment

void	set (const TBox3 &box)
const TBox3 &	operator= (const TBox3 &box)
void	swap (TBox3 &box)
Accessors

void	setWidth (T width)
	Set width.
T	getWidth () const
	Get width.
void	setHeight (T height)
	Set height.
T	getHeight () const
	Get height.
void	setDepth (T depth)
	Set depth.
T	getDepth () const
	Get depth.
const TVector3< T > &	getPoint () const
	Get the point.
void	setPoint (const TVector3< T > &point)
	Set the point.
const TVector3< T > &	getRightVector () const
	Get the right vector.
void	setRightVector (const TVector3< T > &v)
	Set the right vector.
const TVector3< T > &	getHeightVector () const
	Get the height vector.
void	setHeightVector (const TVector3< T > &v)
	Set the height vector.
T	getSurface () const
T	getVolume () const
TVector3< T >	getDiagonalVector () const
Predicates

bool	operator== (const TBox3 &box) const
bool	operator!= (const TBox3 &box) const
Debugging and Diagnostics

bool	isValid () const
void	dump (std::ostream &s=std::cout, Size depth=0) const
Protected Attributes
TVector3< T >	point_
TVector3< T >	right_vector_
TVector3< T >	height_vector_
T	width_
T	height_
T	depth_

Detailed Description

template<typename T>
class BALL::TBox3< T >

Generic three-dimensional Box. This class describes a three-dimensional box. A box is given by the coordinates of the lower left front corner, width, height, depth and the right vector.\

Constructor & Destructor Documentation

template<typename T >

BALL::TBox3< T >::TBox3 ( ) [inline]

Default constructor.

template<typename T >

BALL::TBox3< T >::TBox3 ( const TBox3< T > & box ) [inline]

Copy constructor.

Parameters:

box

the TBox3 object to be copied

template<typename T >

BALL::TBox3< T >::TBox3	(	const TVector3< T > &	point,
		const TVector3< T > &	right_vector = `TVector3<T>((T) 0, (T)1, (T)0)`,
		const TVector3< T > &	height_vector = `TVector3<T>((T)-1, (T)0, (T)0)`,
		const T &	depth = `1`
	)			`[inline]`

Detailed constructor.

template<typename T>

virtual BALL::TBox3< T >::~TBox3 ( ) [inline, virtual]

Destructor.

Member Function Documentation

template<typename T >

void BALL::TBox3< T >::clear ( ) [inline, virtual]

Clear method. The values are set to 0.

Reimplemented in BALL::VIEW::Box.

References BALL::TBox3< T >::depth_, BALL::TBox3< T >::height_, BALL::TBox3< T >::height_vector_, BALL::TBox3< T >::point_, BALL::TBox3< T >::right_vector_, and BALL::TBox3< T >::width_.

template<typename T >

void BALL::TBox3< T >::dump	(	std::ostream &	s = `std::cout`,
		Size	depth = `0`
	)			const `[inline]`

Internal state dump. Dump the current internal state of {*this} to the output ostream s with dumping depth depth .

Parameters:

	s	- output stream where to output the internal state of {*this}
	depth	- the dumping depth

Reimplemented in BALL::VIEW::Box.

References BALL_DUMP_DEPTH, BALL_DUMP_HEADER, BALL_DUMP_STREAM_PREFIX, BALL_DUMP_STREAM_SUFFIX, BALL::TBox3< T >::depth_, BALL::TBox3< T >::height_, BALL::TBox3< T >::height_vector_, BALL::TBox3< T >::point_, BALL::TBox3< T >::right_vector_, and BALL::TBox3< T >::width_.

template<typename T>

T BALL::TBox3< T >::getDepth ( ) const [inline]

Get depth.

References BALL::TBox3< T >::depth_.

template<typename T >

TVector3< T > BALL::TBox3< T >::getDiagonalVector ( ) const [inline]

References BALL::TBox3< T >::depth_, BALL::TBox3< T >::height_vector_, BALL::TVector3< T >::normalize(), and BALL::TBox3< T >::right_vector_.

template<typename T>

T BALL::TBox3< T >::getHeight ( ) const [inline]

Get height.

References BALL::TBox3< T >::height_.

template<typename T>

const TVector3<T>& BALL::TBox3< T >::getHeightVector ( ) const [inline]

Get the height vector.

References BALL::TBox3< T >::height_vector_.

template<typename T>

const TVector3<T>& BALL::TBox3< T >::getPoint ( ) const [inline]

Get the point.

References BALL::TBox3< T >::point_.

template<typename T>

const TVector3<T>& BALL::TBox3< T >::getRightVector ( ) const [inline]

Get the right vector.

References BALL::TBox3< T >::right_vector_.

template<typename T >

BALL_INLINE T BALL::TBox3< T >::getSurface ( ) const [inline]

Calculate the surface area.

Returns:: T the surface

References BALL::TBox3< T >::depth_, BALL::TBox3< T >::height_, and BALL::TBox3< T >::width_.

template<typename T >

BALL_INLINE T BALL::TBox3< T >::getVolume ( ) const [inline]

Calculate the volume.

Returns:: T the volume

References BALL::TBox3< T >::depth_, BALL::TBox3< T >::height_, and BALL::TBox3< T >::width_.

template<typename T>

T BALL::TBox3< T >::getWidth ( ) const [inline]

Get width.

References BALL::TBox3< T >::width_.

template<typename T >

BALL_INLINE bool BALL::TBox3< T >::isValid ( ) const [inline]

Test whether instance is valid. Always returns true.

Returns:: bool true

Reimplemented in BALL::VIEW::Box.

References BALL::TBox3< T >::height_vector_, BALL::TBox3< T >::point_, and BALL::TBox3< T >::right_vector_.

template<typename T >

BALL_INLINE bool BALL::TBox3< T >::operator!= ( const TBox3< T > & box ) const [inline]

Inequality operator.

Returns:: bool, true if the two boxes differ in at least one component, false otherwise

template<typename T >

BALL_INLINE const TBox3< T > & BALL::TBox3< T >::operator= ( const TBox3< T > & box ) [inline]

Assignment operator. Assign the box components from another instance of TBox3.

Parameters:

box

the TBox3 to assign from

template<typename T >

bool BALL::TBox3< T >::operator== ( const TBox3< T > & box ) const [inline]

Equality operator.

Returns:: bool, true if all box components are equal, false otherwise

References BALL::TBox3< T >::depth_, BALL::TBox3< T >::height_, BALL::TBox3< T >::height_vector_, BALL::TBox3< T >::point_, BALL::TBox3< T >::right_vector_, and BALL::TBox3< T >::width_.

template<typename T >

void BALL::TBox3< T >::set ( const TBox3< T > & box ) [inline]

Assign from another instance of TBox3.

Parameters:

box

the TBox3 object to assign from

References BALL::TBox3< T >::depth_, BALL::TBox3< T >::height_, BALL::TBox3< T >::height_vector_, BALL::TBox3< T >::point_, BALL::TBox3< T >::right_vector_, and BALL::TBox3< T >::width_.

template<typename T>

void BALL::TBox3< T >::setDepth ( T depth ) [inline]

Set depth.

References BALL::TBox3< T >::depth_.

Referenced by BALL::operator>>().

template<typename T >

BALL_INLINE void BALL::TBox3< T >::setHeight ( T height ) [inline]

Set height.

References BALL::TBox3< T >::height_, and BALL::TBox3< T >::height_vector_.

template<typename T >

BALL_INLINE void BALL::TBox3< T >::setHeightVector ( const TVector3< T > & v ) [inline]

Set the height vector.

References BALL::TBox3< T >::height_, and BALL::TBox3< T >::height_vector_.

Referenced by BALL::operator>>().

template<typename T>

void BALL::TBox3< T >::setPoint ( const TVector3< T > & point ) [inline]

Set the point.

References BALL::TBox3< T >::point_.

Referenced by BALL::operator>>().

template<typename T >

BALL_INLINE void BALL::TBox3< T >::setRightVector ( const TVector3< T > & v ) [inline]

Set the right vector.

References BALL::TBox3< T >::right_vector_, and BALL::TBox3< T >::width_.

Referenced by BALL::operator>>().

template<typename T >

BALL_INLINE void BALL::TBox3< T >::setWidth ( T width ) [inline]

Set width.

References BALL::TBox3< T >::right_vector_, and BALL::TBox3< T >::width_.

template<typename T >

void BALL::TBox3< T >::swap ( TBox3< T > & box ) [inline]

Swap the contents of two instances.

Parameters:

box

the box to swap contents with

References BALL::TBox3< T >::depth_, BALL::TBox3< T >::height_, BALL::TBox3< T >::height_vector_, BALL::TBox3< T >::point_, BALL::TBox3< T >::right_vector_, and BALL::TBox3< T >::width_.

Member Data Documentation

template<typename T>

T BALL::TBox3< T >::depth_ [protected]

Referenced by BALL::TBox3< T >::clear(), BALL::TBox3< T >::dump(), BALL::TBox3< T >::getDepth(), BALL::TBox3< T >::getDiagonalVector(), BALL::TBox3< T >::getSurface(), BALL::TBox3< T >::getVolume(), BALL::TBox3< T >::operator==(), BALL::TBox3< T >::set(), BALL::TBox3< T >::setDepth(), and BALL::TBox3< T >::swap().

template<typename T>

T BALL::TBox3< T >::height_ [protected]

Referenced by BALL::TBox3< T >::clear(), BALL::TBox3< T >::dump(), BALL::TBox3< T >::getHeight(), BALL::TBox3< T >::getSurface(), BALL::TBox3< T >::getVolume(), BALL::TBox3< T >::operator==(), BALL::TBox3< T >::set(), BALL::TBox3< T >::setHeight(), BALL::TBox3< T >::setHeightVector(), and BALL::TBox3< T >::swap().

template<typename T>

TVector3<T> BALL::TBox3< T >::height_vector_ [protected]

Referenced by BALL::TBox3< T >::clear(), BALL::TBox3< T >::dump(), BALL::TBox3< T >::getDiagonalVector(), BALL::TBox3< T >::getHeightVector(), BALL::TBox3< T >::isValid(), BALL::TBox3< T >::operator==(), BALL::TBox3< T >::set(), BALL::TBox3< T >::setHeight(), BALL::TBox3< T >::setHeightVector(), and BALL::TBox3< T >::swap().

template<typename T>

TVector3<T> BALL::TBox3< T >::point_ [protected]

Referenced by BALL::TBox3< T >::clear(), BALL::TBox3< T >::dump(), BALL::TBox3< T >::getPoint(), BALL::TBox3< T >::isValid(), BALL::TBox3< T >::operator==(), BALL::TBox3< T >::set(), BALL::TBox3< T >::setPoint(), and BALL::TBox3< T >::swap().

template<typename T>

TVector3<T> BALL::TBox3< T >::right_vector_ [protected]

Referenced by BALL::TBox3< T >::clear(), BALL::TBox3< T >::dump(), BALL::TBox3< T >::getDiagonalVector(), BALL::TBox3< T >::getRightVector(), BALL::TBox3< T >::isValid(), BALL::TBox3< T >::operator==(), BALL::TBox3< T >::set(), BALL::TBox3< T >::setRightVector(), BALL::TBox3< T >::setWidth(), and BALL::TBox3< T >::swap().

template<typename T>

T BALL::TBox3< T >::width_ [protected]

Referenced by BALL::TBox3< T >::clear(), BALL::TBox3< T >::dump(), BALL::TBox3< T >::getSurface(), BALL::TBox3< T >::getVolume(), BALL::TBox3< T >::getWidth(), BALL::TBox3< T >::operator==(), BALL::TBox3< T >::set(), BALL::TBox3< T >::setRightVector(), BALL::TBox3< T >::setWidth(), and BALL::TBox3< T >::swap().

BALL::TBox3< T > Class Template Reference [Generic three-dimensional box.]

Public Member Functions

Protected Attributes

Detailed Description

template<typename T> class BALL::TBox3< T >

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

BALL::TBox3< T > Class Template Reference
[Generic three-dimensional box.]

template<typename T>
class BALL::TBox3< T >