mouse motion support

labyrinths/ui/mainwindow.py

@@ -7,6 +7,7 @@
 import sys
 import weakref
 from abc import abstractmethod
+from typing import Any, Callable
 
 import pygame
 
@@ -70,7 +71,10 @@ def close(self):
         if self.parent:
             self.parent.children.remove(self)
 
-    def on_mouse_left_click(self) -> None:
+    def on_mouse_left_button_down(self) -> None:
+        pass
+
+    def on_mouse_left_button_up(self) -> None:
         pass
 
     def on_mouse_hover(self) -> None:
@@ -79,7 +83,13 @@ def on_mouse_hover(self) -> None:
     def on_mouse_hover_end(self) -> None:
         pass
 
-    def on_mouse_right_click(self) -> None:
+    def on_mouse_right_button_down(self) -> None:
+        pass
+
+    def on_mouse_right_button_up(self) -> None:
+        pass
+
+    def on_mouse_motion(self, dx: int, dy: int) -> None:
         pass
 
     def get_widget_at(self, x: int, y: int) -> weakref.ref[Widget] | None:
@@ -118,23 +128,14 @@ def render(self) -> None:
         """Render everything."""
         self.root_widget.render_self_and_children(self.screen, (0, 0))
 
-    def on_mouse_left_click(self, x: int, y: int) -> None:
-        ref = self.root_widget.get_widget_at(x, y)
-        if ref is None:
-            return
-        result = ref()
-        if result is None:
-            return
-        result.on_mouse_left_click()
-
-    def on_mouse_right_click(self, x: int, y: int) -> None:
+    def widget_action(self, x: int, y: int, action: Callable, *args, **kwargs) -> None:
         ref = self.root_widget.get_widget_at(x, y)
         if ref is None:
             return
         result = ref()
         if result is None:
             return
-        result.on_mouse_right_click()
+        action(result, *args, **kwargs)
 
     def on_mouse_hover(self, x: int, y: int) -> None:
         result = self.root_widget.get_widget_at(x, y)
@@ -149,6 +150,21 @@ def on_mouse_hover(self, x: int, y: int) -> None:
                     widget.on_mouse_hover()
             self.hovered_widget = result
 
+    def on_mouse_left_button_down(self, x: int, y: int) -> None:
+        self.widget_action(x, y, lambda this: this.on_mouse_left_button_down())
+
+    def on_mouse_right_button_down(self, x: int, y: int) -> None:
+        self.widget_action(x, y, lambda this: this.on_mouse_right_button_down())
+
+    def on_mouse_left_button_up(self, x: int, y: int) -> None:
+        self.widget_action(x, y, lambda this: this.on_mouse_left_button_up())
+
+    def on_mouse_right_button_up(self, x: int, y: int) -> None:
+        self.widget_action(x, y, lambda this: this.on_mouse_right_button_up())
+
+    def on_mouse_motion(self, x: int, y: int, dx: int, dy: int) -> None:
+        self.widget_action(x, y, lambda this, dx2, dy2: this.on_mouse_motion(dx2, dy2), dx, dy)
+
     def run(self) -> None:
         """Run the event loop."""
 
@@ -166,11 +182,17 @@ def run(self) -> None:
                         self.root_widget.on_keyup_propagate(event.key)
                     case pygame.MOUSEBUTTONDOWN:
                         if event.button == 1:
-                            self.on_mouse_left_click(*event.pos)
+                            self.on_mouse_left_button_down(*event.pos)
+                        elif event.button == 2:
+                            self.on_mouse_right_button_down(*event.pos)
+                    case pygame.MOUSEBUTTONUP:
+                        if event.button == 1:
+                            self.on_mouse_left_button_up(*event.pos)
                         elif event.button == 2:
-                            self.on_mouse_right_click(*event.pos)
+                            self.on_mouse_right_button_up(*event.pos)
                     case pygame.MOUSEMOTION:
                         self.on_mouse_hover(*event.pos)
+                        self.on_mouse_motion(*event.pos, *event.rel)
             self.render()
             pygame.display.flip()
 

labyrinths/ui/widgets/button.py

