N-dimensional axis-aligned bounding-box. More...

#include <Box.h>

Inheritance diagram for fe::Box< N, T >:

Public Member Functions
	Box (const Vector< N, T > &location)

	Box (const Vector< N, T > &location, const Vector< N, T > &size)

	Box (const Box< N, T > &rhs)

Box< N, T > &	operator= (const Box< N, T > &rhs)

Vector< N, T > &	size (void)

const Vector< N, T > &	size (void) const

Public Member Functions inherited from fe::Vector< N, T >
	Vector (const Vector< N, T > &other)

template<typename U >
	Vector (const Vector< N, U > &other)

template<typename U >
	Vector (const Vector< N+1, U > &other)

template<typename U >
	Vector (const Vector< N+2, U > &other)

template<typename U >
	Vector (const Vector< N-1, U > &other)

template<typename U >
	Vector (const Vector< N-2, U > &other)

	Vector (const T *array)

	Vector (T x, T y, T z, T w, T v, T u)

	Vector (T x, T y, T z, T w, T v)

	Vector (T x, T y, T z, T w)

	Vector (T x, T y, T z)

	Vector (T x, T y)

	Vector (T x)

const T &	operator[] (unsigned int index) const

T &	operator[] (unsigned int index)

T *	raw (void)

const T *	raw (void) const

const T *	temp (void) const

Vector< N, T > &	operator= (const T *array)

Vector< N, T > &	operator= (const Vector< N, T > &other)

template<typename U >
Vector< N, T > &	operator= (const Vector< N, U > &other)

Vector< N, T > &	operator= (const Vector< N+1, T > &other)

template<typename U >
Vector< N, T > &	operator= (const Vector< N+1, U > &other)

template<typename U >
Vector< N, T > &	operator= (const Vector< N+2, U > &other)

template<typename U >
Vector< N, T > &	operator= (const Vector< N-1, U > &other)

template<typename U >
Vector< N, T > &	operator= (const Vector< N-2, U > &other)

bool	operator== (const Vector< N, T > &other) const

bool	operator!= (const Vector< N, T > &other) const

template<>
	Vector (const Vector< 2, U > &other)

Private Attributes
Vector< N, T >	m_size

Related Functions
(Note that these are not member functions.)
template<int N, class T , class U >
bool	operator== (const Box< N, T > &lhs, const Box< N, U > &rhs)
	Test equality. More...

template<int N, class T , class U >
bool	operator!= (const Box< N, T > &lhs, const Box< N, U > &rhs)
	Test inequality. More...

template<int N, class T , class U >
Box< N, T > &	resize (Box< N, T > &lhs, const Vector< N, U > &size)
	Change the size. More...

template<int N, class T , class U , class V >
Box< N, T > &	set (Box< N, T > &lhs, const Vector< N, U > &location, const Vector< N, V > &size)
	Redefine the spatial domain. More...

template<class T , class U , class V >
Box< 3, T > &	set (Box< 3, T > &lhs, const Vector< 3, U > &center, V radius)
	Set the box to encapsulate the given sphere. More...

template<int N, class T >
T	width (const Box< N, T > &lhs)
	Get the box width. More...

template<int N, class T >
T	height (const Box< N, T > &lhs)
	Get the box height. More...

template<int N, class T >
T	depth (const Box< N, T > &lhs)
	Get the box depth. More...

template<class T , class U , class V , class W , class X >
Box< 2, T > &	set (Box< 2, T > &lhs, U x, V y, W w, X h)
	Set by explicit elements (2D) More...

template<class T , class U , class V , class W , class X , class Y , class Z >
Box< 3, T > &	set (Box< 3, T > &lhs, U x, V y, W z, X w, Y h, Z d)
	Set by explicit elements (3D) More...

template<class T , class U , class V >
Box< 2, T > &	resize (Box< 2, T > &lhs, U w, V h)
	Resize by explicit elements (2D) More...

template<class T , class U , class V , class W >
Box< 3, T > &	resize (Box< 3, T > &lhs, U w, V h, W d)
	Resize by explicit elements (3D) More...

