feat(gui): use rect in ninepatch draw (#2192)

* feat(gui): use rect in ninepatch draw

Author: eruvanos

.pre-commit-config.yaml

@@ -20,8 +20,8 @@ repos:
     rev: 'v1.10.1'
     hooks:
       - id: mypy
-        args: [ arcade, --explicit-package-bases ]
+        args: [ --explicit-package-bases ]
   - repo: https://github.com/RobertCraigie/pyright-python
-    rev: v1.1.369
+    rev: v1.1.370
     hooks:
       - id: pyright

arcade/application.py

@@ -21,8 +21,7 @@
 from arcade.clock import Clock, FixedClock
 from arcade.color import TRANSPARENT_BLACK
 from arcade.context import ArcadeContext
-from arcade.types import Color, RGBANormalized, RGBOrA255
-from arcade.types.rect import LBWH, Rect
+from arcade.types import LBWH, Color, Rect, RGBANormalized, RGBOrA255
 from arcade.utils import is_raspberry_pi
 
 LOG = logging.getLogger(__name__)
@@ -244,7 +243,6 @@ def __init__(
             self.center_window()
 
         if enable_polling:
-
             self.keyboard = pyglet.window.key.KeyStateHandler()
 
             if pyglet.options["headless"]:

arcade/examples/particle_fireworks.py

@@ -6,14 +6,15 @@
 If Python and Arcade are installed, this example can be run from the command line with:
 python -m arcade.examples.particle_fireworks
 """
+
 import random
 from typing import Optional
 
 import pyglet
 from pyglet.math import Vec2
 
 import arcade
-from arcade.types import Point, PathOrTexture
+from arcade.types import Point, PathOrTexture, LBWH
 from arcade.math import rand_in_rect, clamp, lerp, rand_in_circle, rand_on_circle
 from arcade.particles import (
     Emitter,
@@ -23,8 +24,6 @@
     EmitMaintainCount,
     EmitBurst,
 )
-from arcade import LBWH
-
 
 SCREEN_WIDTH = 800
 SCREEN_HEIGHT = 600
@@ -68,10 +67,8 @@ def make_spinner():
         center_xy=(SCREEN_WIDTH / 2, SPINNER_HEIGHT - 5),
         emit_controller=EmitterIntervalWithTime(0.025, 2.0),
         particle_factory=lambda emitter: FadeParticle(
-            filename_or_texture=random.choice(STAR_TEXTURES),
-            change_xy=(0, 6.0),
-            lifetime=0.2
-        )
+            filename_or_texture=random.choice(STAR_TEXTURES), change_xy=(0, 6.0), lifetime=0.2
+        ),
     )
     spinner.change_angle = 16.28
     return spinner
@@ -89,9 +86,9 @@ def make_rocket(emit_done_cb):
             lifetime=random.uniform(1.0, 1.5),
             start_alpha=100,
             end_alpha=0,
-            mutation_callback=rocket_smoke_mutator
+            mutation_callback=rocket_smoke_mutator,
         ),
-        emit_done_cb=emit_done_cb
+        emit_done_cb=emit_done_cb,
     )
     rocket.change_x = random.uniform(-1.0, 1.0)
     rocket.change_y = random.uniform(5.0, 7.25)
@@ -104,10 +101,8 @@ def make_flash(prev_emitter):
         center_xy=prev_emitter.get_pos(),
         emit_controller=EmitBurst(3),
         particle_factory=lambda emitter: FadeParticle(
-            filename_or_texture=FLASH_TEXTURE,
-            change_xy=rand_in_circle((0.0, 0.0), 3.5),
-            lifetime=0.15
-        )
+            filename_or_texture=FLASH_TEXTURE, change_xy=rand_in_circle((0.0, 0.0), 3.5), lifetime=0.15
+        ),
     )
 
 
@@ -119,38 +114,40 @@ def make_puff(prev_emitter):
         particle_factory=lambda emitter: FadeParticle(
             filename_or_texture=PUFF_TEXTURE,
             change_xy=Vec2(*rand_in_circle((0.0, 0.0), 0.4)) + Vec2(0.3, 0.0),
-            lifetime=4.0
-        )
+            lifetime=4.0,
+        ),
     )
 
 
 class AnimatedAlphaParticle(LifetimeParticle):
     """A custom particle that animates between three different alpha levels"""
 
     def __init__(
-            self,
-            filename_or_texture: Optional[PathOrTexture],
-            change_xy: Vec2,
-            start_alpha: int = 0,
-            duration1: float = 1.0,
-            mid_alpha: int = 255,
-            duration2: float = 1.0,
-            end_alpha: int = 0,
-            center_xy: Point = (0.0, 0.0),
-            angle: float = 0,
-            change_angle: float = 0,
-            scale: float = 1.0,
-            mutation_callback=None,
+        self,
+        filename_or_texture: Optional[PathOrTexture],
+        change_xy: Vec2,
+        start_alpha: int = 0,
+        duration1: float = 1.0,
+        mid_alpha: int = 255,
+        duration2: float = 1.0,
+        end_alpha: int = 0,
+        center_xy: Point = (0.0, 0.0),
+        angle: float = 0,
+        change_angle: float = 0,
+        scale: float = 1.0,
+        mutation_callback=None,
     ):
-        super().__init__(filename_or_texture,
-                         change_xy,
-                         duration1 + duration2,
-                         center_xy,
-                         angle,
-                         change_angle,
-                         scale,
-                         start_alpha,
-                         mutation_callback)
+        super().__init__(
+            filename_or_texture,
+            change_xy,
+            duration1 + duration2,
+            center_xy,
+            angle,
+            change_angle,
+            scale,
+            start_alpha,
+            mutation_callback,
+        )
         self.start_alpha = start_alpha
         self.in_duration = duration1
         self.mid_alpha = mid_alpha
@@ -197,8 +194,8 @@ def __init__(self):
                 mid_alpha=128,
                 duration2=random.uniform(2.0, 6.0),
                 end_alpha=0,
-                center_xy=rand_in_rect(LBWH(0.0, 0.0, SCREEN_WIDTH, SCREEN_HEIGHT))
-            )
+                center_xy=rand_in_rect(LBWH(0.0, 0.0, SCREEN_WIDTH, SCREEN_HEIGHT)),
+            ),
         )
         self.emitters.append(stars)
 
@@ -217,8 +214,8 @@ def __init__(self):
                 mid_alpha=255,
                 duration2=random.uniform(5.0, 10.0),
                 end_alpha=0,
-                center_xy=rand_in_circle((0.0, 0.0), 50)
-            )
+                center_xy=rand_in_circle((0.0, 0.0), 50),
+            ),
         )
         self.emitters.append(self.cloud)
 
@@ -237,7 +234,7 @@ def launch_random_firework(self, _delta_time):
         self.emitters.append(rocket)
 
     def launch_ringed_firework(self, _delta_time):
-        """"Firework that has a basic explosion and a ring of sparks of a different color"""
+        """ "Firework that has a basic explosion and a ring of sparks of a different color"""
         rocket = make_rocket(self.explode_ringed_firework)
         self.emitters.append(rocket)
 
@@ -267,8 +264,8 @@ def explode_firework(self, prev_emitter):
                 filename_or_texture=spark_texture,
                 change_xy=rand_in_circle(center=(0.0, 0.0), radius=9.0),
                 lifetime=random.uniform(0.5, 1.2),
-                mutation_callback=firework_spark_mutator
-            )
+                mutation_callback=firework_spark_mutator,
+            ),
         )
         self.emitters.append(sparks)
 
