RotationBase< Derived, _Dim > Class Template Reference

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

List of all members.

Public Types

typedef Matrix< Scalar, Dim, Dim > RotationMatrixType
typedef internal::traits
< Derived >::Scalar 
Scalar

Public Member Functions

Derived inverse () const
RotationMatrixType matrix () const
template<int Mode, int Options>
Transform< Scalar, Dim, Mode > operator* (const Transform< Scalar, Dim, Mode, Options > &t) const
template<typename OtherDerived >
internal::rotation_base_generic_product_selector
< Derived, OtherDerived,
OtherDerived::IsVectorAtCompileTime >
::ReturnType 
operator* (const EigenBase< OtherDerived > &e) const
RotationMatrixType operator* (const UniformScaling< Scalar > &s) const
Transform< Scalar, Dim, Isometry > operator* (const Translation< Scalar, Dim > &t) const
RotationMatrixType toRotationMatrix () const

Friends

Transform< Scalar, Dim, Affine > operator* (const DiagonalMatrix< Scalar, Dim > &l, const Derived &r)
template<typename OtherDerived >
RotationMatrixType operator* (const EigenBase< OtherDerived > &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 Typedef Documentation

typedef Matrix<Scalar,Dim,Dim> RotationMatrixType

corresponding linear transformation matrix type

typedef internal::traits<Derived>::Scalar Scalar

Member Function Documentation

Derived inverse (  )  const [inline]
Returns:
the inverse rotation

Reimplemented in Rotation2D< _Scalar >, and AngleAxis< _Scalar >.

RotationMatrixType matrix (  )  const [inline]
Returns:
an equivalent rotation matrix This function is added to be conform with the Transform class' naming scheme.
Transform<Scalar,Dim,Mode> operator* ( const Transform< Scalar, Dim, Mode, Options > &  t  )  const [inline]
Returns:
the concatenation of the rotation *this with a transformation t
internal::rotation_base_generic_product_selector<Derived,OtherDerived,OtherDerived::IsVectorAtCompileTime>::ReturnType 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
RotationMatrixType operator* ( const UniformScaling< Scalar > &  s  )  const [inline]
Returns:
the concatenation of the rotation *this with a uniform scaling s
Transform<Scalar,Dim,Isometry> operator* ( const Translation< Scalar, Dim > &  t  )  const [inline]
Returns:
the concatenation of the rotation *this with a translation t
RotationMatrixType toRotationMatrix (  )  const [inline]
Returns:
an equivalent rotation matrix

Reimplemented in Rotation2D< _Scalar >, and AngleAxis< _Scalar >.


Friends And Related Function Documentation

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
RotationMatrixType operator* ( const EigenBase< OtherDerived > &  l,
const Derived &  r 
) [friend]
Returns:
the concatenation of a linear transformation l with the rotation r

The documentation for this class was generated from the following file:
Generated on Sun Jul 3 00:55:35 2011 for Eigen by  doxygen 1.6.3