.. include:: ../substitutions

.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEDrawEquilibriumArrow

.. _OEDepict_OEDrawEquilibriumArrow:


.. oe:function:: OEDrawEquilibriumArrow


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

      .. oe:api::

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

   .. oe:language:: python

      .. oe:api:: python

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

   Draws an equilibrium arrow between two points using the given pen.
   See example in :ref:`Figure: Example of drawing an equilibrium arrow<figure_OEDrawEquilibriumArrow>`.

   .. _figure_OEDrawEquilibriumArrow:

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

      **Example of drawing an equilibrium 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
