Eigen::AlignedBox< _Scalar, _AmbientDim > Class Template Reference

---

Detailed Description

template<typename _Scalar, int _AmbientDim>
class Eigen::AlignedBox< _Scalar, _AmbientDim >

An axis aligned box

Parameters:

_Scalar	the type of the scalar coefficients
_AmbientDim	the dimension of the ambient space, can be a compile time value or Dynamic.

This class represents an axis aligned box as a pair of the minimal and maximal corners.

Definition at line 42 of file Geometry.

List of all members.

Public Types
enum	{ AmbientDimAtCompileTime = _AmbientDim }
enum	CornerType {   Min = 0, Max = 1, BottomLeft = 0, BottomRight = 1,   TopLeft = 2, TopRight = 3, BottomLeftFloor = 0, BottomRightFloor = 1,   TopLeftFloor = 2, TopRightFloor = 3, BottomLeftCeil = 4, BottomRightCeil = 5,   TopLeftCeil = 6, TopRightCeil = 7 }
	Define constants to name the corners of a 1D, 2D or 3D axis aligned bounding box. More...
typedef _Scalar	Scalar
typedef NumTraits< Scalar >	ScalarTraits
typedef DenseIndex	Index
typedef ScalarTraits::Real	RealScalar
typedef ScalarTraits::NonInteger	NonInteger
typedef Matrix< Scalar, AmbientDimAtCompileTime, 1 >	VectorType
Public Member Functions
	AlignedBox ()
	Default constructor initializing a null box.
	AlignedBox (Index _dim)
	Constructs a null box with _dim the dimension of the ambient space.
template<typename OtherVectorType1 , typename OtherVectorType2 >
	AlignedBox (const OtherVectorType1 &_min, const OtherVectorType2 &_max)
	Constructs a box with extremities _min and _max.
template<typename Derived >
	AlignedBox (const MatrixBase< Derived > &a_p)
	Constructs a box containing a single point p.
	~AlignedBox ()
Index	dim () const
bool	isNull () const
void	setNull ()
bool	isEmpty () const
void	setEmpty ()
	Makes *this an empty box.
const VectorType &()	min () const
VectorType &()	min ()
const VectorType &()	max () const
VectorType &()	max ()
const CwiseUnaryOp < internal::scalar_quotient1_op < Scalar >, const CwiseBinaryOp < internal::scalar_sum_op < Scalar >, const VectorType, const VectorType > >	center () const
const CwiseBinaryOp < internal::scalar_difference_op < Scalar >, const VectorType, const VectorType >	sizes () const
Scalar	volume () const
CwiseBinaryOp < internal::scalar_difference_op < Scalar >, const VectorType, const VectorType >	diagonal () const
VectorType	corner (CornerType corner) const
VectorType	sample () const
template<typename Derived >
bool	contains (const MatrixBase< Derived > &a_p) const
bool	contains (const AlignedBox &b) const
template<typename Derived >
AlignedBox &	extend (const MatrixBase< Derived > &a_p)
	Extends *this such that it contains the point p and returns a reference to *this.
AlignedBox &	extend (const AlignedBox &b)
	Extends *this such that it contains the box b and returns a reference to *this.
AlignedBox &	clamp (const AlignedBox &b)
	Clamps *this by the box b and returns a reference to *this.
AlignedBox	intersection (const AlignedBox &b) const
	Returns an AlignedBox that is the intersection of b and *this.
AlignedBox	merged (const AlignedBox &b) const
	Returns an AlignedBox that is the union of b and *this.
template<typename Derived >
AlignedBox &	translate (const MatrixBase< Derived > &a_t)
	Translate *this by the vector t and returns a reference to *this.
template<typename Derived >
Scalar	squaredExteriorDistance (const MatrixBase< Derived > &a_p) const
Scalar	squaredExteriorDistance (const AlignedBox &b) const
template<typename Derived >
NonInteger	exteriorDistance (const MatrixBase< Derived > &p) const
NonInteger	exteriorDistance (const AlignedBox &b) const
template<typename NewScalarType >
internal::cast_return_type < AlignedBox, AlignedBox < NewScalarType, AmbientDimAtCompileTime > >::type	cast () const
template<typename OtherScalarType >
	AlignedBox (const AlignedBox< OtherScalarType, AmbientDimAtCompileTime > &other)
	Copy constructor with scalar type conversion.
bool	isApprox (const AlignedBox &other, RealScalar prec=ScalarTraits::dummy_precision()) const
Protected Attributes
VectorType	m_min
VectorType	m_max

---

Member Typedef Documentation

template<typename _Scalar , int _AmbientDim>

