Eigen::RotationBase Class Reference

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

#include <ForwardDeclarations.h>

Public Types
enum	{ Dim = _Dim }
typedef Matrix< Scalar, Dim, Dim >	RotationMatrixType
typedef internal::traits< Derived >::Scalar	Scalar
typedef Matrix< Scalar, Dim, 1 >	VectorType

Public Member Functions
template<typename OtherVectorType >
EIGEN_DEVICE_FUNC VectorType	_transformVector (const OtherVectorType &v) const
EIGEN_DEVICE_FUNC Derived &	derived ()
const EIGEN_DEVICE_FUNC Derived &	derived () const
EIGEN_DEVICE_FUNC Derived	inverse () const
EIGEN_DEVICE_FUNC RotationMatrixType	matrix () const
template<typename OtherDerived >
EIGEN_DEVICE_FUNC 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>
EIGEN_DEVICE_FUNC Transform< Scalar, Dim, Mode >	operator* (const Transform< Scalar, Dim, Mode, Options > &t) const
EIGEN_DEVICE_FUNC Transform< Scalar, Dim, Isometry >	operator* (const Translation< Scalar, Dim > &t) const
EIGEN_DEVICE_FUNC RotationMatrixType	operator* (const UniformScaling< Scalar > &s) const
EIGEN_DEVICE_FUNC RotationMatrixType	toRotationMatrix () const

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

Detailed Description

Common base class for compact rotation representations.

Template Parameters

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

Definition at line 286 of file ForwardDeclarations.h.

Member Typedef Documentation

RotationMatrixType

typedef Matrix<Scalar,Dim,Dim> Eigen::RotationBase::RotationMatrixType

corresponding linear transformation matrix type

Definition at line 37 of file RotationBase.h.

Scalar

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

the scalar type of the coefficients

Definition at line 34 of file RotationBase.h.

VectorType

typedef Matrix<Scalar,Dim,1> Eigen::RotationBase::VectorType

Definition at line 38 of file RotationBase.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
Dim

Definition at line 32 of file RotationBase.h.

Member Function Documentation

_transformVector()

template<typename OtherVectorType >

EIGEN_DEVICE_FUNC VectorType Eigen::RotationBase::_transformVector ( const OtherVectorType &  v ) const

inline

Definition at line 93 of file RotationBase.h.

derived() [1/2]

EIGEN_DEVICE_FUNC Derived& Eigen::RotationBase::derived ( )

inline

Definition at line 42 of file RotationBase.h.

derived() [2/2]

const EIGEN_DEVICE_FUNC Derived& Eigen::RotationBase::derived ( ) const

inline

Definition at line 41 of file RotationBase.h.

inverse()

EIGEN_DEVICE_FUNC Derived Eigen::RotationBase::inverse ( ) const

inline

Returns

the inverse rotation

Definition at line 53 of file RotationBase.h.

matrix()

EIGEN_DEVICE_FUNC RotationMatrixType Eigen::RotationBase::matrix ( ) const

inline

Returns

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

Definition at line 50 of file RotationBase.h.

operator*() [1/4]

template<typename OtherDerived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE internal::rotation_base_generic_product_selector<Derived,OtherDerived,OtherDerived::IsVectorAtCompileTime>::ReturnType Eigen::RotationBase::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

Definition at line 71 of file RotationBase.h.

operator*() [2/4]

template<int Mode, int Options>

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

inline

Returns

the concatenation of the rotation *this with a transformation t

Definition at line 89 of file RotationBase.h.

operator*() [3/4]

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

inline

Returns

the concatenation of the rotation *this with a translation t

Definition at line 56 of file RotationBase.h.

operator*() [4/4]

EIGEN_DEVICE_FUNC RotationMatrixType Eigen::RotationBase::operator* ( const UniformScaling< Scalar > &  s ) const

inline

Returns

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

Definition at line 60 of file RotationBase.h.

toRotationMatrix()

EIGEN_DEVICE_FUNC RotationMatrixType Eigen::RotationBase::toRotationMatrix ( ) const

inline

Returns

an equivalent rotation matrix

Definition at line 45 of file RotationBase.h.

Friends And Related Function Documentation

operator* [1/2]

EIGEN_DEVICE_FUNC friend 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

Definition at line 80 of file RotationBase.h.

operator* [2/2]

template<typename OtherDerived >

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

friend

Returns

the concatenation of a linear transformation l with the rotation r

Definition at line 76 of file RotationBase.h.

---

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

• ForwardDeclarations.h
• RotationBase.h