Translation< _Scalar, _Dim > Class Template Reference
[Geometry_Module]

Represents a translation transformation. More...

#include <Translation.h>

List of all members.

Public Types
enum	{ Dim = _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
VectorType	operator* (const VectorType &other) const
TransformType	operator* (const TransformType &t) const
template<typename Derived >
TransformType	operator* (const RotationBase< Derived, Dim > &r) const
TransformType	operator* (const LinearMatrixType &linear) const
TransformType	operator* (const ScalingType &other) const
Translation	operator* (const Translation &other) const
Translation &	operator= (const Translation &other)
template<typename OtherScalarType >
	Translation (const Translation< OtherScalarType, Dim > &other)
	Translation (const VectorType &vector)
	Translation (const Scalar &sx, const Scalar &sy, const Scalar &sz)
	Translation (const Scalar &sx, const Scalar &sy)
	Translation ()
VectorType &	vector ()
const VectorType &	vector () const
Protected Attributes
VectorType	m_coeffs
Friends
TransformType	operator* (const LinearMatrixType &linear, const Translation &t)

---

Detailed Description

template<typename _Scalar, int _Dim>
class Translation< _Scalar, _Dim >

Represents a translation transformation.

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

Definition at line 43 of file Translation.h.

---

Member Typedef Documentation

template<typename _Scalar, int _Dim>

typedef Matrix<Scalar,Dim,Dim> Translation< _Scalar, _Dim >::LinearMatrixType

corresponding linear transformation matrix type

Definition at line 54 of file Translation.h.

template<typename _Scalar, int _Dim>

typedef _Scalar Translation< _Scalar, _Dim >::Scalar

the scalar type of the coefficients

Definition at line 50 of file Translation.h.

template<typename _Scalar, int _Dim>

typedef Scaling<Scalar,Dim> Translation< _Scalar, _Dim >::ScalingType

corresponding scaling transformation type

Definition at line 56 of file Translation.h.

template<typename _Scalar, int _Dim>

typedef Transform<Scalar,Dim> Translation< _Scalar, _Dim >::TransformType

corresponding affine transformation type

Definition at line 58 of file Translation.h.

template<typename _Scalar, int _Dim>

typedef Matrix<Scalar,Dim,1> Translation< _Scalar, _Dim >::VectorType

corresponding vector type

Definition at line 52 of file Translation.h.

---

Member Enumeration Documentation

template<typename _Scalar, int _Dim>

anonymous enum

dimension of the space

Enumerator:

Dim

Definition at line 48 of file Translation.h.

---

Constructor & Destructor Documentation

template<typename _Scalar, int _Dim>

Translation< _Scalar, _Dim >::Translation

(

)

[inline]

Default constructor without initialization.

Definition at line 67 of file Translation.h.

template<typename _Scalar, int _Dim>

Translation< _Scalar, _Dim >::Translation	(	const Scalar &	sx,
		const Scalar &	sy
	)			[inline]

Definition at line 69 of file Translation.h.

template<typename _Scalar, int _Dim>

Translation< _Scalar, _Dim >::Translation	(	const Scalar &	sx,
		const Scalar &	sy,
		const Scalar &	sz
	)			[inline]

Definition at line 76 of file Translation.h.

template<typename _Scalar, int _Dim>

Translation< _Scalar, _Dim >::Translation

(

const VectorType &

vector

)

[inline, explicit]

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

Definition at line 84 of file Translation.h.

template<typename _Scalar, int _Dim>

template<typename OtherScalarType >

Translation< _Scalar, _Dim >::Translation

(

const Translation< OtherScalarType, Dim > &

other

)

[inline, explicit]

Copy constructor with scalar type conversion

Definition at line 143 of file Translation.h.

---

Member Function Documentation

template<typename _Scalar, int _Dim>

template<typename NewScalarType >

ei_cast_return_type<Translation,Translation<NewScalarType,Dim> >::type 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.

Definition at line 138 of file Translation.h.

template<typename _Scalar, int _Dim>

Translation Translation< _Scalar, _Dim >::inverse

(

void

)

const [inline]

Returns:

the inverse translation (opposite)

Definition at line 124 of file Translation.h.

template<typename _Scalar, int _Dim>

bool Translation< _Scalar, _Dim >::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()

Definition at line 150 of file Translation.h.

template<typename _Scalar, int _Dim>

VectorType Translation< _Scalar, _Dim >::operator*

(

const VectorType &

other

)

const [inline]

Applies translation to vector

Definition at line 120 of file Translation.h.

template<typename Scalar , int Dim>

Translation< Scalar, Dim >::TransformType Translation< Scalar, Dim >::operator*

(

const TransformType &

t

)

const [inline]

Concatenates a translation and an affine transformation

Definition at line 191 of file Translation.h.

template<typename _Scalar, int _Dim>

template<typename Derived >

TransformType Translation< _Scalar, _Dim >::operator*

(

const RotationBase< Derived, Dim > &

r

)

const [inline]

Definition at line 100 of file Translation.h.

template<typename Scalar , int Dim>

Translation< Scalar, Dim >::TransformType Translation< Scalar, Dim >::operator*

(

const LinearMatrixType &

linear

)

const [inline]

Concatenates a translation and a linear transformation

Definition at line 178 of file Translation.h.

template<typename Scalar , int Dim>

Translation< Scalar, Dim >::TransformType Translation< Scalar, Dim >::operator*

(

const ScalingType &

other

)

const [inline]

Concatenates a translation and a scaling

Definition at line 166 of file Translation.h.

template<typename _Scalar, int _Dim>

Translation Translation< _Scalar, _Dim >::operator*

(

const Translation< _Scalar, _Dim > &

other

)

const [inline]

Concatenates two translation

Definition at line 90 of file Translation.h.

template<typename _Scalar, int _Dim>

Translation& Translation< _Scalar, _Dim >::operator=

(

const Translation< _Scalar, _Dim > &

other

)

[inline]

Definition at line 126 of file Translation.h.

template<typename _Scalar, int _Dim>

VectorType& Translation< _Scalar, _Dim >::vector

(

)

[inline]

Definition at line 87 of file Translation.h.

template<typename _Scalar, int _Dim>

const VectorType& Translation< _Scalar, _Dim >::vector

(

)

const [inline]

Definition at line 86 of file Translation.h.

---

Friends And Related Function Documentation

template<typename _Scalar, int _Dim>

TransformType operator*	(	const LinearMatrixType &	linear,
		const Translation< _Scalar, _Dim > &	t
	)			[friend]

Concatenates a linear transformation and a translation

Definition at line 105 of file Translation.h.

---

Member Data Documentation

template<typename _Scalar, int _Dim>

VectorType Translation< _Scalar, _Dim >::m_coeffs [protected]

Definition at line 62 of file Translation.h.

---

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

• Translation.h