typedef DenseIndex Eigen::AlignedBox< _Scalar, _AmbientDim >::Index

Definition at line 49 of file Geometry.

template<typename _Scalar , int _AmbientDim>

typedef ScalarTraits::NonInteger Eigen::AlignedBox< _Scalar, _AmbientDim >::NonInteger

Definition at line 51 of file Geometry.

template<typename _Scalar , int _AmbientDim>

typedef ScalarTraits::Real Eigen::AlignedBox< _Scalar, _AmbientDim >::RealScalar

Definition at line 50 of file Geometry.

template<typename _Scalar , int _AmbientDim>

typedef _Scalar Eigen::AlignedBox< _Scalar, _AmbientDim >::Scalar

Definition at line 47 of file Geometry.

template<typename _Scalar , int _AmbientDim>

typedef NumTraits<Scalar> Eigen::AlignedBox< _Scalar, _AmbientDim >::ScalarTraits

Definition at line 48 of file Geometry.

template<typename _Scalar , int _AmbientDim>

typedef Matrix<Scalar,AmbientDimAtCompileTime,1> Eigen::AlignedBox< _Scalar, _AmbientDim >::VectorType

Definition at line 52 of file Geometry.

---

Member Enumeration Documentation

template<typename _Scalar , int _AmbientDim>

anonymous enum

Enumerator:

AmbientDimAtCompileTime

Definition at line 46 of file Geometry.

template<typename _Scalar , int _AmbientDim>

enum Eigen::AlignedBox::CornerType

Define constants to name the corners of a 1D, 2D or 3D axis aligned bounding box.

Enumerator:

Min	1D names
Max
BottomLeft	Added names for 2D.
BottomRight
TopLeft
TopRight
BottomLeftFloor	Added names for 3D.
BottomRightFloor
TopLeftFloor
TopRightFloor
BottomLeftCeil
BottomRightCeil
TopLeftCeil
TopRightCeil

Definition at line 55 of file Geometry.

---

Constructor & Destructor Documentation

template<typename _Scalar , int _AmbientDim>

Eigen::AlignedBox< _Scalar, _AmbientDim >::AlignedBox

(

)

[inline, explicit]

Default constructor initializing a null box.

Definition at line 73 of file Geometry.

template<typename _Scalar , int _AmbientDim>

Eigen::AlignedBox< _Scalar, _AmbientDim >::AlignedBox

(

Index

_dim

)

[inline, explicit]

Constructs a null box with _dim the dimension of the ambient space.

Definition at line 77 of file Geometry.

template<typename _Scalar , int _AmbientDim>

template<typename OtherVectorType1 , typename OtherVectorType2 >

Eigen::AlignedBox< _Scalar, _AmbientDim >::AlignedBox	(	const OtherVectorType1 &	_min,
		const OtherVectorType2 &	_max
	)		[inline]

Constructs a box with extremities _min and _max.

Definition at line 82 of file Geometry.

template<typename _Scalar , int _AmbientDim>

template<typename Derived >

Eigen::AlignedBox< _Scalar, _AmbientDim >::AlignedBox

(

const MatrixBase< Derived > &

a_p

)

[inline, explicit]

Constructs a box containing a single point p.

Definition at line 86 of file Geometry.

template<typename _Scalar , int _AmbientDim>

Eigen::AlignedBox< _Scalar, _AmbientDim >::~AlignedBox

(

)

[inline]

Definition at line 93 of file Geometry.

template<typename _Scalar , int _AmbientDim>

template<typename OtherScalarType >

Eigen::AlignedBox< _Scalar, _AmbientDim >::AlignedBox

(

const AlignedBox< OtherScalarType, AmbientDimAtCompileTime > &

other

)

[inline, explicit]

Copy constructor with scalar type conversion.

Definition at line 289 of file Geometry.

---

Member Function Documentation

template<typename _Scalar , int _AmbientDim>

template<typename NewScalarType >

internal::cast_return_type<AlignedBox, AlignedBox<NewScalarType,AmbientDimAtCompileTime> >::type Eigen::AlignedBox< _Scalar, _AmbientDim >::cast

(

)

const [inline]

Returns:

*this with scalar type casted to NewScalarType

Note that if NewScalarType is equal to the current scalar type of *this then this function smartly returns a const reference to *this.

Definition at line 281 of file Geometry.

template<typename _Scalar , int _AmbientDim>

const CwiseUnaryOp<internal::scalar_quotient1_op<Scalar>, const CwiseBinaryOp<internal::scalar_sum_op<Scalar>, const VectorType, const VectorType> > Eigen::AlignedBox< _Scalar, _AmbientDim >::center

(

)

const [inline]

