.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEComplexSurfaceArcFxnBase, ComplexSurfaceArcFxnBase


.. _OEGrapheme_OEComplexSurfaceArcFxnBase:

.. oe:class:: OEComplexSurfaceArcFxnBase

   .. oe:api::

      class OEComplexSurfaceArcFxnBase : public OESurfaceArcFxnBase

   This class represents :ref:`OEComplexSurfaceArcFxnBase <OEGrapheme_OEComplexSurfaceArcFxnBase>`
   which is an abstract class that defines the interface used for drawing
   molecule surfaces. 
   The :ref:`OEComplexSurfaceArcFxnBase <OEGrapheme_OEComplexSurfaceArcFxnBase>` class also stores
   a *depth* parameter that reflects the relative distance between the
   ligand and the receptor when drawing the complex surface.

   .. seealso::

      :ref:`chapter_complex_surface` chapter

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

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

   The following classes derive from this class:
    * :ref:`OEDefaultCavityArcFxn <OEGrapheme_OEDefaultCavityArcFxn>`
    * :ref:`OEDefaultVoidArcFxn <OEGrapheme_OEDefaultVoidArcFxn>`

   .. oe:method:: Constructors

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

         .. oe:api::

            OEComplexSurfaceArcFxnBase()
            OEComplexSurfaceArcFxnBase(double depth)
            OEComplexSurfaceArcFxnBase(const OEComplexSurfaceArcFxnBase& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEComplexSurfaceArcFxnBase() -> OEComplexSurfaceArcFxnBase
            OEComplexSurfaceArcFxnBase(depth: float) -> OEComplexSurfaceArcFxnBase
            OEComplexSurfaceArcFxnBase(rhs: OEComplexSurfaceArcFxnBase) -> OEComplexSurfaceArcFxnBase

      Default and copy constructors.


   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEComplexSurfaceArcFxnBase &operator=(const OEComplexSurfaceArcFxnBase &rhs)

      Assignment operator.


   .. oe:method:: operator()

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

         .. oe:api::

            bool operator()(OEDepict::OEImageBase& image, const OESurfaceArc& arc) const = 0

      .. oe:language:: python

         .. oe:api:: python

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

      It is a virtual const method that is implemented in the concrete 
      derived classes to draw surface arcs.

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

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


   .. ################################################################
      # CreateComplexCopy
      ################################################################

   .. oe:method:: CreateComplexCopy

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

         .. oe:api::

            OEComplexSurfaceArcFxnBase* CreateComplexCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateComplexCopy() -> OEComplexSurfaceArcFxnBase

      Virtual const constructor which allows copying of concrete
      derived objects using a reference to the
      :ref:`OEComplexSurfaceArcFxnBase <OEGrapheme_OEComplexSurfaceArcFxnBase>` base class.


   .. ################################################################
      # CreateCopy
      ################################################################

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OESurfaceArcFxnBase* CreateCopy() const = 0

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEComplexSurfaceArcFxnBase

      Virtual const constructor which allows copying of concrete
      derived objects using a reference to the
      :ref:`OESurfaceArcFxnBase <OEGrapheme_OESurfaceArcFxnBase>` base class.


   .. ################################################################
      # GetDepth
      ################################################################

   .. oe:method:: GetDepth

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

         .. oe:api::

            double GetDepth() const

      .. oe:language:: python

         .. oe:api:: python

            GetDepth() -> float

      Returns the *depth* parameter of the surface arc.


   .. ################################################################
      # SetDepth
      ################################################################

   .. oe:method:: SetDepth

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

         .. oe:api::

            void SetDepth(double depth)

      .. oe:language:: python

         .. oe:api:: python

            SetDepth(depth: float) -> None

      Sets the *depth* parameter of the surface arc.
