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

---

Detailed Description

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

An axis aligned box.

This is defined in the Geometry module.

 #include <Eigen/Geometry> 

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

List of all members.

Public Types
enum	CornerType {   Min,   Max,   BottomLeft,   BottomRight,   TopLeft,   TopRight,   BottomLeftFloor,   BottomRightFloor,   TopLeftFloor,   TopRightFloor,   BottomLeftCeil,   BottomRightCeil,   TopLeftCeil }
typedef Eigen::Index	Index
Public Member Functions
	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 NewScalarType >
internal::cast_return_type < AlignedBox, AlignedBox < NewScalarType, AmbientDimAtCompileTime > >::type	cast () const
AlignedBox &	clamp (const AlignedBox &b)
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, Scalar >, const VectorType, const VectorType >	diagonal () const
Index	dim () const
const	EIGEN_EXPR_BINARYOP_SCALAR_RETURN_TYPE (VectorTypeSum, RealScalar, quotient) center() const
template<typename Derived >
AlignedBox &	extend (const MatrixBase< Derived > &p)
AlignedBox &	extend (const AlignedBox &b)
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, const RealScalar &prec=ScalarTraits::dummy_precision()) const
bool	isEmpty () const
bool	isNull () const
const VectorType &()	max () const
VectorType &()	max ()
AlignedBox	merged (const AlignedBox &b) const
const VectorType &()	min () const
VectorType &()	min ()
VectorType	sample () const
void	setEmpty ()
void	setNull ()
const CwiseBinaryOp < internal::scalar_difference_op < Scalar, Scalar >, const VectorType, const VectorType >	sizes () const
template<typename Derived >
Scalar	squaredExteriorDistance (const MatrixBase< Derived > &p) const
Scalar	squaredExteriorDistance (const AlignedBox &b) const
template<typename Derived >
AlignedBox &	translate (const MatrixBase< Derived > &a_t)
Scalar	volume () const

---

Member Typedef Documentation

template<typename _Scalar, int _AmbientDim>

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

Deprecated:

since Eigen 3.3

---

Member Enumeration Documentation

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

---

Constructor & Destructor Documentation

template<typename _Scalar, int _AmbientDim>

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

(

)

[inline]

Default constructor initializing a null box.

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.

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.

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.

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

---

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.

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()

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.

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.

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.

template<typename _Scalar, int _AmbientDim>

CwiseBinaryOp< internal::scalar_difference_op<Scalar,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.

template<typename _Scalar, int _AmbientDim>

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

(

)

const [inline]

Returns:

the dimension in which the box holds

template<typename _Scalar, int _AmbientDim>

const Eigen::AlignedBox< _Scalar, _AmbientDim >::EIGEN_EXPR_BINARYOP_SCALAR_RETURN_TYPE	(	VectorTypeSum	,
		RealScalar	,
		quotient
	)		const [inline]

Returns:

the center of the box

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&)

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&)

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&)

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&)

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()

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

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()

template<typename _Scalar, int _AmbientDim>

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

(

)

const [inline]

Returns:

true if the box is empty.

See also:

setEmpty

template<typename _Scalar, int _AmbientDim>

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

(

)

const [inline]

Deprecated:

use isEmpty()

template<typename _Scalar, int _AmbientDim>

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

(

)

const [inline]

Returns:

the maximal corner

template<typename _Scalar, int _AmbientDim>

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

(

)

[inline]

Returns:

a non const reference to the maximal corner

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&)

template<typename _Scalar, int _AmbientDim>

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

(

)

const [inline]

Returns:

the minimal corner

template<typename _Scalar, int _AmbientDim>

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

(

)

[inline]

Returns:

a non const reference to the minimal corner

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

template<typename _Scalar, int _AmbientDim>

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

(

)

[inline]

Makes *this an empty box.

See also:

isEmpty

template<typename _Scalar, int _AmbientDim>

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

(

)

[inline]

Deprecated:

use setEmpty()

template<typename _Scalar, int _AmbientDim>

const CwiseBinaryOp< internal::scalar_difference_op<Scalar,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

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&)

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&)

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.

template<typename _Scalar, int _AmbientDim>

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

(

)

const [inline]

Returns:

the volume of the bounding box

---

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

• AlignedBox.h