bluemira.geometry._pyclipper_offset
===================================

.. py:module:: bluemira.geometry._pyclipper_offset

.. autoapi-nested-parse::

   Discretised offset operations used in case of failure in primitive offsetting.



Functions
---------

.. autoapisummary::

   bluemira.geometry._pyclipper_offset.offset_clipper


Module Contents
---------------

.. py:function:: offset_clipper(coordinates: bluemira.geometry.coordinates.Coordinates, delta: float, method: str = 'square', miter_limit: float = 2.0) -> bluemira.geometry.coordinates.Coordinates

   Carries out an offset operation on the Coordinates using the ClipperLib library.
   Only supports closed Coordinates.

   :param coordinates: The Coordinates upon which to perform the offset operation
   :param delta: The value of the offset [m]. Positive for increasing size, negative for
                 decreasing
   :param method: The type of offset to perform ['square', 'round', 'miter']
   :param miter_limit: The ratio of delta to use when mitering acute corners. Only used if
                       method == 'miter'

   :rtype: The offset Coordinates result

   :raises GeometryError: If the Coordinates are not planar
       If the Coordinates are not closed
       Results in no geometry