.. include:: ../../common/cookbook/cookbook-hyperlinks

.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEShapeOverlapDisplayOptions, ShapeOverlapDisplayOptions


.. _OEGrapheme_OEShapeOverlapDisplayOptions:

.. oe:class:: OEShapeOverlapDisplayOptions

   .. oe:api::

      class OEShapeOverlapDisplayOptions : public OEDepict::OE2DMolDisplayOptions

   This class represents :ref:`OEShapeOverlapDisplayOptions <OEGrapheme_OEShapeOverlapDisplayOptions>`
   that encapsulates properties that determine how the color atom
   overlap between the reference and the fit molecule is depicted by the
   :oe:func:`OEGrapheme::OERenderShapeOverlap` function.

   .. seealso::

      * :ref:`OEShapeOverlapDisplay <OEGrapheme_OEShapeOverlapDisplay>` class
      * :oe:func:`OEGrapheme::OERenderShapeOverlap` function

   .. admonition:: Code Example

      * `Visualizing Shape and Color Overlap`_ **OpenEye Python Cookbook** recipe

   The following methods are publicly inherited from :ref:`OE2DMolDisplayOptions <OEDepict_OE2DMolDisplayOptions>`:

   ====================================================================================================== ====================================================================================================== ======================================================================================================
   :oe:meth:`operator=<OEDepict::OE2DMolDisplayOptions::operator=>`                                       :oe:meth:`GetHydrogenStyle<OEDepict::OE2DMolDisplayOptions::GetHydrogenStyle>`                         :oe:meth:`SetBondLineAtomLabelGapScale<OEDepict::OE2DMolDisplayOptions::SetBondLineAtomLabelGapScale>`
   :oe:meth:`GetAromaticStyle<OEDepict::OE2DMolDisplayOptions::GetAromaticStyle>`                         :oe:meth:`GetMargin<OEDepict::OE2DMolDisplayOptions::GetMargin>`                                       :oe:meth:`SetBondLineGapScale<OEDepict::OE2DMolDisplayOptions::SetBondLineGapScale>`
   :oe:meth:`GetAtomColor<OEDepict::OE2DMolDisplayOptions::GetAtomColor>`                                 :oe:meth:`GetScale<OEDepict::OE2DMolDisplayOptions::GetScale>`                                         :oe:meth:`SetBondPropLabelFont<OEDepict::OE2DMolDisplayOptions::SetBondPropLabelFont>`
   :oe:meth:`GetAtomColorStyle<OEDepict::OE2DMolDisplayOptions::GetAtomColorStyle>`                       :oe:meth:`GetSuperAtomLabelFont<OEDepict::OE2DMolDisplayOptions::GetSuperAtomLabelFont>`               :oe:meth:`SetBondPropLabelFontScale<OEDepict::OE2DMolDisplayOptions::SetBondPropLabelFontScale>`
   :oe:meth:`GetAtomLabelFont<OEDepict::OE2DMolDisplayOptions::GetAtomLabelFont>`                         :oe:meth:`GetSuperAtomStyle<OEDepict::OE2DMolDisplayOptions::GetSuperAtomStyle>`                       :oe:meth:`SetBondPropertyFunctor<OEDepict::OE2DMolDisplayOptions::SetBondPropertyFunctor>`
   :oe:meth:`GetAtomLabelFontScale<OEDepict::OE2DMolDisplayOptions::GetAtomLabelFontScale>`               :oe:meth:`GetTitleFont<OEDepict::OE2DMolDisplayOptions::GetTitleFont>`                                 :oe:meth:`SetBondStereoStyle<OEDepict::OE2DMolDisplayOptions::SetBondStereoStyle>`
   :oe:meth:`GetAtomPropLabelFont<OEDepict::OE2DMolDisplayOptions::GetAtomPropLabelFont>`                 :oe:meth:`GetTitleFontScale<OEDepict::OE2DMolDisplayOptions::GetTitleFontScale>`                       :oe:meth:`SetBondWidthScaling<OEDepict::OE2DMolDisplayOptions::SetBondWidthScaling>`
   :oe:meth:`GetAtomPropLabelFontScale<OEDepict::OE2DMolDisplayOptions::GetAtomPropLabelFontScale>`       :oe:meth:`GetTitleHeight<OEDepict::OE2DMolDisplayOptions::GetTitleHeight>`                             :oe:meth:`SetDefaultBondPen<OEDepict::OE2DMolDisplayOptions::SetDefaultBondPen>`
   :oe:meth:`GetAtomPropertyFunctor<OEDepict::OE2DMolDisplayOptions::GetAtomPropertyFunctor>`             :oe:meth:`GetTitleLocation<OEDepict::OE2DMolDisplayOptions::GetTitleLocation>`                         :oe:meth:`SetDimensions<OEDepict::OE2DMolDisplayOptions::SetDimensions>`
   :oe:meth:`GetAtomStereoStyle<OEDepict::OE2DMolDisplayOptions::GetAtomStereoStyle>`                     :oe:meth:`GetWidth<OEDepict::OE2DMolDisplayOptions::GetWidth>`                                         :oe:meth:`SetHeight<OEDepict::OE2DMolDisplayOptions::SetHeight>`
   :oe:meth:`GetBackgroundColor<OEDepict::OE2DMolDisplayOptions::GetBackgroundColor>`                     :oe:meth:`SetAromaticStyle<OEDepict::OE2DMolDisplayOptions::SetAromaticStyle>`                         :oe:meth:`SetHydrogenStyle<OEDepict::OE2DMolDisplayOptions::SetHydrogenStyle>`
   :oe:meth:`GetBondColorStyle<OEDepict::OE2DMolDisplayOptions::GetBondColorStyle>`                       :oe:meth:`SetAtomColor<OEDepict::OE2DMolDisplayOptions::SetAtomColor>`                                 :oe:meth:`SetMargin<OEDepict::OE2DMolDisplayOptions::SetMargin>`
   :oe:meth:`GetBondLineAtomLabelGapScale<OEDepict::OE2DMolDisplayOptions::GetBondLineAtomLabelGapScale>` :oe:meth:`SetAtomColorStyle<OEDepict::OE2DMolDisplayOptions::SetAtomColorStyle>`                       :oe:meth:`SetMargins<OEDepict::OE2DMolDisplayOptions::SetMargins>`
   :oe:meth:`GetBondLineGapScale<OEDepict::OE2DMolDisplayOptions::GetBondLineGapScale>`                   :oe:meth:`SetAtomLabelFont<OEDepict::OE2DMolDisplayOptions::SetAtomLabelFont>`                         :oe:meth:`SetScale<OEDepict::OE2DMolDisplayOptions::SetScale>`
   :oe:meth:`GetBondPropLabelFont<OEDepict::OE2DMolDisplayOptions::GetBondPropLabelFont>`                 :oe:meth:`SetAtomLabelFontScale<OEDepict::OE2DMolDisplayOptions::SetAtomLabelFontScale>`               :oe:meth:`SetSuperAtomLabelFont<OEDepict::OE2DMolDisplayOptions::SetSuperAtomLabelFont>`
   :oe:meth:`GetBondPropLabelFontScale<OEDepict::OE2DMolDisplayOptions::GetBondPropLabelFontScale>`       :oe:meth:`SetAtomPropLabelFont<OEDepict::OE2DMolDisplayOptions::SetAtomPropLabelFont>`                 :oe:meth:`SetSuperAtomStyle<OEDepict::OE2DMolDisplayOptions::SetSuperAtomStyle>`
   :oe:meth:`GetBondPropertyFunctor<OEDepict::OE2DMolDisplayOptions::GetBondPropertyFunctor>`             :oe:meth:`SetAtomPropLabelFontScale<OEDepict::OE2DMolDisplayOptions::SetAtomPropLabelFontScale>`       :oe:meth:`SetTitleFont<OEDepict::OE2DMolDisplayOptions::SetTitleFont>`
   :oe:meth:`GetBondStereoStyle<OEDepict::OE2DMolDisplayOptions::GetBondStereoStyle>`                     :oe:meth:`SetAtomPropertyFunctor<OEDepict::OE2DMolDisplayOptions::SetAtomPropertyFunctor>`             :oe:meth:`SetTitleFontScale<OEDepict::OE2DMolDisplayOptions::SetTitleFontScale>`
   :oe:meth:`GetBondWidthScaling<OEDepict::OE2DMolDisplayOptions::GetBondWidthScaling>`                   :oe:meth:`SetAtomStereoStyle<OEDepict::OE2DMolDisplayOptions::SetAtomStereoStyle>`                     :oe:meth:`SetTitleHeight<OEDepict::OE2DMolDisplayOptions::SetTitleHeight>`
   :oe:meth:`GetDefaultBondPen<OEDepict::OE2DMolDisplayOptions::GetDefaultBondPen>`                       :oe:meth:`SetBackgroundColor<OEDepict::OE2DMolDisplayOptions::SetBackgroundColor>`                     :oe:meth:`SetTitleLocation<OEDepict::OE2DMolDisplayOptions::SetTitleLocation>`
   :oe:meth:`GetHeight<OEDepict::OE2DMolDisplayOptions::GetHeight>`                                       :oe:meth:`SetBondColorStyle<OEDepict::OE2DMolDisplayOptions::SetBondColorStyle>`                       :oe:meth:`SetWidth<OEDepict::OE2DMolDisplayOptions::SetWidth>`
   ====================================================================================================== ====================================================================================================== ======================================================================================================

   .. oe:method:: Constructors

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

         .. oe:api::

            OEShapeOverlapDisplayOptions()

      .. oe:language:: python

         .. oe:api:: python

            OEShapeOverlapDisplayOptions() -> OEShapeOverlapDisplayOptions

      Default constructor.

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

         .. oe:api::

            OEShapeOverlapDisplayOptions(const OEShapeOverlapDisplayOptions& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEShapeOverlapDisplayOptions(rhs: OEShapeOverlapDisplayOptions) -> OEShapeOverlapDisplayOptions

      Copy constructors.


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

      .. oe:api::

         OEShapeOverlapDisplayOptions &operator=(const OEShapeOverlapDisplayOptions &rhs)

      Assignment operator.


   .. oe:method:: ClearQuerySurfaceArcFxn

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

         .. oe:api::

            void ClearQuerySurfaceArcFxn()

      .. oe:language:: python

         .. oe:api:: python

            ClearQuerySurfaceArcFxn() -> None

      Removes the surface drawing functor that is drawn to represent the 2D
      molecule surface of the reference molecule around the fit molecule.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEShapeOverlapDisplayOptions::GetQuerySurfaceArcFxn` method
         * :oe:meth:`OEGrapheme::OEShapeOverlapDisplayOptions::SetQuerySurfaceArcFxn` method


   .. oe:method:: GetClearBackground

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

         .. oe:api::

            bool GetClearBackground() const

      .. oe:language:: python

         .. oe:api:: python

            GetClearBackground() -> bool

      Returns whether or not the image is cleared
      (by calling :oe:meth:`OEDepict::OEImageBase::Clear` method)
      prior to the rendering of the shape overlap.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEShapeOverlapDisplayOptions::SetClearBackground` method


   .. oe:method:: GetOverlapColor

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

         .. oe:api::

            const OESystem::OEColor& GetOverlapColor() const

      .. oe:language:: python

         .. oe:api:: python

            GetOverlapColor() -> OEColor

      Returns the color of the property map that is used to visualize
      shape overlap between the reference and the fit molecule.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEShapeOverlapDisplayOptions::SetOverlapColor` method


   .. oe:method:: GetOverlapDisplayStyle

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

         .. oe:api::

            unsigned int GetOverlapDisplayStyle() const

      .. oe:language:: python

         .. oe:api:: python

            GetOverlapDisplayStyle() -> int

      Returns the style that defines how shape overlay is depicted
      by the :oe:func:`OEGrapheme::OERenderShapeOverlap` function.
      The return value is taken from the
      :oe:constns:`OEGrapheme::OEShapeOverlapDisplayStyle` namespace.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEShapeOverlapDisplayOptions::SetOverlapDisplayStyle` method
         * :oe:constns:`OEGrapheme::OEShapeOverlapDisplayStyle` namespace


   .. oe:method:: GetQuerySurfaceArcFxn

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

         .. oe:api::

            const OESurfaceArcFxnBase* GetQuerySurfaceArcFxn() const

      .. oe:language:: python

         .. oe:api:: python

            GetQuerySurfaceArcFxn() -> OESurfaceArcFxnBase

      Returns the surface drawing functor that is drawn to represent the 2D
      molecule surface of the reference molecule around the fit molecule.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEShapeOverlapDisplayOptions::ClearQuerySurfaceArcFxn` method
         * :oe:meth:`OEGrapheme::OEShapeOverlapDisplayOptions::SetQuerySurfaceArcFxn` method


   .. oe:method:: SetClearBackground

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

         .. oe:api::

            void SetClearBackground(bool clear)

      .. oe:language:: python

         .. oe:api:: python

            SetClearBackground(clear: bool) -> None

      Sets whether or not the image is cleared
      (by calling :oe:meth:`OEDepict::OEImageBase::Clear` method)
      prior to the rendering of the shape overlap.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEShapeOverlapDisplayOptions::GetClearBackground` method


   .. oe:method:: SetOverlapColor

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

         .. oe:api::

            void SetOverlapColor(const OESystem::OEColor& color)

      .. oe:language:: python

         .. oe:api:: python

            SetOverlapColor(color: OEColor) -> None

      Sets the color of the property map that is used to visualize
      shape overlap between the reference and the fit molecule.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEShapeOverlapDisplayOptions::GetOverlapColor` method


   .. oe:method:: SetOverlapDisplayStyle

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

         .. oe:api::

            void SetOverlapDisplayStyle(unsigned int style)

      .. oe:language:: python

         .. oe:api:: python

            SetOverlapDisplayStyle(style: int) -> None

      Sets the style that defines how shape overlay is depicted
      by the :oe:func:`OEGrapheme::OERenderShapeOverlap` function.

      *style*
         This value has to be from the :oe:constns:`OEGrapheme::OEShapeOverlapDisplayStyle`
         namespace.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEShapeOverlapDisplayOptions::GetOverlapDisplayStyle` method
         * :oe:constns:`OEGrapheme::OEShapeOverlapDisplayStyle` namespace


   .. oe:method:: SetQuerySurfaceArcFxn

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

         .. oe:api::

            void SetQuerySurfaceArcFxn(const OESurfaceArcFxnBase& arcfxn)

      .. oe:language:: python

         .. oe:api:: python

            SetQuerySurfaceArcFxn(arcfxn: OESurfaceArcFxnBase) -> None

      Sets the surface drawing functor that is drawn to represent the 2D
      molecule surface of the reference molecule around the fit molecule
      when calling the :oe:func:`OEGrapheme::OERenderShapeOverlap` function
      to depict the shape overlap.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEShapeOverlapDisplayOptions::ClearQuerySurfaceArcFxn` method
         * :oe:meth:`OEGrapheme::OEShapeOverlapDisplayOptions::GetQuerySurfaceArcFxn` method

