bauiv1lib.colorpicker

  1# Released under the MIT License. See LICENSE for details.
  2#
  3"""Provides popup windows for choosing colors."""
  4
  5from __future__ import annotations
  6
  7from typing import TYPE_CHECKING, override
  8
  9from bauiv1lib.popup import PopupWindow
 10import bauiv1 as bui
 11
 12if TYPE_CHECKING:
 13    from typing import Any, Sequence
 14
 15REQUIRE_PRO = False
 16
 17
 18class ColorPicker(PopupWindow):
 19    """A popup UI to select from a set of colors.
 20
 21    Passes the color to the delegate's color_picker_selected_color() method.
 22    """
 23
 24    def __init__(
 25        self,
 26        parent: bui.Widget,
 27        position: tuple[float, float],
 28        *,
 29        initial_color: Sequence[float] = (1.0, 1.0, 1.0),
 30        delegate: Any = None,
 31        scale: float | None = None,
 32        offset: tuple[float, float] = (0.0, 0.0),
 33        tag: Any = '',
 34    ):
 35        # pylint: disable=too-many-locals
 36        assert bui.app.classic is not None
 37
 38        c_raw = bui.app.classic.get_player_colors()
 39        assert len(c_raw) == 16
 40        self.colors = [c_raw[0:4], c_raw[4:8], c_raw[8:12], c_raw[12:16]]
 41
 42        uiscale = bui.app.ui_v1.uiscale
 43        if scale is None:
 44            scale = (
 45                2.3
 46                if uiscale is bui.UIScale.SMALL
 47                else 1.65 if uiscale is bui.UIScale.MEDIUM else 1.23
 48            )
 49        self._parent = parent
 50        self._position = position
 51        self._scale = scale
 52        self._offset = offset
 53        self._delegate = delegate
 54        self._transitioning_out = False
 55        self._tag = tag
 56        self._initial_color = initial_color
 57
 58        # Create our _root_widget.
 59        super().__init__(
 60            position=position,
 61            size=(210, 240),
 62            scale=scale,
 63            focus_position=(10, 10),
 64            focus_size=(190, 220),
 65            bg_color=(0.5, 0.5, 0.5),
 66            offset=offset,
 67        )
 68        rows: list[list[bui.Widget]] = []
 69        closest_dist = 9999.0
 70        closest = (0, 0)
 71        for y in range(4):
 72            row: list[bui.Widget] = []
 73            rows.append(row)
 74            for x in range(4):
 75                color = self.colors[y][x]
 76                dist = (
 77                    abs(color[0] - initial_color[0])
 78                    + abs(color[1] - initial_color[1])
 79                    + abs(color[2] - initial_color[2])
 80                )
 81                if dist < closest_dist:
 82                    closest = (x, y)
 83                    closest_dist = dist
 84                btn = bui.buttonwidget(
 85                    parent=self.root_widget,
 86                    position=(22 + 45 * x, 185 - 45 * y),
 87                    size=(35, 40),
 88                    label='',
 89                    button_type='square',
 90                    on_activate_call=bui.WeakCall(self._select, x, y),
 91                    autoselect=True,
 92                    color=color,
 93                    extra_touch_border_scale=0.0,
 94                )
 95                row.append(btn)
 96        other_button = bui.buttonwidget(
 97            parent=self.root_widget,
 98            position=(105 - 60, 13),
 99            color=(0.7, 0.7, 0.7),
100            text_scale=0.5,
101            textcolor=(0.8, 0.8, 0.8),
102            size=(120, 30),
103            label=bui.Lstr(
104                resource='otherText',
105                fallback_resource='coopSelectWindow.customText',
106            ),
107            autoselect=True,
108            on_activate_call=bui.WeakCall(self._select_other),
109        )
110
111        assert bui.app.classic is not None
112        if REQUIRE_PRO and not bui.app.classic.accounts.have_pro():
113            bui.imagewidget(
114                parent=self.root_widget,
115                position=(50, 12),
116                size=(30, 30),
117                texture=bui.gettexture('lock'),
118                draw_controller=other_button,
119            )
120
121        # If their color is close to one of our swatches, select it.
122        # Otherwise select 'other'.
123        if closest_dist < 0.03:
124            bui.containerwidget(
125                edit=self.root_widget,
126                selected_child=rows[closest[1]][closest[0]],
127            )
128        else:
129            bui.containerwidget(
130                edit=self.root_widget, selected_child=other_button
131            )
132
133    def get_tag(self) -> Any:
134        """Return this popup's tag."""
135        return self._tag
136
137    def _select_other(self) -> None:
138        from bauiv1lib import purchase
139
140        # Requires pro.
141        assert bui.app.classic is not None
142        if REQUIRE_PRO and not bui.app.classic.accounts.have_pro():
143            purchase.PurchaseWindow(items=['pro'])
144            self._transition_out()
145            return
146        ColorPickerExact(
147            parent=self._parent,
148            position=self._position,
149            initial_color=self._initial_color,
150            delegate=self._delegate,
151            scale=self._scale,
152            offset=self._offset,
153            tag=self._tag,
154        )
155
156        # New picker now 'owns' the delegate; we shouldn't send it any
157        # more messages.
158        self._delegate = None
159        self._transition_out()
160
161    def _select(self, x: int, y: int) -> None:
162        if self._delegate:
163            self._delegate.color_picker_selected_color(self, self.colors[y][x])
164        bui.apptimer(0.05, self._transition_out)
165
166    def _transition_out(self) -> None:
167        if not self._transitioning_out:
168            self._transitioning_out = True
169            if self._delegate is not None:
170                self._delegate.color_picker_closing(self)
171            bui.containerwidget(edit=self.root_widget, transition='out_scale')
172
173    @override
174    def on_popup_cancel(self) -> None:
175        if not self._transitioning_out:
176            bui.getsound('swish').play()
177        self._transition_out()
178
179
180class ColorPickerExact(PopupWindow):
181    """pops up a ui to select from a set of colors.
182    passes the color to the delegate's color_picker_selected_color() method"""
183
184    def __init__(
185        self,
186        parent: bui.Widget,
187        position: tuple[float, float],
188        *,
189        initial_color: Sequence[float] = (1.0, 1.0, 1.0),
190        delegate: Any = None,
191        scale: float | None = None,
192        offset: tuple[float, float] = (0.0, 0.0),
193        tag: Any = '',
194    ):
195        # pylint: disable=too-many-locals
196        del parent  # Unused var.
197        assert bui.app.classic is not None
198
199        c_raw = bui.app.classic.get_player_colors()
200        assert len(c_raw) == 16
201        self.colors = [c_raw[0:4], c_raw[4:8], c_raw[8:12], c_raw[12:16]]
202
203        uiscale = bui.app.ui_v1.uiscale
204        if scale is None:
205            scale = (
206                2.3
207                if uiscale is bui.UIScale.SMALL
208                else 1.65 if uiscale is bui.UIScale.MEDIUM else 1.23
209            )
210        self._delegate = delegate
211        self._transitioning_out = False
212        self._tag = tag
213        self._color = list(initial_color)
214        self._last_press_time = bui.apptime()
215        self._last_press_color_name: str | None = None
216        self._last_press_increasing: bool | None = None
217        self._hex_timer: bui.AppTimer | None = None
218        self._hex_prev_text: str = '#FFFFFF'
219        self._change_speed = 1.0
220        width = 180.0
221        height = 240.0
222
223        # Creates our _root_widget.
224        super().__init__(
225            position=position,
226            size=(width, height),
227            scale=scale,
228            focus_position=(10, 10),
229            focus_size=(width - 20, height - 20),
230            bg_color=(0.5, 0.5, 0.5),
231            offset=offset,
232        )
233        self._swatch = bui.imagewidget(
234            parent=self.root_widget,
235            position=(width * 0.5 - 65 + 5, height - 95),
236            size=(130, 115),
237            texture=bui.gettexture('clayStroke'),
238            color=(1, 0, 0),
239        )
240        self._hex_textbox = bui.textwidget(
241            parent=self.root_widget,
242            position=(width * 0.5 - 37.5 + 3, height - 51),
243            max_chars=9,
244            text='#FFFFFF',
245            autoselect=True,
246            size=(75, 30),
247            v_align='center',
248            editable=True,
249            maxwidth=70,
250            allow_clear_button=False,
251            glow_type='uniform',
252        )
253
254        x = 50
255        y = height - 90
256        self._label_r: bui.Widget
257        self._label_g: bui.Widget
258        self._label_b: bui.Widget
259        for color_name, color_val in [
260            ('r', (1, 0.15, 0.15)),
261            ('g', (0.15, 1, 0.15)),
262            ('b', (0.15, 0.15, 1)),
263        ]:
264            txt = bui.textwidget(
265                parent=self.root_widget,
266                position=(x - 10, y),
267                size=(0, 0),
268                h_align='center',
269                color=color_val,
270                v_align='center',
271                text='0.12',
272            )
273            setattr(self, '_label_' + color_name, txt)
274            for b_label, bhval, binc in [('-', 30, False), ('+', 75, True)]:
275                bui.buttonwidget(
276                    parent=self.root_widget,
277                    position=(x + bhval, y - 15),
278                    scale=0.8,
279                    repeat=True,
280                    text_scale=1.3,
281                    size=(40, 40),
282                    label=b_label,
283                    autoselect=True,
284                    enable_sound=False,
285                    on_activate_call=bui.WeakCall(
286                        self._color_change_press, color_name, binc
287                    ),
288                )
289            y -= 42
290
291        btn = bui.buttonwidget(
292            parent=self.root_widget,
293            position=(width * 0.5 - 40, 10),
294            size=(80, 30),
295            text_scale=0.6,
296            color=(0.6, 0.6, 0.6),
297            textcolor=(0.7, 0.7, 0.7),
298            label=bui.Lstr(resource='doneText'),
299            on_activate_call=bui.WeakCall(self._transition_out),
300            autoselect=True,
301        )
302        bui.containerwidget(edit=self.root_widget, start_button=btn)
303
304        # Unlike the swatch picker, we stay open and constantly push our
305        # color to the delegate, so start doing that.
306        self._update_for_color()
307
308        # Update our HEX stuff!
309        self._update_for_hex()
310        self._hex_timer = bui.AppTimer(0.025, self._update_for_hex, repeat=True)
311
312    def _update_for_hex(self) -> None:
313        """Update for any HEX or color change."""
314        from typing import cast
315
316        hextext = cast(str, bui.textwidget(query=self._hex_textbox))
317        hexcolor: tuple
318        # Check if our current hex text doesn't match with our old one.
319        # Convert our current hex text into a color if possible.
320        if hextext != self._hex_prev_text:
321            try:
322                hexcolor = hex_to_color(hextext)
323                if len(hexcolor) == 4:
324                    r, g, b, a = hexcolor
325                    del a  # unused
326                else:
327                    r, g, b = hexcolor
328                # Replace the color!
329                for i, ch in enumerate((r, g, b)):
330                    self._color[i] = max(0.0, min(1.0, ch))
331                self._update_for_color()
332            # Usually, a ValueError will occur if the provided hex
333            # is incomplete, which occurs when in the midst of typing it.
334            except ValueError:
335                pass
336        # Store the current text for our next comparison.
337        self._hex_prev_text = hextext
338
339    # noinspection PyUnresolvedReferences
340    def _update_for_color(self) -> None:
341        if not self.root_widget:
342            return
343        bui.imagewidget(edit=self._swatch, color=self._color)
344
345        # We generate these procedurally, so pylint misses them.
346        # FIXME: create static attrs instead.
347        # pylint: disable=consider-using-f-string
348        bui.textwidget(edit=self._label_r, text='%.2f' % self._color[0])
349        bui.textwidget(edit=self._label_g, text='%.2f' % self._color[1])
350        bui.textwidget(edit=self._label_b, text='%.2f' % self._color[2])
351        if self._delegate is not None:
352            self._delegate.color_picker_selected_color(self, self._color)
353
354        # Show the HEX code of this color.
355        r, g, b = self._color
356        hexcode = color_to_hex(r, g, b, None)
357        self._hex_prev_text = hexcode
358        bui.textwidget(
359            edit=self._hex_textbox,
360            text=hexcode,
361            color=color_overlay_func(r, g, b),
362        )
363
364    def _color_change_press(self, color_name: str, increasing: bool) -> None:
365        # If we get rapid-fire presses, eventually start moving faster.
366        current_time = bui.apptime()
367        since_last = current_time - self._last_press_time
368        if (
369            since_last < 0.2
370            and self._last_press_color_name == color_name
371            and self._last_press_increasing == increasing
372        ):
373            self._change_speed += 0.25
374        else:
375            self._change_speed = 1.0
376        self._last_press_time = current_time
377        self._last_press_color_name = color_name
378        self._last_press_increasing = increasing
379
380        color_index = ('r', 'g', 'b').index(color_name)
381        offs = int(self._change_speed) * (0.01 if increasing else -0.01)
382        self._color[color_index] = max(
383            0.0, min(1.0, self._color[color_index] + offs)
384        )
385        self._update_for_color()
386
387    def get_tag(self) -> Any:
388        """Return this popup's tag value."""
389        return self._tag
390
391    def _transition_out(self) -> None:
392        # Kill our timer
393        self._hex_timer = None
394        if not self._transitioning_out:
395            self._transitioning_out = True
396            if self._delegate is not None:
397                self._delegate.color_picker_closing(self)
398            bui.containerwidget(edit=self.root_widget, transition='out_scale')
399
400    @override
401    def on_popup_cancel(self) -> None:
402        if not self._transitioning_out:
403            bui.getsound('swish').play()
404        self._transition_out()
405
406
407def hex_to_color(hex_color: str) -> tuple:
408    """Transforms an RGB / RGBA hex code into an rgb1/rgba1 tuple.
409
410    Args:
411        hex_color (str): The HEX color.
412    Raises:
413        ValueError: If the provided HEX color isn't 6 or 8 characters long.
414    Returns:
415        tuple: The color tuple divided by 255.
416    """
417    # Remove the '#' from the string if provided.
418    if hex_color.startswith('#'):
419        hex_color = hex_color.lstrip('#')
420    # Check if this has a valid length.
421    hexlength = len(hex_color)
422    if not hexlength in [6, 8]:
423        raise ValueError(f'Invalid HEX color provided: "{hex_color}"')
424
425    # Convert the hex bytes to their true byte form.
426    ar, ag, ab, aa = (
427        (int.from_bytes(bytes.fromhex(hex_color[0:2]))),
428        (int.from_bytes(bytes.fromhex(hex_color[2:4]))),
429        (int.from_bytes(bytes.fromhex(hex_color[4:6]))),
430        (
431            (int.from_bytes(bytes.fromhex(hex_color[6:8])))
432            if hexlength == 8
433            else None
434        ),
435    )
436    # Divide all numbers by 255 and return.
437    nr, ng, nb, na = (
438        x / 255 if x is not None else None for x in (ar, ag, ab, aa)
439    )
440    return (nr, ng, nb, na) if aa is not None else (nr, ng, nb)
441
442
443def color_to_hex(r: float, g: float, b: float, a: float | None = 1.0) -> str:
444    """Converts an rgb1 tuple to a HEX color code.
445
446    Args:
447        r (float): Red.
448        g (float): Green.
449        b (float): Blue.
450        a (float, optional): Alpha. Defaults to 1.0.
451
452    Returns:
453        str: The hexified rgba values.
454    """
455    # Turn our rgb1 to rgb255
456    nr, ng, nb, na = [
457        int(min(255, x * 255)) if x is not None else x for x in [r, g, b, a]
458    ]
459    # Merge all values into their HEX representation.
460    hex_code = (
461        f'#{nr:02x}{ng:02x}{nb:02x}{na:02x}'
462        if na is not None
463        else f'#{nr:02x}{ng:02x}{nb:02x}'
464    )
465    return hex_code
466
467
468def color_overlay_func(
469    r: float, g: float, b: float, a: float | None = None
470) -> tuple:
471    """I could NOT come up with a better function name.
472
473    Args:
474        r (float): Red.
475        g (float): Green.
476        b (float): Blue.
477        a (float | None, optional): Alpha. Defaults to None.
478
479    Returns:
480        tuple: A brighter color if the provided one is dark,
481               and a darker one if it's darker.
482    """
483
484    # Calculate the relative luminance using the formula for sRGB
485    # https://www.w3.org/TR/WCAG20/#relativeluminancedef
486    def relative_luminance(color: float) -> Any:
487        if color <= 0.03928:
488            return color / 12.92
489        return ((color + 0.055) / 1.055) ** 2.4
490
491    luminance = (
492        0.2126 * relative_luminance(r)
493        + 0.7152 * relative_luminance(g)
494        + 0.0722 * relative_luminance(b)
495    )
496    # Set our color multiplier depending on the provided color's luminance.
497    luminant = 1.65 if luminance < 0.33 else 0.2
498    # Multiply our given numbers, making sure
499    # they don't blend in the original bg.
500    avg = (0.7 - (r + g + b / 3)) + 0.15
501    r, g, b = [max(avg, x * luminant) for x in (r, g, b)]
502    # Include our alpha and ship it!
503    return (r, g, b, a) if a is not None else (r, g, b)