Enhancement #672: allow users to change overview exit transition animation (#715)

jtaala · web-flow · commit faaf59e3f3a2 · 2023-11-27T00:42:26.000+11:00
This PR fixes #672. Namely, it now allows users to select from PaperWM settings the animation used to ensure the selected window (after exiting Gnome Overview) is brought into view: ![image](https://github.com/paperwm/PaperWM/assets/30424662/08bf7c1a-b070-41b9-9301-62eec8d3ed4c)
diff --git a/Settings.ui b/Settings.ui
@@ -1114,6 +1114,48 @@
                         </child>
                       </object>
                     </child>
+                    <child>
+                      <object class="GtkListBoxRow">
+                        <property name="activatable">False</property>
+                        <property name="focusable">False</property>
+                        <child>
+                          <object class="GtkGrid">
+                            <property name="focusable">False</property>
+                            <property name="tooltip_text" translatable="yes">Sets the animation when exiting GNOME overview and ensuring selected window is in view</property>
+                            <property name="margin_start">12</property>
+                            <property name="margin_end">12</property>
+                            <property name="margin_top">6</property>
+                            <property name="margin_bottom">6</property>
+                            <property name="column_spacing">32</property>
+                            <child>
+                              <object class="GtkLabel">
+                                <property name="focusable">False</property>
+                                <property name="hexpand">1</property>
+                                <property name="label" translatable="yes">GNOME overview exit &lt;i&gt;select window&lt;/i&gt; animation </property>
+                                <property name="use_markup">1</property>
+                                <property name="xalign">0</property>
+                                <layout>
+                                  <property name="column">0</property>
+                                  <property name="row">0</property>
+                                </layout>
+                              </object>
+                            </child>
+                            <child>
+                              <object class="GtkComboBoxText" id="overview-ensure-viewport-animation">
+                                <property name="focusable">False</property>
+                                <property name="hexpand">0</property>
+                                <property name="width-request">106</property>
+                                <items>
+                                  <item id="none" translatable="yes">None</item>
+                                  <item id="translate" translatable="yes">Translate</item>
+                                  <item id="fade" translatable="yes">Fade</item>
+                                </items>
+                              </object>
+                            </child>
+                          </object>
+                        </child>
+                      </object>
+                    </child>
                   </object>
                 </child>
                 <child>
diff --git a/metadata.json b/metadata.json
@@ -5,5 +5,5 @@
   "url": "https://github.com/paperwm/PaperWM",
   "settings-schema": "org.gnome.shell.extensions.paperwm",
   "shell-version": [ "45" ],
-  "version-name": "45.4.1"
+  "version-name": "45.4.2"
 }
diff --git a/patches.js b/patches.js
@@ -1,7 +1,6 @@
 import Clutter from 'gi://Clutter';
 import Gio from 'gi://Gio';
 import GLib from 'gi://GLib';
-import GObject from 'gi://GObject';
 import Meta from 'gi://Meta';
 import Shell from 'gi://Shell';
 import St from 'gi://St';
diff --git a/prefs.js b/prefs.js
@@ -112,6 +112,20 @@ class SettingsWidget {
             });
         };
 
