Public Types | Public Member Functions
Map< const Quaternion< _Scalar >, _Options > Class Template Reference

Quaternion expression mapping a constant memory buffer. More...

Inherits QuaternionBase< Derived >.

List of all members.

Public Types

typedef _Scalar Scalar
- Public Types inherited from QuaternionBase< Derived >
typedef AngleAxis< Scalar > AngleAxisType
typedef Matrix< Scalar, 3, 3 > Matrix3
typedef Matrix< Scalar, 3, 1 > Vector3

Public Member Functions

 Map (const Scalar *coeffs)
- Public Member Functions inherited from QuaternionBase< Derived >
Vector3 _transformVector (Vector3 v) const
template<class OtherDerived >
Scalar angularDistance (const QuaternionBase< OtherDerived > &other) const
template<typename NewScalarType >
internal::cast_return_type
< Derived, Quaternion
< NewScalarType > >::type 
cast () const
const internal::traits
< Derived >::Coefficients & 
coeffs () const
internal::traits< Derived >
::Coefficients & 
coeffs ()
Quaternion< Scalar > conjugate () const
template<class OtherDerived >
Scalar dot (const QuaternionBase< OtherDerived > &other) const
Quaternion< Scalar > inverse () const
template<class OtherDerived >
bool isApprox (const QuaternionBase< OtherDerived > &other, RealScalar prec=NumTraits< Scalar >::dummy_precision()) const
Scalar norm () const
void normalize ()
Quaternion< Scalar > normalized () const
template<class OtherDerived >
Quaternion< Scalar > operator* (const QuaternionBase< OtherDerived > &q) const
template<class OtherDerived >
Derived & operator*= (const QuaternionBase< OtherDerived > &q)
Derived & operator= (const AngleAxisType &aa)
template<class MatrixDerived >
Derived & operator= (const MatrixBase< MatrixDerived > &xpr)
template<typename Derived1 , typename Derived2 >
Derived & setFromTwoVectors (const MatrixBase< Derived1 > &a, const MatrixBase< Derived2 > &b)
QuaternionBase & setIdentity ()
template<class OtherDerived >
Quaternion< Scalar > slerp (Scalar t, const QuaternionBase< OtherDerived > &other) const
Scalar squaredNorm () const
Matrix3 toRotationMatrix () const
const VectorBlock< const
Coefficients, 3 > 
vec () const
VectorBlock< Coefficients, 3 > vec ()
Scalar w () const
Scalar & w ()
Scalar x () const
Scalar & x ()
Scalar y () const
Scalar & y ()
Scalar z () const
Scalar & z ()

Additional Inherited Members

- Static Public Member Functions inherited from QuaternionBase< Derived >
static Quaternion< Scalar > Identity ()

Detailed Description

template<typename _Scalar, int _Options>
class Eigen::Map< const Quaternion< _Scalar >, _Options >

Quaternion expression mapping a constant memory buffer.

Parameters:
_Scalarthe type of the Quaternion coefficients
_Optionssee class Map

This is a specialization of class Map for Quaternion. This class allows to view a 4 scalar memory buffer as an Eigen's Quaternion object.

See also:
class Map, class Quaternion, class QuaternionBase

Member Typedef Documentation

typedef _Scalar Scalar

the scalar type of the coefficients

Reimplemented from RotationBase< Derived, 3 >.


Constructor & Destructor Documentation

Map ( const Scalar coeffs)
inline

Constructs a Mapped Quaternion object from the pointer coeffs

The pointer coeffs must reference the four coeffecients of Quaternion in the following order:

*coeffs == {x, y, z, w}

If the template parameter _Options is set to Aligned, then the pointer coeffs must be aligned.


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