Please, help us to better know about our user community by answering the following short survey: https://forms.gle/wpyrxWi18ox9Z5ae9
Eigen  3.4.99 (git rev 10c77b0ff44d0b9cb0b252cfa0ccaaa39d3c5da4)
Eigen::Map< Quaternion< _Scalar >, _Options > Class Template Reference

Detailed Description

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

Expression of a quaternion from a memory buffer.

Template 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
+ Inheritance diagram for Eigen::Map< Quaternion< _Scalar >, _Options >:

Public Member Functions

 Map (Scalar *coeffs)
 
- Public Member Functions inherited from Eigen::QuaternionBase< Map< Quaternion< _Scalar >, _Options > >
Vector3 _transformVector (const Vector3 &v) 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< Scalarconjugate () const
 
Scalar dot (const QuaternionBase< OtherDerived > &other) const
 
Quaternion< Scalarinverse () const
 
bool isApprox (const QuaternionBase< OtherDerived > &other, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
 
Scalar norm () const
 
void normalize ()
 
Quaternion< Scalarnormalized () const
 
bool operator!= (const QuaternionBase< OtherDerived > &other) const
 
Quaternion< typename internal::traits< Map< Quaternion< _Scalar >, _Options > >::Scalaroperator* (const QuaternionBase< OtherDerived > &other) 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)
 
bool operator== (const QuaternionBase< OtherDerived > &other) const
 
Map< Quaternion< _Scalar >, _Options > & setFromTwoVectors (const MatrixBase< Derived1 > &a, const MatrixBase< Derived2 > &b)
 
QuaternionBasesetIdentity ()
 
Quaternion< typename internal::traits< Map< Quaternion< _Scalar >, _Options > >::Scalarslerp (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 >
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, Isometryoperator* (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< ScalarAngleAxisType
 
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< ScalarIdentity ()
 

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}
CoeffReturnType z() const
Definition: Quaternion.h:70
CoeffReturnType y() const
Definition: Quaternion.h:68
CoeffReturnType w() const
Definition: Quaternion.h:72
CoeffReturnType x() const
Definition: Quaternion.h:66

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: