.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEHighlightOverlayByBallAndStick, HighlightOverlayByBallAndStick


.. _OEDepict_OEHighlightOverlayByBallAndStick:

.. oe:class:: OEHighlightOverlayByBallAndStick

   .. oe:api::

      class  OEHighlightOverlayByBallAndStick : public OEHighlightOverlayBase

   The :ref:`OEHighlightOverlayByBallAndStick <OEDepict_OEHighlightOverlayByBallAndStick>` class allows the
   customization of the **ball and stick** highlighting style that is
   associated with the :oe:const:`OEDepict::OEHighlightOverlayStyle::BallAndStick`
   constant.
   This style enables the highlighting of overlapping patterns.
   See example in :ref:`Figure: Example of overlay highlighting using the
   'ball and stick' style<figure_OEHighlightOverlayStyle_BallAndStick>`.

   .. _figure_OEHighlightOverlayStyle_BallAndStick:

   .. figure:: ../images/OEHighlightOverlayStyle_BallAndStick.*
      :align:  center

      **Example of overlay highlighting using the 'ball and stick' style**

   .. seealso::

      * :oe:func:`OEDepict::OEAddHighlightOverlay` function.
      * :oe:constns:`OEDepict::OEHighlightOverlayStyle` namespace
      * :ref:`section_highlighting_overlap` section

   .. note::

      It is recommended to select colors with high contrast when highlighting overlapped
      patterns with the :ref:`OEHighlightOverlayByBallAndStick <OEDepict_OEHighlightOverlayByBallAndStick>` class.

      .. seealso::

         * :oe:func:`OESystem::OEGetContrastColors` function

   The following methods are publicly inherited from :ref:`OEHighlightOverlayBase <OEDepict_OEHighlightOverlayBase>`:

   ================================================================= =================================================================
   :oe:meth:`GetColors<OEDepict::OEHighlightOverlayBase::GetColors>` :oe:meth:`SetColors<OEDepict::OEHighlightOverlayBase::SetColors>`
   ================================================================= =================================================================

   .. oe:method:: Constructors

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

         .. oe:api::

            OEHighlightOverlayByBallAndStick(OESystem::OEIter<OESystem::OEColor>& colors,
                                             double stickWidthScale = 3.0,
                                             double ballRadiusScale = 3.0,
                                             bool monochrome = true)
            OEHighlightOverlayByBallAndStick(OESystem::OEIterBase<OESystem::OEColor>* colors,
                                             double stickWidthScale = 3.0,
                                             double ballRadiusScale = 3.0,
                                             bool monochrome = true)

      .. oe:language:: python

         .. oe:api:: python

            OEHighlightOverlayByBallAndStick(colors: OEColorIter,
                                             stickWidthScale: float = 3.0,
                                             ballRadiusScale: float = 3.0,
                                             monochrome: bool = True) -> OEHighlightOverlayByBallAndStick

      Creates an :ref:`OEHighlightOverlayByBallAndStick <OEDepict_OEHighlightOverlayByBallAndStick>` object with the
      specified parameters

      *colors*
         The colors used for highlighting.
         See also :oe:meth:`OEDepict::OEHighlightOverlayBase::SetColors` method.

      *stickWidthScale*
         The multiplier that can be used to increase or decrease
         the stick width of the highlighted bond(s).
         See also :oe:meth:`OEDepict::OEHighlightOverlayByBallAndStick::SetStickWidthScale` method.

      *ballRadiusScale*
         The multiplier that can be used to increase or decrease
         the ball radius of the highlighted atoms(s).
         See also :oe:meth:`OEDepict::OEHighlightOverlayByBallAndStick::SetBallRadiusScale` method.

      *monochrome*
         Defines whether or not to change the color of the atom label
         of the highlighted atom(s).
         See also :oe:meth:`OEDepict::OEHighlightOverlayByBallAndStick::SetAtomLabelMonochrome` method.

      .. ################################################################

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

         .. oe:api::

            OEHighlightOverlayByBallAndStick(const OEHighlightOverlayByBallAndStick& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEHighlightOverlayByBallAndStick(rhs: OEHighlightOverlayByBallAndStick) -> OEHighlightOverlayByBallAndStick


      Copy constructor.


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

      .. oe:api::

         OEHighlightOverlayByBallAndStick &operator=(const OEHighlightOverlayByBallAndStick &rhs)

      Assignment operator.


   .. oe:method:: GetAtomLabelMonochrome

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

         .. oe:api::

            bool GetAtomLabelMonochrome() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomLabelMonochrome() -> bool

      Returns whether or not the color of the atom label of the highlighted
      atom(s) is changed.

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightOverlayByBallAndStick::SetAtomLabelMonochrome` method


   .. oe:method:: GetBallRadiusScale

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

         .. oe:api::

            double GetBallRadiusScale() const

      .. oe:language:: python

         .. oe:api:: python

            GetBallRadiusScale() -> float

      Returns the multiplier that can be used to increase or decrease
      the ball radius of the highlighted atoms(s).

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightOverlayByBallAndStick::SetBallRadiusScale` method


   .. oe:method:: GetStickWidthScale

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

         .. oe:api::

            double GetStickWidthScale() const

      .. oe:language:: python

         .. oe:api:: python

            GetStickWidthScale() -> float

      Returns the multiplier that can be used to increase or decrease
      the stick width of the highlighted bond(s).

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightOverlayByBallAndStick::SetStickWidthScale` method


   .. oe:method:: SetAtomLabelMonochrome

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

         .. oe:api::

            void SetAtomLabelMonochrome(bool monochrome)

      .. oe:language:: python

         .. oe:api:: python

            SetAtomLabelMonochrome(monochrome: bool) -> None

      Sets whether or not to change the color of the atom label
      of the highlighted atom(s).

      Example (:ref:`Figure: Example of using the SetAtomLabelMonochrome method<figure_OEHighlightOverlayByBallAndStick_SetAtomLabelMonochrome>`)

      .. oe:source:: HighlightOverlayBallStick.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTOVERLAYBYBALLANDSTICK-SETATOMLABELMONOCHROME

      .. oe:source:: HighlightOverlayBallStick.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTOVERLAYBYBALLANDSTICK-SETATOMLABELMONOCHROME

      .. oe:language:: java

      .. oe:source:: HighlightOverlayBallStick.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTOVERLAYBYBALLANDSTICK-SETATOMLABELMONOCHROME

      .. oe:language:: csharp

      .. oe:source:: HighlightOverlayBallStick.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTOVERLAYBYBALLANDSTICK-SETATOMLABELMONOCHROME

      .. _figure_OEHighlightOverlayByBallAndStick_SetAtomLabelMonochrome:

      .. figure:: ../images/OEHighlightOverlayByBallAndStick_SetAtomLabelMonochrome.*
         :align:  center

         **Example of using the SetAtomLabelMonochrome method**

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightOverlayByBallAndStick::GetAtomLabelMonochrome` method


   .. oe:method:: SetBallRadiusScale

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

         .. oe:api::

            void SetBallRadiusScale(double ballRadiusScale)

      .. oe:language:: python

         .. oe:api:: python

            SetBallRadiusScale(ballRadiusScale: float) -> None


      Sets the multiplier that can be used to increase or decrease
      the ball radius of the highlighted atoms(s).

      Example (:ref:`Figure: Example of using the SetBallRadiusScale method<figure_OEHighlightOverlayByBallAndStick_SetBallRadiusScale>`)

      .. oe:source:: HighlightOverlayBallStick.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTOVERLAYBYBALLANDSTICK-SETBALLRADIUSSCALE

      .. oe:source:: HighlightOverlayBallStick.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTOVERLAYBYBALLANDSTICK-SETBALLRADIUSSCALE

      .. oe:language:: java

      .. oe:source:: HighlightOverlayBallStick.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTOVERLAYBYBALLANDSTICK-SETBALLRADIUSSCALE

      .. oe:language:: csharp

      .. oe:source:: HighlightOverlayBallStick.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTOVERLAYBYBALLANDSTICK-SETBALLRADIUSSCALE

      .. _figure_OEHighlightOverlayByBallAndStick_SetBallRadiusScale:

      .. figure:: ../images/OEHighlightOverlayByBallAndStick_SetBallRadiusScale.*
         :align:  center

         **Example of using the SetBallRadiusScale method**


      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightOverlayByBallAndStick::GetBallRadiusScale` method


   .. oe:method:: SetStickWidthScale

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

         .. oe:api::

            void SetStickWidthScale(double stickWidthScale)

      .. oe:language:: python

         .. oe:api:: python

            SetStickWidthScale(stickWidthScale: float) -> None

      Sets the multiplier that can be used to increase or decrease
      the stick width of the highlighted bond(s).

      Example (:ref:`Figure: Example of using the SetStickWidthScale method<figure_OEHighlightOverlayByBallAndStick_SetStickWidthScale>`)

      .. oe:source:: HighlightOverlayBallStick.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTOVERLAYBYBALLANDSTICK-SETSTICKWIDTHSCALE

      .. oe:source:: HighlightOverlayBallStick.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTOVERLAYBYBALLANDSTICK-SETSTICKWIDTHSCALE

      .. oe:source:: HighlightOverlayBallStick.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTOVERLAYBYBALLANDSTICK-SETSTICKWIDTHSCALE

      .. oe:language:: csharp

      .. oe:source:: HighlightOverlayBallStick.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTOVERLAYBYBALLANDSTICK-SETSTICKWIDTHSCALE

      .. _figure_OEHighlightOverlayByBallAndStick_SetStickWidthScale:

      .. figure:: ../images/OEHighlightOverlayByBallAndStick_SetStickWidthScale.*
         :align:  center

         **Example of using the SetStickWidthScale method**

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightOverlayByBallAndStick::GetStickWidthScale` method
