Please, help us to better know about our user community by answering the following short survey: https://forms.gle/wpyrxWi18ox9Z5ae9
Eigen  3.3.71
Eigen::Translation Class Reference

Detailed Description

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, AffineAffineTransformType
 
typedef Transform< Scalar, Dim, IsometryIsometryTransformType
 
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
 
template<typename OtherDerived >
AffineTransformType operator* (const EigenBase< OtherDerived > &linear) const
 
template<typename Derived >
internal::enable_if< Derived::IsVectorAtCompileTime, VectorType >::type operator* (const MatrixBase< Derived > &vec) 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
 
Translation operator* (const Translation &other) const
 
AffineTransformType operator* (const UniformScaling< Scalar > &other) const
 
 Translation ()
 
template<typename OtherScalarType >
 Translation (const Translation< OtherScalarType, Dim > &other)
 
 Translation (const VectorType &vector)
 
Scalarx ()
 Retruns the x-translation as a reference.
 
Scalar x () const
 Retruns the x-translation by value.
 
Scalary ()
 Retruns the y-translation as a reference.
 
Scalar y () const
 Retruns the y-translation by value.
 
Scalarz ()
 Retruns the z-translation as a reference.
 
Scalar z () const
 Retruns the z-translation by value.
 

Member Typedef Documentation

◆ AffineTransformType

corresponding affine transformation type

◆ IsometryTransformType

corresponding isometric transformation type

◆ LinearMatrixType

corresponding linear transformation matrix type

◆ Scalar

typedef _Scalar Eigen::Translation::Scalar

the scalar type of the coefficients

◆ VectorType

corresponding vector type

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

dimension of the space

Constructor & Destructor Documentation

◆ Translation() [1/3]

Eigen::Translation::Translation ( )
inline

Default constructor without initialization.

◆ Translation() [2/3]

Eigen::Translation::Translation ( const VectorType vector)
inlineexplicit

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

◆ Translation() [3/3]

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

Copy constructor with scalar type conversion

Member Function Documentation

◆ cast()

template<typename NewScalarType >
internal::cast_return_type<Translation,Translation<NewScalarType,Dim> >::type Eigen::Translation::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()

Translation Eigen::Translation::inverse ( ) const
inline
Returns
the inverse translation (opposite)

◆ isApprox()

bool Eigen::Translation::isApprox ( const Translation 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 OtherDerived >
Translation< Scalar, Dim >::AffineTransformType Eigen::Translation::operator* ( const EigenBase< OtherDerived > &  linear) const
inline

Concatenates a translation and a linear transformation

◆ operator*() [2/6]

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

Applies translation to vector

◆ operator*() [3/6]

template<typename Derived >
IsometryTransformType Eigen::Translation::operator* ( const RotationBase< Derived, Dim > &  r) const
inline

Concatenates a translation and a rotation

◆ operator*() [4/6]

template<int Mode, int Options>
Transform<Scalar,Dim,Mode> Eigen::Translation::operator* ( const Transform< Scalar, Dim, Mode, Options > &  t) const
inline

Concatenates a translation and a transformation

◆ operator*() [5/6]

Translation Eigen::Translation::operator* ( const Translation other) const
inline

Concatenates two translation

◆ operator*() [6/6]

AffineTransformType Eigen::Translation::operator* ( const UniformScaling< Scalar > &  other) const
inline

Concatenates a translation and a uniform scaling


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