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

.. oe:namespace:: OEGrapheme


.. _OEGrapheme_OEResidueSVGStandardMarkup:

.. oe:class:: OEResidueSVGStandardMarkup

   .. oe:api::

      class OEResidueSVGStandardMarkup : public OEResidueSVGMarkupBase

   This class represents :ref:`OEResidueSVGStandardMarkup <OEGrapheme_OEResidueSVGStandardMarkup>` residue
   SVG markup functor.
   If this functor is passed to the
   :oe:meth:`OEGrapheme::OE2DActiveSiteDisplayOptions::SetResidueSVGMarkupFunctor`
   method, the residues will be in :file:`svg` image
   when calling the :ref:`OERenderActiveSite <OEGrapheme_OERenderActiveSite>` function.

   .. seealso::

      * :ref:`chapter_svg` chapter in **OEDepict TK** manual
      * :oe:meth:`OEGrapheme::OE2DActiveSiteDisplayOptions::SetResidueSVGMarkupFunctor` method
      * :ref:`OEResidueSVGNoMarkup <OEGrapheme_OEResidueSVGNoMarkup>` functor

   The following methods are publicly inherited from :ref:`OEResidueSVGMarkupBase <OEGrapheme_OEResidueSVGMarkupBase>`:

   ========================================================================= ========================================================================= =========================================================================
   :oe:meth:`CreateCopy<OEGrapheme::OEResidueSVGMarkupBase::CreateCopy>`     :oe:meth:`GetClassName<OEGrapheme::OEResidueSVGMarkupBase::GetClassName>` :oe:meth:`GetGroupId<OEGrapheme::OEResidueSVGMarkupBase::GetGroupId>`
   ========================================================================= ========================================================================= =========================================================================

   .. oe:method:: Constructors

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

         .. oe:api::

            OEResidueSVGStandardMarkup(const std::string prefix = "",
                                       const std::string classname = "residue",
                                       const char separator = '-')

      .. oe:language:: python

         .. oe:api:: python

            OEResidueSVGStandardMarkup(prefix: str = "",
                                       classname: str = "residue",
                                       separator: str = '-') -> OEResidueSVGStandardMarkup

      Creates an :ref:`OEResidueSVGStandardMarkup <OEGrapheme_OEResidueSVGStandardMarkup>` object.

      prefix
        The string that will be added at the beginning of each residue
        :oe:cls:`group id <OEDepict::OESVGGroup>`.
        For information about valid ids see
        :oe:func:`OEDepict::OEIsValidSVGGroupId` function.
        By default, no prefix will be added.

      classname
        The :oe:cls:`class name <OEDepict::OESVGClass>` that is going to
        be used to mark residues.
        For information about valid names see
        :oe:func:`OEDepict::OEIsValidSVGClassName` function.

      separator
        The character used to separate the components
        (residue name, chain id, residue number)
        of the :oe:cls:`group id <OEDepict::OESVGGroup>`

      By default, the following will be showed in :file:`svg` image for
      marking a Leucine residue with chain id 'A' and residue number ``715``:

      ::

          <g id='LEU-A-715' class='residue'>
          ..
          list of drawing elements
          ..
          </g>

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OEResidueSVGMarkupBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEResidueSVGMarkupBase

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEResidueSVGNoMarkup <OEGrapheme_OEResidueSVGNoMarkup>`
      object is dynamically allocated and owned by the caller.

   .. oe:method:: GetClassName

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

         .. oe:api::

            std::string GetClassName(const OEChem::OEResidue& residue) const

      .. oe:language:: python

         .. oe:api:: python

            GetClassName(arg2: OEResidue) -> str

      Returns the string that specifies the :oe:cls:`group id <OEDepict::OESVGGroup>`
      of a residue in an :file:`svg` image.

   .. oe:method:: GetGroupId

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

         .. oe:api::

            std::string GetGroupId(const OEChem::OEResidue& residue) const

      .. oe:language:: python

         .. oe:api:: python

            GetGroupId(arg2: OEResidue) -> str

      Returns the string that specifies the :oe:cls:`class name <OEDepict::OESVGClass>`
      of a residue in an :file:`svg` image.
