// SPDX-FileCopyrightText: Vlad Zahorodnii , Martin Flöser // , Simon Schneegans // SPDX-License-Identifier: GPL-3.0-or-later 'use strict'; const classBlacklist = [ // The logout screen has to be animated only by the logout effect. 'ksmserver ksmserver', 'ksmserver-logout-greeter ksmserver-logout-greeter', // KDE Plasma splash screen has to be animated only by the login effect. 'ksplashqml ksplashqml', // All the tooltips of IntelliJ IDEs use the same window class as their main window. // This results in many awkward animations, so we have to blacklist them all. // See https://github.com/Schneegans/Burn-My-Windows/issues/284 for details. 'jetbrains-studio jetbrains-studio', 'jetbrains-aqua jetbrains-aqua', 'jetbrains-clion jetbrains-clion', 'jetbrains-datagrip jetbrains-datagrip', 'jetbrains-dataspell jetbrains-dataspell', 'jetbrains-goland jetbrains-goland', 'jetbrains-idea jetbrains-idea', 'jetbrains-idea-ce jetbrains-idea-ce', 'jetbrains-phpstorm jetbrains-phpstorm', 'jetbrains-pycharm jetbrains-pycharm', 'jetbrains-pycharm-ce jetbrains-pycharm-ce', 'jetbrains-rider jetbrains-rider', 'jetbrains-rubymine jetbrains-rubymine', 'jetbrains-webstorm jetbrains-webstorm', // Spectacle (KDE screenshot tool) should not be animated. 'spectacle org.kde.spectacle' ]; const nameBlacklist = [ // Kando uses a normal window, but it should look like a popup menu. We do not // blacklist it by class as this would also affect the settings window. 'Kando Menu' ]; class BurnMyWindowsMarbleMinimizeEffect { constructor() { effect.configChanged.connect(this.loadConfig.bind(this)); effect.animationEnded.connect(this.cleanupForcedRoles.bind(this)); effect.animationEnded.connect(this.slotAnimationEnded.bind(this)); //effects.windowAdded.connect(this.slotWindowAdded.bind(this)); const hook = (w) => { w.minimizedChanged.connect(() => { if (w.minimized) this.slotWindowMinimized(w); else this.slotWindowUnminimized(w); }); }; effects.windowAdded.connect(hook); for (const w of effects.stackingOrder) hook(w); effects.windowDataChanged.connect(this.slotWindowDataChanged.bind(this)); this.shader = effect.addFragmentShader(Effect.MapTexture, 'marble.frag'); this.loadConfig(); } // A small helper which can be used to read a hex color string (e.g. #ff3244) from the // settings. This method will return an array of four floating point values // [r, g, b, a]. If the settings key only refers to an rgb value, the alpha component // will be set to 1.0. readRGBAConfig(key) { const raw = String(effect.readConfig(key, '#ffffff')); const parts = raw.split(',').map(x => parseFloat(x.trim())); if (parts.length >= 3 && parts.every(x => !isNaN(x))) { const c = parts.map(x => x / 255); return [c[0], c[1], c[2], c.length > 3 ? c[3] : 1.0]; } const color = /^#?([a-f\d]{2})([a-f\d]{2})([a-f\d]{2})?([a-f\d]{2})?$/i .exec(effect.readConfig(key, '#ffffff')) .slice(1) .filter(x => x !== undefined) .map(x => parseInt(x, 16) / 255); return color.length == 3 ? [color[0], color[1], color[2], 1.0] : [color[1], color[2], color[3], color[0]]; } // A small helper which can be used to read a hex color string (e.g. #ff3244) from the // settings. This method will return an array of three floating point values [r, g, b] // regardless of whether the settings key actually refers to an argb hex string. readRGBConfig(key) { const color = this.readRGBAConfig(key); color.pop(); return color; } // This is called when the effect is loaded and whenever the settings of the effect // are changed by the user. loadConfig() { this.duration = animationTime(effect.readConfig("Duration", 300)); this.pause = animationTime(Number(effect.readConfig("Pause", 600))); this.gravity = Math.max(100, Number(effect.readConfig('Gravity', 4000))); // px/s^2 let sh = 1080; try { sh = effects.virtualScreenGeometry.height || sh; } catch (e) {} this.fallDistance = 1.5 * sh; // free fall from rest: d = 0.5 g t^2 -> t = sqrt(2d/g); scaled by the global speed factor this.fallDuration = animationTime(Math.round(1000 * Math.sqrt(2 * this.fallDistance / this.gravity))); effect.setUniform(this.shader, 'uDuration', (this.duration + this.pause + this.fallDuration) * 0.001); effect.setUniform(this.shader, 'uCrumpleEnd', this.duration / Math.max(1, this.duration + this.pause + this.fallDuration)); } static shouldAnimateWindow(window) { // We don't want to animate most of plasmashell's windows, yet, some // of them we want to, for example, Task Manager Settings window. // The problem is that all those window share single window class. // So, the only way to decide whether a window should be animated is // to use a heuristic: if a window has decoration, then it's most // likely a dialog or a settings window so we have to animate it. if (window.windowClass == 'plasmashell plasmashell' || window.windowClass == 'plasmashell org.kde.plasmashell') { return window.hasDecoration; } // This is primarily to avoid animating the AltTab popup. // See https://github.com/Schneegans/Burn-My-Windows/issues/384 for details. if (!window.hasDecoration && window.onAllDesktops) { return false } if (classBlacklist.indexOf(window.windowClass) != -1) { return false; } if (nameBlacklist.indexOf(window.caption) != -1) { return false; } if (window.hasDecoration) { return true; } // Don't animate combobox popups, tooltips, popup menus, etc. if (window.popupWindow) { return false; } // Dont't animate the outline and the screenlocker as it looks bad. if (window.lockScreen || window.outline) { return false; } // Override-redirect windows are usually used for user interface // concepts that are not expected to be animated by this effect. if (!window.managed) { return false; } return window.normalWindow || window.dialog; } setupForcedRoles(window) { // marble: no forced blur/contrast (blurred window-sized rect + cost) // window.setData(Effect.WindowForceBackgroundContrastRole, true); // marble: no forced blur/contrast (blurred window-sized rect + cost) // window.setData(Effect.WindowForceBlurRole, true); } cleanupForcedRoles(window) { window.setData(Effect.WindowForceBackgroundContrastRole, null); window.setData(Effect.WindowForceBlurRole, null); } slotWindowAdded(window) { if (effects.hasActiveFullScreenEffect) { return; } if (!BurnMyWindowsMarbleMinimizeEffect.shouldAnimateWindow(window)) { return; } if (!window.visible) { return; } if (effect.isGrabbed(window, Effect.WindowAddedGrabRole)) { return; } this.setupForcedRoles(window); effect.setUniform(this.shader, 'uForOpening', 1.0); effect.setUniform(this.shader, 'uIsFullscreen', window.fullScreen ? 1.0 : 0.0); window.bmwInAnimation = animate({ window: window, curve: QEasingCurve.Linear, duration: this.duration, animations: [{ type: Effect.ShaderUniform, fragmentShader: this.shader, uniform: 'uProgress', from: 0.0, to: 1.0 }] }); } // ---- Smooth S-path: two parallel translations with different easing curves ---- // Along the taskbar normal the marble falls with gravity (InQuad = 0.5 g t^2 from rest); // sideways it moves with InOutSine (slow, fast in the middle, slow). Together this gives an // S-shaped path that leaves straight down and enters the taskbar perpendicular. Duration // from the distance along the normal: t = sqrt(2 d / g). No chains, no per-frame calls. fallPlan(window, ir) { const wr = window.geometry; const dx = (ir.x + ir.width / 2) - (wr.x + wr.width / 2); const dy = (ir.y + ir.height / 2) - (wr.y + wr.height / 2); let vs = {x: 0, y: 0, width: 1920, height: 1080}; try { const g = effects.virtualScreenGeometry; if (g && g.width) vs = g; } catch (e) {} const cx = ir.x + ir.width / 2, cy = ir.y + ir.height / 2; const d = [cy - vs.y, vs.y + vs.height - cy, cx - vs.x, vs.x + vs.width - cx]; // top,bottom,left,right let k = 1; for (let i = 0; i < 4; i++) if (d[i] < d[k]) k = i; // bottom is default const vertical = k < 2; // taskbar at top/bottom const along = Math.max(30, Math.abs(vertical ? dy : dx)); const T = animationTime(Math.round(1000 * Math.sqrt(2 * along / this.gravity))); return {dx: dx, dy: dy, T: Math.max(1, T), vertical: vertical}; } // dir: 1 = minimize (towards the icon), -1 = restore (time-reversed) fallAnims(window, f, dir) { const fwd = dir > 0; const gravityCurve = fwd ? QEasingCurve.InQuad : QEasingCurve.OutQuad; // OutQuad = reversed InQuad const sideCurve = QEasingCurve.InOutSine; // symmetric const xCurve = f.vertical ? sideCurve : gravityCurve; const yCurve = f.vertical ? gravityCurve : sideCurve; const ax = fwd ? [0, f.dx] : [f.dx, 0], ay = fwd ? [0, f.dy] : [f.dy, 0]; window.bmwXAnimation = animate({ window: window, curve: xCurve, duration: f.T, animations: [{ type: Effect.Translation, from: {value1: ax[0], value2: 0.0}, to: {value1: ax[1], value2: 0.0} }, { type: Effect.Opacity, from: 1.0, to: 1.0 }] }); window.bmwYAnimation = animate({ window: window, curve: yCurve, duration: f.T, animations: [{ type: Effect.Translation, from: {value1: 0.0, value2: ay[0]}, to: {value1: 0.0, value2: ay[1]} }] }); // scale 100% -> 10% essentially in the last part (InExpo stays ~1 until late); reverse = OutExpo window.bmwScaleAnimation = animate({ window: window, curve: fwd ? QEasingCurve.InExpo : QEasingCurve.OutExpo, duration: f.T, animations: [{ type: Effect.Scale, from: {value1: fwd ? 1.0 : 0.1, value2: fwd ? 1.0 : 0.1}, to: {value1: fwd ? 0.1 : 1.0, value2: fwd ? 0.1 : 1.0} }] }); } slotWindowMinimized(window) { if (effects.hasActiveFullScreenEffect) return; const ir = window.iconGeometry; if (!ir || ir.width == 0 || ir.height == 0) return; // no taskbar entry this.stopAll(window); const f = this.fallPlan(window, ir); const morph = this.duration + this.pause; const total = morph + f.T; effect.setUniform(this.shader, "uForOpening", 0.0); effect.setUniform(this.shader, "uIsFullscreen", window.fullScreen ? 1.0 : 0.0); effect.setUniform(this.shader, "uDuration", total * 0.001); effect.setUniform(this.shader, "uCrumpleEnd", this.duration / Math.max(1, total)); // one shader animation, deliberately longer; cancelled after the invisible tail (flash fix) window.bmwMinAnimation = animate({ window: window, curve: QEasingCurve.Linear, duration: total + 3000, animations: [{ type: Effect.ShaderUniform, fragmentShader: this.shader, uniform: "uProgress", from: 0.0, to: (total + 3000) / Math.max(1, total) }, { type: Effect.Opacity, from: 1.0, to: 1.0 }] }); window.bmwMarbleDone = animate({ window: window, curve: QEasingCurve.Linear, duration: morph, animations: [{ type: Effect.Translation, from: {value1: 0.0, value2: 0.0}, to: {value1: 0.0, value2: 0.0} }] }); window.bmwFall = f; window.bmwMode = "morph"; window.bmwSegEnd = Date.now() + morph - 8; } slotWindowUnminimized(window) { if (effects.hasActiveFullScreenEffect) return; const ir = window.iconGeometry; this.stopAll(window); if (!ir || ir.width == 0 || ir.height == 0) return; // reverse: rise from the icon (same curves reversed), rest, unfold const f = this.fallPlan(window, ir); const total = this.duration + this.pause + f.T; effect.setUniform(this.shader, "uForOpening", 0.0); effect.setUniform(this.shader, "uIsFullscreen", window.fullScreen ? 1.0 : 0.0); effect.setUniform(this.shader, "uDuration", total * 0.001); effect.setUniform(this.shader, "uCrumpleEnd", this.duration / Math.max(1, total)); window.bmwUnminAnimation = animate({ window: window, curve: QEasingCurve.Linear, duration: total, animations: [{ type: Effect.ShaderUniform, fragmentShader: this.shader, uniform: "uProgress", from: 1.0, to: 0.0 }] }); this.fallAnims(window, f, -1); } stopAll(window) { window.bmwMode = null; for (const k of ["bmwMinAnimation", "bmwMarbleDone", "bmwXAnimation", "bmwYAnimation", "bmwScaleAnimation", "bmwTailAnimation", "bmwUnminAnimation"]) { if (window[k]) { cancel(window[k]); delete window[k]; } } } // KWin reports ids as 0 here, so we use our own state + end times. slotAnimationEnded(window, id) { if (!window || !window.bmwMode) return; if (window.bmwSegEnd && Date.now() < window.bmwSegEnd) return; // another animation ended const f = window.bmwFall; if (window.bmwMode == "morph") { // morph + pause done -> fall (one shot) this.fallAnims(window, f, 1); window.bmwMode = "fall"; window.bmwSegEnd = Date.now() + f.T - 8; } else if (window.bmwMode == "fall") { // arrived: invisible hold at the icon window.bmwTailAnimation = animate({ window: window, curve: QEasingCurve.Linear, duration: 250, animations: [{ type: Effect.Translation, from: {value1: f.dx, value2: f.dy}, to: {value1: f.dx, value2: f.dy} }, { type: Effect.Scale, from: {value1: 0.1, value2: 0.1}, to: {value1: 0.1, value2: 0.1} }, { type: Effect.Opacity, from: 0.0, to: 0.0 }] }); window.bmwMode = "tail"; window.bmwSegEnd = Date.now() + 250 - 8; } else if (window.bmwMode == "tail") { // now stop the shader; window is hidden window.bmwMode = null; if (window.bmwMinAnimation) { cancel(window.bmwMinAnimation); delete window.bmwMinAnimation; } try { effects.addRepaintFull(); } catch (e) {} } } slotWindowDataChanged(window, role) { if (role == Effect.WindowAddedGrabRole) { if (window.bmwInAnimation && effect.isGrabbed(window, role)) { cancel(window.bmwInAnimation); delete window.bmwInAnimation; this.cleanupForcedRoles(window); } } else if (role == Effect.WindowClosedGrabRole) { if (window.bmwOutAnimation && effect.isGrabbed(window, role)) { cancel(window.bmwOutAnimation); delete window.bmwOutAnimation; this.cleanupForcedRoles(window); } } } } new BurnMyWindowsMarbleMinimizeEffect();