\geometry_module More...

#include <AlignedBox.h>

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 Eigen::Index	Index

typedef ScalarTraits::Real	RealScalar

typedef ScalarTraits::NonInteger	NonInteger

typedef Matrix< Scalar, AmbientDimAtCompileTime, 1 >	VectorType

typedef CwiseBinaryOp< internal::scalar_sum_op< Scalar >, const VectorType, const VectorType >	VectorTypeSum

Public Member Functions
EIGEN_DEVICE_FUNC	AlignedBox ()
	Default constructor initializing a null box.

EIGEN_DEVICE_FUNC	AlignedBox (Index _dim)
	Constructs a null box with _dim the dimension of the ambient space.

template<typename OtherVectorType1 , typename OtherVectorType2 >
EIGEN_DEVICE_FUNC	AlignedBox (const OtherVectorType1 &_min, const OtherVectorType2 &_max)
	Constructs a box with extremities _min and _max.

template<typename Derived >
EIGEN_DEVICE_FUNC	AlignedBox (const MatrixBase< Derived > &p)
	Constructs a box containing a single point p.

EIGEN_DEVICE_FUNC Index	dim () const

EIGEN_DEVICE_FUNC bool	isNull () const

EIGEN_DEVICE_FUNC void	setNull ()

EIGEN_DEVICE_FUNC bool	isEmpty () const

EIGEN_DEVICE_FUNC void	setEmpty ()
	Makes `*this` an empty box.

EIGEN_DEVICE_FUNC const VectorType &()	min () const

EIGEN_DEVICE_FUNC VectorType &()	min ()

EIGEN_DEVICE_FUNC const VectorType &()	max () const

EIGEN_DEVICE_FUNC VectorType &()	max ()

EIGEN_DEVICE_FUNC const	EIGEN_EXPR_BINARYOP_SCALAR_RETURN_TYPE (VectorTypeSum, RealScalar, quotient) center() const

EIGEN_DEVICE_FUNC const CwiseBinaryOp< internal::scalar_difference_op< Scalar, Scalar >, const VectorType, const VectorType >	sizes () const

EIGEN_DEVICE_FUNC Scalar	volume () const

EIGEN_DEVICE_FUNC CwiseBinaryOp< internal::scalar_difference_op< Scalar, Scalar >, const VectorType, const VectorType >	diagonal () const

EIGEN_DEVICE_FUNC VectorType	corner (CornerType corner) const

EIGEN_DEVICE_FUNC VectorType	sample () const

template<typename Derived >
EIGEN_DEVICE_FUNC bool	contains (const MatrixBase< Derived > &p) const

EIGEN_DEVICE_FUNC bool	contains (const AlignedBox &b) const

EIGEN_DEVICE_FUNC bool	intersects (const AlignedBox &b) const

template<typename Derived >
EIGEN_DEVICE_FUNC AlignedBox &	extend (const MatrixBase< Derived > &p)
	Extends `this` such that it contains the point p and returns a reference to `this`.

EIGEN_DEVICE_FUNC AlignedBox &	extend (const AlignedBox &b)
	Extends `this` such that it contains the box b and returns a reference to `this`.

EIGEN_DEVICE_FUNC AlignedBox &	clamp (const AlignedBox &b)
	Clamps `this` by the box b and returns a reference to `this`.

EIGEN_DEVICE_FUNC AlignedBox	intersection (const AlignedBox &b) const
	Returns an AlignedBox that is the intersection of b and `*this`.

EIGEN_DEVICE_FUNC AlignedBox	merged (const AlignedBox &b) const
	Returns an AlignedBox that is the union of b and `*this`.

template<typename Derived >
EIGEN_DEVICE_FUNC AlignedBox &	translate (const MatrixBase< Derived > &a_t)
	Translate `this` by the vector t and returns a reference to `this`.

template<typename Derived >
EIGEN_DEVICE_FUNC AlignedBox	translated (const MatrixBase< Derived > &a_t) const

template<typename Derived >
EIGEN_DEVICE_FUNC Scalar	squaredExteriorDistance (const MatrixBase< Derived > &p) const

EIGEN_DEVICE_FUNC Scalar	squaredExteriorDistance (const AlignedBox &b) const

template<typename Derived >
EIGEN_DEVICE_FUNC NonInteger	exteriorDistance (const MatrixBase< Derived > &p) const

EIGEN_DEVICE_FUNC NonInteger	exteriorDistance (const AlignedBox &b) const

template<int Mode, int Options>
EIGEN_DEVICE_FUNC void	transform (const typename Transform< Scalar, AmbientDimAtCompileTime, Mode, Options >::TranslationType &translation)
	Specialization of transform for pure translation.

template<int Mode, int Options>
EIGEN_DEVICE_FUNC void	transform (const Transform< Scalar, AmbientDimAtCompileTime, Mode, Options > &transform)
	Transforms this box by transform and recomputes it to still be an axis-aligned box.

template<int Mode, int Options>
EIGEN_DEVICE_FUNC AlignedBox	transformed (const Transform< Scalar, AmbientDimAtCompileTime, Mode, Options > &transform) const

