Add mouse-click-effects@anaximeno (#635)

mouse-click-effects@anaximeno/README.md

@@ -0,0 +1,3 @@
+# Mouse Click Effects
+
+Display mouse click effects on Cinnamon.

mouse-click-effects@anaximeno/files/mouse-click-effects@anaximeno/5.4/clickAnimations.js

@@ -0,0 +1,206 @@
+/* clickAnimations.js
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * SPDX-License-Identifier: GPL-3.0-or-later
+ */
+'use strict';
+
+const Main = imports.ui.main;
+const Clutter = imports.gi.Clutter;
+const St = imports.gi.St;
+
+class ClickAnimationMode {
+    constructor(mode) {
+        this.mode = mode;
+    }
+
+    /**
+     * Animates the click into the screen
+     * @param {GIcon} icon The icon that will be animated
+     * @param {Object} options Additional options used while during the animation
+     */
+    animateClick(icon, options) {
+        // Implemented by sub-classes
+    }
+}
+
+class ExpansionClickAnimationMode extends ClickAnimationMode {
+    animateClick(icon, options) {
+        const actor_scale = options.icon_size > 20 ? 1.15 : 3;
+        const [mouse_x, mouse_y, mask] = global.get_pointer();
+
+        let actor = new St.Icon({
+            x: mouse_x,
+            y: mouse_y,
+            scale_x: 0,
+            scale_y: 0,
+            reactive: false,
+            can_focus: false,
+            track_hover: false,
+            icon_size: options.icon_size,
+            opacity: options.opacity,
+            gicon: icon,
+        });
+
+        Main.uiGroup.add_child(actor);
+
+        actor.ease({
+            opacity: options.opacity * 0.08,
+            x: mouse_x - (options.icon_size * actor_scale * global.ui_scale / 2),
+            y: mouse_y - (options.icon_size * actor_scale * global.ui_scale / 2),
+            scale_x: actor_scale,
+            scale_y: actor_scale,
+            duration: options.timeout,
+            mode: Clutter.AnimationMode.EASE_OUT_SINE,
+            onComplete: () => {
+                Main.uiGroup.remove_child(actor);
+                actor.destroy();
+                actor = null;
+            }
+        });
+    }
+}
+
+class RetractionClickAnimationMode extends ClickAnimationMode {
+    animateClick(icon, options) {
+        const [mouse_x, mouse_y, mask] = global.get_pointer();
+
+        let actor = new St.Icon({
+            x: mouse_x - (options.icon_size * global.ui_scale / 2),
+            y: mouse_y - (options.icon_size * global.ui_scale / 2),
+            reactive: false,
+            can_focus: false,
+            track_hover: false,
+            icon_size: options.icon_size,
+            opacity: options.opacity,
+            gicon: icon,
+        });
+
+        Main.uiGroup.add_child(actor);
+
+        actor.ease({
+            opacity: options.opacity * 0.1,
+            x: mouse_x,
+            y: mouse_y,
+            scale_x: 0,
+            scale_y: 0,
+            duration: options.timeout,
+            mode: Clutter.AnimationMode.EASE_OUT_SINE,
+            onComplete: () => {
+                Main.uiGroup.remove_child(actor);
+                actor.destroy();
+                actor = null;
+            }
+        });
+    }
+}
+
+class BounceBackClickAnimationMode extends ClickAnimationMode {
+    animateClick(icon, options) {
+        const [mouse_x, mouse_y, mask] = global.get_pointer();
+
+        let actor = new St.Icon({
+            x: mouse_x,
+            y: mouse_y,
+            scale_x: 0,
+            scale_y: 0,
+            reactive: false,
+            can_focus: false,
+            track_hover: false,
+            icon_size: options.icon_size,
+            opacity: options.opacity * 0.1,
+            gicon: icon,
+        });
+
+        Main.uiGroup.add_child(actor);
+
+        actor.ease({
+            x: mouse_x - (options.icon_size * global.ui_scale / 2),
+            y: mouse_y - (options.icon_size * global.ui_scale / 2),
+            scale_x: 1,
+            scale_y: 1,
+            opacity: options.opacity,
+            duration: options.timeout * 0.4,
+            mode: Clutter.AnimationMode.EASE_IN_OUT_CUBIC,
+            onComplete: () => {
+                actor.ease({
+                    opacity: 0,
+                    x: mouse_x,
+                    y: mouse_y,
+                    scale_x: 0,
+                    scale_y: 0,
+                    duration: options.timeout * 0.6,
+                    mode: Clutter.AnimationMode.EASE_IN_OUT_CUBIC,
+                    onComplete: () => {
+                        Main.uiGroup.remove_child(actor);
+                        actor.destroy();
+                        actor = null;
+                    }
+                });
+            }
+        });
+    }
+}
+
+class BlinkClickAnimationMode extends ClickAnimationMode {
+    animateClick(icon, options = {}) {
+        const [mouse_x, mouse_y, mask] = global.get_pointer();
+
+        let actor = new St.Icon({
+            x: mouse_x - (options.icon_size * global.ui_scale / 2),
+            y: mouse_y - (options.icon_size * global.ui_scale / 2),
+            reactive: false,
+            can_focus: false,
+            track_hover: false,
+            icon_size: options.icon_size,
+            opacity: options.opacity,
+            gicon: icon
+        });
+
+        Main.uiGroup.add_child(actor);
+
+        actor.ease({
+            opacity: options.opacity * 0.1,
+            duration: options.timeout,
+            mode: Clutter.AnimationMode.EASE_IN_OUT_CUBIC,
+            onComplete: () => {
+                Main.uiGroup.remove_child(actor);
+                actor.destroy();
+                actor = null;
+            }
+        });
+    }
+}
+
+class ClickAnimationFactory {
+    /**
+     * Returns an click animation mode depending on the given name
+     * @param {String} mode Click Animation mode name to create
+     * @returns ClickAnimationMode subclass
+     */
+    static createForMode(mode) {
+        switch (mode) {
+            case "bounce":
+                return new BounceBackClickAnimationMode(mode);
+            case "retract":
+                return new RetractionClickAnimationMode(mode);
+            case "expand":
+                return new ExpansionClickAnimationMode(mode);
+            case "blink":
+            default:
+                return new BlinkClickAnimationMode(mode);
+        }
+    }
+}