Expression of a quaternion from a memory buffer. More...

#include <Quaternion.h>

Inheritance diagram for Eigen::Map< Quaternion< _Scalar >, _Options >:

Public Types
typedef QuaternionBase< Map< Quaternion< _Scalar >, _Options > >	Base

typedef internal::traits< Map >::Coefficients	Coefficients

typedef _Scalar	Scalar

Public Types inherited from Eigen::QuaternionBase< Map< Quaternion< _Scalar >, _Options > >
enum

typedef AngleAxis< Scalar >	AngleAxisType

typedef RotationBase< Map< Quaternion< _Scalar >, _Options >, 3 >	Base

typedef internal::traits< Map< Quaternion< _Scalar >, _Options > >::Coefficients	Coefficients

typedef Matrix< Scalar, 3, 3 >	Matrix3

typedef NumTraits< Scalar >::Real	RealScalar

typedef internal::traits< Map< Quaternion< _Scalar >, _Options > >::Scalar	Scalar

typedef Matrix< Scalar, 3, 1 >	Vector3

Public Types inherited from Eigen::RotationBase< Map< Quaternion< _Scalar >, _Options >, 3 >
enum

typedef Matrix< Scalar, Dim, Dim >	RotationMatrixType

typedef internal::traits< Map< Quaternion< _Scalar >, _Options > >::Scalar	Scalar

typedef Matrix< Scalar, Dim, 1 >	VectorType

Public Member Functions
EIGEN_DEVICE_FUNC Coefficients &	coeffs ()

EIGEN_DEVICE_FUNC const Coefficients &	coeffs () const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE	Map (Scalar *coeffs)

Public Member Functions inherited from Eigen::QuaternionBase< Map< Quaternion< _Scalar >, _Options > >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Vector3	_transformVector (const Vector3 &v) const

EIGEN_DEVICE_FUNC Scalar	angularDistance (const QuaternionBase< OtherDerived > &other) const

EIGEN_DEVICE_FUNC internal::cast_return_type< Map< Quaternion< _Scalar >, _Options >, Quaternion< NewScalarType > >::type	cast () const

EIGEN_DEVICE_FUNC const internal::traits< Map< Quaternion< _Scalar >, _Options > >::Coefficients &	coeffs () const

EIGEN_DEVICE_FUNC internal::traits< Map< Quaternion< _Scalar >, _Options > >::Coefficients &	coeffs ()

EIGEN_DEVICE_FUNC Quaternion< Scalar >	conjugate () const

EIGEN_DEVICE_FUNC Scalar	dot (const QuaternionBase< OtherDerived > &other) const

EIGEN_DEVICE_FUNC Quaternion< Scalar >	inverse () const

