.. oe:namespace:: OEGrapheme



.. meta::
   :keywords: OEOliveBranchArcFxn, OliveBranchArcFxn


.. _OEGrapheme_OEOliveBranchArcFxn:

.. oe:class:: OEOliveBranchArcFxn

   .. oe:api::

      class OEOliveBranchArcFxn : public OESurfaceArcFxnBase

   This class represents :ref:`OEOliveBranchArcFxn <OEGrapheme_OEOliveBranchArcFxn>`.
   See example in :ref:`Example of drawing molecule surface using OEOliveBranchArcFxn<figure_OEOliveBranchArcFxn>`.

   .. _figure_OEOliveBranchArcFxn:

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

      **Example of drawing molecule surface using OEOliveBranchArcFxn**

   .. seealso::

      * :oe:func:`OEGrapheme::OEDrawOliveBranchSurfaceArc` function
      * :oe:func:`OEGrapheme::OESetSurfaceArcFxn` function
      * :oe:func:`OEGrapheme::OEDraw2DSurface` function

   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::

            OEOliveBranchArcFxn(const OEDepict::OEPen& pen = OEDepict::OEBlackPen)

      .. oe:language:: python

         .. oe:api:: python

            OEOliveBranchArcFxn(pen: OEPen = OEBlackPen) -> OEOliveBranchArcFxn

      Default constructor.

      *pen*
         The graphical properties of the arc.


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

   .. oe:method:: operator()

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

         .. oe:api::

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

      .. oe:language:: python

         .. oe:api:: python

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

      Draws a surface arc with the
      :oe:const:`OEGrapheme::OESurfaceArcStyle::OliveBranch` style.

      See example in :ref:`Example of drawing molecule surface using OEOliveBranchArcFxn<figure_OEOliveBranchArcFxn>`.

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

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

      .. seealso::

         * :ref:`OESurfaceArc <OEGrapheme_OESurfaceArc>` class


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

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OESurfaceArcFxnBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEOliveBranchArcFxn

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