Renamed FreeFormTool to PolygonTool

Author: PierreRaybaut

doc/features/tools/reference.rst

@@ -58,7 +58,7 @@ Shape tools
 
 .. autoclass:: plotpy.tools.MultiLineTool
    :members:
-.. autoclass:: plotpy.tools.FreeFormTool
+.. autoclass:: plotpy.tools.PolygonTool
    :members:
 .. autoclass:: plotpy.tools.LabelTool
    :members:

plotpy/data/icons/shapes/freeform.png plotpy/data/icons/shapes/polygon.pngplotpy/data/icons/shapes/freeform.png renamed to plotpy/data/icons/shapes/polygon.png

@@ -71,7 +71,7 @@ def __init__(
         self.points = np.zeros((0, 2), float)
         if points is not None:
             self.set_points(points)
-        self.setIcon(get_icon("freeform.png"))
+        self.setIcon(get_icon("polygon.png"))
 
     def types(self) -> tuple[type[IItemType], ...]:
         """Returns a group or category for this item.

plotpy/items/shape/polygon.py

@@ -21,11 +21,11 @@
     AnnotatedSegmentTool,
     CircleTool,
     EllipseTool,
-    FreeFormTool,
     LabelTool,
     MultiLineTool,
     ObliqueRectangleTool,
     PlaceAxesTool,
+    PolygonTool,
     RectangleTool,
     SegmentTool,
 )
@@ -41,7 +41,7 @@ def create_window():
         CircleTool,
         EllipseTool,
         MultiLineTool,
-        FreeFormTool,
+        PolygonTool,
         PlaceAxesTool,
         AnnotatedRectangleTool,
         AnnotatedObliqueRectangleTool,

plotpy/tests/features/test_autoscale_shapes.py

@@ -12,7 +12,7 @@
 
 from plotpy.builder import make
 from plotpy.tests import get_path
-from plotpy.tools import EllipseTool, FreeFormTool, PlaceAxesTool, RectangleTool
+from plotpy.tools import EllipseTool, PlaceAxesTool, PolygonTool, RectangleTool
 
 
 def create_window():
@@ -26,7 +26,7 @@ def create_window():
         type="image",
         size=(800, 600),
     )
-    for toolklass in (RectangleTool, EllipseTool, FreeFormTool, PlaceAxesTool):
+    for toolklass in (RectangleTool, EllipseTool, PolygonTool, PlaceAxesTool):
         win.manager.add_tool(toolklass)
     return win
 

plotpy/tests/features/test_imagesuperp.py

@@ -15,8 +15,8 @@
 from plotpy.tests import get_path
 from plotpy.tools import (
     EllipseTool,
-    FreeFormTool,
     MultiLineTool,
+    PolygonTool,
     RectangleTool,
     SegmentTool,
 )
@@ -50,7 +50,7 @@ def create_window():
         EllipseTool,
         SegmentTool,
         MultiLineTool,
-        FreeFormTool,
+        PolygonTool,
     ):
         win.manager.add_tool(toolklass, handle_final_shape_cb=customize_shape)
     return win

plotpy/tests/tools/test_customize_shape_tool.py

@@ -8,6 +8,7 @@
 # guitest: show
 
 from guidata.qthelpers import qt_app_context
+from qtpy import QtWidgets as QW
 
 from plotpy.builder import make
 from plotpy.items import Marker
@@ -21,19 +22,21 @@
     AnnotatedSegmentTool,
     CircleTool,
     EllipseTool,
-    FreeFormTool,
     HCursorTool,
     HRangeTool,
     LabelTool,
     MultiLineTool,
     ObliqueRectangleTool,
     PlaceAxesTool,
+    PolygonTool,
     RectangleTool,
     SegmentTool,
     VCursorTool,
     XCursorTool,
 )
 
+TOOLBAR_ID = "toolbar2"
+
 
 def create_window():
     win = make.dialog(
@@ -43,6 +46,10 @@ def create_window():
         type="image",
         size=(800, 600),
     )
+    toolbar2 = QW.QToolBar()
+    win.layout().addWidget(toolbar2)
+    win.manager.add_toolbar(toolbar2, TOOLBAR_ID)
+
     for toolklass in (
         LabelTool,
         HRangeTool,
@@ -55,7 +62,7 @@ def create_window():
         CircleTool,
         EllipseTool,
         MultiLineTool,
-        FreeFormTool,
+        PolygonTool,
         PlaceAxesTool,
         AnnotatedRectangleTool,
         AnnotatedObliqueRectangleTool,
@@ -64,7 +71,7 @@ def create_window():
         AnnotatedSegmentTool,
         AnnotatedPointTool,
     ):
-        win.manager.add_tool(toolklass)
+        win.manager.add_tool(toolklass, toolbar_id=TOOLBAR_ID)
     return win
 
 

plotpy/tests/tools/test_image_plot_tools.py

@@ -11,14 +11,14 @@
     keyboard_event,
     mouse_event_at_relative_plot_pos,
 )
-from plotpy.tools import FreeFormTool, MultiLineTool
+from plotpy.tools import MultiLineTool, PolygonTool
 
 
 def test_free_form_tool():
     """Test the free form tool."""
     corners = np.array(((0.1, 0.1), (0.1, 0.8), (0.8, 0.8), (0.8, 0.1)))
     with qt_app_context(exec_loop=False):
-        win, tool = create_window(FreeFormTool)
+        win, tool = create_window(PolygonTool)
 
         # drag_mouse(win, x_path, y_path)
         for x, y in corners:

plotpy/tests/unit/test_multiline_tools.py

@@ -88,7 +88,7 @@
 from .shape import (
     CircleTool,
     EllipseTool,
-    FreeFormTool,
+    PolygonTool,
     MultiLineTool,
     ObliqueRectangleTool,
     PointTool,

plotpy/tools/__init__.py

@@ -7,6 +7,8 @@
 
 from __future__ import annotations
 
+from typing import TYPE_CHECKING
+
 from guidata.configtools import get_icon
 from guidata.qthelpers import add_actions, add_separator
 from qtpy import QtCore as QC
@@ -17,7 +19,6 @@
 from plotpy.events import ZoomRectHandler, setup_standard_tool_filter
 from plotpy.interfaces import IImageItemType, IShapeItemType
 from plotpy.items import RectangleShape, get_items_in_rectangle
-from plotpy.plot import BasePlot, PlotManager
 from plotpy.tools.base import (
     CommandTool,
     DefaultToolbarID,
@@ -26,6 +27,9 @@
     RectangularActionTool,
 )
 
+if TYPE_CHECKING:
+    from plotpy.plot import BasePlot, PlotManager
+
 
 class DoAutoscaleTool(CommandTool):
     """A tool to perform autoscale for associated plot."""