Eigen  5.0.1-dev+60122df6
 
Loading...
Searching...
No Matches
Public Types | Public Member Functions | List of all members
Eigen::Translation< Scalar_, Dim_ > Class Template Reference
Geometry » Reference » Geometry module

#include <Eigen/src/Geometry/Translation.h>

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
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, const typename NumTraits< Scalar >::Real &prec=NumTraits< Scalar >::dummy_precision()) const
 
template<typename OtherDerived>
AffineTransformType operator* (const EigenBase< OtherDerived > &linear) const
 
template<typename Derived>
std::enable_if_t< Derived::IsVectorAtCompileTime, VectorType > 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)
 
constexpr Scalar & x ()
 Returns the x-translation as a reference.
 
constexpr Scalar x () const
 Returns the x-translation by value.
 
constexpr Scalar & y ()
 Returns the y-translation as a reference.
 
constexpr Scalar y () const
 Returns the y-translation by value.
 
constexpr Scalar & z ()
 Returns the z-translation as a reference.
 
constexpr Scalar z () const
 Returns the z-translation by value.
 

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::Translation< Scalar_, Dim_ >::Translation ( )
inline

Default constructor without initialization.

◆ Translation() [2/3]

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

◆ Translation() [3/3]

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

◆ cast()

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.

◆ 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_>
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>
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>
std::enable_if_t< Derived::IsVectorAtCompileTime, VectorType > 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>
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>
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_>
Translation Eigen::Translation< Scalar_, Dim_ >::operator* ( const Translation< Scalar_, Dim_ > & other) const
inline

Concatenates two translation

◆ operator*() [6/6]

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

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