An axis aligned box. More...

#include <AlignedBox.h>

Public Types
enum	{ AmbientDimAtCompileTime = _AmbientDim }
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 }
typedef DenseIndex	Index
typedef ScalarTraits::NonInteger	NonInteger
typedef NumTraits< Scalar >::Real	RealScalar
typedef ScalarTraits::Real	RealScalar
typedef _Scalar	Scalar
typedef _Scalar	Scalar
typedef NumTraits< Scalar >	ScalarTraits
typedef Matrix< Scalar, AmbientDimAtCompileTime, 1 >	VectorType
typedef Matrix< Scalar, AmbientDimAtCompileTime, 1 >	VectorType



Public Member Functions
	AlignedBox ()
	AlignedBox (int _dim)
	AlignedBox (const VectorType &_min, const VectorType &_max)
	AlignedBox (const VectorType &p)
	AlignedBox ()
	AlignedBox (Index _dim)
template<typename OtherVectorType1 , typename OtherVectorType2 >
	AlignedBox (const OtherVectorType1 &_min, const OtherVectorType2 &_max)
template<typename Derived >
	AlignedBox (const MatrixBase< Derived > &p)
template<typename OtherScalarType >
	AlignedBox (const AlignedBox< OtherScalarType, AmbientDimAtCompileTime > &other)
template<typename OtherScalarType >
	AlignedBox (const AlignedBox< OtherScalarType, AmbientDimAtCompileTime > &other)
template<typename NewScalarType >
internal::cast_return_type < AlignedBox, AlignedBox < NewScalarType, AmbientDimAtCompileTime > >::type	cast () const
template<typename NewScalarType >
internal::cast_return_type < AlignedBox, AlignedBox < NewScalarType, AmbientDimAtCompileTime > >::type	cast () const
const CwiseUnaryOp < internal::scalar_quotient1_op < Scalar >, const CwiseBinaryOp < internal::scalar_sum_op < Scalar >, const VectorType, const VectorType > >	center () const
AlignedBox &	clamp (const AlignedBox &b)
AlignedBox &	clamp (const AlignedBox &b)
bool	contains (const VectorType &p) const
bool	contains (const AlignedBox &b) const
template<typename Derived >
bool	contains (const MatrixBase< Derived > &p) const
bool	contains (const AlignedBox &b) const
VectorType	corner (CornerType corner) const
CwiseBinaryOp < internal::scalar_difference_op < Scalar >, const VectorType, const VectorType >	diagonal () const
int	dim () const
Index	dim () const
AlignedBox &	extend (const VectorType &p)
AlignedBox &	extend (const AlignedBox &b)
template<typename Derived >
AlignedBox &	extend (const MatrixBase< Derived > &p)
AlignedBox &	extend (const AlignedBox &b)
Scalar	exteriorDistance (const VectorType &p) const
template<typename Derived >
NonInteger	exteriorDistance (const MatrixBase< Derived > &p) const
NonInteger	exteriorDistance (const AlignedBox &b) const
AlignedBox	intersection (const AlignedBox &b) const
bool	intersects (const AlignedBox &b) const
bool	isApprox (const AlignedBox &other, typename NumTraits< Scalar >::Real prec=precision< Scalar >()) const
bool	isApprox (const AlignedBox &other, const RealScalar &prec=ScalarTraits::dummy_precision()) const
bool	isEmpty () const
bool	isNull () const
bool	isNull () const
const VectorType &()	max () const
VectorType &()	max ()
const VectorType &()	max () const
VectorType &()	max ()
AlignedBox	merged (const AlignedBox &b) const
const VectorType &()	min () const
VectorType &()	min ()
const VectorType &()	min () const
VectorType &()	min ()
VectorType	sample () const
void	setEmpty ()
void	setNull ()
void	setNull ()
const CwiseBinaryOp < internal::scalar_difference_op < Scalar >, const VectorType, const VectorType >	sizes () const
Scalar	squaredExteriorDistance (const VectorType &p) const
template<typename Derived >
Scalar	squaredExteriorDistance (const MatrixBase< Derived > &p) const
Scalar	squaredExteriorDistance (const AlignedBox &b) const
AlignedBox &	translate (const VectorType &t)
template<typename Derived >
AlignedBox &	translate (const MatrixBase< Derived > &a_t)
Scalar	volume () const
	~AlignedBox ()
	~AlignedBox ()
Protected Attributes
VectorType	m_max
VectorType	m_min

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.

Template 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.

Warning:: The result of most methods is undefined when applied to an empty box. You can check for empty boxes using isEmpty().

See also:: Global aligned box typedefs