@@ -285,8 +282,8 @@ def explode_ringed_firework(self, prev_emitter):
                 filename_or_texture=spark_texture,
                 change_xy=rand_in_circle((0.0, 0.0), 8.0),
                 lifetime=random.uniform(0.55, 0.8),
-                mutation_callback=firework_spark_mutator
-            )
+                mutation_callback=firework_spark_mutator,
+            ),
         )
         self.emitters.append(sparks)
 
@@ -297,8 +294,8 @@ def explode_ringed_firework(self, prev_emitter):
                 filename_or_texture=ring_texture,
                 change_xy=rand_on_circle(center=(0.0, 0.0), radius=5.0),
                 lifetime=random.uniform(1.0, 1.6),
-                mutation_callback=firework_spark_mutator
-            )
+                mutation_callback=firework_spark_mutator,
+            ),
         )
         self.emitters.append(ring)
 
@@ -319,8 +316,8 @@ def explode_sparkle_firework(self, prev_emitter):
                 mid_alpha=0,
                 duration2=random.uniform(0.1, 0.2),
                 end_alpha=255,
-                mutation_callback=firework_spark_mutator
-            )
+                mutation_callback=firework_spark_mutator,
+            ),
         )
         self.emitters.append(sparks)
 

arcade/gui/examples/exp_hidden_password.py

@@ -37,9 +37,7 @@ def __init__(self):
         self.username_input = grid.add(UIInputText(height=25), col_num=1, row_num=0).with_border()
 
         grid.add(UILabel(text="Password:"), col_num=0, row_num=1)
