Added PlotBuilder.polygon

Author: PierreRaybaut

plotpy/builder.py

@@ -45,6 +45,7 @@
     Marker,
     MaskedImageItem,
     MaskedXYImageItem,
+    PolygonShape,
     QuadGridItem,
     RangeComputation,
     RangeComputation2d,
@@ -2279,6 +2280,27 @@ def ellipse(
             item.set_ydiameter(x2, y2, x3, y3)
         return item
 
+    def polygon(
+        self, x: np.ndarray, y: np.ndarray, closed: bool, title: str | None = None
+    ) -> PolygonShape:
+        """Make a polygon shape `plot item`
+
+        Args:
+            x: polygon x coordinates
+            y: polygon y coordinates
+            closed: closed polygon
+            title: label name. Default is None
+
+        Returns:
+            :py:class:`.PolygonShape` object
+        """
+        points = np.array([x, y]).T
+        item = PolygonShape(points, closed=closed)
+        item.set_style("plot", "shape/drag")
+        if title is not None:
+            item.setTitle(title)
+        return item
+
     def circle(
         self, x0: float, y0: float, x1: float, y1: float, title: str | None = None
     ) -> EllipseShape:

plotpy/tests/gui/test_autoscale_shapes.py

@@ -10,9 +10,10 @@
 import numpy as np
 from guidata.qthelpers import qt_app_context
 
-from plotpy.items import AnnotatedRectangle, EllipseShape, PolygonShape
+from plotpy.builder import make
+from plotpy.items import PolygonShape
 from plotpy.plot import PlotDialog
-from plotpy.styles import AnnotationParam, ShapeParam
+from plotpy.styles import ShapeParam
 from plotpy.tools import (
     AnnotatedCircleTool,
     AnnotatedEllipseTool,
@@ -64,30 +65,22 @@ def test_autoscale_shapes():
         win.manager.get_itemlist_panel().show()
 
         # Add a polygon
-        delta = 0.025
-        x = np.arange(-3.0, 3.0, delta)
-        param = ShapeParam()
-        param.label = "Polygon"
-        crv = PolygonShape(closed=False, shapeparam=param)
-        crv.set_points(np.column_stack((x, np.sin(x))))
+        x = np.arange(-3.0, 3.0, 0.2)
+        crv = make.polygon(x, np.sin(x), False, "Polygon")
         plot.add_item(crv)
 
         # Add a circle
-        param = ShapeParam()
-        param.label = "Circle"
-        circle = EllipseShape(-1, 2, shapeparam=param)
+        circle = make.circle(-1, 2, 0, 0, "Circle")
         plot.add_item(circle)
 
         # Add an annotated rectangle
-        param = AnnotationParam()
-        param.title = "Annotated rectangle"
-        rect = AnnotatedRectangle(2.5, 1, 4, 1.2, annotationparam=param)
+        rect = make.annotated_rectangle(2.5, 1, 4, 1.2, "Annotated rectangle")
         plot.add_item(rect)
 
         # Add an annotated rectangle excluded
-        param = AnnotationParam()
-        param.title = "Annotated rectangle excluded from autoscale"
-        rect = AnnotatedRectangle(1.0, 2.0, 5, 10, annotationparam=param)
+        rect = make.annotated_rectangle(
+            1.0, 2.0, 5, 10, "Annotated rectangle excluded from autoscale"
+        )
         plot.add_item(rect)
 
         plot.add_autoscale_excludes([rect])