.. include:: ../substitutions

.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEDrawResonanceArrow

.. _OEDepict_OEDrawResonanceArrow:


.. oe:function:: OEDrawResonanceArrow


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

      .. oe:api::

         void OEDrawResonanceArrow(OEImageBase& image, const OE2DPoint& bgn,
                                   const OE2DPoint& end, const OEPen& pen)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawResonanceArrow(image: OEImageBase, bgn: OE2DPoint,
                              end: OE2DPoint, pen: OEPen) -> None

   Draws a resonance arrow between two points using the given pen.
   See example in :ref:`Figure: Example of drawing a resonance arrow<figure_OEDrawResonanceArrow>`.

   .. _figure_OEDrawResonanceArrow:

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

      **Example of drawing a resonance arrow**

   *image*
      The image in which the arrow is drawn.

   *bgn*, *end*
      The begin and end points of the arrow.

   *pen*
      The graphical properties of the arrow.

   .. seealso::

      * :ref:`OEImageBase <OEDepict_OEImageBase>` class
      * :ref:`OE2DPoint <OEDepict_OE2DPoint>` class
      * :ref:`OEPen <OEDepict_OEPen>` class
