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

Public Types
enum

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

	Translation (const VectorType &vector)

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

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.

Friends
template<typename OtherDerived >
AffineTransformType	operator* (const EigenBase< OtherDerived > &linear, const Translation &t)

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

Constructor & Destructor Documentation

Translation ( )

inline

Default constructor without initialization.

Referenced by Translation< Scalar, Dim >::inverse(), and Translation< Scalar, Dim >::operator*().

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

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.

Translation inverse ( ) const

inline

Returns: the inverse translation (opposite)

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

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

inline

Concatenates two translation

References Translation< Scalar, Dim >::Translation().

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

inline

Concatenates a translation and a uniform scaling

References Transform< Scalar, Dim, Mode, _Options >::linear(), Transform< Scalar, Dim, Mode, _Options >::matrix(), PlainObjectBase< Derived >::setZero(), and Transform< Scalar, Dim, Mode, _Options >::translation().

AffineTransformType operator* ( const EigenBase< OtherDerived > & linear ) const

inline

Concatenates a translation and a linear transformation

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

VectorType operator* ( const VectorType & other ) const

inline

Applies translation to vector

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

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

Detailed Description

template<typename Scalar, int Dim> class Eigen::Translation< Scalar, Dim >

Public Types

Public Member Functions

Friends

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

template<typename Scalar, int Dim>
class Eigen::Translation< Scalar, Dim >