Represents a translation transformation. More...

#include <Translation.h>

Public Types
enum	{ Dim = _Dim }
enum	{ Dim = _Dim }
typedef Transform< Scalar, Dim, Affine >	AffineTransformType
typedef Transform< Scalar, Dim, Isometry >	IsometryTransformType
typedef Matrix< Scalar, Dim, Dim >	LinearMatrixType
typedef Matrix< Scalar, Dim, Dim >	LinearMatrixType
typedef _Scalar	Scalar
typedef _Scalar	Scalar
typedef Scaling< Scalar, Dim >	ScalingType
typedef Transform< Scalar, Dim >	TransformType
typedef Matrix< Scalar, Dim, 1 >	VectorType
typedef Matrix< Scalar, Dim, 1 >	VectorType
Public Member Functions
template<typename NewScalarType >
internal::cast_return_type < Translation, Translation < NewScalarType, Dim > >::type	cast () const
template<typename NewScalarType >
internal::cast_return_type < Translation, Translation < NewScalarType, Dim > >::type	cast () const
Translation	inverse () const
Translation	inverse () const
bool	isApprox (const Translation &other, typename NumTraits< Scalar >::Real prec=precision< Scalar >()) const
bool	isApprox (const Translation &other, typename NumTraits< Scalar >::Real prec=NumTraits< Scalar >::dummy_precision()) const
Translation	operator* (const Translation &other) const
TransformType	operator* (const ScalingType &other) const
TransformType	operator* (const LinearMatrixType &linear) const
template<typename Derived >
TransformType	operator* (const RotationBase< Derived, Dim > &r) const
Translation	operator* (const Translation &other) const
AffineTransformType	operator* (const UniformScaling< Scalar > &other) const
template<typename OtherDerived >
AffineTransformType	operator* (const EigenBase< OtherDerived > &linear) const
TransformType	operator* (const TransformType &t) const
template<typename Derived >
IsometryTransformType	operator* (const RotationBase< Derived, Dim > &r) const
VectorType	operator* (const VectorType &other) const
template<int Mode, int Options>
Transform< Scalar, Dim, Mode >	operator* (const Transform< Scalar, Dim, Mode, Options > &t) const
VectorType	operator* (const VectorType &other) const
Translation &	operator= (const Translation &other)
Translation &	operator= (const Translation &other)
	Translation ()
	Translation ()
	Translation (const Scalar &sx, const Scalar &sy)
	Translation (const Scalar &sx, const Scalar &sy)
	Translation (const Scalar &sx, const Scalar &sy, const Scalar &sz)
	Translation (const Scalar &sx, const Scalar &sy, const Scalar &sz)
	Translation (const VectorType &vector)
	Translation (const VectorType &vector)
const VectorType &	translation () const
VectorType &	translation ()
template<typename OtherScalarType >
	Translation (const Translation< OtherScalarType, Dim > &other)
template<typename OtherScalarType >
	Translation (const Translation< OtherScalarType, Dim > &other)
const VectorType &	vector () const
VectorType &	vector ()
const VectorType &	vector () const
VectorType &	vector ()
Scalar	x () const
	Retruns the x-translation by value.
Scalar &	x ()
	Retruns the x-translation as a reference.
Scalar	y () const
	Retruns the y-translation by value.
Scalar &	y ()
	Retruns the y-translation as a reference.
Scalar	z () const
	Retruns the z-translation by value.
Scalar &	z ()
	Retruns the z-translation as a reference.
Static Public Member Functions
static const Translation	Identity ()
Protected Attributes
VectorType	m_coeffs
Friends
TransformType	operator* (const LinearMatrixType &linear, const Translation &t)
template<typename OtherDerived >
AffineTransformType	operator* (const EigenBase< OtherDerived > &linear, const Translation &t)

Detailed Description

template<typename _Scalar, int _Dim>
class Eigen::Translation< _Scalar, _Dim >

Represents a translation transformation.

Parameters:

_Scalar	the scalar type, i.e., the type of the coefficients.
_Dim	the dimension of the space, can be a compile time value or Dynamic

Note:: This class is not aimed to be used to store a translation transformation, but rather to make easier the constructions and updates of Transform objects.

See also:: class Scaling, class Transform

Definition at line 29 of file Eigen2Support/Geometry/Translation.h.

Member Typedef Documentation

template<typename _Scalar, int _Dim>

typedef Transform<Scalar,Dim,Affine> Eigen::Translation< _Scalar, _Dim >::AffineTransformType

corresponding affine transformation type

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

template<typename _Scalar, int _Dim>

typedef Transform<Scalar,Dim,Isometry> Eigen::Translation< _Scalar, _Dim >::IsometryTransformType