Definition at line 27 of file Eigen2Support/Geometry/AlignedBox.h.

Member Typedef Documentation

template<typename _Scalar, int _AmbientDim>

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

Definition at line 37 of file Geometry/AlignedBox.h.

template<typename _Scalar, int _AmbientDim>

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

Definition at line 39 of file Geometry/AlignedBox.h.

template<typename _Scalar, int _AmbientDim>

typedef NumTraits<Scalar>::Real Eigen::AlignedBox< _Scalar, _AmbientDim >::RealScalar

Definition at line 33 of file Eigen2Support/Geometry/AlignedBox.h.

template<typename _Scalar, int _AmbientDim>

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

Definition at line 38 of file Geometry/AlignedBox.h.

template<typename _Scalar, int _AmbientDim>

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

Definition at line 32 of file Eigen2Support/Geometry/AlignedBox.h.

template<typename _Scalar, int _AmbientDim>

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

Definition at line 35 of file Geometry/AlignedBox.h.

template<typename _Scalar, int _AmbientDim>

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

Definition at line 36 of file Geometry/AlignedBox.h.

template<typename _Scalar, int _AmbientDim>

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

Definition at line 34 of file Eigen2Support/Geometry/AlignedBox.h.

template<typename _Scalar, int _AmbientDim>

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

Definition at line 40 of file Geometry/AlignedBox.h.

Member Enumeration Documentation

template<typename _Scalar, int _AmbientDim>

anonymous enum

Enumerator:

AmbientDimAtCompileTime

Definition at line 31 of file Eigen2Support/Geometry/AlignedBox.h.

template<typename _Scalar, int _AmbientDim>

anonymous enum

Enumerator:

AmbientDimAtCompileTime

Definition at line 34 of file Geometry/AlignedBox.h.

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	Identifier for 2D corner
BottomRight
TopLeft
TopRight
BottomLeftFloor	Identifier for 3D corner
BottomRightFloor
TopLeftFloor
TopRightFloor
BottomLeftCeil
BottomRightCeil
TopLeftCeil
TopRightCeil

Definition at line 43 of file Geometry/AlignedBox.h.

Constructor & Destructor Documentation

template<typename _Scalar, int _AmbientDim>

Eigen::AlignedBox< _Scalar, _AmbientDim >::AlignedBox ( ) [inline]

Default constructor initializing a null box.

Definition at line 37 of file Eigen2Support/Geometry/AlignedBox.h.

template<typename _Scalar, int _AmbientDim>

Eigen::AlignedBox< _Scalar, _AmbientDim >::AlignedBox ( int _dim ) [inline, explicit]

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

Definition at line 41 of file Eigen2Support/Geometry/AlignedBox.h.

template<typename _Scalar, int _AmbientDim>

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

Constructs a box with extremities _min and _max.

Definition at line 45 of file Eigen2Support/Geometry/AlignedBox.h.

template<typename _Scalar, int _AmbientDim>

Eigen::AlignedBox< _Scalar, _AmbientDim >::AlignedBox ( const VectorType & p ) [inline, explicit]

Constructs a box containing a single point p.

Definition at line 48 of file Eigen2Support/Geometry/AlignedBox.h.

template<typename _Scalar, int _AmbientDim>

Eigen::AlignedBox< _Scalar, _AmbientDim >::~AlignedBox ( ) [inline]

Definition at line 50 of file Eigen2Support/Geometry/AlignedBox.h.

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 126 of file Eigen2Support/Geometry/AlignedBox.h.

template<typename _Scalar, int _AmbientDim>

Eigen::AlignedBox< _Scalar, _AmbientDim >::AlignedBox ( ) [inline]

Default constructor initializing a null box.

Definition at line 64 of file Geometry/AlignedBox.h.

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 68 of file Geometry/AlignedBox.h.

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.

Warning:: If either component of _min is larger than the same component of _max, the constructed box is empty.

Definition at line 74 of file Geometry/AlignedBox.h.

template<typename _Scalar, int _AmbientDim>

template<typename Derived >

Eigen::AlignedBox< _Scalar, _AmbientDim >::AlignedBox ( const MatrixBase< Derived > & p ) [inline, explicit]

Constructs a box containing a single point p.

Definition at line 78 of file Geometry/AlignedBox.h.

template<typename _Scalar, int _AmbientDim>

Eigen::AlignedBox< _Scalar, _AmbientDim >::~AlignedBox ( ) [inline]