template<class T , class U >
bool	intersecting (const Box< 2, T > &box, const Vector< 2, U > &point)
	Returns true if the box contains the point. More...

template<class T , class U >
bool	intersecting (const Box< 2, T > &box1, const Box< 2, U > &box2)
	Returns true if the boxes overlap. More...

template<class T , class U >
bool	intersecting (const Box< 3, T > &box, const Vector< 3, U > &point)
	Returns true if the box contains the point. More...

template<class T , class U >
bool	intersecting (const Box< 3, T > &box1, const Box< 3, U > &box2)
	Returns true if the boxes overlap. More...

FE_DL_EXPORT const Box3	aabb (const Vector3f &location, const Vector3f &span, F32 baseRadius, F32 endRadius)
	Returns Box enveloping a tapered cylinder. More...

FE_DL_EXPORT const Box3	aabb (const Vector3f &location, F32 radius)
	Returns Box enveloping a sphere. More...

template<int N, class T >
String	print (const Box< N, T > &box)
	Print to a string. More...

Related Functions inherited from fe::Vector< N, T >
template<int M, int N, class T , class U >
Vector< M, T > &	multiply (Vector< M, T > &b, const Matrix< M, N, T > &A, const Vector< N, U > &x)
	Matrix Vector multiply. More...

template<int M, int N, class T , class U >
Vector< M, T >	multiply (const Matrix< M, N, T > &A, const Vector< N, U > &x)
	Matrix Vector multiply. More...

template<int M, int N, class T >
Vector< M, T >	transposeMultiply (const Matrix< M, N, T > &A, const Vector< N, T > &x)
	Matrix Vector multiply with the matrix transposed. More...

template<int M, int N, class T , class U >
Vector< M, U >	operator* (const Matrix< M, N, T > &lhs, const Vector< N, U > &rhs)
	Matrix Vector multiply. More...

template<class T , class U >
bool	equivalent (const Matrix< 3, 4, T > &lhs, const Matrix< 3, 4, T > &rhs, U margin)
	Equivalence test within the given tolerance margin. More...

template<int N, class T >
Vector< N, T > &	set (Vector< N, T > &lhs)
	Set all the elements to zero. More...

template<int N, class T , class U >
Vector< N, T > &	setAll (Vector< N, T > &lhs, const U value)
	Set all the elements to the given value. More...

template<int N, class T , class U >
Vector< N, T > &	setAt (Vector< N, T > &lhs, U32 index, const U value)
	Set the value at the index. More...

template<int N, class T >
U32	size (const Vector< N, T > &lhs)
	Return the number of elements. More...

template<int N, class T >
Vector< N, T > &	operator+= (Vector< N, T > &lhs, const Vector< N, T > &rhs)
	In place add operator. More...

template<int M, int N, class T >
Vector< N, T > &	operator+= (Vector< N, T > &lhs, const Vector< M, T > &rhs)
	In place add operator. More...

template<int N, class T >
Vector< N, T > &	operator-= (Vector< N, T > &lhs, const Vector< N, T > &rhs)
	In place subtract operator. More...

template<int M, int N, class T >
Vector< N, T > &	operator-= (Vector< N, T > &lhs, const Vector< M, T > &rhs)
	In place subtract operator. More...

template<int N, class T >
Vector< N, T >	operator- (const Vector< N, T > &rhs)
	Negate operation. More...

template<int N, class T >
Vector< N, T > &	operator*= (Vector< N, T > &lhs, const Vector< N, T > &rhs)
	In place piecewise multiply operator. More...

template<int M, int N, class T >
Vector< N, T > &	operator*= (Vector< N, T > &lhs, const Vector< M, T > &rhs)
	In place piecewise multiply operator. More...

template<int N, class T , class U >
Vector< N, T > &	operator*= (Vector< N, T > &lhs, U scale)
	In place piecewise scale operator. More...

template<int N, class T >
T	dot (const Vector< N, T > &lhs, const Vector< N, T > &rhs)
	Dot (inner) product. More...