corresponding isometric transformation type

Definition at line 45 of file Geometry/Translation.h.

template<typename _Scalar, int _Dim>

typedef Matrix<Scalar,Dim,Dim> Eigen::Translation< _Scalar, _Dim >::LinearMatrixType

corresponding linear transformation matrix type

Definition at line 40 of file Eigen2Support/Geometry/Translation.h.

template<typename _Scalar, int _Dim>

typedef Matrix<Scalar,Dim,Dim> Eigen::Translation< _Scalar, _Dim >::LinearMatrixType

corresponding linear transformation matrix type

Definition at line 41 of file Geometry/Translation.h.

template<typename _Scalar, int _Dim>

typedef _Scalar Eigen::Translation< _Scalar, _Dim >::Scalar

the scalar type of the coefficients

Definition at line 36 of file Eigen2Support/Geometry/Translation.h.

template<typename _Scalar, int _Dim>

typedef _Scalar Eigen::Translation< _Scalar, _Dim >::Scalar

the scalar type of the coefficients

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

template<typename _Scalar, int _Dim>

typedef Scaling<Scalar,Dim> Eigen::Translation< _Scalar, _Dim >::ScalingType

corresponding scaling transformation type

Definition at line 42 of file Eigen2Support/Geometry/Translation.h.

template<typename _Scalar, int _Dim>

typedef Transform<Scalar,Dim> Eigen::Translation< _Scalar, _Dim >::TransformType

corresponding affine transformation type

Definition at line 44 of file Eigen2Support/Geometry/Translation.h.

template<typename _Scalar, int _Dim>

typedef Matrix<Scalar,Dim,1> Eigen::Translation< _Scalar, _Dim >::VectorType

corresponding vector type

Definition at line 38 of file Eigen2Support/Geometry/Translation.h.

template<typename _Scalar, int _Dim>

typedef Matrix<Scalar,Dim,1> Eigen::Translation< _Scalar, _Dim >::VectorType

corresponding vector type

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

Member Enumeration Documentation

template<typename _Scalar, int _Dim>

anonymous enum

dimension of the space

Enumerator:

Dim

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

template<typename _Scalar, int _Dim>

anonymous enum

dimension of the space

Enumerator:

Dim

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

Constructor & Destructor Documentation

template<typename _Scalar, int _Dim>

Eigen::Translation< _Scalar, _Dim >::Translation ( ) [inline]

Default constructor without initialization.

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

template<typename _Scalar, int _Dim>

Eigen::Translation< _Scalar, _Dim >::Translation	(	const Scalar &	sx,
		const Scalar &	sy
	)		`[inline]`

Definition at line 55 of file Eigen2Support/Geometry/Translation.h.

template<typename _Scalar, int _Dim>

Eigen::Translation< _Scalar, _Dim >::Translation	(	const Scalar &	sx,
		const Scalar &	sy,
		const Scalar &	sz
	)		`[inline]`

Definition at line 62 of file Eigen2Support/Geometry/Translation.h.

template<typename _Scalar, int _Dim>

Eigen::Translation< _Scalar, _Dim >::Translation ( const VectorType & vector ) [inline, explicit]

Constructs and initialize the scaling transformation from a vector of scaling coefficients

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

template<typename _Scalar, int _Dim>

template<typename OtherScalarType >

Eigen::Translation< _Scalar, _Dim >::Translation ( const Translation< OtherScalarType, Dim > & other ) [inline, explicit]

Copy constructor with scalar type conversion

Definition at line 129 of file Eigen2Support/Geometry/Translation.h.

template<typename _Scalar, int _Dim>

Eigen::Translation< _Scalar, _Dim >::Translation ( ) [inline]

Default constructor without initialization.

Definition at line 54 of file Geometry/Translation.h.

template<typename _Scalar, int _Dim>

Eigen::Translation< _Scalar, _Dim >::Translation	(	const Scalar &	sx,
		const Scalar &	sy
	)		`[inline]`

Definition at line 56 of file Geometry/Translation.h.

template<typename _Scalar, int _Dim>

Eigen::Translation< _Scalar, _Dim >::Translation	(	const Scalar &	sx,
		const Scalar &	sy,
		const Scalar &	sz
	)		`[inline]`

Definition at line 63 of file Geometry/Translation.h.

template<typename _Scalar, int _Dim>

Eigen::Translation< _Scalar, _Dim >::Translation ( const VectorType & vector ) [inline, explicit]

Constructs and initialize the translation transformation from a vector of translation coefficients

Definition at line 71 of file Geometry/Translation.h.

template<typename _Scalar, int _Dim>