Returns:

the center of the box

Definition at line 126 of file Geometry.

template<typename _Scalar , int _AmbientDim>

AlignedBox& Eigen::AlignedBox< _Scalar, _AmbientDim >::clamp

(

const AlignedBox< _Scalar, _AmbientDim > &

b

)

[inline]

Clamps *this by the box b and returns a reference to *this.

Definition at line 221 of file Geometry.

template<typename _Scalar , int _AmbientDim>

bool Eigen::AlignedBox< _Scalar, _AmbientDim >::contains

(

const AlignedBox< _Scalar, _AmbientDim > &

b

)

const [inline]

Returns:

true if the box b is entirely inside the box *this.

Definition at line 199 of file Geometry.

template<typename _Scalar , int _AmbientDim>

template<typename Derived >

bool Eigen::AlignedBox< _Scalar, _AmbientDim >::contains

(

const MatrixBase< Derived > &

a_p

)

const [inline]

Returns:

true if the point p is inside the box *this.

Definition at line 192 of file Geometry.

template<typename _Scalar , int _AmbientDim>

VectorType Eigen::AlignedBox< _Scalar, _AmbientDim >::corner

(

CornerType

corner

)

const [inline]

Returns:

the vertex of the bounding box at the corner defined by the corner-id corner. It works only for a 1D, 2D or 3D bounding box. For 1D bounding boxes corners are named by 2 enum constants: BottomLeft and BottomRight. For 2D bounding boxes, corners are named by 4 enum constants: BottomLeft, BottomRight, TopLeft, TopRight. For 3D bounding boxes, the following names are added: BottomLeftCeil, BottomRightCeil, TopLeftCeil, TopRightCeil.

Definition at line 156 of file Geometry.

template<typename _Scalar , int _AmbientDim>

CwiseBinaryOp< internal::scalar_difference_op<Scalar>, const VectorType, const VectorType> Eigen::AlignedBox< _Scalar, _AmbientDim >::diagonal

(

)

const [inline]

Returns:

an expression for the bounding box diagonal vector if the length of the diagonal is needed: diagonal().norm() will provide it.

Definition at line 144 of file Geometry.

template<typename _Scalar , int _AmbientDim>

Index Eigen::AlignedBox< _Scalar, _AmbientDim >::dim

(

)

const [inline]

Returns:

the dimension in which the box holds

Definition at line 96 of file Geometry.

template<typename _Scalar , int _AmbientDim>

template<typename Derived >

AlignedBox& Eigen::AlignedBox< _Scalar, _AmbientDim >::extend

(

const MatrixBase< Derived > &

a_p

)

[inline]

Extends *this such that it contains the point p and returns a reference to *this.

Definition at line 204 of file Geometry.

template<typename _Scalar , int _AmbientDim>

AlignedBox& Eigen::AlignedBox< _Scalar, _AmbientDim >::extend

(

const AlignedBox< _Scalar, _AmbientDim > &

b

)

[inline]

Extends *this such that it contains the box b and returns a reference to *this.

Definition at line 213 of file Geometry.

template<typename _Scalar , int _AmbientDim>

template<typename Derived >

NonInteger Eigen::AlignedBox< _Scalar, _AmbientDim >::exteriorDistance

(

const MatrixBase< Derived > &

p

)

const [inline]

Returns:

the distance between the point p and the box *this, and zero if p is inside the box.

See also:

squaredExteriorDistance()

Definition at line 264 of file Geometry.

template<typename _Scalar , int _AmbientDim>

NonInteger Eigen::AlignedBox< _Scalar, _AmbientDim >::exteriorDistance

(

const AlignedBox< _Scalar, _AmbientDim > &

b

)

const [inline]

Returns:

the distance between the boxes b and *this, and zero if the boxes intersect.

See also:

squaredExteriorDistance()

Definition at line 271 of file Geometry.

template<typename _Scalar , int _AmbientDim>

AlignedBox Eigen::AlignedBox< _Scalar, _AmbientDim >::intersection

(

const AlignedBox< _Scalar, _AmbientDim > &

b

)

const [inline]

Returns an AlignedBox that is the intersection of b and *this.

Definition at line 229 of file Geometry.

template<typename _Scalar , int _AmbientDim>

bool Eigen::AlignedBox< _Scalar, _AmbientDim >::isApprox	(	const AlignedBox< _Scalar, _AmbientDim > &	other,
		RealScalar	prec = ScalarTraits::dummy_precision()
	)		const [inline]

Returns:

true if *this is approximately equal to other, within the precision determined by prec.

See also:

MatrixBase::isApprox()

Definition at line 299 of file Geometry.

template<typename _Scalar , int _AmbientDim>

bool Eigen::AlignedBox< _Scalar, _AmbientDim >::isEmpty

(

)

const [inline]

Returns:

true if the box is empty.

Definition at line 105 of file Geometry.

template<typename _Scalar , int _AmbientDim>

bool Eigen::AlignedBox< _Scalar, _AmbientDim >::isNull

(

)

const [inline]

Deprecated:

use isEmpty

Definition at line 99 of file Geometry.

template<typename _Scalar , int _AmbientDim>

const VectorType&() Eigen::AlignedBox< _Scalar, _AmbientDim >::max

(

)

const [inline]

Returns:

the maximal corner

Definition at line 119 of file Geometry.

template<typename _Scalar , int _AmbientDim>

VectorType&() Eigen::AlignedBox< _Scalar, _AmbientDim >::max

(

)

[inline]

Returns:

a non const reference to the maximal corner

Definition at line 121 of file Geometry.

template<typename _Scalar , int _AmbientDim>

AlignedBox Eigen::AlignedBox< _Scalar, _AmbientDim >::merged

(

const AlignedBox< _Scalar, _AmbientDim > &

b

)

const [inline]

Returns an AlignedBox that is the union of b and *this.

Definition at line 233 of file Geometry.

template<typename _Scalar , int _AmbientDim>

const VectorType&() Eigen::AlignedBox< _Scalar, _AmbientDim >::min

(

)

const [inline]

Returns:

the minimal corner

Definition at line 115 of file Geometry.

template<typename _Scalar , int _AmbientDim>

VectorType&() Eigen::AlignedBox< _Scalar, _AmbientDim >::min

(

)

[inline]

Returns:

a non const reference to the minimal corner

Definition at line 117 of file Geometry.

template<typename _Scalar , int _AmbientDim>

VectorType Eigen::AlignedBox< _Scalar, _AmbientDim >::sample

(

)

const [inline]

Returns:

a random point inside the bounding box sampled with a uniform distribution

Definition at line 174 of file Geometry.

template<typename _Scalar , int _AmbientDim>

void Eigen::AlignedBox< _Scalar, _AmbientDim >::setEmpty

(

)

[inline]

Makes *this an empty box.

Definition at line 108 of file Geometry.

template<typename _Scalar , int _AmbientDim>

void Eigen::AlignedBox< _Scalar, _AmbientDim >::setNull

(

)

[inline]

Deprecated:

use setEmpty

Definition at line 102 of file Geometry.

template<typename _Scalar , int _AmbientDim>

const CwiseBinaryOp< internal::scalar_difference_op<Scalar>, const VectorType, const VectorType> Eigen::AlignedBox< _Scalar, _AmbientDim >::sizes

(

)

const [inline]

Returns:

the lengths of the sides of the bounding box. Note that this function does not get the same result for integral or floating scalar types: see

Definition at line 133 of file Geometry.

template<typename Scalar , int AmbientDim>

template<typename Derived >

Scalar Eigen::AlignedBox< Scalar, AmbientDim >::squaredExteriorDistance

(

const MatrixBase< Derived > &

a_p

)

const [inline]

Returns:

the squared distance between the point p and the box *this, and zero if p is inside the box.

See also:

exteriorDistance()

Definition at line 311 of file Geometry.

template<typename Scalar , int AmbientDim>

Scalar Eigen::AlignedBox< Scalar, AmbientDim >::squaredExteriorDistance

(

const AlignedBox< _Scalar, _AmbientDim > &

b

)

const [inline]

Returns:

the squared distance between the boxes b and *this, and zero if the boxes intersect.

See also:

exteriorDistance()

Definition at line 333 of file Geometry.

template<typename _Scalar , int _AmbientDim>

template<typename Derived >

AlignedBox& Eigen::AlignedBox< _Scalar, _AmbientDim >::translate

(

const MatrixBase< Derived > &

a_t

)

[inline]

Translate *this by the vector t and returns a reference to *this.

Definition at line 238 of file Geometry.

template<typename _Scalar , int _AmbientDim>

Scalar Eigen::AlignedBox< _Scalar, _AmbientDim >::volume

(

)

const [inline]

Returns:

the volume of the bounding box

Definition at line 137 of file Geometry.

---

Member Data Documentation

template<typename _Scalar , int _AmbientDim>

VectorType Eigen::AlignedBox< _Scalar, _AmbientDim >::m_max [protected]

Definition at line 304 of file Geometry.

template<typename _Scalar , int _AmbientDim>

VectorType Eigen::AlignedBox< _Scalar, _AmbientDim >::m_min [protected]

Definition at line 304 of file Geometry.