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

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 Coefficients::CoeffReturnType	CoeffReturnType

typedef Matrix< Scalar, 3, 3 >	Matrix3

typedef std::conditional_t< bool(internal::traits< Map< Quaternion< Scalar_ >, Options_ > >::Flags &LvalueBit), Scalar &, CoeffReturnType >	NonConstCoeffReturnType

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< Derived, Dim_ >
enum	{ Dim }

typedef Matrix< Scalar, Dim, Dim >	RotationMatrixType

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

typedef Matrix< Scalar, Dim, 1 >	VectorType

Public Member Functions
Coefficients &	coeffs ()

const Coefficients &	coeffs () const

	Map (Scalar *coeffs)

Public Member Functions inherited from Eigen::QuaternionBase< Map< Quaternion< Scalar_ >, Options_ > >
Vector3	_transformVector (const Vector3 &v) const

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

internal::traits< Map< Quaternion< Scalar_ >, Options_ > >::Scalar	angularDistance (const QuaternionBase< OtherDerived > &other) const

internal::cast_return_type< Map< Quaternion< Scalar_ >, Options_ >, Quaternion< NewScalarType > >::type	cast () const

internal::traits< Map< Quaternion< Scalar_ >, Options_ > >::Coefficients &	coeffs ()

const internal::traits< Map< Quaternion< Scalar_ >, Options_ > >::Coefficients &	coeffs () const

Quaternion< Scalar >	conjugate () const

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

Quaternion< Scalar >	inverse () const

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

Scalar	norm () const

void	normalize ()

Quaternion< Scalar >	normalized () const

bool	operator!= (const QuaternionBase< OtherDerived > &other) const

Quaternion< typename internal::traits< Map< Quaternion< Scalar_ >, Options_ > >::Scalar >	operator* (const QuaternionBase< OtherDerived > &other) const

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

Map< Quaternion< Scalar_ >, Options_ > &	operator*= (const QuaternionBase< OtherDerived > &q)

Map< Quaternion< Scalar_ >, Options_ > &	operator= (const AngleAxisType &aa)

Map< Quaternion< Scalar_ >, Options_ > &	operator= (const MatrixBase< MatrixDerived > &xpr)

Map< Quaternion< Scalar_ >, Options_ > &	operator= (const MatrixBase< OtherDerived > &m)

QuaternionBase< Map< Quaternion< Scalar_ >, Options_ > > &	operator= (const QuaternionBase< Map< Quaternion< Scalar_ >, Options_ > > &other)

Map< Quaternion< Scalar_ >, Options_ > &	operator= (const QuaternionBase< OtherDerived > &other)

bool	operator== (const QuaternionBase< OtherDerived > &other) const

Map< Quaternion< Scalar_ >, Options_ > &	setFromTwoVectors (const MatrixBase< Derived1 > &a, const MatrixBase< Derived2 > &b)

QuaternionBase &	setIdentity ()

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

Quaternion< typename internal::traits< Map< Quaternion< Scalar_ >, Options_ > >::Scalar >	slerp (const Scalar &t, const QuaternionBase< OtherDerived > &other) const

Scalar	squaredNorm () const

Matrix3	toRotationMatrix () const

VectorBlock< Coefficients, 3 >	vec ()

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

NonConstCoeffReturnType	w ()

CoeffReturnType	w () const

NonConstCoeffReturnType	x ()

CoeffReturnType	x () const

NonConstCoeffReturnType	y ()

CoeffReturnType	y () const

NonConstCoeffReturnType	z ()

CoeffReturnType	z () const

Public Member Functions inherited from Eigen::RotationBase< Derived, Dim_ >
template<typename OtherVectorType >
VectorType	_transformVector (const OtherVectorType &v) const

Derived &	derived ()

const Derived &	derived () const

Derived	inverse () const

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

Transform< Scalar, Dim, Isometry >	operator* (const Translation< Scalar, Dim > &t) const

RotationMatrixType	operator* (const UniformScaling< Scalar > &s) const

RotationMatrixType	toRotationMatrix () const

Protected Attributes
Coefficients	m_coeffs

Additional Inherited Members
Static Public Member Functions inherited from Eigen::QuaternionBase< Map< Quaternion< Scalar_ >, Options_ > >
static 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 447 of file Quaternion.h.

Member Typedef Documentation

◆ Base

template<typename Scalar_ , int Options_>

typedef QuaternionBase<Map<Quaternion<Scalar_>, Options_> > Eigen::Map< Quaternion< Scalar_ >, Options_ >::Base

Definition at line 451 of file Quaternion.h.

◆ Coefficients

template<typename Scalar_ , int Options_>

typedef internal::traits<Map>::Coefficients Eigen::Map< Quaternion< Scalar_ >, Options_ >::Coefficients

Definition at line 454 of file Quaternion.h.

◆ Scalar

template<typename Scalar_ , int Options_>

typedef Scalar_ Eigen::Map< Quaternion< Scalar_ >, Options_ >::Scalar

Definition at line 453 of file Quaternion.h.

Constructor & Destructor Documentation

◆ Map()

template<typename Scalar_ , int Options_>

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}

Eigen::Map< Quaternion< Scalar_ >, Options_ >::coeffs

Coefficients & coeffs()

Definition: Quaternion.h:466

Eigen::QuaternionBase< Map< Quaternion< Scalar_ >, Options_ > >::z

CoeffReturnType z() const

Definition: Quaternion.h:72

Eigen::QuaternionBase< Map< Quaternion< Scalar_ >, Options_ > >::y

CoeffReturnType y() const

Definition: Quaternion.h:70

Eigen::QuaternionBase< Map< Quaternion< Scalar_ >, Options_ > >::w

CoeffReturnType w() const

Definition: Quaternion.h:74

Eigen::QuaternionBase< Map< Quaternion< Scalar_ >, Options_ > >::x

CoeffReturnType x() const

Definition: Quaternion.h:68

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

Definition at line 464 of file Quaternion.h.

464 : m_coeffs(coeffs) {}

Eigen::Map< Quaternion< Scalar_ >, Options_ >::m_coeffs

Coefficients m_coeffs

Definition: Quaternion.h:470

Member Function Documentation

◆ coeffs() [1/2]

template<typename Scalar_ , int Options_>

Coefficients& Eigen::Map< Quaternion< Scalar_ >, Options_ >::coeffs ( )

inline

Definition at line 466 of file Quaternion.h.

466 { return m_coeffs; }

◆ coeffs() [2/2]

template<typename Scalar_ , int Options_>

const Coefficients& Eigen::Map< Quaternion< Scalar_ >, Options_ >::coeffs ( ) const

inline

Definition at line 467 of file Quaternion.h.

467 { return m_coeffs; }

Member Data Documentation

◆ m_coeffs

template<typename Scalar_ , int Options_>

Coefficients Eigen::Map< Quaternion< Scalar_ >, Options_ >::m_coeffs

protected

Definition at line 470 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

◆ Base

◆ Coefficients

◆ Scalar

Constructor & Destructor Documentation

◆ Map()

Member Function Documentation

◆ coeffs() [1/2]

◆ coeffs() [2/2]

Member Data Documentation

◆ m_coeffs

template<typename Scalar_, int Options_>
class Eigen::Map< Quaternion< Scalar_ >, Options_ >