.. # split from OEGraphemeFunctions.rst:1388

.. include:: ../substitutions

.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEDrawNecklaceCircle

.. oe:function:: OEDrawNecklaceCircle

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

      .. oe:api::

         bool OEDrawNecklaceCircle(OEDepict::OEImageBase& image,
                                   const OEDepict::OE2DPoint& center,
                                   double radius, const OEDepict::OEPen& pen,
                                   double patternAngle = 20.0,
                                   double patternWidthRatio = 0.15)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawNecklaceCircle(image: OEImageBase, c: OE2DPoint, radius: float,
                              pen: OEPen, patternAngle: float = 20.0,
                              patternWidthRatio: float = 0.15) -> bool

   Draws a circle with the :oe:const:`OEGrapheme::OECircleStyle::Necklace` style.

   .. _figure_draw_circle_necklace:

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

      **OEDrawNecklaceCircle**

   *image*
     The image on which the circle is drawn.

   *center*
     The center of the circle.

   *radius*
     The radius of the circle.

   *pen*
     The graphical properties of the circle.

     See examples (A) and (B) in :ref:`Figure: OEDrawNecklaceCircle<figure_draw_circle_necklace>`.

   *patternAngle*
     |circle_pattern_angle|

     See example (C) in :ref:`Figure: OEDrawNecklaceCircle<figure_draw_circle_necklace>`.

   *patternWidthRatio*
     |circle_width_ratio|

     See example (D) in :ref:`Figure: OEDrawNecklaceCircle<figure_draw_circle_necklace>`.

