.. oe:namespace:: OEChem


.. meta::
   :keywords: OETranslation, Translation


.. _OEChem_OETranslation:

.. oe:class:: OETranslation

   .. oe:api::

      class OETranslation : public OETransBase

   This class represents `OETranslation`.

   The :ref:`OETranslation <OEChem_OETranslation>` class performs Cartesian translation.

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

            OETranslation()
            OETranslation(const float* vec)
            OETranslation(const double* vec)
            OETranslation(float dx, float dy, float dz)
            OETranslation(double dx, double dy, double dz)

      .. oe:language:: python

         .. oe:api:: python

            OETranslation() -> OETranslation
            OETranslation(vec: OEDoubleArray) -> OETranslation
            OETranslation(vec: OEFloatArray) -> OETranslation
            OETranslation(dx: float, dy: float, dz: float) -> OETranslation

      Default and copy constructors.

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

      .. oe:api::

         OETranslation &operator=(const float *vec)
         OETranslation &operator=(const double *vec)

      Assignment operator.


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

      .. oe:api::

         OETranslation &operator+=(const OETranslation &rhs)

   .. 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:`OETranslation <OEChem_OETranslation>`
      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:: GetTranslation

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

         .. oe:api::

            void GetTranslation(float* vec) const
            void GetTranslation(double* vec) const

      .. oe:language:: python

         .. oe:api:: python

            GetTranslation(vec: OEFloatArray) -> None
            GetTranslation(vec: OEDoubleArray) -> None

   .. oe:method: _Extract DO NOT DOCUMENT

      .. oe:api::

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

