plotPolygon

pyslm.visualise.plotPolygon(polygons, zPos=0.0, lineColor='k', lineWidth=0.7, fillColor='r', plot3D=False, plotFilled=False, handle=None)

A helper method for visualising polygons

Note

Method cannot deal with complex polygon i.e. those with interiors due to limitation with Matplotlib

This function can interpret a variety of different polygon formats used throughout the library, including those from Shapely, and those from coordinates generated by ClipperLib.

Parameters:

  • polygons (List[Any]) – A list of polygons

  • zPos (Optional[float]) – The z position of the polygons if plot3D is enabled

  • lineColor (Optional[Any]) – Line color used for matplotlib (optional)

  • lineWidth (Optional[float]) – Line width used for matplotlib (optional)

  • fillColor (Optional[Any]) – Fill color for the polygon if plotFilled is enabled (optional)

  • plot3D (Optional[bool]) – Plot the polygons in 3D

  • plotFilled (Optional[bool]) – Plot filled

  • handle (Optional[Tuple[Figure, Axes]]) – A previous matplotlib (Figure, Axis) object

Return type:

Tuple[Figure, Axes]

Returns:

A tuple with the matplotlib (Figure, Axis)