.. oe:namespace:: OEDepict



.. meta::
   :keywords: OEHighlightOverlayBase, HighlightOverlayBase


.. _OEDepict_OEHighlightOverlayBase:

.. oe:class:: OEHighlightOverlayBase

   .. oe:api::

      class OEHighlightOverlayBase

   The :ref:`OEHighlightOverlayBase <OEDepict_OEHighlightOverlayBase>` is an abstract class
   used for highlighting a set of atoms and/or bonds.

   The following classes derive from this class:

    * :ref:`OEHighlightOverlayByBallAndStick <OEDepict_OEHighlightOverlayByBallAndStick>`

   .. seealso::

      * :oe:func:`OEDepict::OEAddHighlightOverlay` function
      * :ref:`section_highlighting_overlap` section

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

   .. oe:method:: Constructors

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

         .. oe:api::

            OEHighlightOverlayBase()
            OEHighlightOverlayBase(OEHighlightOverlayBaseImpl* impl)

      .. oe:language:: python

         .. oe:api:: python

            OEHighlightOverlayBase() -> OEHighlightOverlayBase

      Default constructors.

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

   .. oe:method:: GetColors

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

         .. oe:api::

            OESystem::OEIterBase<OESystem::OEColor>* GetColors() const

      .. oe:language:: python

         .. oe:api:: python

            GetColors() -> Iterable[OEColor]

      Returns an iterator over the colors used for highlighting.

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

   .. oe:method:: SetColors

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

         .. oe:api::

            void SetColors(OESystem::OEIter<OESystem::OEColor>& colors)
            void SetColors(OESystem::OEIterBase<OESystem::OEColor>* colors)

      .. oe:language:: python

         .. oe:api:: python

            SetColors(colors: OEColorIter) -> None

      Sets the colors used for highlighting.