EIGEN_DEVICE_FUNC bool	isApprox (const QuaternionBase< OtherDerived > &other, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const

EIGEN_DEVICE_FUNC Scalar	norm () const

EIGEN_DEVICE_FUNC void	normalize ()

EIGEN_DEVICE_FUNC Quaternion< Scalar >	normalized () const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Quaternion< Scalar >	operator* (const QuaternionBase< OtherDerived > &q) const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Map< Quaternion< _Scalar >, _Options > &	operator*= (const QuaternionBase< OtherDerived > &q)

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE QuaternionBase< Map< Quaternion< _Scalar >, _Options > > &	operator= (const QuaternionBase< Map< Quaternion< _Scalar >, _Options > > &other)

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Map< Quaternion< _Scalar >, _Options > &	operator= (const QuaternionBase< OtherDerived > &other)

EIGEN_DEVICE_FUNC Map< Quaternion< _Scalar >, _Options > &	operator= (const AngleAxisType &aa)

EIGEN_DEVICE_FUNC Map< Quaternion< _Scalar >, _Options > &	operator= (const MatrixBase< OtherDerived > &m)

EIGEN_DEVICE_FUNC Map< Quaternion< _Scalar >, _Options > &	setFromTwoVectors (const MatrixBase< Derived1 > &a, const MatrixBase< Derived2 > &b)

EIGEN_DEVICE_FUNC QuaternionBase &	setIdentity ()

EIGEN_DEVICE_FUNC Quaternion< Scalar >	slerp (const Scalar &t, const QuaternionBase< OtherDerived > &other) const

EIGEN_DEVICE_FUNC Scalar	squaredNorm () const

EIGEN_DEVICE_FUNC Matrix3	toRotationMatrix () const

EIGEN_DEVICE_FUNC const VectorBlock< const Coefficients, 3 >	vec () const

EIGEN_DEVICE_FUNC VectorBlock< Coefficients, 3 >	vec ()

EIGEN_DEVICE_FUNC Scalar	w () const

EIGEN_DEVICE_FUNC Scalar &	w ()

EIGEN_DEVICE_FUNC Scalar	x () const

EIGEN_DEVICE_FUNC Scalar &	x ()

EIGEN_DEVICE_FUNC Scalar	y () const

EIGEN_DEVICE_FUNC Scalar &	y ()

EIGEN_DEVICE_FUNC Scalar	z () const

EIGEN_DEVICE_FUNC Scalar &	z ()

Public Member Functions inherited from Eigen::RotationBase< Map< Quaternion< _Scalar >, _Options >, 3 >
EIGEN_DEVICE_FUNC VectorType	_transformVector (const OtherVectorType &v) const

EIGEN_DEVICE_FUNC const Map< Quaternion< _Scalar >, _Options > &	derived () const

EIGEN_DEVICE_FUNC Map< Quaternion< _Scalar >, _Options > &	derived ()

EIGEN_DEVICE_FUNC Map< Quaternion< _Scalar >, _Options >	inverse () const

EIGEN_DEVICE_FUNC RotationMatrixType	matrix () 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 EIGEN_STRONG_INLINE internal::rotation_base_generic_product_selector< Map< Quaternion< _Scalar >, _Options >, OtherDerived, OtherDerived::IsVectorAtCompileTime >::ReturnType	operator* (const EigenBase< OtherDerived > &e) const

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

EIGEN_DEVICE_FUNC RotationMatrixType	toRotationMatrix () const

Protected Attributes
Coefficients	m_coeffs

Additional Inherited Members
Static Public Member Functions inherited from Eigen::QuaternionBase< Map< Quaternion< _Scalar >, _Options > >
static EIGEN_DEVICE_FUNC Quaternion< Scalar >	Identity ()

Detailed Description

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

Expression of a quaternion from a memory buffer.

Template Parameters

_Scalar	the type of the Quaternion coefficients
_Options	see 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

Definition at line 380 of file Quaternion.h.

Member Typedef Documentation

template<typename _Scalar , int _Options>

typedef QuaternionBase<Map<Quaternion<_Scalar>, _Options> > Eigen::Map< Quaternion< _Scalar >, _Options >::Base

Definition at line 384 of file Quaternion.h.

template<typename _Scalar , int _Options>

typedef internal::traits<Map>::Coefficients Eigen::Map< Quaternion< _Scalar >, _Options >::Coefficients

Definition at line 387 of file Quaternion.h.

template<typename _Scalar , int _Options>

typedef _Scalar Eigen::Map< Quaternion< _Scalar >, _Options >::Scalar

Definition at line 386 of file Quaternion.h.

Constructor & Destructor Documentation

template<typename _Scalar , int _Options>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Eigen::Map< Quaternion< _Scalar >, _Options >::Map ( Scalar * coeffs )

inlineexplicit

Constructs a Mapped Quaternion object from the pointer coeffs

The pointer coeffs must reference the four coefficients 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.

Definition at line 397 of file Quaternion.h.

Member Function Documentation

template<typename _Scalar , int _Options>

EIGEN_DEVICE_FUNC Coefficients& Eigen::Map< Quaternion< _Scalar >, _Options >::coeffs ( )

inline

Definition at line 399 of file Quaternion.h.

template<typename _Scalar , int _Options>

EIGEN_DEVICE_FUNC const Coefficients& Eigen::Map< Quaternion< _Scalar >, _Options >::coeffs ( ) const

inline

Definition at line 400 of file Quaternion.h.

Member Data Documentation

template<typename _Scalar , int _Options>

Coefficients Eigen::Map< Quaternion< _Scalar >, _Options >::m_coeffs

protected

Definition at line 403 of file Quaternion.h.

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

Quaternion.h

Public Types

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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