template<int N, class T >
T	magnitude (const Vector< N, T > &rhs)
	Frobenius norm operation. More...

template<int N, class T >
T	magnitudeSquared (const Vector< N, T > &rhs)
	Square of the length. More...

template<int N, class T >
Vector< N, T >	unit (const Vector< N, T > &vec)
	Return vector scaled to unit length. More...

template<int N, class T >
Vector< N, T >	unitSafe (const Vector< N, T > &vec)
	Return vector scaled to unit length with zero check. More...

template<int N, class T >
Vector< N, T > &	normalize (Vector< N, T > &vec)
	In place normalize operator. More...

template<int N, class T >
Vector< N, T > &	normalizeSafe (Vector< N, T > &vec)
	In place normalize operator with zero length check. More...

template<int N, class T >
String	print (const Vector< N, T > &vec)
	Print to a string. More...

template<int N, class T >
Vector< N, T >	operator+ (const Vector< N, T > &lhs, const Vector< N, T > &rhs)
	add operation More...

template<int N, int M, class T >
Vector< N, T >	operator+ (const Vector< N, T > &lhs, const Vector< M, T > &rhs)
	add operation More...

template<int N, class T >
Vector< N, T >	operator- (const Vector< N, T > &lhs, const Vector< N, T > &rhs)
	subtract operation More...

template<int N, int M, class T >
Vector< N, T >	operator- (const Vector< N, T > &lhs, const Vector< M, T > &rhs)
	subtract operation More...

template<int N, class T >
bool	operator== (const Vector< N, T > &lhs, const Vector< N, T > &rhs)
	equality test More...

template<int N, class T , class U >
bool	equivalent (const Vector< N, T > &lhs, const Vector< N, T > &rhs, U margin)
	Equivalence test within the given tolerance margin. More...

template<int N, class T >
Vector< N, T >	operator* (const Vector< N, T > &lhs, const Vector< N, T > &rhs)
	Piecewise multiply operation. More...

template<int N, class T , class U >
Vector< N, T >	operator* (const U lhs, const Vector< N, T > &rhs)
	Scale operation. More...

template<int N, class T , class U >
Vector< N, T >	operator* (const Vector< N, T > &lhs, const U &rhs)
	Scale operation. More...

template<int N, class T , class U >
Vector< N, T >	operator/ (const Vector< N, T > &lhs, const U &rhs)
	Inverse Scale operation. More...

template<int N, class T , class U >
Vector< N, T > &	addScaled (Vector< N, T > &lhs, U scalar, const Vector< N, T > &rhs)
	Add with scaling. More...

template<int N, class T , class U >
Vector< N, T > &	scaleAndAdd (Vector< N, T > &lhs, U scalar, const Vector< N, T > &rhs)
	Scale then add. More...

template<typename T >
Vector< 4, T > &	set (Vector< 4, T > &r)
	Set components. More...

template<typename T , typename U >
Vector< 4, T > &	set (Vector< 4, T > &r, U x)
	Set components. More...

template<typename T , typename U , typename V >
Vector< 4, T > &	set (Vector< 4, T > &r, U x, V y)
	Set components. More...

template<typename T , typename U , typename V , typename W >
Vector< 4, T > &	set (Vector< 4, T > &r, U x, V y, W z)
	Set components. More...

template<typename T , typename U , typename V , typename W , typename X >
Vector< 4, T > &	set (Vector< 4, T > &r, U x, V y, W z, X w)
	Set components. More...

template<typename T , typename U >
Vector< 4, T > &	setAt (Vector< 4, T > &lhs, U32 index, U value)
	Set indexed component. More...

template<typename T >
U32	size (const Vector< 4, T > &lhs)
	Return the number of elements. More...

template<typename T >
Vector< 4, T > &	operator+= (Vector< 4, T > &lhs, const Vector< 4, T > &rhs)
	Add to Vector in place. More...

template<typename T >
Vector< 4, T > &	operator-= (Vector< 4, T > &lhs, const Vector< 4, T > &rhs)
	Subtract from Vector in place. More...

