Main MRPT website > C++ reference
MRPT logo
Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | Friends
Eigen::Translation Class Reference

Detailed Description

Represents a translation transformation

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

List of all members.

Public Types

enum  { Dim = _Dim }
 dimension of the space More...
typedef _Scalar Scalar
 the scalar type of the coefficients
typedef Matrix< Scalar, Dim, 1 > VectorType
 corresponding vector type
typedef Matrix< Scalar, Dim, Dim > LinearMatrixType
 corresponding linear transformation matrix type
typedef Transform< Scalar, Dim,
Affine > 
AffineTransformType
 corresponding affine transformation type

Public Member Functions

 Translation ()
 Default constructor without initialization.
 Translation (const Scalar &sx, const Scalar &sy)
 Translation (const Scalar &sx, const Scalar &sy, const Scalar &sz)
 Translation (const VectorType &vector)
 Constructs and initialize the translation transformation from a vector of translation coefficients.
Scalar x () const
 Retruns the x-translation by value.
Scalar y () const
 Retruns the y-translation by value.
Scalar z () const
 Retruns the z-translation by value.
Scalarx ()
 Retruns the x-translation as a reference.
Scalary ()
 Retruns the y-translation as a reference.
Scalarz ()
 Retruns the z-translation as a reference.
const VectorTypevector () const
VectorTypevector ()
const VectorTypetranslation () const
VectorTypetranslation ()
Translation operator* (const Translation &other) const
 Concatenates two translation.
AffineTransformType operator* (const UniformScaling< Scalar > &other) const
 Concatenates a translation and a uniform scaling.
template<typename OtherDerived >
AffineTransformType operator* (const EigenBase< OtherDerived > &linear) const
 Concatenates a translation and a linear transformation.
template<typename Derived >
AffineTransformType operator* (const RotationBase< Derived, Dim > &r) const
 Concatenates a translation and a rotation.
template<int Mode, int Options>
Transform< Scalar, Dim, Mode > operator* (const Transform< Scalar, Dim, Mode, Options > &t) const
 Concatenates a translation and a transformation.
VectorType operator* (const VectorType &other) const
 Applies translation to vector.
Translation inverse () const
Translationoperator= (const Translation &other)
template<typename NewScalarType >
internal::cast_return_type
< Translation, Translation
< NewScalarType, Dim > >::type 
cast () const
template<typename OtherScalarType >
 Translation (const Translation< OtherScalarType, Dim > &other)
 Copy constructor with scalar type conversion.
bool isApprox (const Translation &other, 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 >
AffineTransformType operator* (const EigenBase< OtherDerived > &linear, const Translation &t)

Member Typedef Documentation

corresponding affine transformation type

Definition at line 57 of file Geometry.

corresponding linear transformation matrix type

Definition at line 55 of file Geometry.

typedef _Scalar Eigen::Translation::Scalar

the scalar type of the coefficients

Definition at line 51 of file Geometry.

corresponding vector type

Definition at line 53 of file Geometry.


Member Enumeration Documentation

anonymous enum

dimension of the space

Enumerator:
Dim 

Definition at line 49 of file Geometry.


Constructor & Destructor Documentation

Eigen::Translation::Translation ( ) [inline]

Default constructor without initialization.

Definition at line 66 of file Geometry.

Eigen::Translation::Translation ( const Scalar sx,
const Scalar sy 
) [inline]

Definition at line 68 of file Geometry.

Eigen::Translation::Translation ( const Scalar sx,
const Scalar sy,
const Scalar sz 
) [inline]

Definition at line 75 of file Geometry.

Eigen::Translation::Translation ( const VectorType vector) [inline, explicit]

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

Definition at line 83 of file Geometry.

template<typename OtherScalarType >
Eigen::Translation::Translation ( const Translation< OtherScalarType, Dim > &  other) [inline, explicit]

Copy constructor with scalar type conversion.

Definition at line 170 of file Geometry.


Member Function Documentation

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.

Definition at line 165 of file Geometry.

static const Translation Eigen::Translation::Identity ( ) [inline, static]

Definition at line 157 of file Geometry.

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

Definition at line 149 of file Geometry.

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

Definition at line 177 of file Geometry.

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

Concatenates two translation.

Definition at line 106 of file Geometry.

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

Concatenates a translation and a uniform scaling.

Definition at line 192 of file Geometry.

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

Concatenates a translation and a linear transformation.

Definition at line 205 of file Geometry.

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

Concatenates a translation and a rotation.

Definition at line 118 of file Geometry.

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.

Definition at line 137 of file Geometry.

VectorType Eigen::Translation::operator* ( const VectorType other) const [inline]

Applies translation to vector.

Definition at line 145 of file Geometry.

Translation& Eigen::Translation::operator= ( const Translation other) [inline]

Definition at line 151 of file Geometry.

const VectorType& Eigen::Translation::translation ( ) const [inline]

Definition at line 102 of file Geometry.

VectorType& Eigen::Translation::translation ( ) [inline]

Definition at line 103 of file Geometry.

const VectorType& Eigen::Translation::vector ( ) const [inline]

Definition at line 99 of file Geometry.

VectorType& Eigen::Translation::vector ( ) [inline]

Definition at line 100 of file Geometry.

Scalar Eigen::Translation::x ( ) const [inline]

Retruns the x-translation by value.

Definition at line 86 of file Geometry.

Scalar& Eigen::Translation::x ( ) [inline]

Retruns the x-translation as a reference.

Definition at line 93 of file Geometry.

Scalar Eigen::Translation::y ( ) const [inline]

Retruns the y-translation by value.

Definition at line 88 of file Geometry.

Scalar& Eigen::Translation::y ( ) [inline]

Retruns the y-translation as a reference.

Definition at line 95 of file Geometry.

Scalar Eigen::Translation::z ( ) const [inline]

Retruns the z-translation by value.

Definition at line 90 of file Geometry.

Scalar& Eigen::Translation::z ( ) [inline]

Retruns the z-translation as a reference.

Definition at line 97 of file Geometry.


Friends And Related Function Documentation

template<typename OtherDerived >
AffineTransformType operator* ( const EigenBase< OtherDerived > &  linear,
const Translation t 
) [friend]
Returns:
the concatenation of a linear transformation l with the translation t

Definition at line 124 of file Geometry.


Member Data Documentation

Definition at line 61 of file Geometry.




Page generated by Doxygen 1.7.5 for MRPT 0.9.5 SVN: at Thu Oct 13 21:25:36 UTC 2011