-        self.password_input = grid.add(
-            UIPasswordInput(height=25), col_num=1, row_num=1
-        ).with_border()
+        self.password_input = grid.add(UIPasswordInput(height=25), col_num=1, row_num=1).with_border()
 
         self.login_button = grid.add(UIFlatButton(text="Login"), col_num=0, row_num=2, col_span=2)
         self.login_button.on_click = self.on_login

arcade/gui/nine_patch.py

@@ -193,11 +193,10 @@ def height(self) -> int:
         """The height of the texture in pixels."""
         return self.texture.height
 
-    def draw_sized(
+    def draw_rect(
         self,
         *,
-        position: tuple[float, float] = (0.0, 0.0),
-        size: tuple[float, float],
+        rect: arcade.types.Rect,
         pixelated: bool = False,
         **kwargs,
     ):
@@ -210,8 +209,7 @@ def draw_sized(
                      smaller than the total size of the border areas.
 
 
-        :param position: Bottom left offset of the texture in pixels
-        :param size: Size of the 9-patch as width, height in pixels
+        :param rect: Rectangle to draw the 9-patch texture in
         :param pixelated: Whether to draw with nearest neighbor interpolation
         """
         self.program.set_uniform_safe("texture_id", self._atlas.get_texture_id(self._texture))
@@ -220,10 +218,10 @@ def draw_sized(
         else:
             self._atlas.texture.filter = self._ctx.LINEAR, self._ctx.LINEAR
 
-        self.program["position"] = position
+        self.program["position"] = rect.bottom_left
         self.program["start"] = self._left, self._bottom
         self.program["end"] = self.width - self._right, self.height - self._top
-        self.program["size"] = size
+        self.program["size"] = rect.size
         self.program["t_size"] = self._texture.size
 
         self._atlas.use_uv_texture(0)

arcade/gui/surface.py

@@ -9,8 +9,7 @@
 from arcade.color import TRANSPARENT_BLACK
 from arcade.gl import Framebuffer
 from arcade.gui.nine_patch import NinePatchTexture
-from arcade.types import RGBA255, Point
-from arcade.types.rect import LBWH, Rect
+from arcade.types import LBWH, RGBA255, Point, Rect
 
 
 class Surface:
@@ -118,7 +117,7 @@ def draw_texture(
                     f"Ninepatch does not support an alpha != 255 yet, but got {alpha}"
                 )
 
-            tex.draw_sized(size=(width, height))
+            tex.draw_rect(rect=LBWH(0, 0, width, height))
         else:
             arcade.draw_texture_rect(tex, LBWH(x, y, width, height), angle=angle, alpha=alpha)
 

arcade/gui/ui_manager.py

@@ -18,7 +18,6 @@
 from typing_extensions import TypeGuard
 
 import arcade
-from arcade import LBWH, Rect
 from arcade.gui.events import (
     UIKeyPressEvent,
     UIKeyReleaseEvent,
@@ -34,7 +33,7 @@
 )
 from arcade.gui.surface import Surface
 from arcade.gui.widgets import UIWidget
-from arcade.types import AnchorPoint, Point2
+from arcade.types import LBWH, AnchorPoint, Point2, Rect
 
 W = TypeVar("W", bound=UIWidget)
 

arcade/gui/widgets/text.py

@@ -8,7 +8,6 @@
 from pyglet.text.document import AbstractDocument
 
 import arcade
-from arcade import LBWH
 from arcade.gui.events import (
     UIEvent,
     UIMouseDragEvent,
@@ -23,7 +22,7 @@
 from arcade.gui.surface import Surface
 from arcade.gui.widgets import UIWidget
 from arcade.gui.widgets.layout import UIAnchorLayout
-from arcade.types import RGBA255, Color, RGBOrA255
+from arcade.types import LBWH, RGBA255, Color, RGBOrA255
 
 
 class UILabel(UIWidget):

tests/unit/gui/test_layouting_anchorlayout.py

@@ -1,7 +1,8 @@
-from arcade import LBWH
+from pyglet.math import Vec2
+
 from arcade.gui import UIDummy, UIBoxLayout
 from arcade.gui.widgets.layout import UIAnchorLayout
-from pyglet.math import Vec2
+from arcade.types import LBWH
 
 
 def test_place_widget(window):

tests/unit/gui/test_layouting_boxlayout.py

@@ -1,9 +1,9 @@
 from _pytest.python_api import approx
+from pyglet.math import Vec2
 
-from arcade import LBWH
 from arcade.gui import UIBoxLayout, UIManager
 from arcade.gui.widgets import UIDummy
-from pyglet.math import Vec2
+from arcade.types import LBWH
 
 
 # Vertical