experimental controller support incl inventory example

Author: eruvanos

arcade/examples/gui/exp_controller_support.py

@@ -14,48 +14,107 @@
 )
 from arcade.gui.experimental.controller import (
     UIControllerBridge,
+    UIControllerButtonEvent,
     UIControllerButtonPressEvent,
     UIControllerDpadEvent,
-    UIFocusGroup,
+    UIControllerEvent,
+    UIControllerStickEvent,
+    UIControllerTriggerEvent,
 )
+from arcade.gui.experimental.focus import UIFocusGroup
+from arcade.types import Color
 
 
 class ControllerIndicator(UIAnchorLayout):
+    """
+    A widget that displays the last controller input.
+    """
+
     BLANK_TEX = Texture.create_empty("empty", (40, 40), arcade.color.TRANSPARENT_BLACK)
+    TEXTURE_CACHE = {}
 
     def __init__(self):
         super().__init__()
 
         self._indicator = self.add(UIImage(texture=self.BLANK_TEX), anchor_y="bottom", align_y=10)
+        self._indicator.with_background(color=Color(0, 0, 0, 0))
+        self._indicator._strong_background = True
+
+    @classmethod
+    def get_texture(cls, path: str) -> Texture:
+        if path not in cls.TEXTURE_CACHE:
+            cls.TEXTURE_CACHE[path] = arcade.load_texture(path)
+        return cls.TEXTURE_CACHE[path]
+
+    @classmethod
+    def input_prompts(cls, event: UIControllerEvent) -> Texture | None:
+        if isinstance(event, UIControllerButtonEvent):
+            match event.button:
+                case "a":
+                    return cls.get_texture(":resources:input_prompt/xbox/xbox_button_a.png")
+                case "b":
+                    return cls.get_texture(":resources:input_prompt/xbox/xbox_button_b.png")
+                case "x":
+                    return cls.get_texture(":resources:input_prompt/xbox/xbox_button_x.png")
+                case "y":
+                    return cls.get_texture(":resources:input_prompt/xbox/xbox_button_y.png")
+                case "rightshoulder":
+                    return cls.get_texture(":resources:input_prompt/xbox/xbox_rb.png")
+                case "leftshoulder":
+                    return cls.get_texture(":resources:input_prompt/xbox/xbox_lb.png")
+                case "start":
+                    return cls.get_texture(":resources:input_prompt/xbox/xbox_button_start.png")
+                case "back":
+                    return cls.get_texture(":resources:input_prompt/xbox/xbox_button_back.png")
+
+        if isinstance(event, UIControllerTriggerEvent):
+            match event.name:
+                case "lefttrigger":
+                    return cls.get_texture(":resources:input_prompt/xbox/xbox_lt.png")
+                case "righttrigger":
+                    return cls.get_texture(":resources:input_prompt/xbox/xbox_rt.png")
+
+        if isinstance(event, UIControllerDpadEvent):
+            match event.vector:
+                case (1, 0):
+                    return cls.get_texture(":resources:input_prompt/xbox/xbox_dpad_right.png")
+                case (-1, 0):
+                    return cls.get_texture(":resources:input_prompt/xbox/xbox_dpad_left.png")
+                case (0, 1):
+                    return cls.get_texture(":resources:input_prompt/xbox/xbox_dpad_up.png")
+                case (0, -1):
+                    return cls.get_texture(":resources:input_prompt/xbox/xbox_dpad_down.png")
+
+        if isinstance(event, UIControllerStickEvent) and event.vector.length() > 0.2:
+            stick = "l" if event.name == "leftstick" else "r"
+
+            # map atan2(y, x) to direction string (up, down, left, right)
+            heading = event.vector.heading()
+            if 0.785 > heading > -0.785:
+                return cls.get_texture(f":resources:input_prompt/xbox/xbox_stick_{stick}_right.png")
+            elif 0.785 < heading < 2.356:
+                return cls.get_texture(f":resources:input_prompt/xbox/xbox_stick_{stick}_up.png")
+            elif heading > 2.356 or heading < -2.356:
+                return cls.get_texture(f":resources:input_prompt/xbox/xbox_stick_{stick}_left.png")
+            elif -2.356 < heading < -0.785:
+                return cls.get_texture(f":resources:input_prompt/xbox/xbox_stick_{stick}_down.png")
+
+        return None
 
     def on_event(self, event: UIEvent) -> Optional[bool]:
