Merge pull request #18 from kmatch98/icon_palette

Add zoom animation to icon_widget presses

Author: FoamyGuy

adafruit_displayio_layout/widgets/icon_animated.py

@@ -0,0 +1,316 @@
+# SPDX-FileCopyrightText: 2021 Kevin Matocha
+#
+# SPDX-License-Identifier: MIT
+"""
+
+`icon_animated`
+================================================================================
+A touch enabled widget that includes an animated icon image with a small text label
+centered below it.
+
+* Author(s): Kevin Matocha
+
+Implementation Notes
+--------------------
+
+**Hardware:**
+
+**Software and Dependencies:**
+
+* Adafruit CircuitPython firmware for the supported boards:
+  https://github.com/adafruit/circuitpython/releases
+
+"""
+import gc
+import time
+from math import pi
+import bitmaptools
+from displayio import TileGrid, Bitmap, Palette
+import adafruit_imageload
+from adafruit_displayio_layout.widgets.icon_widget import IconWidget
+from adafruit_displayio_layout.widgets.easing import quadratic_easeout as easein
+from adafruit_displayio_layout.widgets.easing import quadratic_easein as easeout
+
+
+class IconAnimated(IconWidget):
+
+    """
+    An animated touch enabled widget that holds an icon image loaded with
+    OnDiskBitmap and a text label centered beneath it. Includes optional
+    animation to increase the icon size when pressed.
+
+    .. Warning::  The `init_class` class function must be called before instancing any
+        IconAnimated widgets.
+
+    :param str label_text: the text that will be shown beneath the icon image.
+    :param str icon: the filepath of the bmp image to be used as the icon.
+    :param bool on_disk: if True use OnDiskBitmap instead of imageload to load static
+     icon image. This can be helpful to save memory. (default: False)  Note: Bitmap
+     file must use indexed colors to allow animations in the IconAnimated widget.
+
+    :param float scale: the maximum zoom during animation, set 1.0 for no zoom.
+     A value of 1.5 is a good starting point. The ``scale`` can be less than
+     1.0 for shrink animations. (default: same as ``max_scale`` set in ``init_class``),
+
+    :param float angle: the maximum degrees of rotation during animation, positive values
+     are clockwise, set 0 for no rotation, in degrees (default: 4 degrees)
+    :param float animation_time: the time for the animation in seconds, set to 0.0 for
+     no animation, a value of 0.15 is a good starting point (default: 0.15 seconds)
+
+    :param int x: x location the icon widget should be placed. Pixel coordinates.
+    :param int y: y location the icon widget should be placed. Pixel coordinates.
+    :param anchor_point: (X,Y) values from 0.0 to 1.0 to define the anchor point relative to the
+     widget bounding box
+    :type anchor_point: Tuple[float,float]
+    :param int anchored_position: (x,y) pixel value for the location of the anchor_point
+    :type anchored_position: Tuple[int, int]
+    :param int max_size: (Optional) this will get passed through to the
+     displayio.Group constructor. ``max_size`` should be set to the maximum number of
+     graphical elements that will be held within the Group of this widget.
+    """
+
+    # pylint: disable=bad-super-call, too-many-instance-attributes, too-many-locals
+    # pylint: disable=too-many-arguments, unused-argument
+
+    display = None
+    # The other Class variables are created in Class method `init_class`:
+    #               max_scale, bitmap_buffer, palette_buffer
+
+    @classmethod
+    def init_class(
+        cls, display=None, max_scale=1.5, max_icon_size=(80, 80), max_color_depth=256
+    ):
+        """
+        Initializes the IconAnimated Class variables, including preallocating memory
+        buffers for the icon zoom bitmap and icon zoom palette.
+
+        .. Note::  The `init_class` class function must be called before instancing any
+                IconAnimated widgets. Usage example:
+                ``IconAnimated.init_class(display=board.DISPLAY, max_scale=1.5,
+                max_icon_size=(80,80), max_color_depth=256)``
+
+        :param displayio.Display display: The display where the icons will be displayed.
+        :param float max_scale: The maximum zoom of the any of the icons, should be >= 1.0,
+         (default: 1.5)
+        :param max_icon_size: The maximum (x,y) pixel dimensions of any `IconAnimated` bitmap size
+         that will be created (default: (80,80)).  Note: This is the original pixel size,
+         before scaling
+        :type max_icon_size: Tuple[int,int]
+        :param int max_color_depth: The maximum color depth of any `IconAnimated`
+         bitmap that will be created (default: 256)
+        """
+        if display is None:
+            raise ValueError(
+                "IconAninmated.init_class: Must provide display parameter for IconAnimated."
+            )
+
+        if (
+            isinstance(max_icon_size, tuple)
+            and len(max_icon_size) == 2  # validate max_icon_size input
+            and isinstance(max_icon_size[0], int)
+            and isinstance(max_icon_size[1], int)
+        ):
+            pass
+        else:
+            raise ValueError(
+                "IconAninmated.init_class: max_icon_size must be an (x,y) "
+                "tuple of integer pixel sizes."
+            )
+
+        cls.display = display
+        if max_scale < 1.0:
+            print(
+                "Warning: IconAnimated.init_class - max_scale value was "
+                "constrained to minimum of 1.0"
+            )
+        cls.max_scale = max(1.0, max_scale)
+        cls.bitmap_buffer = Bitmap(
+            round(cls.max_scale * max_icon_size[0]),
+            round(cls.max_scale * max_icon_size[1]),
+            max_color_depth + 1,
+        )
+        cls.palette_buffer = Palette(max_color_depth + 1)
+
+    def __init__(
+        self,
+        label_text,
+        icon,
+        on_disk=False,
+        scale=None,
+        angle=4,
+        animation_time=0.15,
+        **kwargs,
+    ):
+
+        if self.__class__.display is None:
+            raise ValueError(
+                "Must initialize class using\n"
+                "`IconAnimated.init_class(display, max_scale, max_size, max_color_depth)`\n"
+                "prior to instancing IconAnimated widgets."
+            )
+
+        super().__init__(label_text, icon, on_disk, **kwargs)  # initialize superclasses
+
+        # constrain instance's maximum_scaling between 1.0 and the Class's max_scale
+        if scale is None:
+            self._scale = self.__class__.max_scale
+        else:
+            if scale > self.__class__.max_scale:
+                print(
+                    "Warning - IconAnimated: max_scale is constrained by value of "
+                    "IconAnimated.max_scale set by IconAnimated.init_class(): {}".format(
+                        self.__class__.max_scale
+                    )
+                )
+            self._scale = max(0, min(scale, self.__class__.max_scale))
+
+        self._animation_time = animation_time  # in seconds
+        self._angle = (angle / 360) * 2 * pi  # in degrees, convert to radians
+        self._zoomed = False  # state variable for zoom status
+
+    def zoom_animation(self, touch_point):
+        """Performs zoom animation when icon is pressed.
+
+        :param touch_point: x,y location of the screen.
+        :type touch_point: Tuple[x,y]
+        :return: None
+        """
+
+        if self._animation_time > 0:
+            try:
+                _image, _palette = adafruit_imageload.load(self._icon)
+
+                if len(self.__class__.palette_buffer) < len(_palette) + 1:
+                    self._animation_time = 0  # skip any animation
+                    print(
+                        "Warning: IconAnimated - icon bitmap exceeds IconAnimated.max_color_depth;"
+                        " defaulting to no animation"
+                    )
+
+            except NotImplementedError:
+                self._animation_time = 0  # skip any animation
+                print(
+                    "Warning: IconAnimated - True color BMP unsupported for animation;"
+                    " defaulting to no animation"
+                )
+
+        if self._animation_time > 0:
+
+            animation_bitmap = self.__class__.bitmap_buffer
+            animation_palette = self.__class__.palette_buffer
+
+            # store the current display refresh setting
+            refresh_status = self.__class__.display.auto_refresh
+
+            ###
+            ## Update the zoom palette and bitmap buffers and append the tilegrid
+            ###
+
+            # copy the image palette, add a transparent color at the end
+            for i, color in enumerate(_palette):
+                animation_palette[i] = color
+            animation_palette[len(animation_palette) - 1] = 0x000000
+            animation_palette.make_transparent(len(animation_palette) - 1)
+
+            # create the zoom bitmap larger than the original image to allow for zooming
+            animation_bitmap.fill(len(animation_palette) - 1)  # transparent fill
+            animation_bitmap.blit(
+                (animation_bitmap.width - _image.width) // 2,
+                (animation_bitmap.height - _image.height) // 2,
+                _image,
+            )  # blit the image into the center of the zoom_bitmap
+
+            # place zoom_bitmap at same location as image
+            animation_tilegrid = TileGrid(
+                animation_bitmap, pixel_shader=animation_palette
+            )
+            animation_tilegrid.x = -(animation_bitmap.width - _image.width) // 2
+            animation_tilegrid.y = -(animation_bitmap.height - _image.height) // 2
+
+            self.__class__.display.auto_refresh = False  # set auto_refresh off
+            self[0].hidden = True  # hide the original icon
+            self.append(animation_tilegrid)  # add to the self group.
+
+            # Animation: zoom larger
+            start_time = time.monotonic()
+
+            while True:
+                elapsed_time = time.monotonic() - start_time
+                position = min(
+                    1.0, easein(elapsed_time / self._animation_time)
+                )  # fractional position
+                animation_bitmap.fill(len(animation_palette) - 1)
+                bitmaptools.rotozoom(
+                    dest_bitmap=animation_bitmap,
+                    ox=animation_bitmap.width // 2,
+                    oy=animation_bitmap.height // 2,
+                    source_bitmap=_image,
+                    px=_image.width // 2,
+                    py=_image.height // 2,
+                    scale=1.0 + position * (self._scale - 1.0),  # start scaling at 1.0
+                    angle=position * self._angle,
+                )
+                self.__class__.display.refresh()
+                if elapsed_time > self._animation_time:
+                    break
+
+            # set display.auto_refresh back to original value
+            self.__class__.display.auto_refresh = refresh_status
+
+            del _image
+            del _palette
+            gc.collect()
+
+            self._zoomed = True
+
+    def zoom_out_animation(self, touch_point):
+        """Performs un-zoom animation when icon is released.
+
+        :param touch_point: x,y location of the screen.
+        :type touch_point: Tuple[x,y]
+        :return: None
+        """
+
+        if (self._animation_time > 0) and self._zoomed:
+            _image, _palette = adafruit_imageload.load(self._icon)
+            animation_bitmap = self.__class__.bitmap_buffer
+            animation_palette = self.__class__.palette_buffer
+
+            # store the current display refresh setting
+            refresh_status = self.__class__.display.auto_refresh
+
+            self.__class__.display.auto_refresh = False  # set auto_refresh off
+
+            # Animation: shrink down to the original size
+            start_time = time.monotonic()
+            while True:
+                elapsed_time = time.monotonic() - start_time
+                position = max(0.0, easeout(1 - (elapsed_time / self._animation_time)))
+                animation_bitmap.fill(len(animation_palette) - 1)
+                bitmaptools.rotozoom(
+                    dest_bitmap=animation_bitmap,
+                    ox=animation_bitmap.width // 2,
+                    oy=animation_bitmap.height // 2,
+                    source_bitmap=_image,
+                    px=_image.width // 2,
+                    py=_image.height // 2,
+                    scale=1.0 + position * (self._scale - 1.0),
+                    angle=position * self._angle,
+                )
+                self.__class__.display.refresh()
+                if elapsed_time > self._animation_time:
+                    break
+
+            # clean up the zoom display elements
+            self[0].hidden = False  # unhide the original icon
+            self.pop(-1)  # remove zoom tilegrid from the group
+            self.__class__.display.refresh()
+
+            # set display.auto_refresh back to original value
+            self.__class__.display.auto_refresh = refresh_status
+
+            del _image
+            del _palette
+            gc.collect()
+
+        self._zoomed = False