@@ -28,7 +28,7 @@ def __init__(
         self.normal_color = color
         self.hovered_color = hovered_color
 
-    def on_mouse_left_click(self) -> None:
+    def on_mouse_left_button_down(self) -> None:
         self.onclick()
 
     def on_mouse_hover(self) -> None:

labyrinths/ui/widgets/mazewindow.py

@@ -27,28 +27,29 @@ def __init__(self, parent: Widget, width: int, height: int, x: int, y: int) -> N
         self.current_maze: MazeData | None = None
         self.maze_viewport = (-self.cellsize * 3, -self.cellsize * 3)
         self.solution: Solution | None = None
-
         self.generators = [
             (KruskalGenerator, "Kruskal MST"),
             (DepthFirstSearchGenerator, "DFS"),
         ]
         self.gen_id = 0
 
+        self.mouse_pressed = False
+
         self.help_widget = TextLabel(
             self,
-            300,
-            300,
+            400,
+            200,
             30,
             30,
             # fmt: off
             text=("Use arrow keys to move.\n"
-                  "WASD to look around.\n"
+                  "WASD or left-click&drag to look around.\n"
                   "By default, mazes\n"
-                  "are saved into\n"
+                  "are saved to\n"
                   "maze.json.gz"),
             # fmt: on
         )
-        self.help_widget.hide()
+        # self.help_widget.hide()
 
         Button(self, 100, 30, 0, self.height - 30, onclick=self.new_maze, text="new maze")
         self.next_gen_button = Button(self, 120, 30, 0, self.height - 60, onclick=self.next_gen, text="")
@@ -57,7 +58,7 @@ def __init__(self, parent: Widget, width: int, height: int, x: int, y: int) -> N
         Button(self, 30, 30, self.width - 60, 0, onclick=self.scale_down, text="-")
         Button(self, 60, 30, self.width - 60, self.height // 2, onclick=self.save_maze, text="save")
         Button(self, 60, 30, self.width - 60, self.height // 2 - 30, onclick=self.load_maze, text="load")
-        Button(self, 30, 30, 0, 0, onclick=self.toggle_help, text="?")
+        self.help_button = Button(self, 30, 30, 0, 0, onclick=self.toggle_help, text="x")
 
         self.next_gen()
 
@@ -72,7 +73,12 @@ def next_gen(self):
 
     def toggle_help(self):
         """Show/hide help message."""
-        self.help_widget.toggle()
+        if self.help_widget.hidden:
+            self.help_widget.show()
+            self.help_button.text = "x"
+        else:
+            self.help_widget.hide()
+            self.help_button.text = "?"
 
     def new_maze(self) -> None:
         """Generate new maze."""
@@ -165,6 +171,17 @@ def on_keydown(self, key: int) -> None:
             case pygame.K_RIGHT:
                 self.try_move_player(1, 0)
 
+    def on_mouse_left_button_down(self) -> None:
+        self.mouse_pressed = True
+
+    def on_mouse_left_button_up(self) -> None:
+        self.mouse_pressed = False
+
+    def on_mouse_motion(self, dx: int, dy: int) -> None:
+        if self.mouse_pressed:
+            x, y = self.maze_viewport
+            self.maze_viewport = x - dx, y - dy
+
     def draw_maze(self) -> None:
         maze = self.current_maze
         assert maze is not None

test/test_ui.py

@@ -50,27 +50,27 @@ def test_keyup(mocker, pygame_headless) -> None:
 def test_mouse_click(mocker, pygame_headless) -> None:
     mainwindow = MainWindow(800, 600)
     widget = EmptyWidget(mainwindow.root_widget, 30, 40, 10, 20)
-    spy = mocker.spy(widget, "on_mouse_left_click")
+    spy = mocker.spy(widget, "on_mouse_left_button_down")
 
-    mainwindow.on_mouse_left_click(9, 19)
+    mainwindow.on_mouse_left_button_down(9, 19)
     assert spy.call_count == 0
 
-    mainwindow.on_mouse_left_click(10, 20)
+    mainwindow.on_mouse_left_button_down(10, 20)
     assert spy.call_count == 1
 
-    mainwindow.on_mouse_left_click(20, 30)
+    mainwindow.on_mouse_left_button_down(20, 30)
     assert spy.call_count == 2
 
-    mainwindow.on_mouse_left_click(0, 80)
+    mainwindow.on_mouse_left_button_down(0, 80)
     assert spy.call_count == 2
 
-    mainwindow.on_mouse_left_click(90, 0)
+    mainwindow.on_mouse_left_button_down(90, 0)
     assert spy.call_count == 2
 
-    mainwindow.on_mouse_left_click(40, 50)
+    mainwindow.on_mouse_left_button_down(40, 50)
     assert spy.call_count == 2
 
-    mainwindow.on_mouse_left_click(30, 60)
+    mainwindow.on_mouse_left_button_down(30, 60)
     assert spy.call_count == 2
 
 

test/test_ui_button.py

@@ -19,22 +19,22 @@ def test_button_click(pygame_headless) -> None:
     mainwindow = MainWindow(800, 600)
     Button(mainwindow.root_widget, 40, 40, 80, 80, callback)
 
-    mainwindow.on_mouse_left_click(80, 80)
+    mainwindow.on_mouse_left_button_down(80, 80)
     assert callback.call_count == 1
 
-    mainwindow.on_mouse_left_click(120, 100)
+    mainwindow.on_mouse_left_button_down(120, 100)
     assert callback.call_count == 1
 
-    mainwindow.on_mouse_left_click(100, 120)
+    mainwindow.on_mouse_left_button_down(100, 120)
     assert callback.call_count == 1
 
-    mainwindow.on_mouse_left_click(100, 100)
+    mainwindow.on_mouse_left_button_down(100, 100)
     assert callback.call_count == 2
 
-    mainwindow.on_mouse_left_click(100, 20)
+    mainwindow.on_mouse_left_button_down(100, 20)
     assert callback.call_count == 2
 
-    mainwindow.on_mouse_left_click(20, 100)
+    mainwindow.on_mouse_left_button_down(20, 100)
     assert callback.call_count == 2
 
 
@@ -59,14 +59,14 @@ def call_counts():
     # 55..65
     Button(mainwindow.root_widget, 10, 10, 55, 55, callback3)
 
-    mainwindow.on_mouse_left_click(60, 60)
+    mainwindow.on_mouse_left_button_down(60, 60)
     assert call_counts() == (0, 0, 1)
 
-    mainwindow.on_mouse_left_click(50, 50)
+    mainwindow.on_mouse_left_button_down(50, 50)
     assert call_counts() == (0, 1, 1)
 
-    mainwindow.on_mouse_left_click(67, 67)
+    mainwindow.on_mouse_left_button_down(67, 67)
     assert call_counts() == (0, 2, 1)
 
-    mainwindow.on_mouse_left_click(45, 45)
+    mainwindow.on_mouse_left_button_down(45, 45)
     assert call_counts() == (1, 2, 1)