template<typename NewScalarType >
EIGEN_DEVICE_FUNC internal::cast_return_type< AlignedBox, AlignedBox< NewScalarType, AmbientDimAtCompileTime > >::type	cast () const

template<typename OtherScalarType >
EIGEN_DEVICE_FUNC	AlignedBox (const AlignedBox< OtherScalarType, AmbientDimAtCompileTime > &other)
	Copy constructor with scalar type conversion.

EIGEN_DEVICE_FUNC bool	isApprox (const AlignedBox &other, const RealScalar &prec=ScalarTraits::dummy_precision()) const

Protected Attributes
VectorType	m_min

VectorType	m_max

Detailed Description

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

\geometry_module

An axis aligned box

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

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
BottomLeft	Identifier for 2D corner.
BottomLeftFloor	Identifier for 3D corner.

Constructor & Destructor Documentation

◆ AlignedBox()

template<typename _Scalar , int _AmbientDim>

template<typename OtherVectorType1 , typename OtherVectorType2 >

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

Member Function Documentation

◆ cast()

template<typename _Scalar , int _AmbientDim>

template<typename NewScalarType >

EIGEN_DEVICE_FUNC 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>

EIGEN_DEVICE_FUNC 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>

EIGEN_DEVICE_FUNC 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 >

EIGEN_DEVICE_FUNC 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>

EIGEN_DEVICE_FUNC 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>

EIGEN_DEVICE_FUNC 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>

EIGEN_DEVICE_FUNC 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>

EIGEN_DEVICE_FUNC 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>

EIGEN_DEVICE_FUNC 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 >

EIGEN_DEVICE_FUNC 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>

EIGEN_DEVICE_FUNC 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 >

EIGEN_DEVICE_FUNC 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>

EIGEN_DEVICE_FUNC 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>

EIGEN_DEVICE_FUNC 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>

EIGEN_DEVICE_FUNC 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>

EIGEN_DEVICE_FUNC bool Eigen::AlignedBox< _Scalar, _AmbientDim >::isEmpty ( ) const

inline

Returns: true if the box is empty.

See also: setEmpty

◆ isNull()

template<typename _Scalar , int _AmbientDim>

EIGEN_DEVICE_FUNC bool Eigen::AlignedBox< _Scalar, _AmbientDim >::isNull ( ) const

inline

Deprecated:: use isEmpty()

◆ max() [1/2]

template<typename _Scalar , int _AmbientDim>

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

inline

Returns: a non const reference to the maximal corner

◆ max() [2/2]

template<typename _Scalar , int _AmbientDim>

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

inline

Returns: the maximal corner

◆ merged()

template<typename _Scalar , int _AmbientDim>

EIGEN_DEVICE_FUNC 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>

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

inline

Returns: a non const reference to the minimal corner

◆ min() [2/2]

template<typename _Scalar , int _AmbientDim>

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

inline

Returns: the minimal corner

◆ sample()

template<typename _Scalar , int _AmbientDim>

EIGEN_DEVICE_FUNC 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>

EIGEN_DEVICE_FUNC void Eigen::AlignedBox< _Scalar, _AmbientDim >::setEmpty ( )

inline

Makes *this an empty box.

See also: isEmpty

◆ setNull()

template<typename _Scalar , int _AmbientDim>

EIGEN_DEVICE_FUNC void Eigen::AlignedBox< _Scalar, _AmbientDim >::setNull ( )

inline

Deprecated:: use setEmpty()

◆ sizes()

template<typename _Scalar , int _AmbientDim>

EIGEN_DEVICE_FUNC 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>

EIGEN_DEVICE_FUNC 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 >

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

template<typename _Scalar , int _AmbientDim>

template<int Mode, int Options>

EIGEN_DEVICE_FUNC 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).

◆ transformed()

template<typename _Scalar , int _AmbientDim>

template<int Mode, int Options>

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

◆ translated()

template<typename _Scalar , int _AmbientDim>

template<typename Derived >

EIGEN_DEVICE_FUNC 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>

EIGEN_DEVICE_FUNC 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 files:

External/Eigen/src/Core/util/ForwardDeclarations.h
External/Eigen/src/Geometry/AlignedBox.h

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Index

Member Enumeration Documentation

◆ CornerType

Constructor & Destructor Documentation

◆ AlignedBox()

Member Function Documentation

◆ cast()

◆ clamp()

◆ contains() [1/2]

◆ contains() [2/2]

◆ corner()

◆ diagonal()

◆ dim()

◆ EIGEN_EXPR_BINARYOP_SCALAR_RETURN_TYPE()

◆ extend() [1/2]

◆ extend() [2/2]

◆ exteriorDistance() [1/2]

◆ exteriorDistance() [2/2]

◆ intersection()

◆ intersects()

◆ isApprox()

◆ isEmpty()

◆ isNull()

◆ max() [1/2]

◆ max() [2/2]

◆ merged()

◆ min() [1/2]

◆ min() [2/2]

◆ sample()

◆ setEmpty()

◆ setNull()

◆ sizes()

◆ squaredExteriorDistance() [1/2]

◆ squaredExteriorDistance() [2/2]

◆ transform()

◆ transformed()

◆ translated()

◆ volume()