.. # split from OEGraphemeFunctions.rst:53

.. include:: ../substitutions

.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEAddComplexSurfaceArcs

.. oe:function:: OEAddComplexSurfaceArcs

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

      .. oe:api::

         bool OEAddComplexSurfaceArcs(OEChem::OEMolBase& ligand,
                                      const OEChem::OEMolBase& protein,
                                      const OESurfaceArcFxnBase& solventExposedFxn = OEDefaultSolventArcFxn(),
                                      const OESurfaceArcFxnBase& buriedFxn = OEDefaultBuriedArcFxn(),
                                      const OEComplexSurfaceArcFxnBase& cavityFxn = OEDefaultCavityArcFxn(),
                                      const OEComplexSurfaceArcFxnBase& voidFxn = OEDefaultVoidArcFxn())

   .. oe:language:: python

      .. oe:api:: python

         OEAddComplexSurfaceArcs(ligand: Union[OEGraphMol,OEMol,OEQMol],
                                 protein: Union[OEGraphMol,OEMol,OEQMol],
                                 solventExposedFxn: OESurfaceArcFxnBase = OEDefaultSolventArcFxn(),
                                 buriedFxn: OESurfaceArcFxnBase = OEDefaultBuriedArcFxn(),
                                 cavityFxn: OEComplexSurfaceArcFxnBase = OEDefaultCavityArcFxn(),
                                 voidFxn: OEComplexSurfaceArcFxnBase = OEDefaultVoidArcFxn()) -> bool

   Takes a ligand-protein complex and generates the 2D molecule
   surface of the ligand, where the arcs of the surface are annotated
   based on the distance calculated between the accessible surface of
   the ligand and the protein.
   See :ref:`Figure: Example of surface drawing with the OEAddComplexSurfaceArcs function<figure_OEAddComplexSurfaceArcs>`.

   *ligand*
      The molecule for which the 2D surface is generated.
      Must have 3D coordinates and VDW radii assigned.

   *protein*
      The macromolecule whose contact with the ligand influences
      the surface drawing.
      Must have 3D coordinates and VDW radii assigned.

   *solventExposedFxn*
      This functor is used to draw those arc segments of the 2D
      molecule surface where the ligand is exposed to the solvent
      in the 3D complex.
      By default, the :ref:`OEDefaultSolventArcFxn <OEGrapheme_OEDefaultSolventArcFxn>`
      functor is used.

   *buriedFxn*
      This functor is used to draw those arc segments of the 2D
      molecule surface where the ligand and the protein tightly fit
      in the 3D complex.
      By default, the :ref:`OEDefaultBuriedArcFxn <OEGrapheme_OEDefaultBuriedArcFxn>`
      functor is used.

   *cavityFxn*
      This functor is used to draw those arc segments of the 2D
      molecule surface where there is a cavity detected between the
      ligand and the protein in the 3D complex.
      By default, the :ref:`OEDefaultCavityArcFxn <OEGrapheme_OEDefaultCavityArcFxn>`
      functor is used.

   *voidFxn*
      This functor is used to draw those arc segments of the 2D
      molecule surface where there is a small gap detected between
      the ligand and the protein in the 3D complex.
      By default, the :ref:`OEDefaultVoidArcFxn <OEGrapheme_OEDefaultVoidArcFxn>`
      functor is used.

   .. _figure_OEAddComplexSurfaceArcs:

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

      **Example of surface drawing with the OEAddComplexSurfaceArcs function**

   .. seealso::

      * :ref:`chapter_complex_surface` chapter

