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

Public Types
enum	CornerType {   Min ,   Max ,   BottomLeft ,   BottomRight ,   TopLeft ,   TopRight ,   BottomLeftFloor ,   BottomRightFloor ,   TopLeftFloor ,   TopRightFloor ,   BottomLeftCeil ,   BottomRightCeil ,   TopLeftCeil ,   TopRightCeil }
typedef Eigen::Index	Index

Public Member Functions
	AlignedBox ()
template<typename OtherScalarType >
	AlignedBox (const AlignedBox< OtherScalarType, AmbientDimAtCompileTime > &other)
template<typename Derived >
	AlignedBox (const MatrixBase< Derived > &p)
template<typename OtherVectorType1 , typename OtherVectorType2 >
	AlignedBox (const OtherVectorType1 &_min, const OtherVectorType2 &_max)
	AlignedBox (Index _dim)
template<typename NewScalarType >
internal::cast_return_type< AlignedBox, AlignedBox< NewScalarType, AmbientDimAtCompileTime > >::type	cast () const
AlignedBox &	clamp (const AlignedBox &b)
bool	contains (const AlignedBox &b) const
template<typename Derived >
bool	contains (const MatrixBase< Derived > &p) 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
AlignedBox &	extend (const AlignedBox &b)
template<typename Derived >
AlignedBox &	extend (const MatrixBase< Derived > &p)
NonInteger	exteriorDistance (const AlignedBox &b) const
template<typename Derived >
NonInteger	exteriorDistance (const MatrixBase< Derived > &p) 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
VectorType &()	max ()
const VectorType &()	max () const
AlignedBox	merged (const AlignedBox &b) const
VectorType &()	min ()
const VectorType &()	min () const
VectorType	sample () const
void	setEmpty ()
void	setNull ()
const CwiseBinaryOp< internal::scalar_difference_op< Scalar, Scalar >, const VectorType, const VectorType >	sizes () const
Scalar	squaredExteriorDistance (const AlignedBox &b) const
template<typename Derived >
Scalar	squaredExteriorDistance (const MatrixBase< Derived > &p) const
template<int Mode, int Options>
void	transform (const Transform< Scalar, AmbientDimAtCompileTime, Mode, Options > &transform)
template<int Mode, int Options>
void	transform (const typename Transform< Scalar, AmbientDimAtCompileTime, Mode, Options >::TranslationType &translation)
template<int Mode, int Options>
AlignedBox	transformed (const Transform< Scalar, AmbientDimAtCompileTime, Mode, Options > &transform) const
template<typename Derived >
AlignedBox &	translate (const MatrixBase< Derived > &a_t)
template<typename Derived >
AlignedBox	translated (const MatrixBase< Derived > &a_t) const
Scalar	volume () const

Member Typedef Documentation

Index

template<typename Scalar_ , int AmbientDim_>

typedef Eigen::Index Eigen::AlignedBox< Scalar_, AmbientDim_ >::Index

Deprecated:

since Eigen 3.3

Member Enumeration Documentation

CornerType

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
TopRightCeil	Identifier for 3D corner

Constructor & Destructor Documentation

AlignedBox() [1/5]

template<typename Scalar_ , int AmbientDim_>

Eigen::AlignedBox< Scalar_, AmbientDim_ >::AlignedBox ( )

inline

Default constructor initializing a null box.

AlignedBox() [2/5]

template<typename Scalar_ , int AmbientDim_>

Eigen::AlignedBox< Scalar_, AmbientDim_ >::AlignedBox ( Index  _dim )

inlineexplicit

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

AlignedBox() [3/5]

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.

AlignedBox() [4/5]

template<typename Scalar_ , int AmbientDim_>

template<typename Derived >

Eigen::AlignedBox< Scalar_, AmbientDim_ >::AlignedBox ( const MatrixBase< Derived > &  p )

inlineexplicit

Constructs a box containing a single point p.

AlignedBox() [5/5]

template<typename Scalar_ , int AmbientDim_>

template<typename OtherScalarType >

Eigen::AlignedBox< Scalar_, AmbientDim_ >::AlignedBox ( const AlignedBox< OtherScalarType, AmbientDimAtCompileTime > &  other )

