Merge branch 'development' into pyglet-3

Author: Cleptomania

CHANGELOG.md

@@ -11,6 +11,16 @@ Arcade [PyPi Release History](https://pypi.org/project/arcade/#history) page.
 ### Breaking Changes
 - `arcade.future.input` package has been moved to the top level `arcade.input`
 
+## Unreleased
+
+- Upgraded Pillow to 12.0.0 for Python 3.14 support.
+- Adds a new `arcade.NoAracdeWindowError` exception type. This is raised when certain window operations are performed and there is no valid Arcade window found. Previously where this error would be raised, we raised a standard `RuntimeError`, this made it harder to properly catch and act accordingly. This new exception subclasses `RuntimeError`, so you can still catch this error the same way as before. The `arcade.get_window()` function will now raise this if there is no window.
+- Along with the new exception type, is a new `arcade.windows_exists()` function which will return True or False based on if there is currently an active window.
+- GUI
+  - `UIManager` did not apply size hint of (0,0). Mainly an issue with `UIBoxLayout`.
+  - Allow multiple children in `UIScrollArea`.
+  - Fix `UIDropdown Overlay` positioning within a `UIScrollArea`.
+
 ## 3.3.3
 
 - Support for Python 3.14

arcade/__init__.py

@@ -90,6 +90,7 @@ def configure_logging(level: int | None = None):
 from .window_commands import start_render
 from .window_commands import unschedule
 from .window_commands import schedule_once
+from .window_commands import window_exists
 
 from .sections import Section, SectionManager
 
@@ -361,6 +362,7 @@ def configure_logging(level: int | None = None):
     "create_text_sprite",
     "clear_timings",
     "get_window",
+    "window_exists",
     "get_fps",
     "has_line_of_sight",
     "load_animated_gif",

arcade/examples/procedural_caves_bsp.py

@@ -3,7 +3,7 @@
 Binary Space Partitioning (BSP)
 
 For more information, see:
-https://roguebasin.roguelikedevelopment.org/index.php?title=Basic_BSP_Dungeon_generation
+https://www.roguebasin.com/index.php?title=Basic_BSP_Dungeon_generation
 https://github.com/DanaL/RLDungeonGenerator
 
 If Python and Arcade are installed, this example can be run from the command line with:

arcade/exceptions.py

@@ -7,6 +7,7 @@
 from typing import TypeVar
 
 __all__ = [
+    "NoArcadeWindowError",
     "OutsideRangeError",
     "IntOutsideRangeError",
     "FloatOutsideRangeError",
@@ -23,6 +24,15 @@
 _CT = TypeVar("_CT")  # Comparable type, ie supports the <= operator
 
 
+class NoArcadeWindowError(RuntimeError):
+    """No valid Arcade window exists.
+
+    It may be handled as a :py:class:`RuntimeError`.
+    """
+
+    ...
+
+
 class OutsideRangeError(ValueError):
     """
     Raised when a value is outside and expected range

arcade/gui/experimental/scroll_area.py

@@ -239,9 +239,6 @@ def __init__(
 
     def add(self, child: W, **kwargs) -> W:
         """Add a child to the widget."""
-        if self._children:
-            raise ValueError("UIScrollArea can only have one child")
-
         super().add(child, **kwargs)
         self.trigger_full_render()
 

arcade/gui/ui_manager.py

@@ -246,8 +246,8 @@ def _do_layout(self):
                 # actual layout
                 if child.size_hint:
                     sh_x, sh_y = child.size_hint
-                    nw = surface_width * sh_x if sh_x else None
-                    nh = surface_height * sh_y if sh_y else None
+                    nw = surface_width * sh_x if sh_x is not None else None
+                    nh = surface_height * sh_y if sh_y is not None else None
                     child.rect = child.rect.resize(nw, nh, anchor=AnchorPoint.BOTTOM_LEFT)
 
                 if child.size_hint_min:

arcade/gui/widgets/dropdown.py

@@ -6,6 +6,7 @@
 from arcade import uicolor
 from arcade.gui import UIEvent, UIMousePressEvent
 from arcade.gui.events import UIControllerButtonPressEvent, UIOnChangeEvent, UIOnClickEvent
+from arcade.gui.experimental import UIScrollArea
 from arcade.gui.experimental.focus import UIFocusMixin
 from arcade.gui.ui_manager import UIManager
 from arcade.gui.widgets import UILayout, UIWidget
@@ -21,7 +22,7 @@ class _UIDropdownOverlay(UIFocusMixin, UIBoxLayout):
 
     # TODO move also options logic to this class
 
-    def show(self, manager: UIManager):
+    def show(self, manager: UIManager | UIScrollArea):
         manager.add(self, layer=UIManager.OVERLAY_LAYER)
 
     def hide(self):
@@ -197,11 +198,19 @@ def _update_options(self):
         self._overlay.detect_focusable_widgets()
 
     def _show_overlay(self):
-        manager = self.get_ui_manager()
-        if manager is None:
-            raise Exception("UIDropdown could not find UIManager in its parents.")
-
-        self._overlay.show(manager)
+        # traverse parents until UIManager or UIScrollArea is found
+        parent = self.parent
+        while parent is not None:
+            if isinstance(parent, UIManager):
+                break
+            if isinstance(parent, UIScrollArea):
+                break
+            parent = parent.parent
+
+        if parent is None:
+            raise Exception("UIDropdown could not find a valid parent for the overlay.")
+
+        self._overlay.show(parent)
 
     def _on_button_click(self, _: UIOnClickEvent):
         self._show_overlay()

arcade/window_commands.py

@@ -14,6 +14,7 @@
 
 import pyglet
 
+from arcade.exceptions import NoArcadeWindowError
 from arcade.types import RGBA255, Color
 
 if TYPE_CHECKING:
@@ -26,6 +27,7 @@
     "get_display_size",
     "get_window",
     "set_window",
+    "window_exists",
     "close_window",
     "run",
     "exit",
@@ -55,13 +57,19 @@ def get_display_size(screen_id: int = 0) -> tuple[int, int]:
 
 
 def get_window() -> Window:
-    """
-    Return a handle to the current window.
+    """Return a handle to the current window.
+
+    If no window exists, it will raise an exception you can
+    handle as a :py:class:`RuntimeError`. Use :py:func:`window_exists`
+    to prevent raising an exception.
 
-    :return: Handle to the current window.
+    Raises:
+        :py:class:`~arcade.exceptions.NoArcadeWindowError` when no window exists.
     """
     if _window is None:
-        raise RuntimeError("No window is active. It has not been created yet, or it was closed.")
+        raise NoArcadeWindowError(
+            "No window is active. It has not been created yet, or it was closed."
+        )
 
     return _window
 
@@ -77,6 +85,21 @@ def set_window(window: Window | None) -> None:
     _window = window
 
 
+def window_exists() -> bool:
+    """
+    Returns True or False based on wether there is currently a Window.
+
+    Returns:
+        Boolean for if a window exists.
+    """
+    try:
+        get_window()
+    except NoArcadeWindowError:
+        return False
+
+    return True
+
+
 def close_window() -> None:
     """
     Closes the current window, and then runs garbage collection. The garbage collection

doc/tutorials/framebuffer/index.rst

@@ -16,11 +16,11 @@ Then create a simple program with a frame buffer:
 Now, color everything that doesn't have an alpha of zero as green:
 
 .. literalinclude:: step_02.py
-    :caption: Pass-through frame buffer
+    :caption: Green where alpha is not zero in the FBO
     :linenos:
 
 Something about passing uniform data to the shader:
 
 .. literalinclude:: step_03.py
-    :caption: Pass-through frame buffer
+    :caption: Passing uniform data to the shader
     :linenos:

tests/unit/gui/test_uimanager_layouting.py

@@ -25,16 +25,21 @@ def test_supports_size_hint(window):
     widget3 = UIDummy()
     widget3.size_hint = (1, None)
 
+    widget4 = UIDummy()
+    widget4.size_hint = (0, 0)
+
     manager.add(widget1)
     manager.add(widget2)
     manager.add(widget3)
+    manager.add(widget4)
 
     with sized(window, 200, 300):
         manager.draw()
 
     assert widget1.size == Vec2(200, 300)
     assert widget2.size == Vec2(100, 75)
     assert widget3.size == Vec2(200, 100)
+    assert widget4.size == Vec2(0, 0)
 
 
 def test_supports_size_hint_min(window):