.. oe:namespace:: OEChem

.. meta::
   :keywords: OEQuaternion, Quaternion


.. _OEChem_OEQuaternion:

.. oe:class:: OEQuaternion

   .. oe:api::

      class OEQuaternion : public OETransBase

   This class represents `OEQuaternion`.

   The :ref:`OEQuaternion <OEChem_OEQuaternion>` class performs quaternion
   rotation transformation.

   .. This quaternion object does not include a translation, thus the
      vec arrays are assumed to be of length three and the quat arrays of
      length four.


   The following methods are publicly inherited from :ref:`OETransBase <OEChem_OETransBase>`:

   ====================================================== ====================================================== =====================================================
   :oe:meth:`CreateCopy<OEChem::OETransBase::CreateCopy>` :oe:meth:`GetInverse<OEChem::OETransBase::GetInverse>`                                                      
   :oe:meth:`Extract<OEChem::OETransBase::Extract>`       :oe:meth:`Transform<OEChem::OETransBase::Transform>`                                                        
   ====================================================== ====================================================== =====================================================

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEQuaternion()
            OEQuaternion(const float* quat)
            OEQuaternion(const double* quat)
            OEQuaternion(const float* vec, float angle)
            OEQuaternion(const double* vec, double angle)
            OEQuaternion(const double w, const double x, const double y,
                         const double z)
            OEQuaternion(const float w, const float x, const float y,
                         const float z)

      .. oe:language:: python

         .. oe:api:: python

            OEQuaternion() -> OEQuaternion
            OEQuaternion(w: float, x: float, y: float, z: float) -> OEQuaternion
            OEQuaternion(vec: OEDoubleArray, angle: float) -> OEQuaternion
            OEQuaternion(vec: OEFloatArray, angle: float) -> OEQuaternion
            OEQuaternion(quat: OEDoubleArray) -> OEQuaternion
            OEQuaternion(quat: OEFloatArray) -> OEQuaternion

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEQuaternion &operator=(const float *quat)
         OEQuaternion &operator=(const double *quat)

      Assignment operator.


   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OETransBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OETransBase

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEQuaternion <OEChem_OEQuaternion>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++ 

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak. 

   .. oe:method:: Extract

      .. oe:language:: c++ java csharp

         .. oe:api::

            void Extract(float* r, float* t) const
            void Extract(float* r, double* t) const
            void Extract(double* r, float* t) const
            void Extract(double* r, double* t) const

      .. oe:language:: python

         .. oe:api:: python

            Extract(r: OEFloatArray, t: OEFloatArray) -> None
            Extract(r: OEFloatArray, t: OEDoubleArray) -> None
            Extract(r: OEDoubleArray, t: OEFloatArray) -> None
            Extract(r: OEDoubleArray, t: OEDoubleArray) -> None

   .. oe:method:: GetInverse

      .. oe:language:: c++ java csharp

         .. oe:api::

            OETransBase* GetInverse() const

      .. oe:language:: python

         .. oe:api:: python

            GetInverse() -> OETransBase

   .. oe:method:: GetQuaternion

      .. oe:language:: c++ java csharp

         .. oe:api::

            void GetQuaternion(float* quat) const
            void GetQuaternion(double* quat) const

      .. oe:language:: python

         .. oe:api:: python

            GetQuaternion(quat: OEFloatArray) -> None
            GetQuaternion(quat: OEDoubleArray) -> None

   .. oe:method: _Extract NO NOT DOCUMENT

      .. oe:api::

         template<class T, class U>
         void _Extract(T *rmat, U *trans) const