-        if isinstance(event, UIControllerButtonPressEvent):
-            self._indicator.texture = arcade.load_texture(
-                f":resources:onscreen_controls/flat_dark/{event.button}.png"
-            )
-            arcade.unschedule(self.reset)
-            arcade.schedule_once(self.reset, 0.5)
-        elif isinstance(event, UIControllerDpadEvent):
-            tex_map = {
-                (1, 0): "right",
-                (-1, 0): "left",
-                (0, 1): "up",
-                (0, -1): "down",
-            }
-
-            if event.vector in tex_map:
-                self._indicator.texture = arcade.load_texture(
-                    f":resources:onscreen_controls/flat_dark/{tex_map[event.vector]}.png"
-                )
+        if isinstance(event, UIControllerEvent):
+            input_texture = self.input_prompts(event)
+
+            if input_texture:
+                self._indicator.texture = input_texture
+
                 arcade.unschedule(self.reset)
                 arcade.schedule_once(self.reset, 0.5)
 
         return super().on_event(event)
 
     def reset(self, *_):
-        print("Reset")
         self._indicator.texture = self.BLANK_TEX
-        self.trigger_full_render()
 
 
 class ControllerModal(UIMouseFilterMixin, UIFocusGroup):

arcade/examples/gui/exp_controller_support_grid.py

@@ -0,0 +1,88 @@
+from typing import Dict, Tuple
+
+import arcade
+from arcade.examples.gui.exp_controller_support import ControllerIndicator
+from arcade.gui import (
+    UIFlatButton,
+    UIGridLayout,
+    UIView,
+)
+from arcade.gui.experimental.controller import (
+    UIControllerBridge,
+)
+from arcade.gui.experimental.focus import Focusable, UIFocusGroup
+
+
+class FocusableButton(Focusable, UIFlatButton):
+    pass
+
+
+def setup_grid_focus_transition(grid: Dict[Tuple[int, int], Focusable]):
+    """Setup focus transition in grid.
+
+    Connect focus transition between `Focusable` in grid.
+
+    Args:
+        grid: Dict[Tuple[int, int], Focusable]: grid of Focusable widgets.
+        key represents position in grid (x,y)
+
+    """
+
+    cols = max(x for x, y in grid.keys()) + 1
+    rows = max(y for x, y in grid.keys()) + 1
+    for c in range(cols):
+        for r in range(rows):
+            btn = grid.get((c, r))
+            if btn is None or not isinstance(btn, Focusable):
+                continue
+
+            if c > 0:
+                btn.neighbor_left = grid.get((c - 1, r))
+            else:
+                btn.neighbor_left = grid.get((cols - 1, r))
+
+            if c < cols - 1:
+                btn.neighbor_right = grid.get((c + 1, r))
+            else:
+                btn.neighbor_right = grid.get((0, r))
+
+            if r > 0:
+                btn.neighbor_up = grid.get((c, r - 1))
+            else:
+                btn.neighbor_up = grid.get((c, rows - 1))
+
+            if r < rows - 1:
+                btn.neighbor_down = grid.get((c, r + 1))
+            else:
+                btn.neighbor_down = grid.get((c, 0))
+
+
+class MyView(UIView):
+    def __init__(self):
+        super().__init__()
+        arcade.set_background_color(arcade.color.AMAZON)
+
+        self.controller_bridge = UIControllerBridge(self.ui)
+
+        self.root = self.add_widget(ControllerIndicator())
+        self.root = self.root.add(UIFocusGroup())
+        grid = self.root.add(
+            UIGridLayout(column_count=3, row_count=3, vertical_spacing=10, horizontal_spacing=10)
+        )
+
+        _grid = {}
+        for i in range(9):
+            btn = FocusableButton(text=f"Button {i}")
+            _grid[(i % 3, i // 3)] = btn
+            grid.add(btn, column=i % 3, row=i // 3)
+
+        # connect focus transition in grid
+        setup_grid_focus_transition(_grid)
+
+        self.root.detect_focusable_widgets()
+
+
+if __name__ == "__main__":
+    window = arcade.Window(title="Controller UI Example")
+    window.show_view(MyView())
+    arcade.run()