feat: add /dizz and /flick slash commands

Author: gounux

qchat/constants.py

@@ -28,6 +28,7 @@
 
 # QChat cheatcodes
 CHEATCODE_DIZZY: str = "givemesomecheese"
+CHEATCODE_FLICK: str = "lookattheflickofqgis"
 CHEATCODE_IAMAROBOT: str = "iamarobot"
 CHEATCODE_10OCLOCK: str = "its10oclock"
 CHEATCODE_QGIS_PRO_LICENSE: str = "qgisprolicense"

qchat/gui/dck_qchat.py

@@ -31,6 +31,7 @@
     ADMIN_MESSAGES_NICKNAME,
     CHEATCODE_10OCLOCK,
     CHEATCODE_DIZZY,
+    CHEATCODE_FLICK,
     CHEATCODE_IAMAROBOT,
     CHEATCODE_QGIS_PRO_LICENSE,
     CHEATCODES,
@@ -45,6 +46,7 @@
     QCHAT_NICKNAME_MAXLENGTH_DEFAULT,
     QCHAT_NICKNAME_MINLENGTH,
 )
+from qchat.gui.effects import dizzy, flick_of_the_wrist
 from qchat.gui.qchat_tree_widget_items import (
     MESSAGE_COLUMN,
     QChatAdminTreeWidgetItem,
@@ -71,7 +73,6 @@
 )
 from qchat.logic.qchat_websocket import QChatWebsocket
 from qchat.logic.slash_commands import SlashCommandHandler
-from qchat.tasks.dizzy import DizzyTask
 from qchat.toolbelt import PlgLogger, PlgOptionsManager
 from qchat.toolbelt.commons import open_url_in_browser, play_resource_sound
 from qchat.toolbelt.preferences import PlgSettingsStructure
@@ -910,6 +911,9 @@ def on_send_button_clicked(self) -> None:
                 if action_result and action_result[0] == "show_message":
                     # Show message locally via QMessageBox
                     QMessageBox.information(self, self.tr("QChat"), action_result[1])
+                if action_result and action_result[0] == "show_message_bar":
+                    # Show message locally in QGIS message bar
+                    self.iface.messageBar().pushInfo(self.tr("QChat"), action_result[1])
                 return
 
             # If there's a message text, send it to chat