template<typename OtherScalarType >

Eigen::Translation< _Scalar, _Dim >::Translation ( const Translation< OtherScalarType, Dim > & other ) [inline, explicit]

Copy constructor with scalar type conversion

Definition at line 158 of file Geometry/Translation.h.

Member Function Documentation

template<typename _Scalar, int _Dim>

template<typename NewScalarType >

internal::cast_return_type<Translation,Translation<NewScalarType,Dim> >::type Eigen::Translation< _Scalar, _Dim >::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 124 of file Eigen2Support/Geometry/Translation.h.

template<typename _Scalar, int _Dim>

template<typename NewScalarType >

internal::cast_return_type<Translation,Translation<NewScalarType,Dim> >::type Eigen::Translation< _Scalar, _Dim >::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 153 of file Geometry/Translation.h.

template<typename _Scalar, int _Dim>

static const Translation Eigen::Translation< _Scalar, _Dim >::Identity ( ) [inline, static]

Definition at line 145 of file Geometry/Translation.h.

template<typename _Scalar, int _Dim>

Translation Eigen::Translation< _Scalar, _Dim >::inverse ( void ) const [inline]

Returns:: the inverse translation (opposite)

Definition at line 110 of file Eigen2Support/Geometry/Translation.h.

template<typename _Scalar, int _Dim>

Translation Eigen::Translation< _Scalar, _Dim >::inverse ( void ) const [inline]

Returns:: the inverse translation (opposite)

Definition at line 137 of file Geometry/Translation.h.

template<typename _Scalar, int _Dim>

