.. # split from OEGraphemeFunctions.rst:2497

.. include:: ../substitutions

.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEGet2DSurfaceArcs

.. oe:function:: OEGet2DSurfaceArcs

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

      .. oe:api::

         OESystem::OEIterBase<OESurfaceArc>* OEGet2DSurfaceArcs(const OEDepict::OE2DMolDisplay& disp,
                                                                double radiusScale = OESurfaceArcScale::Default)

   .. oe:language:: python

      .. oe:api:: python

         OEGet2DSurfaceArcs(disp: OE2DMolDisplay, radiusScale: double) -> Iterable[OESurfaceArc]

   Returns an iterator over the :ref:`OESurfaceArc <OEGrapheme_OESurfaceArc>`
   objects from which a continuous 2D molecule surface can be drawn.
   See :ref:`Figure: Example of the data stored in the OESurfaceArc
   class<figure_OEGet2DSurfaceArcs>`.

   *disp*
      The :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object for which the arcs
      of the 2D molecule surface are generated.

   *radiusScale*
      The multiplier used to modify the radius of the returned arcs.
      The scaling factor has to be in the range of
      [:oe:const:`OEGrapheme::OESurfaceArcScale::Minimum`,
      :oe:const:`OEGrapheme::OESurfaceArcScale::Maximum`].

   .. _figure_OEGet2DSurfaceArcs:

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

      **Example of the data stored in the OESurfaceArc class**

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

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

      .. oe:api::

         OESystem::OEIterBase<OESurfaceArc>* OEGet2DSurfaceArcs(const OEDepict::OE2DMolDisplay& mdisp,
                                                                const OEDepict::OE2DAtomDisplay& adisp,
                                                                double radiusScale = OESurfaceArcScale::Default)

   .. oe:language:: python

      .. oe:api:: python

         OEGet2DSurfaceArcs(mdisp: OE2DMolDisplay, adisp: OE2DAtomDisplay,
                            radiusScale: double) -> Iterable[OESurfaceArc]

   Returns an iterator over the :ref:`OESurfaceArc <OEGrapheme_OESurfaceArc>`
   object(s) generated for the given atom display.
   See :ref:`Figure: Example of the arcs returned for an atom display
   with various radius scales <figure_OEGet2DSurfaceArcs>`.

   *mdisp*
      The :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object to which the
      :ref:`OE2DAtomDisplay <OEDepict_OE2DAtomDisplay>` object belongs.

   *adisp*
      The :ref:`OE2DAtomDisplay <OEDepict_OE2DAtomDisplay>` object for which the arc(s)
      of the 2D molecule surface are generated.

   *radiusScale*
      The multiplier used to modify the radius of the returned arcs.
      The scaling factor has to be in the range of
      [:oe:const:`OEGrapheme::OESurfaceArcScale::Minimum`,
      :oe:const:`OEGrapheme::OESurfaceArcScale::Maximum`].


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

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

      .. oe:api::

         OESystem::OEIterBase<OESurfaceArc>* OEGet2DSurfaceArcs(const OEDepict::OE2DMolDisplay& disp,
                                                                const std::vector<double>& radiusScales)

   .. oe:language:: python

      .. oe:api:: python

         OEGet2DSurfaceArcs(disp: OE2DMolDisplay, radiusScales: OEDoubleVector) -> Iterable[OESurfaceArc]

   Returns an iterator over the :ref:`OESurfaceArc <OEGrapheme_OESurfaceArc>`
   objects from which a continuous 2D molecule surface can be drawn.

   *disp*
      The :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object for which the arcs
      of the 2D molecule surface are generated.

   *radiusScales*
      The multipliers used to modify the radius of the returned arcs.
      The vector has to be :oe:meth:`OEChem::OEMolBase::GetMaxAtomIdx`
      long.
      Each scaling factor has to be in the range of
      [:oe:const:`OEGrapheme::OESurfaceArcScale::Minimum`,
      :oe:const:`OEGrapheme::OESurfaceArcScale::Maximum`].

   .. seealso::

      * :ref:`chapter_draw_surface` chapter
      * :ref:`OESurfaceArc <OEGrapheme_OESurfaceArc>` classes
      * :oe:constns:`OEGrapheme::OESurfaceArcScale` namespace

