// 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 BurnMyWindowsMarbleEffect { 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)); effects.windowClosed.connect(this.slotWindowClosed.bind(this)); 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", 200)); this.pause = animationTime(Number(effect.readConfig("Pause", 400))); this.gravity = Math.max(100, Number(effect.readConfig('Gravity', 4500))); // 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); this.tintMode = Math.max(0, Math.min(12, Number(effect.readConfig('MixColor', 0)) | 0)); this.applyTint(null, false); effect.setUniform(this.shader, 'uMarbleSize', Math.max(4, Number(effect.readConfig('MarbleSize', 56)))); effect.setUniform(this.shader, 'uMixOuter', Math.min(100, Math.max(0, Number(effect.readConfig('BlackMixOuter', 80)))) / 100); effect.setUniform(this.shader, 'uMixCenter', Math.min(100, Math.max(0, Number(effect.readConfig('BlackMixCenter', 5)))) / 100); effect.setUniform(this.shader, 'uCrumpleEnd', this.duration / Math.max(1, this.duration + this.pause + this.fallDuration)); } // Mix target colour. tintMode 12 = random; with reuse, a random colour picked for this // window (e.g. at minimize) is used again (e.g. at unminimize) and then forgotten. applyTint(window, reuse) { const C = [[0.0000,0.0000,0.0000],[0.0000,0.0000,0.6667],[0.6667,0.0000,0.0000],[0.0000,0.6667,0.0000],[0.4000,0.0000,0.6667],[0.6667,0.6667,0.0000],[0.6667,0.3333,0.0000],[0.0000,0.6667,0.6667],[0.6667,0.0000,0.4000],[0.3333,0.3333,0.3333],[1.0000,1.0000,1.0000],[0.3333,0.2000,0.0000]]; let c; if (this.tintMode < C.length) c = C[this.tintMode]; else if (window && reuse && window.bmwTint) { c = window.bmwTint; window.bmwTint = null; } else { c = C[Math.floor(Math.random() * C.length)]; if (window) window.bmwTint = c; } effect.setUniform(this.shader, 'uTintR', c[0]); effect.setUniform(this.shader, 'uTintG', c[1]); effect.setUniform(this.shader, 'uTintB', c[2]); } 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 (!BurnMyWindowsMarbleEffect.shouldAnimateWindow(window)) { return; } if (!window.visible) { return; } if (effect.isGrabbed(window, Effect.WindowAddedGrabRole)) { return; } this.setupForcedRoles(window); this.applyTint(window, false); 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 }] }); } slotWindowClosed(window) { if (effects.hasActiveFullScreenEffect) { return; } if (!BurnMyWindowsMarbleEffect.shouldAnimateWindow(window)) { return; } if (!window.visible || window.skipsCloseAnimation) { return; } if (effect.isGrabbed(window, Effect.WindowClosedGrabRole)) { return; } if (window.bmwInAnimation) { cancel(window.bmwInAnimation); delete window.bmwInAnimation; } this.setupForcedRoles(window); this.applyTint(window, false); effect.setUniform(this.shader, 'uForOpening', 0.0); effect.setUniform(this.shader, 'uIsFullscreen', window.fullScreen ? 1.0 : 0.0); // 1) marble morph (shader); runs the whole time so the marble stays drawn while falling window.bmwOutAnimation = animate({ window: window, curve: QEasingCurve.Linear, duration: this.duration + this.pause + this.fallDuration, animations: [{ type: Effect.ShaderUniform, fragmentShader: this.shader, uniform: 'uProgress', from: 0.0, to: 1.0 }] }); // 2) marker animation that ends exactly when the marble is done; the fall is // started from its animationEnded (KWin ignored the per-call delay). window.bmwMarbleDone = animate({ window: window, curve: QEasingCurve.Linear, duration: this.duration + this.pause, animations: [{ type: Effect.Translation, from: {value1: 0.0, value2: 0.0}, to: {value1: 0.0, value2: 0.0} }] }); window.bmwFallPending = true; } slotAnimationEnded(window, id) { // marble is drawn outside the window's own damage region: repaint all on every end this.repaintAll(); if (!window || !window.bmwFallPending) return; // first end = marble marker (ids arrive as 0) window.bmwFallPending = false; // free fall from rest: InQuad = t^2 = constant acceleration, d = 0.5 g t^2 window.bmwFallAnimation = animate({ window: window, curve: QEasingCurve.InQuad, duration: this.fallDuration, animations: [{ type: Effect.Translation, from: {value1: 0.0, value2: 0.0}, to: {value1: 0.0, value2: this.fallDistance} }] }); } repaintAll() { try { effects.addRepaintFull(); } catch (e) { if (!this.bmwWarned) { this.bmwWarned = true; console.warn("marble: addRepaintFull unavailable: " + 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 BurnMyWindowsMarbleEffect();