.. oe:namespace:: OEDepict

.. oe:constnamespace:: OEHighlightStyle

   This namespace contains constants representing various styles
   of highlighting.

   .. seealso::

      * :oe:func:`OEDepict::OEAddHighlighting` function
      * :ref:`OEHighlightBase <OEDepict_OEHighlightBase>` class
      * :ref:`chapter_highlighting` chapter

   The :oe:constns:`OEDepict::OEHighlightStyle` namespace contains the 
   following constants:

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

   .. oe:constant:: Default

      The default highlighting style is
      :oe:const:`OEDepict::OEHighlightStyle::Color`.


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

   .. oe:constant:: BallAndStick

      See example in :ref:`Figure: Example of highlighting using the 'ball and stick' style<figure_BallAndStick>`.

      * Atoms are highlighted by depicting spheres underneath them.
      * Bonds are highlighted by depicting sticks underneath them.

      .. _figure_BallAndStick:

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

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

      The radius of the spheres and the width of the sticks are automatically
      scaled with the molecule.
      See example in :ref:`Figure: Example of scaling the 'ball and stick' style highlighting along with the molecule<figure_BallAndStick_Scaling>`.

      .. _figure_BallAndStick_Scaling:

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

         **Example of scaling the 'ball and stick' style highlighting along with the molecule**

      .. seealso::

         * :ref:`OEHighlightByBallAndStick <OEDepict_OEHighlightByBallAndStick>` class


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

   .. oe:constant:: Color

      See example in :ref:`Figure: Example of highlighting using the 'color' style<figure_Color>`.

      * Atoms are highlighted by changing the color of their label,
        if present. If the atom being highlighted is an isolated carbon atom,
        then its atom label is explicitly displayed.
        See example in :ref:`Figure: Example of highlighting isolated atoms using the 'color' style<figure_Color_IsolatedAtoms>`.

      * Bonds are highlighted by changing their color.

      .. _figure_Color:

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

         **Example of highlighting using the 'color' style**

      .. _figure_Color_IsolatedAtoms:

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

         **Example of highlighting isolated atoms using the 'color' style**

      .. seealso::

         * :ref:`OEHighlightByColor <OEDepict_OEHighlightByColor>` class


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

   .. oe:constant:: Cogwheel

      See example in :ref:`Figure: Example of highlighting using the 'cogwheel' style<figure_Cogwheel>`.

      .. _figure_Cogwheel:

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

         **Example of highlighting using the 'cogwheel' style**

      The radius of the spheres and the width of the sticks are automatically
      scaled with the molecule.
      See example in :ref:`Figure: Example of scaling the 'cogwheel' style highlighting
      along with the molecule<figure_Cogwheel_Scaling>`.

      .. _figure_Cogwheel_Scaling:

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

         **Example of scaling the 'cogwheel' style highlighting along with the molecule**

      .. seealso::

         * :ref:`OEHighlightByCogwheel <OEDepict_OEHighlightByCogwheel>` class

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


   .. oe:constant:: Lasso

      See example in :ref:`Figure: Example of highlighting using the 'lasso' style<figure_Lasso>`.

      Atoms and bond are highlighted by drawing a "curved" convex hull around
      them.

      .. _figure_Lasso:

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

         **Example of highlighting using the 'lasso' style**

      The width of "lasso" line is automatically scaled with the molecule.
      See example in :ref:`Figure: Example of scaling the 'lasso' style highlighting along with the molecule<figure_Lasso_Scaling>`.

      .. _figure_Lasso_Scaling:

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

         **Example of scaling the 'lasso' style highlighting along with the molecule**

      .. seealso::

         * :ref:`OEHighlightByLasso <OEDepict_OEHighlightByLasso>` class

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

   .. oe:constant:: Stick

      See example in :ref:`Figure: Example of highlighting using the 'stick' style<figure_Stick>`.

      * Atoms are highlighted by changing the color of their label to
        be monochrome, if present.
        Isolated atoms are highlighted by depicting spheres underneath them.
        See example in :ref:`Figure: Example of highlighting isolated atoms using the 'stick' style<figure_Stick_IsolatedAtoms>`.

      * Bonds are highlighted by depicting sticks underneath them.

      .. _figure_Stick:

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

         **Example of highlighting using the 'stick' style**

      .. _figure_Stick_IsolatedAtoms:

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

         **Example of highlighting isolated atoms using the 'stick' style**

      The width of the sticks is automatically scaled with the molecule.
      See example in :ref:`Figure: Example of scaling the 'stick' style highlighting along with the molecule<figure_Stick_Scaling>`.

      .. _figure_Stick_Scaling:

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

         **Example of scaling the 'stick' style highlighting along with the molecule**

      .. seealso::

         * :ref:`OEHighlightByStick <OEDepict_OEHighlightByStick>` class
