.. oe:namespace:: OEShape

.. meta::
   :keywords: OEOverlapFunc, ShapeFunc


.. _OEShape_OEOverlapFunc:

.. oe:class:: OEOverlapFunc

   .. oe:api::


      class OEOverlapFunc : public OEOverlapFuncBase

   The :ref:`OEOverlapFunc <OEShape_OEOverlapFunc>` class defines an interface for combined shape and color
   overlap calculation between a reference object and a fit molecule. 
   The :ref:`OEOverlapFunc <OEShape_OEOverlapFunc>` is a specialization of The :ref:`OEOverlapFuncBase <OEShape_OEOverlapFuncBase>`
   for combined shape and color overlap.

   .. _figure_OEOverlapFunc_Hierarchy:

   .. figure:: ../images/OEOverlapFunc.*
      :align:  center

   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`         
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>` 
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`
   
   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`

   The following methods are publicly inherited from :ref:`OEOverlapFuncBase <OEShape_OEOverlapFuncBase>`:
    * :oe:meth:`Overlap<OEShape::OEOverlapFuncBase::Overlap>` 
    * :oe:meth:`SetupFlex<OEShape::OEOverlapFuncBase::SetupFlex>`
    * :oe:meth:`SetupRef<OEShape::OEOverlapFuncBase::SetupRef>`

   The :ref:`OEOverlapFunc <OEShape_OEOverlapFunc>` class defines the following public methods:
    * :oe:meth:`GetColorFunc<OEShape::OEOverlapFunc::GetColorFunc>`
    * :oe:meth:`GetShapeFunc<OEShape::OEOverlapFunc::GetShapeFunc>`

   .. oe:method:: Constructors

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

         .. oe:api::

            OEOverlapFunc(const OEShapeFunc& argShape = OEGridShapeFunc(),
                          const OEColorFunc& argColor = OEExactColorFunc())
            OEOverlapFunc(const OEColorFunc&)
            OEOverlapFunc(const OEOverlapFunc&)

      .. oe:language:: python

         .. oe:api:: python

            OEOverlapFunc(argShape: OEShapeFunc = OEGridShapeFunc(),
                          argColor: OEColorFunc = OEExactColorFunc()) -> OEOverlapFunc
            OEOverlapFunc(argFunc: OEColorFunc) -> OEOverlapFunc
            OEOverlapFunc(argFunc: OEOverlapFunc) -> OEOverlapFunc

      Default and copy constructors.

      Constructs an :ref:`OEOverlapFunc <OEShape_OEOverlapFunc>` instance using the specified set of parameters.

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

      .. oe:api::

         OEOverlapFunc &operator=(const OEOverlapFunc &)

      The assignment operator.

.. _OEShape_OEOverlapFunc_GetColorFunc:

      Assignment operator.



   .. oe:method:: GetColorFunc

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

         .. oe:api::

            const OEColorFunc& GetColorFunc() const

      .. oe:language:: python

         .. oe:api:: python

            GetColorFunc() -> OEColorFunc

      Returns a reference to the :ref:`OEColorFunc <OEShape_OEColorFunc>`
      instance as currently set for this :ref:`OEOverlapFunc <OEShape_OEOverlapFunc>`.

.. _OEShape_OEOverlapFunc_GetColorFunc_GetShapeFunc:


   .. oe:method:: GetShapeFunc

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

         .. oe:api::

            const OEShapeFunc& GetShapeFunc() const

      .. oe:language:: python

         .. oe:api:: python

            GetShapeFunc() -> OEShapeFunc

      Returns a reference to the :ref:`OEShapeFunc <OEShape_OEShapeFunc>`
      instance as currently set for this :ref:`OEOverlapFunc <OEShape_OEOverlapFunc>`.
