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

Detailed Description

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

Common base class for compact rotation representations.

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

Public Types

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

Public Member Functions

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

Member Typedef Documentation

◆ RotationMatrixType

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

corresponding linear transformation matrix type

◆ Scalar

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

the scalar type of the coefficients

Member Function Documentation

◆ inverse()

template<typename Derived, int _Dim>
Derived Eigen::RotationBase< Derived, _Dim >::inverse ( ) 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/4]

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*() [2/4]

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*() [3/4]

template<typename Derived, int _Dim>
template<typename OtherDerived >
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*() [4/4]

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()

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: