Eigen: Eigen::Map< Quaternion< Scalar_ >, Options

Searching...

No Matches

#include <Eigen/src/Geometry/Quaternion.h>

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

Inheritance diagram for Eigen::Map< Quaternion< Scalar_ >, Options_ >:

Public Member Functions
	Map (PointerArgType dataPtr, const StrideType &stride=StrideType())

	Map (PointerArgType dataPtr, Index rows, Index cols, const StrideType &stride=StrideType())

	Map (PointerArgType dataPtr, Index size, const StrideType &stride=StrideType())

	Map (Scalar *coeffs)

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

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

Vector3	_transformVector (const Vector3 &v) const

internal::traits< Map< Quaternion< Scalar_ >, Options_ > >::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::cast_return_type< Map< Quaternion< Scalar_ >, Options_ >, Quaternion< NewScalarType > >::type	cast () const

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

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

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

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

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

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

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

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

Quaternion< Scalar >	conjugate () const

Quaternion< Scalar >	conjugate () const

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

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

Quaternion< Scalar >	inverse () const

Quaternion< Scalar >	inverse () const

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

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

Scalar	norm () const

Scalar	norm () const

void	normalize ()

void	normalize ()

Quaternion< Scalar >	normalized () const

Quaternion< Scalar >	normalized () const

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

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

internal::rotation_base_generic_product_selector< Map< Quaternion< Scalar_ >, Options_ >, OtherDerived, OtherDerived::IsVectorAtCompileTime >::ReturnType	operator* (const EigenBase< OtherDerived > &e) const

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

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

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

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< MatrixDerived > &xpr)

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

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

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

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

QuaternionBase &	setIdentity ()

QuaternionBase &	setIdentity ()

Quaternion< typename internal::traits< Map< Quaternion< Scalar_ >, Options_ > >::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

Scalar	squaredNorm () const

Matrix3	toRotationMatrix () const

Matrix3	toRotationMatrix () const

VectorBlock< Coefficients, 3 >	vec ()

VectorBlock< Coefficients, 3 >	vec ()

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

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

constexpr NonConstCoeffReturnType	w ()

constexpr NonConstCoeffReturnType	w ()

constexpr CoeffReturnType	w () const

constexpr CoeffReturnType	w () const

constexpr NonConstCoeffReturnType	x ()

constexpr NonConstCoeffReturnType	x ()

constexpr CoeffReturnType	x () const

constexpr CoeffReturnType	x () const

constexpr NonConstCoeffReturnType	y ()

constexpr NonConstCoeffReturnType	y ()

constexpr CoeffReturnType	y () const

constexpr CoeffReturnType	y () const

constexpr NonConstCoeffReturnType	z ()

constexpr NonConstCoeffReturnType	z ()

constexpr CoeffReturnType	z () const

constexpr CoeffReturnType	z () const

Public Member Functions inherited from Eigen::RotationBase< Derived, Dim_ >
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

Additional Inherited Members
Public Types inherited from Eigen::QuaternionBase< Map< Quaternion< Scalar_ >, Options_ > >
typedef AngleAxis< Scalar >	AngleAxisType

typedef Matrix< Scalar, 3, 3 >	Matrix3

typedef Matrix< Scalar, 3, 1 >	Vector3

Public Types inherited from Eigen::RotationBase< Derived, Dim_ >
typedef Matrix< Scalar, Dim, Dim >	RotationMatrixType

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

Static Public Member Functions inherited from Eigen::QuaternionBase< Map< Quaternion< Scalar_ >, Options_ > >
static Quaternion< Scalar >	Identity ()

static Quaternion< Scalar >	Identity ()

Constructor & Destructor Documentation

◆ Map() [1/4]

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::QuaternionBase< Map< Quaternion< Scalar_ >, Options_ > >::z

constexpr CoeffReturnType z() const

Definition Quaternion.h:64

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

constexpr CoeffReturnType x() const

Definition Quaternion.h:60

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

constexpr CoeffReturnType y() const

Definition Quaternion.h:62

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

constexpr CoeffReturnType w() const

Definition Quaternion.h:66

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

◆ Map() [2/4]

Eigen::Map< Quaternion< Scalar_ >, MapOptions, StrideType >::Map	(	PointerArgType	dataPtr,
		const StrideType &	stride = StrideType() )

inlineexplicit

Constructor in the fixed-size case.

Parameters

dataPtr	pointer to the array to map
stride	optional Stride object, passing the strides.

◆ Map() [3/4]

Eigen::Map< Quaternion< Scalar_ >, MapOptions, StrideType >::Map	(	PointerArgType	dataPtr,
		Index	size,
		const StrideType &	stride = StrideType() )

inline

Constructor in the dynamic-size vector case.

Parameters

dataPtr	pointer to the array to map
size	the size of the vector expression
stride	optional Stride object, passing the strides.

◆ Map() [4/4]

Eigen::Map< Quaternion< Scalar_ >, MapOptions, StrideType >::Map	(	PointerArgType	dataPtr,
		Index	rows,
		Index	cols,
		const StrideType &	stride = StrideType() )

inline

Constructor in the dynamic-size matrix case.

Parameters

dataPtr	pointer to the array to map
rows	the number of rows of the matrix expression
cols	the number of columns of the matrix expression
stride	optional Stride object, passing the strides.

Member Function Documentation

◆ operator*=()

template<typename Scalar_, int Options_>

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

inline

See also: operator*(Quaternion)

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

/builds/libeigen/eigen/Eigen/src/Geometry/Quaternion.h

Detailed Description

Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ Map() [1/4]

◆ Map() [2/4]

◆ Map() [3/4]

◆ Map() [4/4]

Member Function Documentation

◆ operator*=()