template<typename T >
Vector< 4, T >	operator- (const Vector< 4, T > &rhs)
	Negate the Vector. More...

template<typename T >
Vector< 4, T > &	operator*= (Vector< 4, T > &lhs, const Vector< 4, T > &rhs)
	Independently scale components in place. More...

template<typename T , typename U >
Vector< 4, T > &	operator*= (Vector< 4, T > &lhs, U scale)
	Uniformly scale components in place. More...

template<typename T >
T	dot (const Vector< 4, T > &lhs, const Vector< 4, T > &rhs)
	Return dot product. More...

template<typename T >
T	magnitudeSquared (const Vector< 4, T > &rhs)
	Return square of the Vector length. More...

template<typename T >
T	magnitude (const Vector< 4, T > &rhs)
	Return the Vector length. More...

template<typename T >
Vector< 4, T >	unit (const Vector< 4, T > &vector)
	Return the Vector direction scaled to unit length. More...

template<typename T >
Vector< 4, T >	unitSafe (const Vector< 4, T > &vector)
	Return the Vector direction scaled to unit length with zero check. More...

template<typename T >
Vector< 4, T > &	normalize (Vector< 4, T > &vector)
	Scale Vector to unit length. More...

template<typename T >
Vector< 4, T > &	normalizeSafe (Vector< 4, T > &vector)
	Scale Vector to unit length with zero check. More...

template<typename T >
String	print (const Vector< 4, T > &vector)
	Return text describing the Vector's state. More...

template<typename T >
Vector< 4, T >	operator+ (const Vector< 4, T > &lhs, const Vector< 4, T > &rhs)
	Return sum of Vectors. More...

template<typename T >
Vector< 4, T >	operator- (const Vector< 4, T > &lhs, const Vector< 4, T > &rhs)
	Return difference of Vectors. More...

template<typename T >
Vector< 4, T >	operator* (const Vector< 4, T > &lhs, const Vector< 4, T > &rhs)
	Return a Vector of products of each component. More...

template<typename T , typename U >
boost::enable_if< boost::is_arithmetic< U >, Vector< 4, T > >::type	operator* (const U lhs, const Vector< 4, T > &rhs)
	Return a uniformly scale Vector (pre) More...

template<typename T , typename U >
boost::enable_if< boost::is_arithmetic< U >, Vector< 4, T > >::type	operator* (const Vector< 4, T > &lhs, const U rhs)
	Return a uniformly scale Vector (post) More...

template<typename T >
Vector< 4, T > &	cross3 (Vector< 4, T > &r, const Vector< 4, T > &lhs, const Vector< 4, T > &rhs)
	Return a cross product of Vectors. More...

template<typename T >
Vector< 4, T >	cross3 (const Vector< 4, T > &lhs, const Vector< 4, T > &rhs)
	Set the Vector as a cross product of Vectors. More...

String	print (const Vector< FE_VDIM, F32 > &rhs)
	Return text describing the Vector's state. More...

Vector< FE_VDIM, F32 > &	set (Vector< FE_VDIM, F32 > &r)
	Set components. More...

template<typename T >
Vector< FE_VDIM, F32 > &	set (Vector< FE_VDIM, F32 > &r, T x)
	Set components. More...

template<typename T , typename U >
Vector< FE_VDIM, F32 > &	set (Vector< FE_VDIM, F32 > &r, T x, U y)
	Set components. More...

template<typename T , typename U , typename V >
Vector< FE_VDIM, F32 > &	set (Vector< FE_VDIM, F32 > &r, T x, U y, V z)
	Set components. More...

template<typename T , typename U , typename V , typename W >
Vector< FE_VDIM, F32 > &	set (Vector< FE_VDIM, F32 > &r, T x, U y, V z, W w)
	Set components. More...

template<typename T >
Vector< FE_VDIM, F32 > &	setAll (Vector< FE_VDIM, F32 > &lhs, T value)
	Set all components to the same value. More...

