Eigen  3.3.4
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Eigen::Map< const Quaternion< _Scalar >, _Options > Class Template Reference

Detailed Description

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

Quaternion expression mapping a constant 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< const Quaternion< _Scalar >, _Options >:

Public Member Functions

 Map (const Scalar *coeffs)
 
- Public Member Functions inherited from Eigen::QuaternionBase< Map< const Quaternion< _Scalar >, _Options > >
Vector3 _transformVector (const Vector3 &v) const
 
internal::cast_return_type
< Map< const Quaternion
< _Scalar >, _Options >
, Quaternion< NewScalarType >
>::type 
cast () const
 
const internal::traits< Map
< const Quaternion< _Scalar >
, _Options > >::Coefficients & 
coeffs () const
 
internal::traits< Map< const
Quaternion< _Scalar >
, _Options > >::Coefficients & 
coeffs ()
 
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
 
Map< const Quaternion< _Scalar >
, _Options > & 
setFromTwoVectors (const MatrixBase< Derived1 > &a, const MatrixBase< Derived2 > &b)
 
QuaternionBasesetIdentity ()
 
Scalar squaredNorm () const
 
Matrix3 toRotationMatrix () const
 
const VectorBlock< const
Coefficients, 3 > 
vec () const
 
VectorBlock< Coefficients, 3 > vec ()
 
CoeffReturnType w () const
 
NonConstCoeffReturnType w ()
 
CoeffReturnType x () const
 
NonConstCoeffReturnType x ()
 
CoeffReturnType y () const
 
NonConstCoeffReturnType y ()
 
CoeffReturnType z () const
 
NonConstCoeffReturnType z ()
 
- Public Member Functions inherited from Eigen::RotationBase< Map< const Quaternion< _Scalar >, _Options >, 3 >
Map< const Quaternion< _Scalar >
, _Options > 
inverse () const
 
RotationMatrixType matrix () const
 
Transform< Scalar, Dim, Isometry > operator* (const Translation< Scalar, Dim > &t) const
 
RotationMatrixType operator* (const UniformScaling< Scalar > &s) const
 
internal::rotation_base_generic_product_selector
< Map< const Quaternion
< _Scalar >, _Options >
, OtherDerived,
OtherDerived::IsVectorAtCompileTime >
::ReturnType 
operator* (const EigenBase< OtherDerived > &e) const
 
Transform< Scalar, Dim, Mode > operator* (const Transform< Scalar, Dim, Mode, Options > &t) const
 
RotationMatrixType toRotationMatrix () const
 

Additional Inherited Members

- Public Types inherited from Eigen::QuaternionBase< Map< const Quaternion< _Scalar >, _Options > >
typedef AngleAxis< ScalarAngleAxisType
 
typedef Matrix< Scalar, 3, 3 > Matrix3
 
typedef Matrix< Scalar, 3, 1 > Vector3
 
- Public Types inherited from Eigen::RotationBase< Map< const Quaternion< _Scalar >, _Options >, 3 >
typedef Matrix< Scalar, Dim, Dim > RotationMatrixType
 
typedef internal::traits< Map
< const Quaternion< _Scalar >
, _Options > >::Scalar 
Scalar
 
- Static Public Member Functions inherited from Eigen::QuaternionBase< Map< const Quaternion< _Scalar >, _Options > >
static Quaternion< ScalarIdentity ()
 

Constructor & Destructor Documentation

template<typename _Scalar , int _Options>
Eigen::Map< const Quaternion< _Scalar >, _Options >::Map ( const 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.


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