Represents a translation transformation. More...

#include <Translation.h>

Public Types
enum	{ Dim = _Dim }

typedef _Scalar	Scalar

typedef Matrix< Scalar, Dim, 1 >	VectorType

typedef Matrix< Scalar, Dim, Dim >	LinearMatrixType

typedef Transform< Scalar, Dim, Affine >	AffineTransformType

typedef Transform< Scalar, Dim, Isometry >	IsometryTransformType

Public Member Functions
EIGEN_DEVICE_FUNC	Translation ()

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

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

EIGEN_DEVICE_FUNC	Translation (const VectorType &vector)

EIGEN_DEVICE_FUNC Scalar	x () const
	Returns the x-translation by value.

EIGEN_DEVICE_FUNC Scalar	y () const
	Returns the y-translation by value.

EIGEN_DEVICE_FUNC Scalar	z () const
	Returns the z-translation by value.

EIGEN_DEVICE_FUNC Scalar &	x ()
	Returns the x-translation as a reference.

EIGEN_DEVICE_FUNC Scalar &	y ()
	Returns the y-translation as a reference.

EIGEN_DEVICE_FUNC Scalar &	z ()
	Returns the z-translation as a reference.

EIGEN_DEVICE_FUNC const VectorType &	vector () const

EIGEN_DEVICE_FUNC VectorType &	vector ()

EIGEN_DEVICE_FUNC const VectorType &	translation () const

EIGEN_DEVICE_FUNC VectorType &	translation ()

EIGEN_DEVICE_FUNC Translation	operator* (const Translation &other) const

EIGEN_DEVICE_FUNC AffineTransformType	operator* (const UniformScaling< Scalar > &other) const

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

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

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

template<typename Derived >
internal::enable_if< Derived::IsVectorAtCompileTime, VectorType >::type	operator* (const MatrixBase< Derived > &vec) const

Translation	inverse () const

template<typename NewScalarType >
EIGEN_DEVICE_FUNC internal::cast_return_type< Translation, Translation< NewScalarType, Dim > >::type	cast () const

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

EIGEN_DEVICE_FUNC bool	isApprox (const Translation &other, const typename NumTraits< Scalar >::Real &prec=NumTraits< Scalar >::dummy_precision()) const

Static Public Member Functions
static const Translation	Identity ()

Protected Attributes
VectorType	m_coeffs

Friends
template<typename OtherDerived >
EIGEN_DEVICE_FUNC 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.

\geometry_module

Template 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

◆ AffineTransformType

template<typename _Scalar , int _Dim>

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

corresponding affine transformation type

◆ IsometryTransformType

template<typename _Scalar , int _Dim>

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

corresponding isometric transformation type

◆ LinearMatrixType

template<typename _Scalar , int _Dim>

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

corresponding linear transformation matrix type

◆ Scalar

template<typename _Scalar , int _Dim>

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

the scalar type of the coefficients

◆ VectorType

template<typename _Scalar , int _Dim>

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

corresponding vector type

Member Enumeration Documentation

◆ anonymous enum

template<typename _Scalar , int _Dim>

anonymous enum

dimension of the space

Constructor & Destructor Documentation

◆ Translation() [1/3]

template<typename _Scalar , int _Dim>

EIGEN_DEVICE_FUNC Eigen::Translation< _Scalar, _Dim >::Translation ( )

inline

Default constructor without initialization.

◆ Translation() [2/3]

template<typename _Scalar , int _Dim>

EIGEN_DEVICE_FUNC Eigen::Translation< _Scalar, _Dim >::Translation ( const VectorType & vector )

inlineexplicit

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

◆ Translation() [3/3]

template<typename _Scalar , int _Dim>

template<typename OtherScalarType >

EIGEN_DEVICE_FUNC Eigen::Translation< _Scalar, _Dim >::Translation ( const Translation< OtherScalarType, Dim > & other )

inlineexplicit

Copy constructor with scalar type conversion

Member Function Documentation

◆ cast()

template<typename _Scalar , int _Dim>

template<typename NewScalarType >

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

◆ inverse()

template<typename _Scalar , int _Dim>

Translation Eigen::Translation< _Scalar, _Dim >::inverse ( ) const

inline

Returns: the inverse translation (opposite)

◆ isApprox()

template<typename _Scalar , int _Dim>

EIGEN_DEVICE_FUNC bool Eigen::Translation< _Scalar, _Dim >::isApprox	(	const Translation< _Scalar, _Dim > &	other,
		const 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()

◆ operator*() [1/6]

template<typename Scalar , int Dim>

template<typename OtherDerived >

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

inline

Concatenates a translation and a linear transformation

◆ operator*() [2/6]

template<typename _Scalar , int _Dim>

template<typename Derived >

internal::enable_if<Derived::IsVectorAtCompileTime,VectorType>::type Eigen::Translation< _Scalar, _Dim >::operator* ( const MatrixBase< Derived > & vec ) const

inline

Applies translation to vector

◆ operator*() [3/6]

template<typename _Scalar , int _Dim>

template<typename Derived >

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

inline

Concatenates a translation and a rotation

◆ operator*() [4/6]

template<typename _Scalar , int _Dim>

template<int Mode, int Options>

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

inline

Concatenates a translation and a transformation

◆ operator*() [5/6]

template<typename _Scalar , int _Dim>

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

inline

Concatenates two translation

◆ operator*() [6/6]

template<typename Scalar , int Dim>

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

inline

Concatenates a translation and a uniform scaling

Friends And Related Function Documentation

◆ operator*

template<typename _Scalar , int _Dim>

template<typename OtherDerived >

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

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

◆ AffineTransformType

◆ IsometryTransformType

◆ LinearMatrixType

◆ Scalar

◆ VectorType

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ Translation() [1/3]

◆ Translation() [2/3]

◆ Translation() [3/3]

Member Function Documentation

◆ cast()

◆ inverse()

◆ isApprox()

◆ operator*() [1/6]

◆ operator*() [2/6]

◆ operator*() [3/6]

◆ operator*() [4/6]

◆ operator*() [5/6]

◆ operator*() [6/6]

Friends And Related Function Documentation

◆ operator*

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