.. include:: ../substitutions

.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEDrawChevronArrow

.. _OEDepict_OEDrawChevronArrow:


.. oe:function:: OEDrawChevronArrow


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

      .. oe:api::

         void OEDrawChevronArrow(OEImageBase& image, const OE2DPoint& bgn,
                                 const OE2DPoint& end, const OEPen& pen,
                                 double arrowWidth = 5.0, double gapScale = 2.0)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawChevronArrow(image: OEImageBase, bgn: OE2DPoint, end: OE2DPoint,
                            pen: OEPen, arrowWidth: float = 5.0,
                            gapScale: float = 2.0) -> None


   Draws a chevron arrow.
   See example in :ref:`Figure: Example of drawing a chevron arrows<figure_OEDrawChevronArrow>`.

   .. _figure_OEDrawChevronArrow:

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

      **Example of drawing a chevron 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.

   *width*
      The width of the arrow.

   *gapScale*
      The multiplier that defines the space between the lines of the chevron.

   .. seealso::

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


