Translation< Scalar, Dim > Class Template Reference

Represents a translation transformation. More...

Public Types
enum	{ Dim }
typedef Matrix< Scalar, Dim, Dim >	LinearMatrixType
typedef _Scalar	Scalar
typedef Scaling< Scalar, Dim >	ScalingType
typedef Transform< Scalar, Dim >	TransformType
typedef Matrix< Scalar, Dim, 1 >	VectorType

Public Member Functions
template<typename NewScalarType >
ei_cast_return_type < Translation, Translation < NewScalarType, Dim > >::type	cast () const
Translation	inverse () const
bool	isApprox (const Translation &other, typename NumTraits< Scalar >::Real prec=precision< Scalar >()) 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
TransformType	operator* (const TransformType &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)
template<typename OtherScalarType >
	Translation (const Translation< OtherScalarType, Dim > &other)
const VectorType &	vector () const
VectorType &	vector ()

Protected Attributes
VectorType	m_coeffs

Friends
TransformType	operator* (const LinearMatrixType &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 Matrix<Scalar,Dim,Dim> LinearMatrixType

corresponding linear transformation matrix type

typedef _Scalar Scalar

the scalar type of the coefficients

typedef Scaling<Scalar,Dim> ScalingType

corresponding scaling transformation type

typedef Transform<Scalar,Dim> TransformType

corresponding affine transformation type

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.

Translation ( const VectorType &  vector )

inlineexplicit

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

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

inlineexplicit

Copy constructor with scalar type conversion

Member Function Documentation

ei_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 ( void  ) const

inline

Returns

the inverse translation (opposite)

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

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

inline

Concatenates two translation

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

inline

Concatenates a translation and a scaling

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

inline

Concatenates a translation and a linear transformation

Translation< Scalar, Dim >::TransformType operator* ( const TransformType &  t ) const

inline

Concatenates a translation and an affine transformation

VectorType operator* ( const VectorType &  other ) const

inline

Applies translation to vector

Friends And Related Function Documentation

TransformType operator* ( const LinearMatrixType &  linear, const Translation< Scalar, Dim > &  t  )

friend

Concatenates a linear transformation and a translation

---

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

• Core
• Geometry