template<typename T >
Vector< FE_VDIM, F32 > &	setAt (Vector< FE_VDIM, F32 > &lhs, U32 index, T value)
	Set indexed component. More...

template<typename T >
U32	size (const Vector< FE_VDIM, F32 > &lhs)
	Return the number of elements. More...

Vector< FE_VDIM, F32 > &	operator+= (Vector< FE_VDIM, F32 > &lhs, const Vector< FE_VDIM, F32 > &rhs)
	Add to Vector in place. More...

Vector< FE_VDIM, F32 > &	operator-= (Vector< FE_VDIM, F32 > &lhs, const Vector< FE_VDIM, F32 > &rhs)
	Subtract from Vector in place. More...

Vector< FE_VDIM, F32 >	operator- (const Vector< FE_VDIM, F32 > &rhs)
	Negate the Vector. More...

Vector< FE_VDIM, F32 > &	operator*= (Vector< FE_VDIM, F32 > &lhs, const Vector< FE_VDIM, F32 > &rhs)
	Independently scale components in place. More...

template<typename T >
Vector< FE_VDIM, F32 > &	operator*= (Vector< FE_VDIM, F32 > &lhs, T rhs)
	Uniformly scale components in place. More...

F32	dot (const Vector< FE_VDIM, F32 > &lhs, const Vector< FE_VDIM, F32 > &rhs)
	Return dot product. More...

F32	magnitudeSquared (const Vector< FE_VDIM, F32 > &rhs)
	Return square of the Vector length. More...

F32	magnitude (const Vector< FE_VDIM, F32 > &rhs)
	Return the Vector length. More...

Vector< FE_VDIM, F32 >	operator+ (const Vector< FE_VDIM, F32 > &lhs, const Vector< FE_VDIM, F32 > &rhs)
	Return sum of Vectors. More...

Vector< FE_VDIM, F32 >	operator- (const Vector< FE_VDIM, F32 > &lhs, const Vector< FE_VDIM, F32 > &rhs)
	Return difference of Vectors. More...

Vector< FE_VDIM, F32 >	operator* (const Vector< FE_VDIM, F32 > &lhs, const Vector< FE_VDIM, F32 > &rhs)
	Return a Vector of products of each component. More...

template<typename T >
boost::enable_if< boost::is_arithmetic< T >, Vector< FE_VDIM, F32 > >::type	operator* (const T lhs, const Vector< FE_VDIM, F32 > &rhs)
	Return a uniformly scaled Vector (pre) More...

template<typename T >
boost::enable_if< boost::is_arithmetic< T >, Vector< FE_VDIM, F32 > >::type	operator* (const Vector< FE_VDIM, F32 > &lhs, const T rhs)
	Return a uniformly scaled Vector (post) More...

Vector< FE_VDIM, F32 >	unit (const Vector< FE_VDIM, F32 > &rhs)
	Return the Vector direction scaled to unit length. More...

Vector< FE_VDIM, F32 >	unitSafe (const Vector< FE_VDIM, F32 > &rhs)
	Return the Vector direction scaled to unit length with zero check. More...

Vector< FE_VDIM, F32 > &	normalize (Vector< FE_VDIM, F32 > &rhs)
	Scale Vector to unit length. More...

Vector< FE_VDIM, F32 > &	normalizeSafe (Vector< FE_VDIM, F32 > &rhs)
	Scale Vector to unit length. More...

Vector< FE_VDIM, F32 > &	cross3 (Vector< FE_VDIM, F32 > &r, const Vector< FE_VDIM, F32 > &lhs, const Vector< FE_VDIM, F32 > &rhs)
	Return a cross product of Vectors. More...

Vector< FE_VDIM, F32 >	cross3 (const Vector< FE_VDIM, F32 > &lhs, const Vector< FE_VDIM, F32 > &rhs)
	Set the Vector as a cross product of Vectors. More...

Additional Inherited Members
Public Attributes inherited from fe::Vector< N, T >
T	m_data [N]

Detailed Description

template<int N, class T>
class fe::Box< N, T >

N-dimensional axis-aligned bounding-box.