Definition at line 81 of file Geometry/AlignedBox.h.

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 292 of file Geometry/AlignedBox.h.

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 118 of file Eigen2Support/Geometry/AlignedBox.h.

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 284 of file Geometry/AlignedBox.h.

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 116 of file Geometry/AlignedBox.h.

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 91 of file Eigen2Support/Geometry/AlignedBox.h.

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.

Note:: If the boxes don't intersect, the resulting box is empty.

See also:: intersection(), intersects()

Definition at line 220 of file Geometry/AlignedBox.h.

template<typename _Scalar, int _AmbientDim>

bool Eigen::AlignedBox< _Scalar, _AmbientDim >::contains ( const VectorType & p ) const [inline]

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

Definition at line 75 of file Eigen2Support/Geometry/AlignedBox.h.

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 79 of file Eigen2Support/Geometry/AlignedBox.h.

template<typename _Scalar, int _AmbientDim>

template<typename Derived >

bool Eigen::AlignedBox< _Scalar, _AmbientDim >::contains ( const MatrixBase< Derived > & p ) const [inline]

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

Definition at line 182 of file Geometry/AlignedBox.h.

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 189 of file Geometry/AlignedBox.h.

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 146 of file Geometry/AlignedBox.h.

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 134 of file Geometry/AlignedBox.h.

template<typename _Scalar, int _AmbientDim>

int Eigen::AlignedBox< _Scalar, _AmbientDim >::dim ( ) const [inline]

Returns:: the dimension in which the box holds

Definition at line 53 of file Eigen2Support/Geometry/AlignedBox.h.

template<typename _Scalar, int _AmbientDim>

Index Eigen::AlignedBox< _Scalar, _AmbientDim >::dim ( ) const [inline]

Returns:: the dimension in which the box holds

Definition at line 84 of file Geometry/AlignedBox.h.

template<typename _Scalar, int _AmbientDim>

AlignedBox& Eigen::AlignedBox< _Scalar, _AmbientDim >::extend ( const VectorType & p ) [inline]

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

Definition at line 83 of file Eigen2Support/Geometry/AlignedBox.h.

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 87 of file Eigen2Support/Geometry/AlignedBox.h.

template<typename _Scalar, int _AmbientDim>

template<typename Derived >

AlignedBox& Eigen::AlignedBox< _Scalar, _AmbientDim >::extend ( const MatrixBase< Derived > & p ) [inline]

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

See also:: extend(const AlignedBox&)

Definition at line 200 of file Geometry/AlignedBox.h.

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.

See also:: merged, extend(const MatrixBase&)

Definition at line 210 of file Geometry/AlignedBox.h.

template<typename _Scalar, int _AmbientDim>

