| 1 | // SPDX-FileCopyrightText: Vlad Zahorodnii <vlad.zahorodnii@kde.org>, Martin Flöser |
| 2 | // <mgraesslin@kde.org>, Simon Schneegans <code@simonschneegans.de> |
| 3 | // SPDX-License-Identifier: GPL-3.0-or-later |
| 4 | |
| 5 | 'use strict'; |
| 6 | |
| 7 | const classBlacklist = [ |
| 8 | // The logout screen has to be animated only by the logout effect. |
| 9 | 'ksmserver ksmserver', 'ksmserver-logout-greeter ksmserver-logout-greeter', |
| 10 | |
| 11 | // KDE Plasma splash screen has to be animated only by the login effect. |
| 12 | 'ksplashqml ksplashqml', |
| 13 | |
| 14 | // All the tooltips of IntelliJ IDEs use the same window class as their main window. |
| 15 | // This results in many awkward animations, so we have to blacklist them all. |
| 16 | // See https://github.com/Schneegans/Burn-My-Windows/issues/284 for details. |
| 17 | 'jetbrains-studio jetbrains-studio', 'jetbrains-aqua jetbrains-aqua', |
| 18 | 'jetbrains-clion jetbrains-clion', 'jetbrains-datagrip jetbrains-datagrip', |
| 19 | 'jetbrains-dataspell jetbrains-dataspell', 'jetbrains-goland jetbrains-goland', |
| 20 | 'jetbrains-idea jetbrains-idea', 'jetbrains-idea-ce jetbrains-idea-ce', |
| 21 | 'jetbrains-phpstorm jetbrains-phpstorm', 'jetbrains-pycharm jetbrains-pycharm', |
| 22 | 'jetbrains-pycharm-ce jetbrains-pycharm-ce', 'jetbrains-rider jetbrains-rider', |
| 23 | 'jetbrains-rubymine jetbrains-rubymine', 'jetbrains-webstorm jetbrains-webstorm', |
| 24 | |
| 25 | // Spectacle (KDE screenshot tool) should not be animated. |
| 26 | 'spectacle org.kde.spectacle' |
| 27 | ]; |
| 28 | |
| 29 | const nameBlacklist = [ |
| 30 | // Kando uses a normal window, but it should look like a popup menu. We do not |
| 31 | // blacklist it by class as this would also affect the settings window. |
| 32 | 'Kando Menu' |
| 33 | ]; |
| 34 | |
| 35 | class BurnMyWindowsMarbleMinimizeEffect { |
| 36 | constructor() { |
| 37 | effect.configChanged.connect(this.loadConfig.bind(this)); |
| 38 | effect.animationEnded.connect(this.cleanupForcedRoles.bind(this)); |
| 39 | effect.animationEnded.connect(this.slotAnimationEnded.bind(this)); |
| 40 | //effects.windowAdded.connect(this.slotWindowAdded.bind(this)); |
| 41 | const hook = (w) => { |
| 42 | w.minimizedChanged.connect(() => { |
| 43 | if (w.minimized) this.slotWindowMinimized(w); else this.slotWindowUnminimized(w); |
| 44 | }); |
| 45 | }; |
| 46 | effects.windowAdded.connect(hook); |
| 47 | for (const w of effects.stackingOrder) hook(w); |
| 48 | effects.windowDataChanged.connect(this.slotWindowDataChanged.bind(this)); |
| 49 | |
| 50 | this.shader = effect.addFragmentShader(Effect.MapTexture, 'marble.frag'); |
| 51 | |
| 52 | this.loadConfig(); |
| 53 | } |
| 54 | |
| 55 | // A small helper which can be used to read a hex color string (e.g. #ff3244) from the |
| 56 | // settings. This method will return an array of four floating point values |
| 57 | // [r, g, b, a]. If the settings key only refers to an rgb value, the alpha component |
| 58 | // will be set to 1.0. |
| 59 | readRGBAConfig(key) { |
| 60 | const raw = String(effect.readConfig(key, '#ffffff')); |
| 61 | const parts = raw.split(',').map(x => parseFloat(x.trim())); |
| 62 | if (parts.length >= 3 && parts.every(x => !isNaN(x))) { |
| 63 | const c = parts.map(x => x / 255); |
| 64 | return [c[0], c[1], c[2], c.length > 3 ? c[3] : 1.0]; |
| 65 | } |
| 66 | const color = /^#?([a-f\d]{2})([a-f\d]{2})([a-f\d]{2})?([a-f\d]{2})?$/i |
| 67 | .exec(effect.readConfig(key, '#ffffff')) |
| 68 | .slice(1) |
| 69 | .filter(x => x !== undefined) |
| 70 | .map(x => parseInt(x, 16) / 255); |
| 71 | return color.length == 3 ? [color[0], color[1], color[2], 1.0] : |
| 72 | [color[1], color[2], color[3], color[0]]; |
| 73 | } |
| 74 | |
| 75 | // A small helper which can be used to read a hex color string (e.g. #ff3244) from the |
| 76 | // settings. This method will return an array of three floating point values [r, g, b] |
| 77 | // regardless of whether the settings key actually refers to an argb hex string. |
| 78 | readRGBConfig(key) { |
| 79 | const color = this.readRGBAConfig(key); |
| 80 | color.pop(); |
| 81 | return color; |
| 82 | } |
| 83 | |
| 84 | // This is called when the effect is loaded and whenever the settings of the effect |
| 85 | // are changed by the user. |
| 86 | loadConfig() { |
| 87 | this.duration = animationTime(effect.readConfig("Duration", 300)); |
| 88 | this.pause = animationTime(Number(effect.readConfig("Pause", 600))); |
| 89 | this.gravity = Math.max(100, Number(effect.readConfig('Gravity', 4000))); // px/s^2 |
| 90 | let sh = 1080; |
| 91 | try { sh = effects.virtualScreenGeometry.height || sh; } catch (e) {} |
| 92 | this.fallDistance = 1.5 * sh; |
| 93 | // free fall from rest: d = 0.5 g t^2 -> t = sqrt(2d/g); scaled by the global speed factor |
| 94 | this.fallDuration = animationTime(Math.round(1000 * Math.sqrt(2 * this.fallDistance / this.gravity))); |
| 95 | effect.setUniform(this.shader, 'uDuration', (this.duration + this.pause + this.fallDuration) * 0.001); |
| 96 | effect.setUniform(this.shader, 'uCrumpleEnd', this.duration / Math.max(1, this.duration + this.pause + this.fallDuration)); |
| 97 | } |
| 98 | |
| 99 | static shouldAnimateWindow(window) { |
| 100 | |
| 101 | // We don't want to animate most of plasmashell's windows, yet, some |
| 102 | // of them we want to, for example, Task Manager Settings window. |
| 103 | // The problem is that all those window share single window class. |
| 104 | // So, the only way to decide whether a window should be animated is |
| 105 | // to use a heuristic: if a window has decoration, then it's most |
| 106 | // likely a dialog or a settings window so we have to animate it. |
| 107 | if (window.windowClass == 'plasmashell plasmashell' || |
| 108 | window.windowClass == 'plasmashell org.kde.plasmashell') { |
| 109 | return window.hasDecoration; |
| 110 | } |
| 111 | |
| 112 | // This is primarily to avoid animating the AltTab popup. |
| 113 | // See https://github.com/Schneegans/Burn-My-Windows/issues/384 for details. |
| 114 | if (!window.hasDecoration && window.onAllDesktops) { |
| 115 | return false |
| 116 | } |
| 117 | |
| 118 | if (classBlacklist.indexOf(window.windowClass) != -1) { |
| 119 | return false; |
| 120 | } |
| 121 | |
| 122 | if (nameBlacklist.indexOf(window.caption) != -1) { |
| 123 | return false; |
| 124 | } |
| 125 | |
| 126 | if (window.hasDecoration) { |
| 127 | return true; |
| 128 | } |
| 129 | |
| 130 | // Don't animate combobox popups, tooltips, popup menus, etc. |
| 131 | if (window.popupWindow) { |
| 132 | return false; |
| 133 | } |
| 134 | |
| 135 | // Dont't animate the outline and the screenlocker as it looks bad. |
| 136 | if (window.lockScreen || window.outline) { |
| 137 | return false; |
| 138 | } |
| 139 | |
| 140 | // Override-redirect windows are usually used for user interface |
| 141 | // concepts that are not expected to be animated by this effect. |
| 142 | if (!window.managed) { |
| 143 | return false; |
| 144 | } |
| 145 | |
| 146 | return window.normalWindow || window.dialog; |
| 147 | } |
| 148 | |
| 149 | setupForcedRoles(window) { |
| 150 | // marble: no forced blur/contrast (blurred window-sized rect + cost) |
| 151 | // window.setData(Effect.WindowForceBackgroundContrastRole, true); |
| 152 | // marble: no forced blur/contrast (blurred window-sized rect + cost) |
| 153 | // window.setData(Effect.WindowForceBlurRole, true); |
| 154 | } |
| 155 | |
| 156 | cleanupForcedRoles(window) { |
| 157 | window.setData(Effect.WindowForceBackgroundContrastRole, null); |
| 158 | window.setData(Effect.WindowForceBlurRole, null); |
| 159 | } |
| 160 | |
| 161 | slotWindowAdded(window) { |
| 162 | if (effects.hasActiveFullScreenEffect) { |
| 163 | return; |
| 164 | } |
| 165 | if (!BurnMyWindowsMarbleMinimizeEffect.shouldAnimateWindow(window)) { |
| 166 | return; |
| 167 | } |
| 168 | if (!window.visible) { |
| 169 | return; |
| 170 | } |
| 171 | if (effect.isGrabbed(window, Effect.WindowAddedGrabRole)) { |
| 172 | return; |
| 173 | } |
| 174 | this.setupForcedRoles(window); |
| 175 | |
| 176 | effect.setUniform(this.shader, 'uForOpening', 1.0); |
| 177 | effect.setUniform(this.shader, 'uIsFullscreen', window.fullScreen ? 1.0 : 0.0); |
| 178 | |
| 179 | |
| 180 | |
| 181 | window.bmwInAnimation = animate({ |
| 182 | window: window, |
| 183 | curve: QEasingCurve.Linear, |
| 184 | duration: this.duration, |
| 185 | animations: [{ |
| 186 | type: Effect.ShaderUniform, |
| 187 | fragmentShader: this.shader, |
| 188 | uniform: 'uProgress', |
| 189 | from: 0.0, |
| 190 | to: 1.0 |
| 191 | }] |
| 192 | }); |
| 193 | } |
| 194 | |
| 195 | // ---- Smooth S-path: two parallel translations with different easing curves ---- |
| 196 | // Along the taskbar normal the marble falls with gravity (InQuad = 0.5 g t^2 from rest); |
| 197 | // sideways it moves with InOutSine (slow, fast in the middle, slow). Together this gives an |
| 198 | // S-shaped path that leaves straight down and enters the taskbar perpendicular. Duration |
| 199 | // from the distance along the normal: t = sqrt(2 d / g). No chains, no per-frame calls. |
| 200 | fallPlan(window, ir) { |
| 201 | const wr = window.geometry; |
| 202 | const dx = (ir.x + ir.width / 2) - (wr.x + wr.width / 2); |
| 203 | const dy = (ir.y + ir.height / 2) - (wr.y + wr.height / 2); |
| 204 | let vs = {x: 0, y: 0, width: 1920, height: 1080}; |
| 205 | try { const g = effects.virtualScreenGeometry; if (g && g.width) vs = g; } catch (e) {} |
| 206 | const cx = ir.x + ir.width / 2, cy = ir.y + ir.height / 2; |
| 207 | const d = [cy - vs.y, vs.y + vs.height - cy, cx - vs.x, vs.x + vs.width - cx]; // top,bottom,left,right |
| 208 | let k = 1; for (let i = 0; i < 4; i++) if (d[i] < d[k]) k = i; // bottom is default |
| 209 | const vertical = k < 2; // taskbar at top/bottom |
| 210 | const along = Math.max(30, Math.abs(vertical ? dy : dx)); |
| 211 | const T = animationTime(Math.round(1000 * Math.sqrt(2 * along / this.gravity))); |
| 212 | return {dx: dx, dy: dy, T: Math.max(1, T), vertical: vertical}; |
| 213 | } |
| 214 | |
| 215 | // dir: 1 = minimize (towards the icon), -1 = restore (time-reversed) |
| 216 | fallAnims(window, f, dir) { |
| 217 | const fwd = dir > 0; |
| 218 | const gravityCurve = fwd ? QEasingCurve.InQuad : QEasingCurve.OutQuad; // OutQuad = reversed InQuad |
| 219 | const sideCurve = QEasingCurve.InOutSine; // symmetric |
| 220 | const xCurve = f.vertical ? sideCurve : gravityCurve; |
| 221 | const yCurve = f.vertical ? gravityCurve : sideCurve; |
| 222 | const ax = fwd ? [0, f.dx] : [f.dx, 0], ay = fwd ? [0, f.dy] : [f.dy, 0]; |
| 223 | window.bmwXAnimation = animate({ window: window, curve: xCurve, duration: f.T, |
| 224 | animations: [{ type: Effect.Translation, from: {value1: ax[0], value2: 0.0}, to: {value1: ax[1], value2: 0.0} }, |
| 225 | { type: Effect.Opacity, from: 1.0, to: 1.0 }] }); |
| 226 | window.bmwYAnimation = animate({ window: window, curve: yCurve, duration: f.T, |
| 227 | animations: [{ type: Effect.Translation, from: {value1: 0.0, value2: ay[0]}, to: {value1: 0.0, value2: ay[1]} }] }); |
| 228 | // scale 100% -> 10% essentially in the last part (InExpo stays ~1 until late); reverse = OutExpo |
| 229 | window.bmwScaleAnimation = animate({ window: window, curve: fwd ? QEasingCurve.InExpo : QEasingCurve.OutExpo, duration: f.T, |
| 230 | animations: [{ type: Effect.Scale, from: {value1: fwd ? 1.0 : 0.1, value2: fwd ? 1.0 : 0.1}, |
| 231 | to: {value1: fwd ? 0.1 : 1.0, value2: fwd ? 0.1 : 1.0} }] }); |
| 232 | } |
| 233 | |
| 234 | slotWindowMinimized(window) { |
| 235 | if (effects.hasActiveFullScreenEffect) return; |
| 236 | const ir = window.iconGeometry; |
| 237 | if (!ir || ir.width == 0 || ir.height == 0) return; // no taskbar entry |
| 238 | this.stopAll(window); |
| 239 | const f = this.fallPlan(window, ir); |
| 240 | const morph = this.duration + this.pause; |
| 241 | const total = morph + f.T; |
| 242 | effect.setUniform(this.shader, "uForOpening", 0.0); |
| 243 | effect.setUniform(this.shader, "uIsFullscreen", window.fullScreen ? 1.0 : 0.0); |
| 244 | effect.setUniform(this.shader, "uDuration", total * 0.001); |
| 245 | effect.setUniform(this.shader, "uCrumpleEnd", this.duration / Math.max(1, total)); |
| 246 | // one shader animation, deliberately longer; cancelled after the invisible tail (flash fix) |
| 247 | window.bmwMinAnimation = animate({ |
| 248 | window: window, curve: QEasingCurve.Linear, duration: total + 3000, |
| 249 | animations: [{ type: Effect.ShaderUniform, fragmentShader: this.shader, uniform: "uProgress", from: 0.0, to: (total + 3000) / Math.max(1, total) }, |
| 250 | { type: Effect.Opacity, from: 1.0, to: 1.0 }] |
| 251 | }); |
| 252 | window.bmwMarbleDone = animate({ |
| 253 | window: window, curve: QEasingCurve.Linear, duration: morph, |
| 254 | animations: [{ type: Effect.Translation, from: {value1: 0.0, value2: 0.0}, to: {value1: 0.0, value2: 0.0} }] |
| 255 | }); |
| 256 | window.bmwFall = f; window.bmwMode = "morph"; window.bmwSegEnd = Date.now() + morph - 8; |
| 257 | } |
| 258 | |
| 259 | slotWindowUnminimized(window) { |
| 260 | if (effects.hasActiveFullScreenEffect) return; |
| 261 | const ir = window.iconGeometry; |
| 262 | this.stopAll(window); |
| 263 | if (!ir || ir.width == 0 || ir.height == 0) return; |
| 264 | // reverse: rise from the icon (same curves reversed), rest, unfold |
| 265 | const f = this.fallPlan(window, ir); |
| 266 | const total = this.duration + this.pause + f.T; |
| 267 | effect.setUniform(this.shader, "uForOpening", 0.0); |
| 268 | effect.setUniform(this.shader, "uIsFullscreen", window.fullScreen ? 1.0 : 0.0); |
| 269 | effect.setUniform(this.shader, "uDuration", total * 0.001); |
| 270 | effect.setUniform(this.shader, "uCrumpleEnd", this.duration / Math.max(1, total)); |
| 271 | window.bmwUnminAnimation = animate({ |
| 272 | window: window, curve: QEasingCurve.Linear, duration: total, |
| 273 | animations: [{ type: Effect.ShaderUniform, fragmentShader: this.shader, uniform: "uProgress", from: 1.0, to: 0.0 }] |
| 274 | }); |
| 275 | this.fallAnims(window, f, -1); |
| 276 | window.bmwFadeInAnimation = animate({ window: window, curve: QEasingCurve.InExpo, duration: 80, |
| 277 | animations: [{ type: Effect.Opacity, from: 0.0, to: 1.0 }] }); |
| 278 | } |
| 279 | |
| 280 | stopAll(window) { |
| 281 | window.bmwMode = null; |
| 282 | for (const k of ["bmwMinAnimation", "bmwMarbleDone", "bmwXAnimation", "bmwYAnimation", "bmwScaleAnimation", |
| 283 | "bmwTailAnimation", "bmwUnminAnimation", "bmwFadeInAnimation"]) { |
| 284 | if (window[k]) { cancel(window[k]); delete window[k]; } |
| 285 | } |
| 286 | this.repaintAll(); |
| 287 | } |
| 288 | |
| 289 | // KWin reports ids as 0 here, so we use our own state + end times. |
| 290 | slotAnimationEnded(window, id) { |
| 291 | // marble is drawn outside the window's own damage region: repaint all on every end |
| 292 | this.repaintAll(); |
| 293 | if (!window || !window.bmwMode) return; |
| 294 | if (window.bmwSegEnd && Date.now() < window.bmwSegEnd) return; // another animation ended |
| 295 | const f = window.bmwFall; |
| 296 | if (window.bmwMode == "morph") { // morph + pause done -> fall (one shot) |
| 297 | this.fallAnims(window, f, 1); |
| 298 | window.bmwMode = "fall"; window.bmwSegEnd = Date.now() + f.T - 8; |
| 299 | } else if (window.bmwMode == "fall") { // arrived: invisible hold at the icon |
| 300 | window.bmwTailAnimation = animate({ |
| 301 | window: window, curve: QEasingCurve.Linear, duration: 250, |
| 302 | animations: [{ type: Effect.Translation, from: {value1: f.dx, value2: f.dy}, to: {value1: f.dx, value2: f.dy} }, |
| 303 | { type: Effect.Scale, from: {value1: 0.1, value2: 0.1}, to: {value1: 0.1, value2: 0.1} }, |
| 304 | { type: Effect.Opacity, from: 0.0, to: 0.0 }] |
| 305 | }); |
| 306 | window.bmwMode = "tail"; window.bmwSegEnd = Date.now() + 250 - 8; |
| 307 | this.repaintAll(); |
| 308 | } else if (window.bmwMode == "tail") { // now stop the shader; window is hidden |
| 309 | window.bmwMode = null; |
| 310 | if (window.bmwMinAnimation) { cancel(window.bmwMinAnimation); delete window.bmwMinAnimation; } |
| 311 | this.repaintAll(); |
| 312 | } |
| 313 | } |
| 314 | |
| 315 | repaintAll() { |
| 316 | try { effects.addRepaintFull(); } catch (e) { |
| 317 | if (!this.bmwWarned) { this.bmwWarned = true; console.warn("marble: addRepaintFull unavailable: " + e); } |
| 318 | } |
| 319 | } |
| 320 | |
| 321 | slotWindowDataChanged(window, role) { |
| 322 | if (role == Effect.WindowAddedGrabRole) { |
| 323 | if (window.bmwInAnimation && effect.isGrabbed(window, role)) { |
| 324 | cancel(window.bmwInAnimation); |
| 325 | delete window.bmwInAnimation; |
| 326 | this.cleanupForcedRoles(window); |
| 327 | } |
| 328 | } else if (role == Effect.WindowClosedGrabRole) { |
| 329 | if (window.bmwOutAnimation && effect.isGrabbed(window, role)) { |
| 330 | cancel(window.bmwOutAnimation); |
| 331 | delete window.bmwOutAnimation; |
| 332 | this.cleanupForcedRoles(window); |
| 333 | } |
| 334 | } |
| 335 | } |
| 336 | } |
| 337 | |
| 338 | new BurnMyWindowsMarbleMinimizeEffect(); |