adafruit_displayio_layout/widgets/icon_widget.py

@@ -50,16 +50,18 @@ class IconWidget(Widget, Control):
     :param int anchored_position: (x,y) pixel value for the location of the anchor_point
     :type anchored_position: Tuple[int, int]
     :param int max_size: (Optional) this will get passed through to the
-     displayio.Group constructor. If omitted we default to
-     grid_size width * grid_size height to make room for all (1, 1) sized cells.
+     displayio.Group constructor. ``max_size`` should be set to the maximum number of
+     graphical elements that will be held within the Group of this widget.
 
     """
 
     def __init__(self, label_text, icon, on_disk=False, **kwargs):
         super().__init__(**kwargs)
 
+        self._icon = icon
+
         if on_disk:
-            self._file = open(icon, "rb")
+            self._file = open(self._icon, "rb")
             image = OnDiskBitmap(self._file)
             tile_grid = TileGrid(image, pixel_shader=ColorConverter())
         else:

docs/api.rst

@@ -33,3 +33,7 @@
 .. automodule:: adafruit_displayio_layout.widgets.icon_widget
    :members:
    :member-order: bysource
+
+.. automodule:: adafruit_displayio_layout.widgets.icon_animated
+   :members:
+   :member-order: bysource

docs/conf.py

@@ -36,6 +36,7 @@
     "terminalio",
     "adafruit_imageload",
     "adafruit_display_text",
+    "bitmaptools",
 ]