test(gui): add camera tests for rotation and zoom (#2206)

* test(gui): add camera tests for rotation and zoom
* fix(gui): gui test broke due to resized window
* fix(gui): cleanup camera example

closes #2162

Author: eruvanos

arcade/gui/examples/gui_and_camera.py

@@ -1,9 +1,11 @@
 """
-Arrange widgets in vertical or horizontal lines with UIBoxLayout
+This example shows how to use arcade.gui with a camera.
+It is a simple game where the player can move around and collect coins.
+The player can upgrade their speed and the spawn rate of the coins.
+The game has a timer and ends after 60 seconds.
+The game is controlled with the arrow keys or WASD.
 
-The direction UIBoxLayout follows is controlled by the `vertical` keyword
-argument. It is True by default. Pass False to it to arrange elements in
-a horizontal line.
+At the beginning of the game, the UI camera is used, to apply some animations.
 
 If arcade and Python are properly installed, you can run this example with:
 python -m arcade.gui.examples.gui_and_camera
@@ -26,7 +28,7 @@ class MyCoinGame(UIView):
     basic GUI setup. We add UIManager to the view under `self.ui`.
 
     The example showcases how to:
-    - use UIView to setup a basic GUI
+    - use UIView to set up a basic GUI
     - add a button to the view and connect it to a function
     - use camera to move the view
 
@@ -37,8 +39,8 @@ def __init__(self):
 
         # basic camera setup
         self.keys = set()
-        self.ingame_camera = arcade.Camera2D()
-        self.ingame_camera.bottom_left = 100, 100
+        self.in_game_camera = arcade.Camera2D()
+        self.in_game_camera.bottom_left = 100, 100
 
         # in-game counter
         self._total_time = 0
@@ -157,7 +159,7 @@ def upgrade_spawn_rate(event: UIOnClickEvent):
         self.cam_pos = self.ui.camera.position
 
     def on_draw_before_ui(self):
-        self.ingame_camera.use()  # use the in-game camera to draw in-game objects
+        self.in_game_camera.use()  # use the in-game camera to draw in-game objects
         self.sprites.draw()
         self.coins.draw()
 
@@ -212,7 +214,7 @@ def on_update(self, delta_time: float) -> Optional[bool]:
             self.player.top -= self._player_speed
 
         # move the camera with the player
-        self.ingame_camera.position = self.player.position
+        self.in_game_camera.position = self.player.position
 
         # collect coins
         collisions = self.player.collides_with_list(self.coins)
@@ -246,9 +248,6 @@ def on_key_press(self, symbol: int, modifiers: int) -> Optional[bool]:
             arcade.close_window()
         if symbol == arcade.key.ENTER:
             self.window.show_view(MyCoinGame())
-        if symbol == arcade.key.SPACE:
-            # Allows user to rotate camera to show off full functionality of the ui camera
-            self.ui.camera.angle += 5
 
         return False
 
@@ -259,7 +258,7 @@ def on_key_release(self, symbol: int, modifiers: int) -> Optional[bool]:
 
 
 if __name__ == "__main__":
-    window = arcade.Window(1280, 720, "CoinGame Example", resizable=True)
+    window = arcade.Window(1280, 720, "CoinGame Example", resizable=False)
     window.background_color = arcade.color.DARK_BLUE_GRAY
     window.show_view(MyCoinGame())
     window.run()

arcade/gui/view.py

@@ -21,9 +21,11 @@ def __init__(self):
         self.ui = UIManager()
 
     def on_show_view(self):
+        """If subclassing UIView, don't forget to call super().on_show_view()."""
         self.ui.enable()
 
     def on_hide_view(self):
+        """If subclassing UIView, don't forget to call super().on_hide_view()."""
         self.ui.disable()
 
     def on_draw(self):

tests/conftest.py

@@ -5,6 +5,7 @@
 
 if os.environ.get("ARCADE_PYTEST_USE_RUST"):
     import arcade_accelerate  # pyright: ignore [reportMissingImports]
+
     arcade_accelerate.bootstrap()
 
 import pytest
@@ -24,10 +25,10 @@
 OFFSCREEN = None
 
 
-def create_window(width=800, height=600, caption="Testing", **kwargs):
+def create_window(width=1280, height=720, caption="Testing", **kwargs):
     global WINDOW
     if not WINDOW:
-        WINDOW = REAL_WINDOW_CLASS(title="Testing", vsync=False, antialiasing=False)
+        WINDOW = REAL_WINDOW_CLASS(width=width, height=height, title=caption, vsync=False, antialiasing=False)
         WINDOW.set_vsync(False)
         # This value is being monkey-patched into the Window class so that tests can identify if we are using
         # arcade-accelerate easily in case they need to disable something when it is enabled.
@@ -151,7 +152,7 @@ def aspect_ratio(self):
     @property
     def mouse(self):
         return self.window.mouse
-    
+
     @property
     def keyboard(self):
         return self.window.keyboard
@@ -174,7 +175,7 @@ def current_camera(self):
     @property
     def _start_finish_render_data(self):
         return self.window._start_finish_render_data
-    
+
     @_start_finish_render_data.setter
     def _start_finish_render_data(self, data):
         self.window._start_finish_render_data = data
@@ -193,7 +194,7 @@ def flip(self):
 
     def on_draw(self):
         return self.window.on_draw()
-    
+
     def on_update(self, dt):
         return self.window.on_update(dt)
 
@@ -294,10 +295,12 @@ def window_proxy():
     arcade.Window = WindowProxy
 
     _open_window = arcade.open_window
+
     def open_window(*args, **kwargs):
         window = create_window(*args, **kwargs)
         prepare_window(window)
         return window
+
     arcade.open_window = open_window
 
     yield None
@@ -307,7 +310,6 @@ def open_window(*args, **kwargs):
 
 # --- Fixtures for offscreen rendering
 class Offscreen:
-
     def __init__(self):
         self.ctx = WINDOW.ctx
         self.texture = self.ctx.texture((1280, 720), components=4)

tests/unit/gui/test_uimanager_camera.py

@@ -1,7 +1,5 @@
 from unittest.mock import Mock
 
-import pytest
-
 import arcade
 from arcade import LBWH
 from arcade.gui import UIFlatButton
@@ -36,21 +34,29 @@ def test_ui_manager_use_positioned_camera(uimanager, window):
     assert button.on_click.called
 
 
-@pytest.mark.skip("Rotation still work in progress")
 def test_ui_manager_use_rotated_camera(uimanager, window):
     # GIVEN
-    clicked = False
-
     button = uimanager.add(UIFlatButton(text="BottomLeftButton", width=100, height=100))
-
-    @button.event("on_click")
-    def on_click(event):
-        nonlocal clicked
-        clicked = True
+    button.on_click = Mock()
 
     # WHEN
     uimanager.camera.angle = 90
-    uimanager.click(150, 150)
+    x, y = uimanager.camera.project((50, 50))
+    uimanager.click(x, y)
 
     # THEN
-    assert clicked
+    assert button.on_click.called, (uimanager.camera.project((50, 50)), window.size)
+
+
+def test_ui_manager_use_zoom_camera(uimanager, window):
+    # GIVEN
+    button = uimanager.add(UIFlatButton(text="BottomLeftButton", width=100, height=100))
+    button.on_click = Mock()
+
+    # WHEN
+    uimanager.camera.zoom = 0.9
+    x, y = uimanager.camera.project((50, 50))
+    uimanager.click(x, y)
+
+    # THEN
+    assert button.on_click.called