ERC CISST - cisst software

---

vctQuaternionRotation3< _elementType > Class Template Reference
[Vectors]

#include <vctQuaternionRotation3.h>

Inheritance diagram for vctQuaternionRotation3< _elementType >:

[legend]Collaboration diagram for vctQuaternionRotation3< _elementType >:

[legend]List of all members.

---

Detailed Description

template<class _elementType>
class vctQuaternionRotation3< _elementType >

Define a rotation quaternion for a space of dimension 3.

This class is templated by the element type. It is derived from vctMatrixRotation2Base and uses a vctFixedSizeMatrix as underlying container. It provides a more humain interface for programmers only interested in templating by _elementType.

Parameters:

_elementType

The type of elements of the quaternion.

See also:

vctQuaternionRotation3Base vctFixedSizeVector

Definition at line 52 of file vctQuaternionRotation3.h.

Public Types

• enum
• enum
• typedef vctFixedSizeVector<
  value_type, SIZE > ContainerType
• typedef vctQuaternionRotation3Base<
  ContainerType > BaseType
• typedef vctQuaternionRotation3<
  value_type > ThisType
• typedef cmnTypeTraits< value_type > TypeTraits

Public Member Functions

• vctQuaternionRotation3 ()
• vctQuaternionRotation3 (const ThisType &quaternionRotation)
• template<class _containerType> vctQuaternionRotation3 (const _containerType &vector4) throw (std::runtime_error)
• vctQuaternionRotation3 (const value_type &x, const value_type &y, const value_type &z, const value_type &r) throw (std::runtime_error)
• template<class __containerType> vctQuaternionRotation3 (const vctMatrixRotation3Base< __containerType > &matrixRotation) throw (std::runtime_error)
• vctQuaternionRotation3 (const vctAxisAngleRotation3< value_type > &axisAngleRotation) throw (std::runtime_error)
• template<class __containerType> vctQuaternionRotation3 (const vctRodriguezRotation3Base< __containerType > &rodriguezRotation) throw (std::runtime_error)
• vctQuaternionRotation3 (const ThisType &quaternionRotation, bool normalizeInput)
• template<class _containerType> vctQuaternionRotation3 (const _containerType &vector4, bool normalizeInput)
• vctQuaternionRotation3 (const value_type &x, const value_type &y, const value_type &z, const value_type &r, bool normalizeInput)
• template<class __containerType> vctQuaternionRotation3 (const vctMatrixRotation3Base< __containerType > &matrixRotation, bool normalizeInput)
• vctQuaternionRotation3 (const vctAxisAngleRotation3< value_type > &axisAngleRotation, bool normalizeInput)
• template<class __containerType> vctQuaternionRotation3 (const vctRodriguezRotation3Base< __containerType > &rodriguezRotation, bool normalizeInput)
• ThisType & operator= (const BaseType &other)

Public Attributes

• _elementType

---

Member Typedef Documentation

template<class _elementType>

typedef vctFixedSizeVector<value_type, SIZE> vctQuaternionRotation3< _elementType >::ContainerType

Type of container. This must be a vector of 4 elements (either fixed size or dynamic). In any case, this class should only be used by the library programmers.

Reimplemented from vctQuaternionRotation3Base< vctFixedSizeVector< _elementType, 4 > >.

Definition at line 59 of file vctQuaternionRotation3.h.

template<class _elementType>

typedef vctQuaternionRotation3Base<ContainerType> vctQuaternionRotation3< _elementType >::BaseType

Type of base class.

Reimplemented from vctQuaternionRotation3Base< vctFixedSizeVector< _elementType, 4 > >.

Definition at line 60 of file vctQuaternionRotation3.h.

template<class _elementType>

typedef vctQuaternionRotation3<value_type> vctQuaternionRotation3< _elementType >::ThisType

Type of the vector itself.

Reimplemented from vctQuaternionRotation3Base< vctFixedSizeVector< _elementType, 4 > >.

Definition at line 61 of file vctQuaternionRotation3.h.

template<class _elementType>

typedef cmnTypeTraits<value_type> vctQuaternionRotation3< _elementType >::TypeTraits

Traits used for all useful types and values related to the element type.

Reimplemented from vctQuaternionRotation3Base< vctFixedSizeVector< _elementType, 4 > >.

Definition at line 63 of file vctQuaternionRotation3.h.

---

Member Function Documentation

template<class _elementType>

ThisType& vctQuaternionRotation3< _elementType >::operator=

(

const BaseType &

other

)

[inline]

The assignment from BaseType has to be redefined for this class (C++ restriction). This operator uses the Assign() method inherited from the ContainerType. This operator (as well as the Assign method) allows to set a rotation quaternion to whatever value without any further validity checking. It is recommended to use it with caution.

Definition at line 155 of file vctQuaternionRotation3.h.

---

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

• vctQuaternionRotation3.h

---