Scalar Eigen::AlignedBox< _Scalar, _AmbientDim >::exteriorDistance ( const VectorType & 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 108 of file Eigen2Support/Geometry/AlignedBox.h.

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(const MatrixBase&), exteriorDistance(const AlignedBox&)

Definition at line 267 of file Geometry/AlignedBox.h.

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(const AlignedBox&), exteriorDistance(const MatrixBase&)

Definition at line 274 of file Geometry/AlignedBox.h.

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

Note:: If the boxes don't intersect, the resulting box is empty.

See also:: intersects(), clamp, contains()

Definition at line 230 of file Geometry/AlignedBox.h.

template<typename _Scalar, int _AmbientDim>

bool Eigen::AlignedBox< _Scalar, _AmbientDim >::intersects ( const AlignedBox< _Scalar, _AmbientDim > & b ) const [inline]

Returns:: true if the box b is intersecting the box *this.

See also:: intersection, clamp

Definition at line 194 of file Geometry/AlignedBox.h.

template<typename _Scalar, int _AmbientDim>

bool Eigen::AlignedBox< _Scalar, _AmbientDim >::isApprox	(	const AlignedBox< _Scalar, _AmbientDim > &	other,
		typename NumTraits< Scalar >::Real	prec = `precision<Scalar>()`
	)		const `[inline]`

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

See also:: MatrixBase::isApprox()

Definition at line 136 of file Eigen2Support/Geometry/AlignedBox.h.

template<typename _Scalar, int _AmbientDim>

bool Eigen::AlignedBox< _Scalar, _AmbientDim >::isApprox	(	const AlignedBox< _Scalar, _AmbientDim > &	other,
		const 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 302 of file Geometry/AlignedBox.h.

template<typename _Scalar, int _AmbientDim>

bool Eigen::AlignedBox< _Scalar, _AmbientDim >::isEmpty ( ) const [inline]

Returns:: true if the box is empty.

See also:: setEmpty

Definition at line 94 of file Geometry/AlignedBox.h.

template<typename _Scalar, int _AmbientDim>

bool Eigen::AlignedBox< _Scalar, _AmbientDim >::isNull ( ) const [inline]

Returns:: true if the box is null, i.e, empty.

Definition at line 56 of file Eigen2Support/Geometry/AlignedBox.h.

template<typename _Scalar, int _AmbientDim>

bool Eigen::AlignedBox< _Scalar, _AmbientDim >::isNull ( ) const [inline]

Deprecated:: use isEmpty()

Definition at line 87 of file Geometry/AlignedBox.h.

template<typename _Scalar, int _AmbientDim>

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

Returns:: the maximal corner

Definition at line 70 of file Eigen2Support/Geometry/AlignedBox.h.

template<typename _Scalar, int _AmbientDim>

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

Returns:: a non const reference to the maximal corner

Definition at line 72 of file Eigen2Support/Geometry/AlignedBox.h.

template<typename _Scalar, int _AmbientDim>

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

Returns:: the maximal corner

Definition at line 109 of file Geometry/AlignedBox.h.

template<typename _Scalar, int _AmbientDim>

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

Returns:: a non const reference to the maximal corner

Definition at line 111 of file Geometry/AlignedBox.h.

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.

Note:: Merging with an empty box may result in a box bigger than *this.

See also:: extend(const AlignedBox&)

Definition at line 236 of file Geometry/AlignedBox.h.

template<typename _Scalar, int _AmbientDim>

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

Returns:: the minimal corner

Definition at line 66 of file Eigen2Support/Geometry/AlignedBox.h.

template<typename _Scalar, int _AmbientDim>

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

Returns:: a non const reference to the minimal corner

Definition at line 68 of file Eigen2Support/Geometry/AlignedBox.h.

template<typename _Scalar, int _AmbientDim>

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

Returns:: the minimal corner

Definition at line 105 of file Geometry/AlignedBox.h.

template<typename _Scalar, int _AmbientDim>

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

Returns:: a non const reference to the minimal corner

Definition at line 107 of file Geometry/AlignedBox.h.

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 164 of file Geometry/AlignedBox.h.

template<typename _Scalar, int _AmbientDim>

void Eigen::AlignedBox< _Scalar, _AmbientDim >::setEmpty ( ) [inline]

Makes *this an empty box.

See also:: isEmpty

Definition at line 98 of file Geometry/AlignedBox.h.

template<typename _Scalar, int _AmbientDim>

void Eigen::AlignedBox< _Scalar, _AmbientDim >::setNull ( ) [inline]

Makes *this a null/empty box.

Definition at line 59 of file Eigen2Support/Geometry/AlignedBox.h.

template<typename _Scalar, int _AmbientDim>

void Eigen::AlignedBox< _Scalar, _AmbientDim >::setNull ( ) [inline]

Deprecated:: use setEmpty()

Definition at line 90 of file Geometry/AlignedBox.h.

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 123 of file Geometry/AlignedBox.h.

template<typename Scalar , int AmbiantDim>

Scalar Eigen::AlignedBox< Scalar, AmbiantDim >::squaredExteriorDistance ( const VectorType & 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 145 of file Eigen2Support/Geometry/AlignedBox.h.

template<typename Scalar , int AmbientDim>

template<typename Derived >

Scalar Eigen::AlignedBox< Scalar, AmbientDim >::squaredExteriorDistance ( const MatrixBase< Derived > & 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(const MatrixBase&), squaredExteriorDistance(const AlignedBox&)

Definition at line 314 of file Geometry/AlignedBox.h.

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(const AlignedBox&), squaredExteriorDistance(const MatrixBase&)

Definition at line 336 of file Geometry/AlignedBox.h.

template<typename _Scalar, int _AmbientDim>

AlignedBox& Eigen::AlignedBox< _Scalar, _AmbientDim >::translate ( const VectorType & t ) [inline]

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

Definition at line 95 of file Eigen2Support/Geometry/AlignedBox.h.

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 241 of file Geometry/AlignedBox.h.

template<typename _Scalar, int _AmbientDim>

Scalar Eigen::AlignedBox< _Scalar, _AmbientDim >::volume ( ) const [inline]

Returns:: the volume of the bounding box

Definition at line 127 of file Geometry/AlignedBox.h.

Member Data Documentation

template<typename _Scalar, int _AmbientDim>

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

Definition at line 141 of file Eigen2Support/Geometry/AlignedBox.h.

template<typename _Scalar, int _AmbientDim>

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

Definition at line 141 of file Eigen2Support/Geometry/AlignedBox.h.

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

Public Types

Public Member Functions

Protected Attributes

Detailed Description

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

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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