@@ -1054,8 +1058,12 @@ def check_cheatcode(self, text: str) -> bool:
         """
         # make QGIS shuffle for a few seconds
         if text == CHEATCODE_DIZZY:
-            task = DizzyTask(f"Cheatcode activation: {CHEATCODE_DIZZY}", self.iface)
-            self.task_manager.addTask(task)
+            dizzy()
+            return True
+
+        # make QGIS flick the wrist for a few seconds
+        if text == CHEATCODE_FLICK:
+            flick_of_the_wrist()
             return True
 
         # QGIS pro license expiration message

qchat/gui/effects.py

@@ -0,0 +1,122 @@
+import random
+from datetime import datetime, timedelta
+from typing import Tuple
+
+import numpy as np
+from qgis.PyQt.QtCore import QTimer
+from qgis.PyQt.QtGui import QTransform
+from qgis.utils import iface
+
+
+def dizzy(
+    duration: int = 3,
+    d: int = 12,
+    r: int = 6,
+    interval: int = 50,
+    should_start: bool = True,
+) -> QTimer:
+    """Dizz command, make QGIS shake.
+
+    :param duration: duration in seconds
+    :param d: max offset in pixels
+    :param r: max rotation in degrees
+    :param interval: refresh interval in milliseconds
+    :param should_start: whether to start the timer immediately
+    :return: QTimer instance
+    """
+
+    canvas = iface.mapCanvas()
+    stop_time = datetime.now() + timedelta(seconds=duration)
+
+    initial_scene_rect = canvas.sceneRect()
+    initial_transform = canvas.transform()
+
+    timer = QTimer()
+    timer.setInterval(interval)
+
+    def dizz():
+        if datetime.now() >= stop_time:
+            timer.stop()
+            canvas.setSceneRect(initial_scene_rect)
+            canvas.setTransform(initial_transform)
+            canvas.refresh()
+            return
+
+        rect = initial_scene_rect.translated(
+            random.randint(-d, d), random.randint(-d, d)
+        )
+        canvas.setSceneRect(rect)
+
+        matrix = QTransform()
+        matrix.rotate(random.randint(-r, r))
+        canvas.setTransform(matrix)
+
+        canvas.refresh()
+
+    timer.timeout.connect(dizz)
+
+    if should_start:
+        timer.start()
+
+    return timer
+
+
+def coords8(size: int, nb_points: int = 100) -> Tuple[int, int]:
+    t = np.linspace(0, 2 * np.pi, nb_points)
+    x = size * np.sin(t)
+    y = size * np.cos(t) / 2
+    return (x, y)
+
+
+def flick_of_the_wrist(
+    duration: int = 3,
+    size: int = 500,
+    nb_points: int = 20,
+    interval: int = 50,
+    should_start: bool = True,
+) -> QTimer:
+    canvas = iface.mapCanvas()
+    stop_time = datetime.now() + timedelta(seconds=duration)
+
+    center = canvas.center()
+    cx, cy = center.x(), center.y()
+    coords = coords8(size, nb_points)
+
+    i = 0
+    up = True
+
+    timer = QTimer()
+    timer.setInterval(interval)
+
+    def flick():
+        nonlocal cx, cy, i, up
+
+        if datetime.now() >= stop_time:
+            timer.stop()
+            return
+
+        nx, ny = coords[0][i], coords[1][i]
+        dx, dy = nx - cx, ny - cy
+
+        rect = canvas.sceneRect()
+        rect.moveTo(dx, dy)
+        canvas.setSceneRect(rect)
+
+        cx = nx
+        cy = ny
+
+        if up:
+            i += 1
+            if i >= nb_points - 1:
+                up = False
+        else:
+            i -= 1
+            if i <= 0:
+                up = True
+
+    timer.timeout.connect(flick)
+
+    if should_start:
+        timer.start()
+
+    return timer

qchat/logic/slash_commands.py

@@ -7,6 +7,8 @@
 from dataclasses import dataclass
 from typing import Callable, Optional
 
+from qchat.gui.effects import dizzy, flick_of_the_wrist
+
 
 @dataclass
 class SlashCommandResult:
@@ -55,6 +57,8 @@ class SlashCommandHandler:
         "flip": "Flip a coin (heads or tails)",
         "roll": "Roll dice (e.g. /roll 2d20)",
         "8ball": "Ask the magic 8-ball",
+        "dizz": "Let QGIS shake",
+        "flick": "Look at QGIS flicking the wrist",
     }
 
     def __init__(self):
@@ -68,6 +72,8 @@ def __init__(self):
             "flip": self.cmd_flip,
             "roll": self.cmd_roll,
             "8ball": self.cmd_8ball,
+            "dizz": self.cmd_dizz,
+            "flick": self.cmd_flick,
         }
 
     def get_command_list(self) -> list[str]:
@@ -222,6 +228,32 @@ def cmd_8ball(self, args: str) -> SlashCommandResult:
         message = f"{emoji} {answer}"
         return SlashCommandResult(success=True, message_text=message)
 
+    def cmd_dizz(self, args: str) -> SlashCommandResult:
+        """Dizz command, makes QGIS shake.
+
+        :param args: optional message displayed in message bar
+        :return: SlashCommandResult
+        """
+
+        dizzy()
+
+        return SlashCommandResult(
+            success=True, local_action=lambda: ("show_message_bar", args)
+        )
+
+    def cmd_flick(self, args: str) -> SlashCommandResult:
+        """Flick command, QGIS is flicking the wrist.
+
+        :param args: optional message displayed in message bar
+        :return: SlashCommandResult
+        """
+
+        flick_of_the_wrist()
+
+        return SlashCommandResult(
+            success=True, local_action=lambda: ("show_message_bar", args)
+        )
+
     def cmd_list(self, args: str) -> SlashCommandResult:
         """List all available commands.