Public Types | Public Member Functions | List of all members
RotationBase< Derived, _Dim > Class Template Reference

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

#include <RotationBase.h>

+ Inheritance diagram for RotationBase< Derived, _Dim >:

Public Types

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

Public Member Functions

Derived inverse () const
 
RotationMatrixType matrix () const
 
template<typename OtherDerived>
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
 
Transform< Scalar, Dim, Isometry > operator* (const Translation< Scalar, Dim > &t) const
 
RotationMatrixType operator* (const UniformScaling< Scalar > &s) const
 
RotationMatrixType toRotationMatrix () const
 

Detailed Description

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

Common base class for compact rotation representations.

Parameters
Derivedis the derived type, i.e., a rotation type
_Dimthe dimension of the space

Member Typedef Documentation

◆ RotationMatrixType

template<typename Derived, int _Dim>
typedef Matrix<Scalar,Dim,Dim> RotationMatrixType

corresponding linear transformation matrix type

◆ Scalar

template<typename Derived, int _Dim>
typedef internal::traits<Derived>::Scalar Scalar

the scalar type of the coefficients

Member Function Documentation

◆ inverse()

template<typename Derived, int _Dim>
Derived inverse ( ) const
inline
Returns
the inverse rotation

◆ matrix()

template<typename Derived, int _Dim>
RotationMatrixType matrix ( ) const
inline
Returns
an equivalent rotation matrix This function is added to be conform with the Transform class' naming scheme.

◆ operator*() [1/4]

template<typename Derived, int _Dim>
template<typename OtherDerived>
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

◆ operator*() [2/4]

template<typename Derived, int _Dim>
template<int Mode, int Options>
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

◆ operator*() [3/4]

template<typename Derived, int _Dim>
Transform< Scalar, Dim, Isometry > operator* ( const Translation< Scalar, Dim > & t) const
inline
Returns
the concatenation of the rotation *this with a translation t

◆ operator*() [4/4]

template<typename Derived, int _Dim>
RotationMatrixType operator* ( const UniformScaling< Scalar > & s) const
inline
Returns
the concatenation of the rotation *this with a uniform scaling s

◆ toRotationMatrix()

template<typename Derived, int _Dim>
RotationMatrixType toRotationMatrix ( void ) const
inline
Returns
an equivalent rotation matrix

Referenced by Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >::Matrix(), RotationBase< AngleAxis< _Scalar >, 3 >::operator*(), RotationBase< AngleAxis< _Scalar >, 3 >::operator*(), and Matrix< Scalar, RowsAtCompileTime, 1, Options, MaxRowsAtCompileTime, 1 >::operator=().

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