Eigen::RotationBase< Derived, _Dim > Class Template Reference

Common base class for compact rotation representations. More...

#include <RotationBase.h>

Public Types
enum	{ Dim = _Dim }
enum	{ Dim = _Dim }
typedef ei_traits< Derived >::Scalar	Scalar
	the scalar type of the coefficients
typedef Matrix< Scalar, Dim, Dim >	RotationMatrixType
	corresponding linear transformation matrix type
typedef internal::traits< Derived >::Scalar	Scalar
	the scalar type of the coefficients
typedef Matrix< Scalar, Dim, Dim >	RotationMatrixType
	corresponding linear transformation matrix type
typedef Matrix< Scalar, Dim, 1 >	VectorType

Public Member Functions
const Derived &	derived () const
Derived &	derived ()
RotationMatrixType	toRotationMatrix () const
Derived	inverse () const
Transform< Scalar, Dim >	operator* (const Translation< Scalar, Dim > &t) const
RotationMatrixType	operator* (const Scaling< Scalar, Dim > &s) const
Transform< Scalar, Dim >	operator* (const Transform< Scalar, Dim > &t) const
const Derived &	derived () const
Derived &	derived ()
RotationMatrixType	toRotationMatrix () const
RotationMatrixType	matrix () const
Derived	inverse () const
Transform< Scalar, Dim, Isometry >	operator* (const Translation< Scalar, Dim > &t) const
RotationMatrixType	operator* (const UniformScaling< Scalar > &s) const
template<typename OtherDerived >
EIGEN_STRONG_INLINE internal::rotation_base_generic_product_selector< Derived, OtherDerived, OtherDerived::IsVectorAtCompileTime >::ReturnType	operator* (const EigenBase< OtherDerived > &e) const
template<int Mode, int Options>
Transform< Scalar, Dim, Mode >	operator* (const Transform< Scalar, Dim, Mode, Options > &t) const
template<typename OtherVectorType >
VectorType	_transformVector (const OtherVectorType &v) const

Friends
template<typename OtherDerived >
RotationMatrixType	operator* (const EigenBase< OtherDerived > &l, const Derived &r)
Transform< Scalar, Dim, Affine >	operator* (const DiagonalMatrix< Scalar, Dim > &l, const Derived &r)

Detailed Description

template<typename Derived, int _Dim>
class Eigen::RotationBase< Derived, _Dim >

Common base class for compact rotation representations.

Parameters

Derived	is the derived type, i.e., a rotation type
_Dim	the dimension of the space

Member Function Documentation

inverse() [1/2]

template<typename Derived, int _Dim>

Derived Eigen::RotationBase< Derived, _Dim >::inverse ( void  ) const

inline

Returns

the inverse rotation

inverse() [2/2]

template<typename Derived, int _Dim>

Derived Eigen::RotationBase< Derived, _Dim >::inverse ( void  ) const

inline

Returns

the inverse rotation

matrix()

template<typename Derived, int _Dim>

RotationMatrixType Eigen::RotationBase< Derived, _Dim >::matrix ( ) const

inline

Returns

an equivalent rotation matrix This function is added to be conform with the Transform class' naming scheme.

operator*() [1/7]

template<typename Derived, int _Dim>

Transform<Scalar,Dim> Eigen::RotationBase< Derived, _Dim >::operator* ( const Translation< Scalar, Dim > &  t ) const

inline

Returns

the concatenation of the rotation *this with a translation t

operator*() [2/7]

template<typename Derived, int _Dim>

RotationMatrixType Eigen::RotationBase< Derived, _Dim >::operator* ( const Scaling< Scalar, Dim > &  s ) const

inline

Returns

the concatenation of the rotation *this with a scaling s

operator*() [3/7]

template<typename Derived, int _Dim>

Transform<Scalar,Dim> Eigen::RotationBase< Derived, _Dim >::operator* ( const Transform< Scalar, Dim > &  t ) const

inline

Returns

the concatenation of the rotation *this with an affine transformation t

operator*() [4/7]

template<typename Derived, int _Dim>

Transform<Scalar,Dim,Isometry> Eigen::RotationBase< Derived, _Dim >::operator* ( const Translation< Scalar, Dim > &  t ) const

inline

Returns

the concatenation of the rotation *this with a translation t

operator*() [5/7]

template<typename Derived, int _Dim>

RotationMatrixType Eigen::RotationBase< Derived, _Dim >::operator* ( const UniformScaling< Scalar > &  s ) const

inline

Returns

the concatenation of the rotation *this with a uniform scaling s

operator*() [6/7]

template<typename Derived, int _Dim>

template<typename OtherDerived >

EIGEN_STRONG_INLINE internal::rotation_base_generic_product_selector<Derived,OtherDerived,OtherDerived::IsVectorAtCompileTime>::ReturnType Eigen::RotationBase< Derived, _Dim >::operator* ( const EigenBase< OtherDerived > &  e ) const

inline

Returns

the concatenation of the rotation *this with a generic expression e e can be:

• a DimxDim linear transformation matrix
• a DimxDim diagonal matrix (axis aligned scaling)
• a vector of size Dim

operator*() [7/7]

template<typename Derived, int _Dim>

template<int Mode, int Options>

Transform<Scalar,Dim,Mode> Eigen::RotationBase< Derived, _Dim >::operator* ( const Transform< Scalar, Dim, Mode, Options > &  t ) const

inline

Returns

the concatenation of the rotation *this with a transformation t

toRotationMatrix() [1/2]

template<typename Derived, int _Dim>

RotationMatrixType Eigen::RotationBase< Derived, _Dim >::toRotationMatrix ( void  ) const

inline

Returns

an equivalent rotation matrix

toRotationMatrix() [2/2]

template<typename Derived, int _Dim>

RotationMatrixType Eigen::RotationBase< Derived, _Dim >::toRotationMatrix ( void  ) const

inline

Returns

an equivalent rotation matrix

Friends And Related Function Documentation

operator* [1/2]

template<typename Derived, int _Dim>

template<typename OtherDerived >

RotationMatrixType operator* ( const EigenBase< OtherDerived > &  l, const Derived &  r  )

friend

Returns

the concatenation of a linear transformation l with the rotation r

operator* [2/2]

template<typename Derived, int _Dim>

Transform<Scalar,Dim,Affine> operator* ( const DiagonalMatrix< Scalar, Dim > &  l, const Derived &  r  )

friend

Returns

the concatenation of a scaling l with the rotation r

---

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

• vendor/eigen/Eigen/src/Core/util/ForwardDeclarations.h
• vendor/eigen/Eigen/src/Eigen2Support/Geometry/RotationBase.h