.. oe:namespace:: OEShape

.. meta::
   :keywords: OEGridColorFunc, GridColorFunc


.. _OEShape_OEGridColorFunc:

.. oe:class:: OEGridColorFunc

   .. oe:api::


      class OEGridColorFunc : public OEShapeFunc

   The :ref:`OEGridColorFunc <OEShape_OEGridColorFunc>` class defines color overlap between a reference
   object and a fit molecule, using the *Grid* method.

   .. _figure_OEGridColorFunc_Hierarchy:

   .. figure:: ../images/OEGridColorFunc.*
      :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 following methods are publicly inherited from :ref:`OEColorFunc <OEShape_OEColorFunc>`:
    * :oe:meth:`GetColorOptions<OEShape::OEColorFunc::GetColorOptions>`

   The :ref:`OEGridColorFunc <OEShape_OEGridColorFunc>` class defines the following public methods:
    * :oe:meth:`GetGridOptions<OEShape::OEGridColorFunc::GetGridOptions>`

   .. oe:method:: Constructors

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

         .. oe:api::

            OEGridColorFunc(const OEColorOptions& argOptions = OEColorOptions())
            OEGridColorFunc(const OEShapeGridOptions&)
            OEGridColorFunc(const OEColorOptions& argColor,
                            const OEShapeGridOptions& argGrid)
            OEGridColorFunc(const OEGridColorFunc&)

      .. oe:language:: python

         .. oe:api:: python

            OEGridColorFunc(argOptions: OEColorOptions = OEColorOptions()) -> OEGridColorFunc
            OEGridColorFunc(argOptions: OEShapeGridOptions) -> OEGridColorFunc
            OEGridColorFunc(argColor: OEColorOptions,
                            argGrid: OEShapeGridOptions) -> OEGridColorFunc
            OEGridColorFunc(argFunc: OEGridColorFunc) -> OEGridColorFunc

      Default and copy constructors.

      Constructs an :ref:`OEGridColorFunc <OEShape_OEGridColorFunc>` instance using the specified set of parameters.

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

      .. oe:api::

         OEGridColorFunc &operator=(const OEGridColorFunc &)

      The assignment operator.

      Assignment operator.


   .. oe:method:: GetGridOptions

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

         .. oe:api::

            const OEShapeGridOptions& GetGridOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetGridOptions() -> OEShapeGridOptions

      Returns a reference to the :ref:`OEShapeGridOptions <OEShape_OEShapeGridOptions>`
      instance as currently set for this :ref:`OEGridColorFunc <OEShape_OEGridColorFunc>`.
