.. include:: ../../toolkit-substitutions

.. oe:namespace:: OEGrapheme

.. oe:class:: OEHighlightMonomerDisplayOptions

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEHighlightMonomerDisplayOptions : public OEDepict::OE2DMolDisplayOptions

   The :oe:cls:`OEGrapheme::OEHighlightMonomerDisplayOptions` class
   is used to customize molecule depiction when using  :oe:cls:`OEGrapheme::OEHighlightMonomers` function.


   .. figure:: ../images/HighlightMonomers.*
      :width: 450pt
      :align:  center

      **Example of using OEHighlightMonomers function**


   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::

            OEHighlightMonomerDisplayOptions()

      .. oe:language:: python

         .. oe:api:: python

            OEHighlightMonomerDisplayOptions() -> OEHighlightMonomerDisplayOptions

      Default constructor.

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

         .. oe:api::

            OEHighlightMonomerDisplayOptions(double width, double height,
                                             double scale)

      .. oe:language:: python

         .. oe:api:: python

            OEHighlightMonomerDisplayOptions(width: float, height: float,
                                             scale: float) -> OEHighlightMonomerDisplayOptions

      Constructor that sets the image dimensions and scale.

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

         .. oe:api::

            OEHighlightMonomerDisplayOptions(const OEHighlightMonomerDisplayOptions& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEHighlightMonomerDisplayOptions(rhs: OEHighlightMonomerDisplayOptions) -> OEHighlightMonomerDisplayOptions

      Copy constructor.

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

      .. oe:api::

         OEHighlightMonomerDisplayOptions &operator=(const OEHighlightMonomerDisplayOptions &rhs)

      Assignment operator.

   .. oe:method:: GetMonomerHighlightColorFunctor

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

         .. oe:api::

            const OEMonomerColorBase& GetMonomerHighlightColorFunctor() const

      .. oe:language:: python

         .. oe:api:: python

            GetMonomerHighlightColorFunctor() -> OEMonomerColorBase

      Returns the functor that is used to determine the color used
      to highlight the monomers. 
      By default, the :oe:cls:`OEGrapheme::OEMonomerColorDefault` functor is used.

   .. oe:method:: GetMonomerLabelColorFunctor

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

         .. oe:api::

            const OEMonomerColorBase& GetMonomerLabelColorFunctor() const

      .. oe:language:: python

         .. oe:api:: python

            GetMonomerLabelColorFunctor() -> OEMonomerColorBase

      Returns the functor that is used to determine the color of the font
      use to draw the monomer code.

      By default, the :oe:cls:`OEGrapheme::OEMonomerColorMonochrome` functor is used
      to set all monomer code fonts to black.

   .. oe:method:: SetMonomerHighlightColorFunctor

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

         .. oe:api::

            void SetMonomerHighlightColorFunctor(const OEMonomerColorBase& func)

      .. oe:language:: python

         .. oe:api:: python

            SetMonomerHighlightColorFunctor(func: OEMonomerColorBase) -> None

      Sets the functor that is used to determine the color used
      to highlight the monomers.

   .. oe:method:: SetMonomerLabelColorFunctor

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

         .. oe:api::

            void SetMonomerLabelColorFunctor(const OEMonomerColorBase& func)

      .. oe:language:: python

         .. oe:api:: python

            SetMonomerLabelColorFunctor(func: OEMonomerColorBase) -> None

      Sets the functor that is used to determine the color of the font
      used to draw the monomer code.

   .. oe:method:: GetHighlightUnspecifiedStereo

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

         .. oe:api::

            bool GetHighlightUnspecifiedStereo() const

      .. oe:language:: python

         .. oe:api:: python

            GetHighlightUnspecifiedStereo() -> bool

      Returns whether monomers with unspecified stereo are highlighted.

   .. oe:method:: SetHighlightUnspecifiedStereo

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

         .. oe:api::

            void SetHighlightUnspecifiedStereo(bool highlight)

      .. oe:language:: python

         .. oe:api:: python

            SetHighlightUnspecifiedStereo(highlight: bool) -> None

      Sets whether monomers with unspecified stereo are highlighted.

