.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEAtomGlyphBase, AtomGlyphBase


.. _OEGrapheme_OEAtomGlyphBase:

.. oe:class:: OEAtomGlyphBase

   .. oe:api::

      class OEAtomGlyphBase

   :ref:`OEAtomGlyphBase <OEGrapheme_OEAtomGlyphBase>` is an abstract class that
   defines the interface used for atom annotation.

   .. seealso::

      * :ref:`chapter_annotation` chapter
      * :oe:func:`OEGrapheme::OEAddGlyph` function.

   The following classes derive from this class:

    * :ref:`OEAtomGlyphCircle <OEGrapheme_OEAtomGlyphCircle>`

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

   .. oe:method:: Constructors

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

         .. oe:api::

            OEAtomGlyphBase()

      .. oe:language:: python

         .. oe:api:: python

            OEAtomGlyphBase() -> OEAtomGlyphBase

      Default constructor.


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

   .. oe:method:: CreateCopy

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

         .. oe:api::

            virtual OEAtomGlyphBase* CreateCopy() const = 0

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEAtomGlyphBase

      Virtual const constructor which allows copying of concrete
      derived objects using a reference to this base class.


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

   .. oe:method:: RenderGlyph

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

         .. oe:api::

            bool RenderGlyph(OEDepict::OE2DMolDisplay& disp,
                             const OEChem::OEAtomBase* atom) const = 0

      .. oe:language:: python

         .. oe:api:: python

            RenderGlyph(disp: OE2DMolDisplay, atom: OEAtomBase) -> bool

      It is a virtual const method that is implemented in the concrete
      derived classes to annotate the given atom (*i.e.* to draw a `glyph` to
      mark the atom).

      *disp*
         The :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object that is modified
         to annotate the specified atom. 

      *atom*
         The :ref:`OEAtomBase <OEChem_OEAtomBase>` object being annotated.
