.. oe:namespace:: OEShape

.. meta::
   :keywords: OEColorFunc, ShapeFunc


.. _OEShape_OEColorFunc:

.. oe:class:: OEColorFunc

   .. oe:api::


      class OEColorFunc : public OEOverlapFuncBase

   The :ref:`OEColorFunc <OEShape_OEColorFunc>` is an abstract base class. This class defines
   an interface for color overlap calculation between a reference object and a fit molecule. 
   The :ref:`OEColorFunc <OEShape_OEColorFunc>` is a specialization of The :ref:`OEOverlapFuncBase <OEShape_OEOverlapFuncBase>`
   for color only overlap.

   .. _figure_OEColorFunc_Hierarchy:

   .. figure:: ../images/OEColorFunc.*
      :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:`OEColorFunc <OEShape_OEColorFunc>` class defines the following public methods:
    * :oe:meth:`GetColorOptions<OEShape::OEColorFunc::GetColorOptions>`

   The following classes derive from this class:
    * :ref:`OEAnalyticColorFunc <OEShape_OEAnalyticColorFunc>`
    * :ref:`OEExactColorFunc <OEShape_OEExactColorFunc>`
    * :ref:`OEGridColorFunc <OEShape_OEGridColorFunc>`

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

      .. oe:api::

         OEColorFunc & operator=(const OEColorFunc & argFunc)

      Assignment operator.


   .. oe:method:: GetColorOptions

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

         .. oe:api::

            const OEColorOptions& GetColorOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetColorOptions() -> OEColorOptions

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