Friends And Related Function Documentation

◆ aabb() [1/2]

template<int N, class T>

FE_DL_EXPORT const Box3 aabb	(	const Vector3f &	location,
		const Vector3f &	span,
		F32	baseRadius,
		F32	endRadius
	)

◆ aabb() [2/2]

template<int N, class T>

FE_DL_EXPORT const Box3 aabb	(	const Vector3f &	location,
		F32	radius
	)

◆ depth()

template<int N, class T >

T depth ( const Box< N, T > & lhs )

◆ height()

template<int N, class T >

T height ( const Box< N, T > & lhs )

◆ intersecting() [1/4]

template<class T , class U >

bool intersecting	(	const Box< 2, T > &	box,
		const Vector< 2, U > &	point
	)

◆ intersecting() [2/4]

template<class T , class U >

bool intersecting	(	const Box< 2, T > &	box1,
		const Box< 2, U > &	box2
	)

◆ intersecting() [3/4]

template<class T , class U >

bool intersecting	(	const Box< 3, T > &	box,
		const Vector< 3, U > &	point
	)

◆ intersecting() [4/4]

template<class T , class U >

bool intersecting	(	const Box< 3, T > &	box1,
		const Box< 3, U > &	box2
	)

◆ operator!=()

template<int N, class T , class U >

bool operator!=	(	const Box< N, T > &	lhs,
		const Box< N, U > &	rhs
	)

◆ operator==()

template<int N, class T , class U >

bool operator==	(	const Box< N, T > &	lhs,
		const Box< N, U > &	rhs
	)

◆ print()

template<int N, class T >

String print ( const Box< N, T > & box )

Referenced by fe::Box< 2, I32 >::print().

◆ resize() [1/3]

template<int N, class T , class U >

Box< N, T > & resize	(	Box< N, T > &	lhs,
		const Vector< N, U > &	size
	)

Referenced by fe::Box< 2, I32 >::set().

◆ resize() [2/3]

template<class T , class U , class V >

Box< 2, T > & resize	(	Box< 2, T > &	lhs,
		U	w,
		V	h
	)

◆ resize() [3/3]

template<class T , class U , class V , class W >

Box< 3, T > & resize	(	Box< 3, T > &	lhs,
		U	w,
		V	h,
		W	d
	)

◆ set() [1/4]

template<int N, class T , class U , class V >

Box< N, T > & set	(	Box< N, T > &	lhs,
		const Vector< N, U > &	location,
		const Vector< N, V > &	size
	)

◆ set() [2/4]

template<class T , class U , class V >

Box< 3, T > & set	(	Box< 3, T > &	lhs,
		const Vector< 3, U > &	center,
		V	radius
	)

◆ set() [3/4]

template<class T , class U , class V , class W , class X >

Box< 2, T > & set	(	Box< 2, T > &	lhs,
		U	x,
		V	y,
		W	w,
		X	h
	)

◆ set() [4/4]

template<class T , class U , class V , class W , class X , class Y , class Z >

Box< 3, T > & set	(	Box< 3, T > &	lhs,
		U	x,
		V	y,
		W	z,
		X	w,
		Y	h,
		Z	d
	)

◆ width()

template<int N, class T >

T width ( const Box< N, T > & lhs )

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

Box.h

Public Member Functions

Private Attributes

Related Functions

Additional Inherited Members

Detailed Description

template<int N, class T> class fe::Box< N, T >

Friends And Related Function Documentation

◆ aabb() [1/2]

◆ aabb() [2/2]

◆ depth()

◆ height()

◆ intersecting() [1/4]

◆ intersecting() [2/4]

◆ intersecting() [3/4]

◆ intersecting() [4/4]

◆ operator!=()

◆ operator==()

◆ print()

◆ resize() [1/3]

◆ resize() [2/3]

◆ resize() [3/3]

◆ set() [1/4]

◆ set() [2/4]

◆ set() [3/4]

◆ set() [4/4]

◆ width()

template<int N, class T>
class fe::Box< N, T >