Expression of a quaternion from a memory buffer. More...
#include <Quaternion.h>
Public Types | |
| typedef internal::traits< Map > ::Coefficients | Coefficients |
| typedef _Scalar | Scalar |
Public Member Functions | |
| Coefficients & | coeffs () |
| const Coefficients & | coeffs () const |
| EIGEN_STRONG_INLINE | Map (Scalar *coeffs) |
Protected Attributes | |
| Coefficients | m_coeffs |
Private Types | |
| typedef QuaternionBase< Map < Quaternion< _Scalar > , _Options > > | Base |
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 375 of file Geometry/Quaternion.h.
Member Typedef Documentation
typedef QuaternionBase<Map<Quaternion<_Scalar>, _Options> > Eigen::Map< Quaternion< _Scalar >, _Options >::Base [private] |
Reimplemented from Eigen::QuaternionBase< Map< Quaternion< _Scalar >, _Options > >.
Definition at line 378 of file Geometry/Quaternion.h.
| typedef internal::traits<Map>::Coefficients Eigen::Map< Quaternion< _Scalar >, _Options >::Coefficients |
Reimplemented from Eigen::QuaternionBase< Map< Quaternion< _Scalar >, _Options > >.
Definition at line 382 of file Geometry/Quaternion.h.
| typedef _Scalar Eigen::Map< Quaternion< _Scalar >, _Options >::Scalar |
the scalar type of the coefficients
Reimplemented from Eigen::QuaternionBase< Map< Quaternion< _Scalar >, _Options > >.
Definition at line 381 of file Geometry/Quaternion.h.
Constructor & Destructor Documentation
| EIGEN_STRONG_INLINE Eigen::Map< Quaternion< _Scalar >, _Options >::Map | ( | Scalar * | coeffs | ) | [inline] |
Constructs a Mapped Quaternion object from the pointer coeffs
The pointer coeffs must reference the four coeffecients of Quaternion in the following order:
If the template parameter _Options is set to Aligned, then the pointer coeffs must be aligned.
Definition at line 392 of file Geometry/Quaternion.h.
Member Function Documentation
| Coefficients& Eigen::Map< Quaternion< _Scalar >, _Options >::coeffs | ( | ) | [inline] |
- Returns:
- a vector expression of the coefficients (x,y,z,w)
Reimplemented from Eigen::QuaternionBase< Map< Quaternion< _Scalar >, _Options > >.
Definition at line 394 of file Geometry/Quaternion.h.
| const Coefficients& Eigen::Map< Quaternion< _Scalar >, _Options >::coeffs | ( | ) | const [inline] |
- Returns:
- a read-only vector expression of the coefficients (x,y,z,w)
Reimplemented from Eigen::QuaternionBase< Map< Quaternion< _Scalar >, _Options > >.
Definition at line 395 of file Geometry/Quaternion.h.
Member Data Documentation
Coefficients Eigen::Map< Quaternion< _Scalar >, _Options >::m_coeffs [protected] |
Definition at line 398 of file Geometry/Quaternion.h.
The documentation for this class was generated from the following file: