.. oe:namespace:: OEGrapheme


.. meta::
   :keywords: OESurfaceArc, SurfaceArc


.. _OEGrapheme_OESurfaceArc:

.. oe:class:: OESurfaceArc

   .. oe:api::

      class OESurfaceArc

   This class represents :ref:`OESurfaceArc <OEGrapheme_OESurfaceArc>` that stores
   data for drawing the arcs of molecule surface.
   See :ref:`Figure: Example of the data stored in the OESurfaceArc class<figure_OESurfaceArc>`.

   .. _figure_OESurfaceArc:

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

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

   .. note::

      Angles are interpreted such that :math:`0.0^{\circ}` and
      :math:`360.0^{\circ}` degrees are at the *12 o'clock*
      position, :math:`90.0^{\circ}` degree corresponds
      to *3 o'clock*, etc.

   .. seealso::

      * :ref:`OESurfaceArcFxnBase <OEGrapheme_OESurfaceArcFxnBase>` class
      * :oe:func:`OEGrapheme::OEGet2DSurfaceArcs` function

   .. oe:method:: Constructors


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

         .. oe:api::

            OESurfaceArc()

      .. oe:language:: python

         .. oe:api:: python

            OESurfaceArc() -> OESurfaceArc

      Default constructor.

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

         .. oe:api::

            OESurfaceArc(const OEDepict::OE2DAtomDisplay* adisp,
                         const OEDepict::OE2DPoint& center, double bgnAngle,
                         double endAngle, double radius)

      .. oe:language:: python

         .. oe:api:: python

            OESurfaceArc(adisp: OE2DAtomDisplay, center: OE2DPoint,
                         bgnAngle: float, endAngle: float, radius: float) -> OESurfaceArc

      Creates an :ref:`OESurfaceArc <OEGrapheme_OESurfaceArc>` object with the given parameters.

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

         .. oe:api::

            OESurfaceArc(const OESurfaceArc& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OESurfaceArc(rhs: OESurfaceArc) -> OESurfaceArc

      Copy constructor.

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

      .. oe:api::

         OESurfaceArc &operator=(const OESurfaceArc &rhs)

      Assignment operator.


   .. oe:method:: GetAtomDisplay

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

         .. oe:api::

            const OEDepict::OE2DAtomDisplay* GetAtomDisplay() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomDisplay() -> OE2DAtomDisplay

      Returns the pointer of the :ref:`OE2DAtomDisplay <OEDepict_OE2DAtomDisplay>`
      object the given arc belongs to.

      .. seealso::

         * :ref:`OE2DAtomDisplay <OEDepict_OE2DAtomDisplay>` class in the **OEDepict TK** manual


   .. oe:method:: GetBgnAngle

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

         .. oe:api::

            double GetBgnAngle() const

      .. oe:language:: python

         .. oe:api:: python

            GetBgnAngle() -> float

      Returns the angle (in degrees) where the arc of the surface starts.


   .. oe:method:: GetCenter

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

         .. oe:api::

            const OEDepict::OE2DPoint& GetCenter() const

      .. oe:language:: python

         .. oe:api:: python

            GetCenter() -> OE2DPoint

      Returns the (x,y) coordinates of the center of the surface arc.

      .. seealso::

         * :ref:`OE2DPoint <OEDepict_OE2DPoint>` class in the **OEDepict TK** manual

   .. oe:method:: GetEndAngle

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

         .. oe:api::

            double GetEndAngle() const

      .. oe:language:: python

         .. oe:api:: python

            GetEndAngle() -> float

      Returns the angle (in degrees) where the arc of the surface ends.


   .. oe:method:: GetRadius

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

         .. oe:api::

            double GetRadius() const

      .. oe:language:: python

         .. oe:api:: python

            GetRadius() -> float

      Returns the radius of the arc.


   .. oe:method:: SetAtomDisplay

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

         .. oe:api::

            bool SetAtomDisplay(const OEDepict::OE2DAtomDisplay* adisp)

      .. oe:language:: python

         .. oe:api:: python

            SetAtomDisplay(adisp: OE2DAtomDisplay) -> bool

      Sets the atom display to which the arc belongs.

      .. seealso::

         * :ref:`OE2DAtomDisplay <OEDepict_OE2DAtomDisplay>` class in the OEDepict manual


   .. oe:method:: SetBgnAngle

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

         .. oe:api::

            bool SetBgnAngle(double angle)

      .. oe:language:: python

         .. oe:api:: python

            SetBgnAngle(angle: float) -> bool

      Sets the angle where the arc of the surface begins.

      *angle*
         The angle has to in the range of :math:`[0.0^{\circ}, 360.0^{\circ}]`


   .. oe:method:: SetCenter

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

         .. oe:api::

            bool SetCenter(const OEDepict::OE2DPoint& center)

      .. oe:language:: python

         .. oe:api:: python

            SetCenter(center: OE2DPoint) -> bool

      Sets the (x,y) coordinates of the center of the surface arc.


   .. oe:method:: SetEndAngle

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

         .. oe:api::

            bool SetEndAngle(double angle)

      .. oe:language:: python

         .. oe:api:: python

            SetEndAngle(angle: float) -> bool

      Sets the angle where the arc of the surface ends.

      *angle*
         The angle has to in the range of :math:`[0.0^{\circ}, 360.0^{\circ}]`

   .. oe:method:: SetRadius

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

         .. oe:api::

            bool SetRadius(double radius)

      .. oe:language:: python

         .. oe:api:: python

            SetRadius(radius: float) -> bool

      Sets the radius of the arc.
