.. oe:namespace:: OEGrapheme


.. meta::
   :keywords: OEDefaultCavityArcFxn, DefaultCavityArcFxn


.. _OEGrapheme_OEDefaultCavityArcFxn:

.. oe:class:: OEDefaultCavityArcFxn

   .. oe:api::

      class OEDefaultCavityArcFxn : public OEComplexSurfaceArcFxnBase

   This class represents :ref:`OEDefaultCavityArcFxn <OEGrapheme_OEDefaultCavityArcFxn>`
   functor that is used to draw the arc segment of the 2D molecule
   surface, where there is a cavity detected between the ligand and
   the protein in the 3D complex.
   See example in :ref:`Figure: Example of drawing an arc using OEDefaultCavityArcFxn<figure_OEDefaultCavityArcFxn>`.

   .. _figure_OEDefaultCavityArcFxn:

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

      **Example of drawing an arc using OEDefaultCavityArcFxn**

   .. seealso::

      * :ref:`chapter_complex_surface` chapter
      * :oe:func:`OEGrapheme::OEAddComplexSurfaceArcs` function
      * :ref:`OEDefaultBuriedArcFxn <OEGrapheme_OEDefaultBuriedArcFxn>` class
      * :ref:`OEDefaultSolventArcFxn <OEGrapheme_OEDefaultSolventArcFxn>` class
      * :ref:`OEDefaultVoidArcFxn <OEGrapheme_OEDefaultVoidArcFxn>` class

   The following methods are publicly inherited from :ref:`OEComplexSurfaceArcFxnBase <OEGrapheme_OEComplexSurfaceArcFxnBase>`:

   ====================================================================================== ======================================================================================= ======================================================================================
   :oe:meth:`operator=<OEGrapheme::OEComplexSurfaceArcFxnBase::operator=>`                :oe:meth:`CreateComplexCopy<OEGrapheme::OEComplexSurfaceArcFxnBase::CreateComplexCopy>` :oe:meth:`GetDepth<OEGrapheme::OEComplexSurfaceArcFxnBase::GetDepth>`                 
   :oe:meth:`operator()<OEGrapheme::OEComplexSurfaceArcFxnBase::operator()>`              :oe:meth:`CreateCopy<OEGrapheme::OEComplexSurfaceArcFxnBase::CreateCopy>`               :oe:meth:`SetDepth<OEGrapheme::OEComplexSurfaceArcFxnBase::SetDepth>`                 
   ====================================================================================== ======================================================================================= ======================================================================================

   The following methods are publicly inherited from :ref:`OESurfaceArcFxnBase <OEGrapheme_OESurfaceArcFxnBase>`:

   ================================================================== ==================================================================
   :oe:meth:`operator()<OEGrapheme::OESurfaceArcFxnBase::operator()>` :oe:meth:`CreateCopy<OEGrapheme::OESurfaceArcFxnBase::CreateCopy>`
   ================================================================== ==================================================================

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

   .. oe:method:: Constructors

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

         .. oe:api::

            OEDefaultCavityArcFxn()

      .. oe:language:: python

         .. oe:api:: python

            OEDefaultCavityArcFxn() -> OEDefaultCavityArcFxn

      Default constructors.


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

   .. oe:method:: operator()

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

         .. oe:api::

            bool operator()(OEDepict::OEImageBase& image, const OESurfaceArc& a) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(image: OEImageBase, a: OESurfaceArc) -> bool

      Draws a surface arc with the
      :oe:const:`OEGrapheme::OESurfaceArcStyle::Cog` style using
      a black pen.

      *image*
         The image on which the *cavity* surface arc is drawn.

      *arc*
         The object that stores the parameters of the surface arc.

      .. seealso::

         * :oe:func:`OEGrapheme::OEAddComplexSurfaceArcs` function
         * :oe:func:`OEGrapheme::OEDrawCogSurfaceArc` function


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

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OESurfaceArcFxnBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEDefaultCavityArcFxn

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

