.. oe:namespace:: OEShape

.. meta::
   :keywords: OEColorOptions, ColorOptions


.. _OEShape_OEColorOptions:

.. oe:class:: OEColorOptions

   .. oe:api::

      class OEColorOptions : public OESystem::OEOptions

   This class provides an interface to setup options required for :ref:`OEColorFunc <OEShape_OEColorFunc>`
   calculations.
   
   The :ref:`OEColorOptions <OEShape_OEColorOptions>` class defines the following public methods:
    * :oe:meth:`GetColorForceField<OEShape::OEColorOptions::GetColorForceField>` and
      :oe:meth:`SetColorForceField<OEShape::OEColorOptions::SetColorForceField>`
    * :oe:meth:`GetMultiplier<OEShape::OEColorOptions::GetMultiplier>` and
      :oe:meth:`SetMultiplier<OEShape::OEColorOptions::SetMultiplier>`
    * :oe:meth:`GetScoreType<OEShape::OEColorOptions::GetScoreType>` and
      :oe:meth:`SetScoreType<OEShape::OEColorOptions::SetScoreType>`
   
   
   .. oe:method:: Constructors

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

         .. oe:api::

            OEColorOptions(const bool loadColorFF = true)
            OEColorOptions(const OEColorOptions&)

      .. oe:language:: python

         .. oe:api:: python

            OEColorOptions(loadColorFF: bool = True) -> OEColorOptions
            OEColorOptions(argOpts: OEColorOptions) -> OEColorOptions

      Default and copy constructors.

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

      .. oe:api::

         OEColorOptions &operator=(const OEColorOptions &)

      Assignment operator.


   .. oe:method:: GetColorForceField

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

         .. oe:api::

            const OEColorForceField* GetColorForceField() const

      .. oe:language:: python

         .. oe:api:: python

            GetColorForceField() -> OEColorForceField

      See :oe:meth:`SetColorForceField<OEShape::OEColorOptions::SetColorForceField>` method.

   .. oe:method:: GetMultiplier

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

         .. oe:api::

            double GetMultiplier() const

      .. oe:language:: python

         .. oe:api:: python

            GetMultiplier() -> float

      See :oe:meth:`SetMultiplier<OEShape::OEColorOptions::SetMultiplier>` method.

   .. oe:method:: GetScoreType

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

         .. oe:api::

            unsigned int GetScoreType() const

      .. oe:language:: python

         .. oe:api:: python

            GetScoreType() -> int

      See :oe:meth:`SetScoreType<OEShape::OEColorOptions::SetScoreType>` method.

   .. oe:method:: SetColorForceField

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

         .. oe:api::

            bool SetColorForceField(unsigned int type)
            bool SetColorForceField(OEPlatform::oeistream& is)
            bool SetColorForceField(const std::string& filename)
            bool SetColorForceField(const OEColorForceField& cff)

      .. oe:language:: python

         .. oe:api:: python

            SetColorForceField(value: int) -> bool
            SetColorForceField(value: oeistream) -> bool
            SetColorForceField(value: str) -> bool
            SetColorForceField(value: OEColorForceField) -> bool

      Sets the color force field to be used. By default the ImplicitMillsDean
      color force field is used.

   .. oe:method:: SetMultiplier

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

         .. oe:api::

            bool SetMultiplier(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetMultiplier(value: float) -> bool

      Sets the **multiplier** to the color score. THe multiplier only effects 
      the *color score* and has no effect on the *color tanimoto*.
      **Default: 1.0**

   .. oe:method:: SetScoreType

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

         .. oe:api::

            bool SetScoreType(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetScoreType(value: int) -> bool

      Sets the **score type** to be reported by this function. Possible 
      values are defined in the :oe:constns:`OEShape::OEScoreType` namespace.
      **Default:** :oe:const:`OEShape::OEScoreType::Overlap`

