Please, help us to better know about our user community by answering the following short survey: https://forms.gle/wpyrxWi18ox9Z5ae9
Eigen  3.4.0
 
Loading...
Searching...
No Matches
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)
 
 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< const Quaternion< _Scalar >, _Options > & operator*= (const QuaternionBase< OtherDerived > &q)
 
- Public Member Functions inherited from Eigen::QuaternionBase< Map< const Quaternion< _Scalar >, _Options > >
Vector3 _transformVector (const Vector3 &v) const
 
Vector3 _transformVector (const Vector3 &v) const
 
internal::traits< Map< const Quaternion< _Scalar >, _Options > >::Scalar angularDistance (const QuaternionBase< OtherDerived > &other) const
 
internal::traits< Map< const Quaternion< _Scalar >, _Options > >::Scalar angularDistance (const QuaternionBase< OtherDerived > &other) const
 
internal::cast_return_type< Map< const Quaternion< _Scalar >, _Options >, Quaternion< NewScalarType > >::type cast () const
 
internal::cast_return_type< Map< const Quaternion< _Scalar >, _Options >, Quaternion< NewScalarType > >::type cast () const
 
internal::traits< Map< const Quaternion< _Scalar >, _Options > >::Coefficients & coeffs ()
 
internal::traits< Map< const Quaternion< _Scalar >, _Options > >::Coefficients & coeffs ()
 
const internal::traits< Map< const Quaternion< _Scalar >, _Options > >::Coefficients & coeffs () const
 
const internal::traits< Map< const Quaternion< _Scalar >, _Options > >::Coefficients & coeffs () 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< const Quaternion< _Scalar >, _Options >, OtherDerived, OtherDerived::IsVectorAtCompileTime >::ReturnType operator* (const EigenBase< OtherDerived > &e) const
 
Quaternion< typename internal::traits< Map< const Quaternion< _Scalar >, _Options > >::Scalar > operator* (const QuaternionBase< OtherDerived > &other) const
 
Quaternion< typename internal::traits< Map< const 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, Isometryoperator* (const Translation< Scalar, Dim > &t) const
 
RotationMatrixType operator* (const UniformScaling< Scalar > &s) const
 
Map< const Quaternion< _Scalar >, _Options > & operator*= (const QuaternionBase< OtherDerived > &q)
 
Map< const Quaternion< _Scalar >, _Options > & operator= (const AngleAxisType &aa)
 
Map< const Quaternion< _Scalar >, _Options > & operator= (const MatrixBase< MatrixDerived > &xpr)
 
Map< const Quaternion< _Scalar >, _Options > & operator= (const MatrixBase< MatrixDerived > &xpr)
 
bool operator== (const QuaternionBase< OtherDerived > &other) const
 
bool operator== (const QuaternionBase< OtherDerived > &other) const
 
Map< const Quaternion< _Scalar >, _Options > & setFromTwoVectors (const MatrixBase< Derived1 > &a, const MatrixBase< Derived2 > &b)
 
Map< const Quaternion< _Scalar >, _Options > & setFromTwoVectors (const MatrixBase< Derived1 > &a, const MatrixBase< Derived2 > &b)
 
QuaternionBasesetIdentity ()
 
QuaternionBasesetIdentity ()
 
Quaternion< typename internal::traits< Map< const Quaternion< _Scalar >, _Options > >::Scalar > slerp (const Scalar &t, const QuaternionBase< OtherDerived > &other) const
 
Quaternion< typename internal::traits< Map< const 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
 
NonConstCoeffReturnType w ()
 
NonConstCoeffReturnType w ()
 
CoeffReturnType w () const
 
CoeffReturnType w () const
 
NonConstCoeffReturnType x ()
 
NonConstCoeffReturnType x ()
 
CoeffReturnType x () const
 
CoeffReturnType x () const
 
NonConstCoeffReturnType y ()
 
NonConstCoeffReturnType y ()
 
CoeffReturnType y () const
 
CoeffReturnType y () const
 
NonConstCoeffReturnType z ()
 
NonConstCoeffReturnType z ()
 
CoeffReturnType z () const
 
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< const 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< const Quaternion< _Scalar >, _Options > >
static Quaternion< Scalar > Identity ()
 
static Quaternion< Scalar > Identity ()
 

Constructor & Destructor Documentation

◆ Map() [1/4]

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}
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.

◆ Map() [2/4]

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

Constructor in the fixed-size case.

Parameters
dataPtrpointer to the array to map
strideoptional Stride object, passing the strides.

◆ Map() [3/4]

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

Constructor in the dynamic-size vector case.

Parameters
dataPtrpointer to the array to map
sizethe size of the vector expression
strideoptional Stride object, passing the strides.

◆ Map() [4/4]

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

Constructor in the dynamic-size matrix case.

Parameters
dataPtrpointer to the array to map
rowsthe number of rows of the matrix expression
colsthe number of columns of the matrix expression
strideoptional Stride object, passing the strides.

Member Function Documentation

◆ operator*=()

template<typename _Scalar, int _Options>
Map< const Quaternion< _Scalar >, _Options > & Eigen::QuaternionBase< Map< const Quaternion< _Scalar >, _Options > >::operator*= ( const QuaternionBase< OtherDerived > & q)
inline
See also
operator*(Quaternion)

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