.. oe:namespace:: OEChem

.. meta::
   :keywords: OERotMatrix, RotMatrix


.. _OEChem_OERotMatrix:

.. oe:class:: OERotMatrix

   .. oe:api::

      class OERotMatrix : public OETransBase

   This class represents `OERotMatrix`.

   The :ref:`OERotMatrix <OEChem_OERotMatrix>` class performs rotation specified
   by a rotation matrix.


   .. The mat array in the constructors is assumed to be of length nine.


   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::

            OERotMatrix()
            OERotMatrix(const float* mat)
            OERotMatrix(const double* mat)
            OERotMatrix(const OERotMatrix& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OERotMatrix() -> OERotMatrix
            OERotMatrix(mat: OEDoubleArray) -> OERotMatrix
            OERotMatrix(mat: OEFloatArray) -> OERotMatrix
            OERotMatrix(rhs: OERotMatrix) -> OERotMatrix

      Default and copy constructors.

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

      .. oe:api::

         OERotMatrix &operator=(const float *mat)
         OERotMatrix &operator=(const double *mat)
         OERotMatrix &operator=(const OERotMatrix& rhs)

      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:`OERotMatrix <OEChem_OERotMatrix>`
      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(double* r, float* t) const
            void Extract(float* r, double* t) const
            void Extract(double* r, double* t) const

      .. oe:language:: python

         .. oe:api:: python

            Extract(r: OEFloatArray, t: OEFloatArray) -> None
            Extract(r: OEDoubleArray, t: OEFloatArray) -> None
            Extract(r: OEFloatArray, t: OEDoubleArray) -> 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:: GetRotMatrix

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

         .. oe:api::

            void GetRotMatrix(float* mat) const
            void GetRotMatrix(double* mat) const

      .. oe:language:: python

         .. oe:api:: python

            GetRotMatrix(mat: OEFloatArray) -> None
            GetRotMatrix(mat: OEDoubleArray) -> None


   .. oe:method: _Extract NO NOT DOCUMENT

      .. oe:api::

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