inlineexplicit

Copy constructor with scalar type conversion

Member Function Documentation

cast()

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.

clamp()

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

contains() [1/2]

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.

contains() [2/2]

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.

corner()

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.

diagonal()

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.

dim()

template<typename Scalar_ , int AmbientDim_>

Index Eigen::AlignedBox< Scalar_, AmbientDim_ >::dim ( ) const

inline

Returns

the dimension in which the box holds

EIGEN_EXPR_BINARYOP_SCALAR_RETURN_TYPE()

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

extend() [1/2]

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

extend() [2/2]

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

exteriorDistance() [1/2]

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

exteriorDistance() [2/2]

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

intersection()

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

intersects()

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

isApprox()

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

isEmpty()

template<typename Scalar_ , int AmbientDim_>

bool Eigen::AlignedBox< Scalar_, AmbientDim_ >::isEmpty ( ) const

inline

Returns

true if the box is empty.

See also

setEmpty

isNull()

template<typename Scalar_ , int AmbientDim_>

bool Eigen::AlignedBox< Scalar_, AmbientDim_ >::isNull ( ) const

inline

Deprecated:

use isEmpty()

max() [1/2]

template<typename Scalar_ , int AmbientDim_>

VectorType&() Eigen::AlignedBox< Scalar_, AmbientDim_ >::max ( )

inline

Returns

a non const reference to the maximal corner

max() [2/2]

template<typename Scalar_ , int AmbientDim_>

const VectorType&() Eigen::AlignedBox< Scalar_, AmbientDim_ >::max ( ) const

inline

Returns

the maximal corner

merged()

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

min() [1/2]

template<typename Scalar_ , int AmbientDim_>

VectorType&() Eigen::AlignedBox< Scalar_, AmbientDim_ >::min ( )

inline

Returns

a non const reference to the minimal corner

min() [2/2]

template<typename Scalar_ , int AmbientDim_>

const VectorType&() Eigen::AlignedBox< Scalar_, AmbientDim_ >::min ( ) const

inline

Returns

the minimal corner

sample()

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

setEmpty()

template<typename Scalar_ , int AmbientDim_>

void Eigen::AlignedBox< Scalar_, AmbientDim_ >::setEmpty ( )

inline

Makes *this an empty box.

See also

isEmpty

setNull()

template<typename Scalar_ , int AmbientDim_>

void Eigen::AlignedBox< Scalar_, AmbientDim_ >::setNull ( )

inline

Deprecated:

use setEmpty()

sizes()

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

squaredExteriorDistance() [1/2]

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

squaredExteriorDistance() [2/2]

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

transform() [1/2]

template<typename Scalar_ , int AmbientDim_>

template<int Mode, int Options>

void Eigen::AlignedBox< Scalar_, AmbientDim_ >::transform ( const Transform< Scalar, AmbientDimAtCompileTime, Mode, Options > &  transform )

inline

Transforms this box by transform and recomputes it to still be an axis-aligned box.

Note

This method is provided under BSD license (see the top of this file).

transform() [2/2]

template<typename Scalar_ , int AmbientDim_>

template<int Mode, int Options>

void Eigen::AlignedBox< Scalar_, AmbientDim_ >::transform ( const typename Transform< Scalar, AmbientDimAtCompileTime, Mode, Options >::TranslationType &  translation )

inline

Specialization of transform for pure translation.

transformed()

template<typename Scalar_ , int AmbientDim_>

template<int Mode, int Options>

AlignedBox Eigen::AlignedBox< Scalar_, AmbientDim_ >::transformed ( const Transform< Scalar, AmbientDimAtCompileTime, Mode, Options > &  transform ) const

inline

Returns

a copy of *this transformed by transform and recomputed to still be an axis-aligned box.

translate()

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.

translated()

template<typename Scalar_ , int AmbientDim_>

template<typename Derived >

AlignedBox Eigen::AlignedBox< Scalar_, AmbientDim_ >::translated ( const MatrixBase< Derived > &  a_t ) const

inline

Returns

a copy of *this translated by the vector t.

volume()

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