bool Eigen::Translation< _Scalar, _Dim >::isApprox	(	const Translation< _Scalar, _Dim > &	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/Translation.h.

template<typename _Scalar, int _Dim>

bool Eigen::Translation< _Scalar, _Dim >::isApprox	(	const Translation< _Scalar, _Dim > &	other,
		typename NumTraits< Scalar >::Real	prec = `NumTraits<Scalar>::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 165 of file Geometry/Translation.h.

template<typename _Scalar, int _Dim>

Translation Eigen::Translation< _Scalar, _Dim >::operator* ( const Translation< _Scalar, _Dim > & other ) const [inline]

Concatenates two translation

Definition at line 76 of file Eigen2Support/Geometry/Translation.h.

template<typename Scalar , int Dim>

Translation< Scalar, Dim >::TransformType Eigen::Translation< Scalar, Dim >::operator* ( const ScalingType & other ) const [inline]

Concatenates a translation and a scaling

Definition at line 152 of file Eigen2Support/Geometry/Translation.h.

template<typename Scalar , int Dim>

Translation< Scalar, Dim >::TransformType Eigen::Translation< Scalar, Dim >::operator* ( const LinearMatrixType & linear ) const [inline]

Concatenates a translation and a linear transformation

Definition at line 164 of file Eigen2Support/Geometry/Translation.h.

template<typename _Scalar, int _Dim>

template<typename Derived >

TransformType Eigen::Translation< _Scalar, _Dim >::operator* ( const RotationBase< Derived, Dim > & r ) const [inline]

Definition at line 86 of file Eigen2Support/Geometry/Translation.h.

template<typename _Scalar, int _Dim>

Translation Eigen::Translation< _Scalar, _Dim >::operator* ( const Translation< _Scalar, _Dim > & other ) const [inline]

Concatenates two translation

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

template<typename Scalar , int Dim>

Translation< Scalar, Dim >::AffineTransformType Eigen::Translation< Scalar, Dim >::operator* ( const UniformScaling< Scalar > & other ) const [inline]

Concatenates a translation and a uniform scaling

Definition at line 180 of file Geometry/Translation.h.

template<typename Scalar , int Dim>

template<typename OtherDerived >

Translation< Scalar, Dim >::AffineTransformType Eigen::Translation< Scalar, Dim >::operator* ( const EigenBase< OtherDerived > & linear ) const [inline]

Concatenates a translation and a linear transformation

Definition at line 193 of file Geometry/Translation.h.

template<typename Scalar , int Dim>

Translation< Scalar, Dim >::TransformType Eigen::Translation< Scalar, Dim >::operator* ( const TransformType & t ) const [inline]

Concatenates a translation and an affine transformation

Definition at line 177 of file Eigen2Support/Geometry/Translation.h.

template<typename _Scalar, int _Dim>

VectorType Eigen::Translation< _Scalar, _Dim >::operator* ( const VectorType & other ) const [inline]

Applies translation to vector

Definition at line 106 of file Eigen2Support/Geometry/Translation.h.

template<typename _Scalar, int _Dim>

template<typename Derived >

IsometryTransformType Eigen::Translation< _Scalar, _Dim >::operator* ( const RotationBase< Derived, Dim > & r ) const [inline]

Concatenates a translation and a rotation

Definition at line 106 of file Geometry/Translation.h.

template<typename _Scalar, int _Dim>

template<int Mode, int Options>

Transform<Scalar,Dim,Mode> Eigen::Translation< _Scalar, _Dim >::operator* ( const Transform< Scalar, Dim, Mode, Options > & t ) const [inline]

Concatenates a translation and a transformation

Definition at line 125 of file Geometry/Translation.h.

template<typename _Scalar, int _Dim>

VectorType Eigen::Translation< _Scalar, _Dim >::operator* ( const VectorType & other ) const [inline]

Applies translation to vector

Definition at line 133 of file Geometry/Translation.h.

template<typename _Scalar, int _Dim>

Translation& Eigen::Translation< _Scalar, _Dim >::operator= ( const Translation< _Scalar, _Dim > & other ) [inline]

Definition at line 112 of file Eigen2Support/Geometry/Translation.h.

template<typename _Scalar, int _Dim>

Translation& Eigen::Translation< _Scalar, _Dim >::operator= ( const Translation< _Scalar, _Dim > & other ) [inline]

Definition at line 139 of file Geometry/Translation.h.

template<typename _Scalar, int _Dim>

const VectorType& Eigen::Translation< _Scalar, _Dim >::translation ( ) const [inline]

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

template<typename _Scalar, int _Dim>

VectorType& Eigen::Translation< _Scalar, _Dim >::translation ( ) [inline]

Definition at line 91 of file Geometry/Translation.h.

template<typename _Scalar, int _Dim>

const VectorType& Eigen::Translation< _Scalar, _Dim >::vector ( ) const [inline]

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

template<typename _Scalar, int _Dim>

VectorType& Eigen::Translation< _Scalar, _Dim >::vector ( ) [inline]

Definition at line 73 of file Eigen2Support/Geometry/Translation.h.

template<typename _Scalar, int _Dim>

const VectorType& Eigen::Translation< _Scalar, _Dim >::vector ( ) const [inline]

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

template<typename _Scalar, int _Dim>

VectorType& Eigen::Translation< _Scalar, _Dim >::vector ( ) [inline]

Definition at line 88 of file Geometry/Translation.h.

template<typename _Scalar, int _Dim>

Scalar Eigen::Translation< _Scalar, _Dim >::x ( ) const [inline]

Retruns the x-translation by value.

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

template<typename _Scalar, int _Dim>

Scalar& Eigen::Translation< _Scalar, _Dim >::x ( ) [inline]

Retruns the x-translation as a reference.

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

template<typename _Scalar, int _Dim>

Scalar Eigen::Translation< _Scalar, _Dim >::y ( ) const [inline]

Retruns the y-translation by value.

Definition at line 76 of file Geometry/Translation.h.

template<typename _Scalar, int _Dim>

Scalar& Eigen::Translation< _Scalar, _Dim >::y ( ) [inline]

Retruns the y-translation as a reference.

Definition at line 83 of file Geometry/Translation.h.

template<typename _Scalar, int _Dim>

Scalar Eigen::Translation< _Scalar, _Dim >::z ( ) const [inline]

Retruns the z-translation by value.

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

template<typename _Scalar, int _Dim>

Scalar& Eigen::Translation< _Scalar, _Dim >::z ( ) [inline]

Retruns the z-translation as a reference.

Definition at line 85 of file Geometry/Translation.h.

Friends And Related Function Documentation

template<typename _Scalar, int _Dim>

TransformType operator*	(	const LinearMatrixType &	linear,
		const Translation< _Scalar, _Dim > &	t
	)		`[friend]`

Concatenates a linear transformation and a translation

Definition at line 91 of file Eigen2Support/Geometry/Translation.h.

template<typename _Scalar, int _Dim>

template<typename OtherDerived >

AffineTransformType operator*	(	const EigenBase< OtherDerived > &	linear,
		const Translation< _Scalar, _Dim > &	t
	)		`[friend]`

Returns:: the concatenation of a linear transformation l with the translation t

Definition at line 112 of file Geometry/Translation.h.

Member Data Documentation

template<typename _Scalar, int _Dim>

VectorType Eigen::Translation< _Scalar, _Dim >::m_coeffs [protected]

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

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Friends

Detailed Description

template<typename _Scalar, int _Dim> class Eigen::Translation< _Scalar, _Dim >

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation

template<typename _Scalar, int _Dim>
class Eigen::Translation< _Scalar, _Dim >