Represents a translation transformation. More...

#include <Translation.h>

Public Types
enum	{ Dim }
typedef Transform< Scalar, Dim, Affine >	AffineTransformType
typedef Transform< Scalar, Dim, Isometry >	IsometryTransformType
typedef Matrix< Scalar, Dim, Dim >	LinearMatrixType
typedef _Scalar	Scalar
typedef Matrix< Scalar, Dim, 1 >	VectorType

Public Member Functions
template<typename NewScalarType >
internal::cast_return_type < Translation, Translation < NewScalarType, Dim > >::type	cast () const
Translation	inverse () const
bool	isApprox (const Translation &other, typename NumTraits< Scalar >::Real prec=NumTraits< Scalar >::dummy_precision()) const
Translation	operator* (const Translation &other) const
AffineTransformType	operator* (const UniformScaling< Scalar > &other) const
template<typename OtherDerived >
AffineTransformType	operator* (const EigenBase< OtherDerived > &linear) const
template<typename Derived >
IsometryTransformType	operator* (const RotationBase< Derived, Dim > &r) 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 ()
	Translation (const Scalar &sx, const Scalar &sy)
	Translation (const Scalar &sx, const Scalar &sy, const Scalar &sz)
	Translation (const VectorType &vector)
const VectorType &	translation () const
VectorType &	translation ()
template<typename OtherScalarType >
	Translation (const Translation< OtherScalarType, Dim > &other)
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
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.

This is defined in the Geometry module.

#include <Eigen/Geometry>

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

Member Typedef Documentation

typedef Transform<Scalar,Dim,Affine> AffineTransformType

corresponding affine transformation type

typedef Transform<Scalar,Dim,Isometry> IsometryTransformType

corresponding isometric transformation type

typedef Matrix<Scalar,Dim,Dim> LinearMatrixType

corresponding linear transformation matrix type

typedef _Scalar Scalar

the scalar type of the coefficients

typedef Matrix<Scalar,Dim,1> VectorType

corresponding vector type

Member Enumeration Documentation

anonymous enum

dimension of the space

Enumerator:

Dim

Constructor & Destructor Documentation

Translation ( )

inline

Default constructor without initialization.

Referenced by Translation< _Scalar, _Dim >::Identity(), Translation< _Scalar, _Dim >::inverse(), and Translation< _Scalar, _Dim >::operator*().

Translation	(	const Scalar &	sx,
		const Scalar &	sy
	)

inline

References Translation< _Scalar, _Dim >::Dim, eigen_assert, and Translation< _Scalar, _Dim >::m_coeffs.

Translation	(	const Scalar &	sx,
		const Scalar &	sy,
		const Scalar &	sz
	)

inline

References Translation< _Scalar, _Dim >::Dim, eigen_assert, and Translation< _Scalar, _Dim >::m_coeffs.

Translation ( const VectorType & vector )

inlineexplicit

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

Translation ( const Translation< OtherScalarType, Dim > & other )

inlineexplicit

Copy constructor with scalar type conversion

References Translation< _Scalar, _Dim >::m_coeffs, and Translation< _Scalar, _Dim >::vector().

Member Function Documentation

internal::cast_return_type<Translation,Translation<NewScalarType,Dim> >::type 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.

static const Translation Identity ( )

inlinestatic

References Translation< _Scalar, _Dim >::Translation().

Translation inverse ( ) const

inline

Returns:: the inverse translation (opposite)

References Translation< _Scalar, _Dim >::m_coeffs, and Translation< _Scalar, _Dim >::Translation().

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

References Translation< _Scalar, _Dim >::m_coeffs.

Translation operator* ( const Translation< _Scalar, _Dim > & other ) const

inline

Concatenates two translation

References Translation< _Scalar, _Dim >::m_coeffs, and Translation< _Scalar, _Dim >::Translation().

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

inline

Concatenates a translation and a uniform scaling

References UniformScaling< _Scalar >::factor(), Transform< _Scalar, _Dim, _Mode, _Options >::linear(), Transform< _Scalar, _Dim, _Mode, _Options >::matrix(), PlainObjectBase< Derived >::setZero(), and Transform< _Scalar, _Dim, _Mode, _Options >::translation().

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

inline

Concatenates a translation and a linear transformation

References EigenBase< Derived >::derived(), Transform< _Scalar, _Dim, _Mode, _Options >::linear(), Transform< _Scalar, _Dim, _Mode, _Options >::matrix(), DenseBase< Derived >::row(), PlainObjectBase< Derived >::setZero(), and Transform< _Scalar, _Dim, _Mode, _Options >::translation().

IsometryTransformType operator* ( const RotationBase< Derived, Dim > & r ) const

inline

Concatenates a translation and a rotation

Transform<Scalar,Dim,Mode> operator* ( const Transform< Scalar, Dim, Mode, Options > & t ) const

inline

Concatenates a translation and a transformation

References Translation< _Scalar, _Dim >::m_coeffs, and Transform< _Scalar, _Dim, _Mode, _Options >::pretranslate().

VectorType operator* ( const VectorType & other ) const

inline

Applies translation to vector

References Translation< _Scalar, _Dim >::m_coeffs.

Translation& operator= ( const Translation< _Scalar, _Dim > & other )

inline

References Translation< _Scalar, _Dim >::m_coeffs.

const VectorType& translation ( ) const

inline

References Translation< _Scalar, _Dim >::m_coeffs.

VectorType& translation ( )

inline

References Translation< _Scalar, _Dim >::m_coeffs.

const VectorType& vector ( ) const

inline

References Translation< _Scalar, _Dim >::m_coeffs.

Referenced by UniformScaling< _Scalar >::operator*(), Transform< _Scalar, _Dim, _Mode, _Options >::operator*(), Transform< _Scalar, _Dim, _Mode, _Options >::operator*=(), Transform< _Scalar, _Dim, _Mode, _Options >::operator=(), and Translation< _Scalar, _Dim >::Translation().

VectorType& vector ( )

inline

References Translation< _Scalar, _Dim >::m_coeffs.

Scalar x ( ) const

inline

Retruns the x-translation by value.

References Translation< _Scalar, _Dim >::m_coeffs.

Scalar& x ( )

inline

Retruns the x-translation as a reference.

References Translation< _Scalar, _Dim >::m_coeffs.

Scalar y ( ) const

inline

Retruns the y-translation by value.

References Translation< _Scalar, _Dim >::m_coeffs.

Scalar& y ( )

inline

Retruns the y-translation as a reference.

References Translation< _Scalar, _Dim >::m_coeffs.

Scalar z ( ) const

inline

Retruns the z-translation by value.

References Translation< _Scalar, _Dim >::m_coeffs.

Scalar& z ( )

inline

Retruns the z-translation as a reference.

References Translation< _Scalar, _Dim >::m_coeffs.

Friends And Related Function Documentation

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

friend

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

Member Data Documentation

VectorType m_coeffs

protected

Referenced by Translation< _Scalar, _Dim >::inverse(), Translation< _Scalar, _Dim >::isApprox(), Translation< _Scalar, _Dim >::operator*(), Translation< _Scalar, _Dim >::operator=(), Translation< _Scalar, _Dim >::Translation(), Translation< _Scalar, _Dim >::translation(), Translation< _Scalar, _Dim >::vector(), Translation< _Scalar, _Dim >::x(), Translation< _Scalar, _Dim >::y(), and Translation< _Scalar, _Dim >::z().

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

Translation.h

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 >