Eigen  3.3.4
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Eigen::Translation< Scalar, Dim > Class Template Reference

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>
Template Parameters
_Scalarthe scalar type, i.e., the type of the coefficients.
_Dimthe 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, const 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
 
template<typename Derived >
internal::enable_if
< Derived::IsVectorAtCompileTime,
VectorType >::type 
operator* (const MatrixBase< Derived > &vec) const
 
 Translation ()
 
 Translation (const VectorType &vector)
 
template<typename OtherScalarType >
 Translation (const Translation< OtherScalarType, Dim > &other)
 
Scalar x () const
 Retruns the x-translation by value.
 
Scalarx ()
 Retruns the x-translation as a reference.
 
Scalar y () const
 Retruns the y-translation by value.
 
Scalary ()
 Retruns the y-translation as a reference.
 
Scalar z () const
 Retruns the z-translation by value.
 
Scalarz ()
 Retruns the z-translation as a reference.
 

Friends

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

Member Typedef Documentation

template<typename Scalar, int Dim>
typedef Transform<Scalar,Dim,Affine> Eigen::Translation< Scalar, Dim >::AffineTransformType

corresponding affine transformation type

template<typename Scalar, int Dim>
typedef Transform<Scalar,Dim,Isometry> Eigen::Translation< Scalar, Dim >::IsometryTransformType

corresponding isometric transformation type

template<typename Scalar, int Dim>
typedef Matrix<Scalar,Dim,Dim> Eigen::Translation< Scalar, Dim >::LinearMatrixType

corresponding linear transformation matrix type

template<typename Scalar, int Dim>
typedef _Scalar Eigen::Translation< Scalar, Dim >::Scalar

the scalar type of the coefficients

template<typename Scalar, int Dim>
typedef Matrix<Scalar,Dim,1> Eigen::Translation< Scalar, Dim >::VectorType

corresponding vector type

Member Enumeration Documentation

template<typename Scalar, int Dim>
anonymous enum

dimension of the space

Constructor & Destructor Documentation

template<typename Scalar, int Dim>
Eigen::Translation< Scalar, Dim >::Translation ( )
inline

Default constructor without initialization.

template<typename Scalar, int Dim>
Eigen::Translation< Scalar, Dim >::Translation ( const VectorType vector)
inlineexplicit

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

template<typename Scalar, int Dim>
template<typename OtherScalarType >
Eigen::Translation< Scalar, Dim >::Translation ( const Translation< OtherScalarType, Dim > &  other)
inlineexplicit

Copy constructor with scalar type conversion

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.

template<typename Scalar, int Dim>
Translation Eigen::Translation< Scalar, Dim >::inverse ( ) const
inline
Returns
the inverse translation (opposite)
template<typename Scalar, int Dim>
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()
template<typename Scalar, int Dim>
Translation Eigen::Translation< Scalar, Dim >::operator* ( const Translation< Scalar, Dim > &  other) const
inline

Concatenates two translation

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

template<typename Scalar, int Dim>
template<typename OtherDerived >
AffineTransformType Eigen::Translation< Scalar, Dim >::operator* ( const EigenBase< OtherDerived > &  linear) const
inline

Concatenates a translation and a linear transformation

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

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

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

Friends And Related Function Documentation

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

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