Rename RectangularROI views

Author: gselzer

src/ndv/controllers/_array_viewer.py

@@ -22,7 +22,7 @@
     from ndv._types import MouseMoveEvent
     from ndv.models._array_display_model import ArrayDisplayModelKwargs
     from ndv.views.bases import HistogramCanvas
-    from ndv.views.bases._graphics._canvas_elements import RectangularROI
+    from ndv.views.bases._graphics._canvas_elements import RectangularROIHandle
 
     LutKey: TypeAlias = int | None
 
@@ -102,7 +102,7 @@ def __init__(
             self._canvas.frontend_widget(), self._data_model, self._viewer_model
         )
 
-        self._roi_view: RectangularROI | None = None
+        self._roi_view: RectangularROIHandle | None = None
 
         self._set_model_connected(self._data_model.display)
         self._canvas.set_ndim(self.display_model.n_visible_axes)

src/ndv/v1/_old_viewer.py

@@ -39,7 +39,7 @@
     from ndv.views.bases._graphics._canvas_elements import (
         CanvasElement,
         ImageHandle,
-        RectangularROI,
+        RectangularROIHandle,
     )
 
     DimKey = int
@@ -166,7 +166,7 @@ def __init__(
         # Canvas selection
         self._selection: CanvasElement | None = None
         # ROI
-        self._roi: RectangularROI | None = None
+        self._roi: RectangularROIHandle | None = None
 
         # WIDGETS ----------------------------------------------------
 
@@ -764,9 +764,10 @@ def _update_cursor(self, event: QMouseEvent) -> bool:
             self._qcanvas.setCursor(Qt.CursorShape.CrossCursor)
             return False
         # If any local elements have a preference, use it
+        mme = MouseMoveEvent(event.pos().x(), event.pos().y())
         pos = (event.pos().x(), event.pos().y())
         for e in self._canvas.elements_at(pos):
-            if (pref := e.get_cursor(pos)) is not None:
+            if (pref := e.get_cursor(mme)) is not None:
                 self._qcanvas.setCursor(pref.to_qt())
                 return False
         # Otherwise, normal cursor

src/ndv/views/_pygfx/_array_canvas.py

@@ -20,7 +20,7 @@
 from ndv.models._viewer_model import ArrayViewerModel, InteractionMode
 from ndv.views._app import filter_mouse_events
 from ndv.views.bases import ArrayCanvas, CanvasElement, ImageHandle
-from ndv.views.bases._graphics._canvas_elements import RectangularROI, ROIMoveMode
+from ndv.views.bases._graphics._canvas_elements import RectangularROIHandle, ROIMoveMode
 
 if TYPE_CHECKING:
     from collections.abc import Sequence
@@ -110,7 +110,7 @@ def get_cursor(self, mme: MouseMoveEvent) -> CursorType | None:
         return None
 
 
-class PyGFXBoundingBox(RectangularROI):
+class PyGFXRectangle(RectangularROIHandle):
     def __init__(
         self,
         render: Callable,
@@ -407,8 +407,8 @@ def __init__(self, viewer_model: ArrayViewerModel) -> None:
 
         self._elements = WeakKeyDictionary[pygfx.WorldObject, CanvasElement]()
         self._selection: CanvasElement | None = None
-        # TODO: Weak Reference?
-        self._last_roi_created: ReferenceType[PyGFXBoundingBox] | None = None
+        # Maintain a weak reference to the last ROI created.
+        self._last_roi_created: ReferenceType[PyGFXRectangle] | None = None
 
     def frontend_widget(self) -> Any:
         return self._canvas
@@ -504,9 +504,9 @@ def add_volume(self, data: np.ndarray | None = None) -> PyGFXImageHandle:
         self._elements[vol] = handle
         return handle
 
-    def add_bounding_box(self) -> PyGFXBoundingBox:
+    def add_bounding_box(self) -> PyGFXRectangle:
         """Add a new Rectangular ROI node to the scene."""
-        roi = PyGFXBoundingBox(
+        roi = PyGFXRectangle(
             render=self.refresh,
             canvas_to_world=self.canvas_to_world,
             parent=self._scene,

src/ndv/views/_qt/_array_view.py

@@ -38,7 +38,10 @@
 
     from ndv._types import AxisKey
     from ndv.models._data_display_model import _ArrayDataDisplayModel
-    from ndv.views.bases._graphics._canvas_elements import CanvasElement, RectangularROI
+    from ndv.views.bases._graphics._canvas_elements import (
+        CanvasElement,
+        RectangularROIHandle,
+    )
 
 SLIDER_STYLE = """
 QSlider::groove:horizontal {
@@ -346,7 +349,7 @@ def __init__(self, canvas_widget: QWidget, parent: QWidget | None = None):
         self.histogram_btn = QPushButton(add_histogram_icon, "", self)
 
         # button to draw ROIs
-        self._roi_handle: RectangularROI | None = None
+        self._roi_handle: RectangularROIHandle | None = None
         self._selection: CanvasElement | None = None
         self.add_roi_btn = ROIButton()
 

src/ndv/views/_vispy/_array_canvas.py

@@ -28,7 +28,7 @@
 from ndv.views.bases._graphics._canvas_elements import (
     CanvasElement,
     ImageHandle,
-    RectangularROI,
+    RectangularROIHandle,
     ROIMoveMode,
 )
 
@@ -116,7 +116,7 @@ def get_cursor(self, mme: MouseMoveEvent) -> CursorType | None:
         return None
 
 
-class VispyBoundingBox(RectangularROI):
+class VispyRectangle(RectangularROIHandle):
     def __init__(self, parent: Any) -> None:
         self._selected = False
         self._move_mode: ROIMoveMode | None = None
@@ -307,8 +307,8 @@ def __init__(self, viewer_model: ArrayViewerModel) -> None:
 
         self._elements: WeakKeyDictionary = WeakKeyDictionary()
         self._selection: CanvasElement | None = None
-        # TODO: Weak Reference?
-        self._last_roi_created: ReferenceType[VispyBoundingBox] | None = None
+        # Maintain weak reference to last ROI created
+        self._last_roi_created: ReferenceType[VispyRectangle] | None = None
 
     @property
     def _camera(self) -> vispy.scene.cameras.BaseCamera:
@@ -389,9 +389,9 @@ def add_volume(self, data: np.ndarray | None = None) -> VispyImageHandle:
             self.set_range()
         return handle
 
-    def add_bounding_box(self) -> VispyBoundingBox:
+    def add_bounding_box(self) -> VispyRectangle:
         """Add a new Rectangular ROI node to the scene."""
-        roi = VispyBoundingBox(parent=self._view.scene)
+        roi = VispyRectangle(parent=self._view.scene)
         roi.set_visible(False)
         self._elements[roi._handles] = roi
         self._elements[roi._rect] = roi
@@ -423,7 +423,7 @@ def set_range(
                 _y[1] = max(_y[1], shape[1])
                 if len(shape) > 2:
                     _z[1] = max(_z[1], shape[2])
-            elif isinstance(handle, VispyBoundingBox):
+            elif isinstance(handle, VispyRectangle):
                 for v in handle.vertices:
                     _x[0] = min(_x[0], v[0])
                     _x[1] = max(_x[1], v[0])

src/ndv/views/bases/__init__.py

@@ -3,7 +3,7 @@
 from ._app import NDVApp
 from ._array_view import ArrayView
 from ._graphics._canvas import ArrayCanvas, HistogramCanvas
-from ._graphics._canvas_elements import CanvasElement, ImageHandle, RectangularROI
+from ._graphics._canvas_elements import CanvasElement, ImageHandle, RectangularROIHandle
 from ._graphics._mouseable import Mouseable
 from ._lut_view import LutView
 from ._view_base import Viewable
@@ -17,6 +17,6 @@
     "LutView",
     "Mouseable",
     "NDVApp",
-    "RectangularROI",
+    "RectangularROIHandle",
     "Viewable",
 ]

src/ndv/views/bases/_graphics/__init__.py

@@ -1,7 +1,7 @@
 """Base classes for graphics elements."""
 
 from ._canvas import ArrayCanvas, HistogramCanvas
-from ._canvas_elements import CanvasElement, ImageHandle, RectangularROI
+from ._canvas_elements import CanvasElement, ImageHandle, RectangularROIHandle
 from ._mouseable import Mouseable
 
 __all__ = [
@@ -10,5 +10,5 @@
     "HistogramCanvas",
     "ImageHandle",
     "Mouseable",
-    "RectangularROI",
+    "RectangularROIHandle",
 ]

src/ndv/views/bases/_graphics/_canvas.py

@@ -15,7 +15,7 @@
 
     from ndv.models._viewer_model import ArrayViewerModel
 
-    from ._canvas_elements import CanvasElement, ImageHandle, RectangularROI
+    from ._canvas_elements import CanvasElement, ImageHandle, RectangularROIHandle
 
 
 class GraphicsCanvas(Viewable, Mouseable):
@@ -57,7 +57,7 @@ def add_image(self, data: np.ndarray | None = ...) -> ImageHandle: ...
     @abstractmethod
     def add_volume(self, data: np.ndarray | None = ...) -> ImageHandle: ...
     @abstractmethod
-    def add_bounding_box(self) -> RectangularROI: ...
+    def add_bounding_box(self) -> RectangularROIHandle: ...
 
 
 class HistogramCanvas(GraphicsCanvas, LutView):

src/ndv/views/bases/_graphics/_canvas_elements.py

@@ -66,7 +66,7 @@ class ROIMoveMode(Enum):
     TRANSLATE = auto()  # Translating everything
 
 
-class RectangularROI(CanvasElement):
+class RectangularROIHandle(CanvasElement):
     """An axis-aligned rectanglular ROI."""
 
     boundingBoxChanged = Signal(tuple[tuple[float, float], tuple[float, float]])