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

.. oe:namespace:: OEDepict


.. _OEDepict_OEAtomSVGMarkupBase:

.. oe:class:: OEAtomSVGMarkupBase

   .. oe:api::

      class OEAtomSVGMarkupBase

   :ref:`OEAtomSVGMarkupBase <OEDepict_OEAtomSVGMarkupBase>` is an abstract base class.
   Concrete classes derived from the base class define the markup of
   the atoms in :file:`.svg` images that are generated
   when calling the :ref:`OERenderMolecule <OEDepict_OERenderMolecule>` function.
   Drawing elements representing atoms in the :file:`.svg` images are grouped together
   in the following format in which the ``<group id>`` and ``<class name>``
   strings can be defined in the derived concrete classes.

   ::

      <g id='<group id>' class='<class name>'>
      ..
      list of drawing elements
      ..
      </g>

   The following classes derive from this class:

    * :ref:`OEAtomSVGAtomIdxMarkup <OEDepict_OEAtomSVGAtomIdxMarkup>`
    * :ref:`OEAtomSVGNoMarkup <OEDepict_OEAtomSVGNoMarkup>`
    * :ref:`OEAtomSVGResidueMarkup <OEDepict_OEAtomSVGResidueMarkup>`

   .. seealso::

      * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomSVGMarkupFunctor` method
      * :ref:`chapter_svg` chapter


   .. note::

      User defined SVG atom marking can be implemented by deriving from this class
      and implementing all the methods listed below.

   .. oe:source:: UserAtomMarkup.py
      :language: python
      :noindent:
      :frag:     SNIPPET-USER-DEF-ATOM-MARKUP
      :caption:  Example of using user defined SVG atom markings


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

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OEAtomSVGMarkupBase* CreateCopy() const = 0

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEAtomSVGMarkupBase

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

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

   .. oe:method:: GetClassName

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

         .. oe:api::

            std::string GetClassName(const OEChem::OEAtomBase &) const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetClassName(arg0: OEAtomBase) -> str

      Returns the ``<class name>`` associated with a specific atom group
      in the :file:`.svg` image.
      This is a virtual method that has to be implemented in the concrete
      derived classes.
      The return string will be verified by the
      :oe:func:`OEDepict::OEIsValidSVGClassName` function.
      Invalid SVG class names will be ignored.

      .. seealso::

         * :oe:func:`OEDepict::OEIsValidSVGClassName` function


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

   .. oe:method:: GetGroupId

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

         .. oe:api::

            std::string GetGroupId(const OEChem::OEAtomBase &) const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetGroupId(arg0: OEAtomBase) -> str

      Returns the ``<group id>`` associated with a specific atom group
      in the :file:`.svg` image.
      This is a virtual method that has to be implemented in the concrete
      derived classes.
      The return string will be verified by the
      :oe:func:`OEDepict::OEIsValidSVGGroupId` function.
      Invalid SVG group ids will be ignored.

      .. seealso::

         * :oe:func:`OEDepict::OEIsValidSVGGroupId` function
