Eigen::RotationBase Class Reference

---

Detailed Description

Common base class for compact rotation representations.

Parameters:

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

Inheritance diagram for Eigen::RotationBase:

List of all members.

Public Types
enum	{ Dim = _Dim }
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
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)

---

Member Typedef Documentation

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

corresponding linear transformation matrix type

Definition at line 51 of file Geometry.

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

the scalar type of the coefficients

Reimplemented in Eigen::AngleAxis, Eigen::Rotation2D, and Eigen::QuaternionBase.

Definition at line 48 of file Geometry.

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

Definition at line 52 of file Geometry.

---

Member Enumeration Documentation

anonymous enum

Enumerator:

Dim

Definition at line 46 of file Geometry.

---

Member Function Documentation

template<typename OtherVectorType >

VectorType Eigen::RotationBase::_transformVector

(

const OtherVectorType &

v

)

const [inline]

Definition at line 107 of file Geometry.

const Derived& Eigen::RotationBase::derived

(

)

const [inline]

Definition at line 55 of file Geometry.

Derived& Eigen::RotationBase::derived

(

)

[inline]

Definition at line 56 of file Geometry.

Derived Eigen::RotationBase::inverse

(

)

const [inline]

Returns:

the inverse rotation

Reimplemented in Eigen::QuaternionBase, Eigen::AngleAxis, and Eigen::Rotation2D.

Definition at line 67 of file Geometry.

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 64 of file Geometry.

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 70 of file Geometry.

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 74 of file Geometry.

template<typename OtherDerived >

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 85 of file Geometry.

template<int Mode, int Options>

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 103 of file Geometry.

RotationMatrixType Eigen::RotationBase::toRotationMatrix

(

)

const [inline]

Returns:

an equivalent rotation matrix

Reimplemented in Eigen::QuaternionBase, Eigen::AngleAxis, and Eigen::Rotation2D.

Definition at line 59 of file Geometry.

---

Friends And Related Function Documentation

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

Definition at line 90 of file Geometry.

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 94 of file Geometry.