+        const enumOptionsChanged = (settingKey, optionNumberEnum, defaultOption, defaultNumber) => {
+            const builder = this.builder.get_object(settingKey);
+            const setting = this._settings.get_int(settingKey);
+            const numberOptionEnum = Object.fromEntries(
+                Object.entries(optionNumberEnum).map(a => a.reverse())
+            );
+
+            builder.set_active_id(numberOptionEnum[setting] ?? defaultOption);
+            builder.connect('changed', obj => {
+                const value = optionNumberEnum[obj.get_active_id()] ?? defaultNumber;
+                this._settings.set_int(settingKey, value);
+            });
+        };
+
         const gestureFingersChanged = key => {
             const builder = this.builder.get_object(key);
             const setting = this._settings.get_int(key);
@@ -388,27 +402,34 @@ class SettingsWidget {
 
         // Advanced
         booleanStateChanged('gesture-enabled');
-        gestureFingersChanged('gesture-horizontal-fingers');
-        gestureFingersChanged('gesture-workspace-fingers');
-
-        const defaultFocusMode = this.builder.get_object('default-focus-mode');
-        const dfmSetting = this._settings.get_int('default-focus-mode');
-        switch (dfmSetting) {
-        case 1:
-            defaultFocusMode.set_active_id('center');
-            break;
-        default:
-            defaultFocusMode.set_active_id('default');
-        }
-        defaultFocusMode.connect('changed', obj => {
-            switch (obj.get_active_id()) {
-            case 'center':
-                this._settings.set_int('default-focus-mode', 1);
-                break;
-            default:
-                this._settings.set_int('default-focus-mode', 0);
-            }
-        });
+
+        const fingerOptions = {
+            'fingers-disabled': 0,
+            'three-fingers': 3,
+            'four-fingers': 4,
+        };
+        const fingerOptionDefault = 'fingers-disabled';
+        const fingerNumberDefault = 0;
+        enumOptionsChanged('gesture-horizontal-fingers', fingerOptions, fingerOptionDefault, fingerNumberDefault);
+        enumOptionsChanged('gesture-workspace-fingers', fingerOptions, fingerOptionDefault, fingerNumberDefault);
+        enumOptionsChanged(
+            'default-focus-mode',
+            {
+                'default': 0,
+                'center': 1,
+            },
+            'default',
+            0);
+
+        enumOptionsChanged(
+            'overview-ensure-viewport-animation',
+            {
+                'none': 0,
+                'translate': 1,
+                'fade': 2,
+            },
+            'translate',
+            1);
 
         booleanStateChanged('show-focus-mode-icon');
         booleanStateChanged('disable-topbar-styling', true);
diff --git a/schemas/gschemas.compiled b/schemas/gschemas.compiled
diff --git a/schemas/org.gnome.shell.extensions.paperwm.gschema.xml b/schemas/org.gnome.shell.extensions.paperwm.gschema.xml
@@ -449,6 +449,11 @@
         <summary>Duration of animations in seconds</summary>
     </key>
 
+    <key type="i" name="overview-ensure-viewport-animation">
+        <default>1</default>
+        <summary>Sets the animation when exiting GNOME overview and ensuring selected window is in view. 0:NONE, 1:TRANSLATE, 2:FADE</summary>
+    </key>
+
     <key type="as" name="winprops">
         <default><![CDATA[[]]]></default>
         <summary>Array of winprops as (JSON) string objects</summary>
diff --git a/settings.js b/settings.js
@@ -18,6 +18,9 @@ const META_KEY_ABOVE_TAB = 0x2f7259c9;
 // position to open window at (e.g. to the right of current window)
 export const OpenWindowPositions = { RIGHT: 0, LEFT: 1, START: 2, END: 3 };
 
+// Animation used when ensuring viewport on a window
+export const EnsureViewportAnimation = { NONE: 0, TRANSLATE: 1, FADE: 2 };
+
 export let prefs;
 let gsettings, keybindSettings, _overriddingConflicts;
 let acceleratorParse;
@@ -35,7 +38,8 @@ export function enable(extension) {
         'window-switcher-preview-scale', 'winprops', 'show-workspace-indicator',
         'show-window-position-bar', 'show-focus-mode-icon', 'disable-topbar-styling',
         'default-focus-mode', 'gesture-enabled', 'gesture-horizontal-fingers',
-        'gesture-workspace-fingers', 'open-window-position']
+        'gesture-workspace-fingers', 'open-window-position',
+        'overview-ensure-viewport-animation']
         .forEach(k => setState(null, k));
     prefs.__defineGetter__("minimum_margin", () => {
         return Math.min(15, prefs.horizontal_margin);
diff --git a/tiling.js b/tiling.js
@@ -362,7 +362,11 @@ export class Space extends Array {
             Utils.warpPointerToMonitor(this.monitor);
             Utils.later_add(Meta.LaterType.IDLE, () => {
                 this.moveDone(() => {
-                    ensureViewport(display.focus_window, this, { moveto: true, force: true });
+                    ensureViewport(display.focus_window, this, {
+                        moveto: true,
+                        force: true,
+                        ensureAnimation: Settings.prefs.overview_ensure_viewport_animation,
+                    });
                 });
             });
         });
@@ -3501,6 +3505,8 @@ export function ensureViewport(meta_window, space, options = {}) {
     space = space || spaces.spaceOfWindow(meta_window);
     let force = options?.force ?? false;
     let moveto = options?.moveto ?? true;
+    let animate = options?.animate ?? true;
+    let ensureAnimation = options.ensureAnimation ?? Settings.EnsureViewportAnimation.TRANSLATE;
 
     let index = space.indexOf(meta_window);
     if (index === -1 || space.length === 0)
@@ -3531,7 +3537,7 @@ export function ensureViewport(meta_window, space, options = {}) {
 
     if (moveto) {
         move_to(space, meta_window, {
-            x, force,
+            x, force, animate, ensureAnimation,
         });
     }
 
@@ -3582,8 +3588,11 @@ export function updateSelection(space, metaWindow) {
  * Move the column containing @meta_window to x, y and propagate the change
  * in @space. Coordinates are relative to monitor and y is optional.
  */
-export function move_to(space, metaWindow, { x, force, animate }) {
-    animate = animate ?? true;
+export function move_to(space, metaWindow, options = {}) {
+    let x = options.x ?? 0;
+    let force = options.force ?? false;
+    let animate = options.animate ?? true;
+    let ensureAnimation = options.ensureAnimation ?? Settings.EnsureViewportAnimation.TRANSLATE;
     if (space.indexOf(metaWindow) === -1)
         return;
 
@@ -3594,25 +3603,46 @@ export function move_to(space, metaWindow, { x, force, animate }) {
         return;
     }
 
-    space.targetX = target;
+    const done = () => {
+        space.moveDone();
+        space.fixOverlays(metaWindow);
+    };
 
-    if (Main.overview.visible) {
+    space.targetX = target;
+    if (space.cloneContainer.x === target ||
+        Main.overview.visible) {
         // Do the move immediately, and let the overview take care of animation
         space.cloneContainer.x = target;
-        space.moveDone();
+        done();
         return;
     }
 
+    // if here need to animate
     space.startAnimate();
-    Easer.addEase(space.cloneContainer,
-        {
+    if (!animate ||
+        ensureAnimation === Settings.EnsureViewportAnimation.NONE) {
+        space.cloneContainer.x = target;
+        Easer.addEase(space.cloneContainer, {
+            instant: true,
+            onComplete: () => done(),
+        });
+    }
+    else if (ensureAnimation === Settings.EnsureViewportAnimation.FADE) {
+        space.cloneContainer.x = target;
+        space.cloneContainer.opacity = 0;
+        Easer.addEase(space.cloneContainer, {
+            opacity: 255,
+            time: Settings.prefs.animation_time,
+            onComplete: () => done(),
+        });
+    }
+    else {
+        Easer.addEase(space.cloneContainer, {
             x: target,
             time: Settings.prefs.animation_time,
-            instant: !animate,
-            onComplete: () => space.moveDone(),
+            onComplete: () => done(),
         });
-
-    space.fixOverlays(metaWindow);
+    }
 }
 
 export function grabBegin(metaWindow, type) {

Original file line number	Diff line number	Diff line change
`@@ -5,5 +5,5 @@`
`5`	`5`	`"url": "https://github.com/paperwm/PaperWM",`
`6`	`6`	`"settings-schema": "org.gnome.shell.extensions.paperwm",`
`7`	`7`	`"shell-version": [ "45" ],`
`8`		`- "version-name": "45.4.1"`
	`8`	`+ "version-name": "45.4.2"`
`9`	`9`	`}`