BlueGit

timfa kwin-marble

Files

kwin-marble / kwin6_effect_marble_minimize / contents / code / main.js

main.js

main.js 20.5 KiB Download Raw
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
7const 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
29const 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
35class 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", 200));
88 this.pause = animationTime(Number(effect.readConfig("Pause", 300)));
89 this.gravity = Math.max(100, Number(effect.readConfig('Gravity', 4500))); // 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 // 0..10 named colours, 11 = Willekeurig, 12 = Semiwillekeurig. Older >12 → 12.
97 let mc = Math.floor(Number(effect.readConfig('MixColor', 0)));
98 if (!(mc >= 0)) mc = 0; else if (mc > 12) mc = 12;
99 this.tintMode = mc;
100 this.applyTint(null, false);
101 effect.setUniform(this.shader, 'uMarbleSize', Math.max(4, Number(effect.readConfig('MarbleSize', 42))));
102 this.debug = Math.max(0, Number(effect.readConfig('DebugMarble', 0)) | 0);
103 effect.setUniform(this.shader, 'uDebug', this.debug);
104 effect.setUniform(this.shader, 'uMixOuter', Math.min(100, Math.max(0, Number(effect.readConfig('BlackMixOuter', 80)))) / 100);
105 effect.setUniform(this.shader, 'uMixCenter', Math.min(100, Math.max(0, Number(effect.readConfig('BlackMixCenter', 5)))) / 100);
106 effect.setUniform(this.shader, 'uCrumpleEnd', this.duration / Math.max(1, this.duration + this.pause + this.fallDuration));
107 }
108
109
110 // Mix target. tintMode 0..10 = named colours; 11 = Willekeurig (seq → hue);
111 // 12 = Semiwillekeurig (hash of window.windowClass → hue). Random modes use HSV
112 // with fixed S=1 and V=0.6667 (matches the named #aa… glass colours), not a palette.
113 prog(window, m) {
114 const v = (window.bmwBase || 0) + Math.min(4000, Math.max(0, m));
115 if (this.debug) console.log('MARBLEDBG prog caption=' + window.caption + ' m=' + m + ' v=' + v);
116 return v;
117 }
118
119 hsvToRgb(h, s, v) {
120 const c = v * s, x = c * (1 - Math.abs((h / 60) % 2 - 1)), m = v - c;
121 let r = 0, g = 0, b = 0;
122 if (h < 60) { r = c; g = x; }
123 else if (h < 120) { r = x; g = c; }
124 else if (h < 180) { g = c; b = x; }
125 else if (h < 240) { g = x; b = c; }
126 else if (h < 300) { r = x; b = c; }
127 else { r = c; b = x; }
128 return [r + m, g + m, b + m];
129 }
130
131 hashHue(str) {
132 let h = 2166136261;
133 for (let i = 0; i < str.length; i++) { h ^= str.charCodeAt(i); h = Math.imul(h, 16777619); }
134 return (h >>> 0) % 360;
135 }
136
137 applyTint(window, reuse) {
138 const FIXED = [[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],[0.3333,0.2000,0.0000]];
139 const HS = 1.0, HV = 0.6667; // same peak channel as #aa0000 / #0000aa / …
140 let c, hue = null;
141 if (this.tintMode < FIXED.length) {
142 c = FIXED[this.tintMode];
143 if (window) { window.bmwTint = null; window.bmwHue = null; }
144 } else if (this.tintMode === 12 && window) {
145 // Semiwillekeurig: stable per application (windowClass); empty → black
146 const cls = String(window.windowClass || '').trim();
147 if (!cls) { c = FIXED[0]; hue = null; }
148 else { hue = this.hashHue(cls); c = this.hsvToRgb(hue, HS, HV); }
149 window.bmwTint = c; window.bmwHue = hue;
150 } else if (window && reuse && window.bmwTint) {
151 c = window.bmwTint; hue = (window.bmwHue == null ? null : window.bmwHue);
152 window.bmwTint = null;
153 } else if (window) {
154 // Willekeurig: next sequence number → hue spaced by ~golden angle
155 if (!(window.bmwSeq >= 1)) window.bmwSeq = (this.seq = (this.seq || 0) + 1);
156 hue = Math.floor((window.bmwSeq * 137.508) % 360);
157 c = this.hsvToRgb(hue, HS, HV);
158 window.bmwTint = c; window.bmwHue = hue;
159 } else {
160 c = FIXED[0];
161 }
162 if (window) {
163 // Shader: tk < 11 → named table; tk >= 1000 → HSV hue = tk - 1000
164 window.bmwBase = (hue == null)
165 ? 4096 * Math.max(0, FIXED.findIndex(x => x[0] == c[0] && x[1] == c[1] && x[2] == c[2]))
166 : 4096 * (1000 + (hue | 0));
167 }
168 if (this.debug && window) console.log('MARBLEDBG tint caption=' + window.caption + ' class=' + window.windowClass + ' seq=' + window.bmwSeq + ' hue=' + hue + ' reuse=' + reuse + ' mode=' + this.tintMode + ' base=' + window.bmwBase);
169 effect.setUniform(this.shader, 'uTintR', c[0]);
170 effect.setUniform(this.shader, 'uTintG', c[1]);
171 effect.setUniform(this.shader, 'uTintB', c[2]);
172 }
173
174 static shouldAnimateWindow(window) {
175
176 // We don't want to animate most of plasmashell's windows, yet, some
177 // of them we want to, for example, Task Manager Settings window.
178 // The problem is that all those window share single window class.
179 // So, the only way to decide whether a window should be animated is
180 // to use a heuristic: if a window has decoration, then it's most
181 // likely a dialog or a settings window so we have to animate it.
182 if (window.windowClass == 'plasmashell plasmashell' ||
183 window.windowClass == 'plasmashell org.kde.plasmashell') {
184 return window.hasDecoration;
185 }
186
187 // This is primarily to avoid animating the AltTab popup.
188 // See https://github.com/Schneegans/Burn-My-Windows/issues/384 for details.
189 if (!window.hasDecoration && window.onAllDesktops) {
190 return false
191 }
192
193 if (classBlacklist.indexOf(window.windowClass) != -1) {
194 return false;
195 }
196
197 if (nameBlacklist.indexOf(window.caption) != -1) {
198 return false;
199 }
200
201 if (window.hasDecoration) {
202 return true;
203 }
204
205 // Don't animate combobox popups, tooltips, popup menus, etc.
206 if (window.popupWindow) {
207 return false;
208 }
209
210 // Dont't animate the outline and the screenlocker as it looks bad.
211 if (window.lockScreen || window.outline) {
212 return false;
213 }
214
215 // Override-redirect windows are usually used for user interface
216 // concepts that are not expected to be animated by this effect.
217 if (!window.managed) {
218 return false;
219 }
220
221 return window.normalWindow || window.dialog;
222 }
223
224 setupForcedRoles(window) {
225 // marble: no forced blur/contrast (blurred window-sized rect + cost)
226 // window.setData(Effect.WindowForceBackgroundContrastRole, true);
227 // marble: no forced blur/contrast (blurred window-sized rect + cost)
228 // window.setData(Effect.WindowForceBlurRole, true);
229 }
230
231 cleanupForcedRoles(window) {
232 window.setData(Effect.WindowForceBackgroundContrastRole, null);
233 window.setData(Effect.WindowForceBlurRole, null);
234 }
235
236 slotWindowAdded(window) {
237 if (effects.hasActiveFullScreenEffect) {
238 return;
239 }
240 if (!BurnMyWindowsMarbleMinimizeEffect.shouldAnimateWindow(window)) {
241 return;
242 }
243 if (!window.visible) {
244 return;
245 }
246 if (effect.isGrabbed(window, Effect.WindowAddedGrabRole)) {
247 return;
248 }
249 this.setupForcedRoles(window);
250
251 effect.setUniform(this.shader, 'uForOpening', 1.0);
252 effect.setUniform(this.shader, 'uIsFullscreen', window.fullScreen ? 1.0 : 0.0);
253
254
255
256 window.bmwInAnimation = animate({
257 window: window,
258 curve: QEasingCurve.Linear,
259 duration: this.duration,
260 animations: [{
261 type: Effect.ShaderUniform,
262 fragmentShader: this.shader,
263 uniform: 'uProgress',
264 from: this.prog(window, 0.0),
265 to: this.prog(window, 1.0 / Math.max(1e-4, this.duration / Math.max(1, this.duration + this.pause + this.fallDuration)))
266 }]
267 });
268 }
269
270 // ---- Smooth S-path: two parallel translations with different easing curves ----
271 // Along the taskbar normal the marble falls with gravity (InQuad = 0.5 g t^2 from rest);
272 // sideways it moves with InOutSine (slow, fast in the middle, slow). Together this gives an
273 // S-shaped path that leaves straight down and enters the taskbar perpendicular. Duration
274 // from the distance along the normal: t = sqrt(2 d / g). No chains, no per-frame calls.
275 fallPlan(window, ir) {
276 const wr = window.geometry;
277 const dx = (ir.x + ir.width / 2) - (wr.x + wr.width / 2);
278 const dy = (ir.y + ir.height / 2) - (wr.y + wr.height / 2);
279 let vs = {x: 0, y: 0, width: 1920, height: 1080};
280 try { const g = effects.virtualScreenGeometry; if (g && g.width) vs = g; } catch (e) {}
281 const cx = ir.x + ir.width / 2, cy = ir.y + ir.height / 2;
282 const d = [cy - vs.y, vs.y + vs.height - cy, cx - vs.x, vs.x + vs.width - cx]; // top,bottom,left,right
283 let k = 1; for (let i = 0; i < 4; i++) if (d[i] < d[k]) k = i; // bottom is default
284 const vertical = k < 2; // taskbar at top/bottom
285 const along = Math.max(30, Math.abs(vertical ? dy : dx));
286 const T = animationTime(Math.round(1000 * Math.sqrt(2 * along / this.gravity)));
287 // KWin scales around the centre of the expanded geometry (incl. shadow), not the window
288 // centre; when the marble shrinks to ~0 it would drift there. Offset to compensate.
289 let ox = 0, oy = 0;
290 try { const eg = window.expandedGeometry;
291 ox = (wr.x + wr.width / 2) - (eg.x + eg.width / 2); oy = (wr.y + wr.height / 2) - (eg.y + eg.height / 2); } catch (e) {}
292 return {dx: dx, dy: dy, T: Math.max(1, T), vertical: vertical, ox: ox, oy: oy};
293 }
294
295 // dir: 1 = minimize (towards the icon), -1 = restore (time-reversed)
296 fallAnims(window, f, dir) {
297 const fwd = dir > 0;
298 const gravityCurve = fwd ? QEasingCurve.InQuad : QEasingCurve.OutQuad; // OutQuad = reversed InQuad
299 const sideCurve = QEasingCurve.InOutSine; // symmetric
300 const xCurve = f.vertical ? sideCurve : gravityCurve;
301 const yCurve = f.vertical ? gravityCurve : sideCurve;
302 const ax = fwd ? [0, f.dx] : [f.dx, 0], ay = fwd ? [0, f.dy] : [f.dy, 0];
303 window.bmwXAnimation = animate({ window: window, curve: xCurve, duration: f.T,
304 animations: [{ type: Effect.Translation, from: {value1: ax[0], value2: 0.0}, to: {value1: ax[1], value2: 0.0} },
305 { type: Effect.Opacity, from: 1.0, to: 1.0 }] });
306 window.bmwYAnimation = animate({ window: window, curve: yCurve, duration: f.T,
307 animations: [{ type: Effect.Translation, from: {value1: 0.0, value2: ay[0]}, to: {value1: 0.0, value2: ay[1]} }] });
308 // single scale 100% -> ~0 (0.001, never 0) essentially in the last part (InExpo stays ~1 until late); reverse = OutExpo
309 window.bmwScaleAnimation = animate({ window: window, curve: fwd ? QEasingCurve.InExpo : QEasingCurve.OutExpo, duration: f.T,
310 animations: [{ type: Effect.Scale, from: {value1: fwd ? 1.0 : 0.001, value2: fwd ? 1.0 : 0.001},
311 to: {value1: fwd ? 0.001 : 1.0, value2: fwd ? 0.001 : 1.0} }] });
312
313 }
314
315 slotWindowMinimized(window) {
316 if (effects.hasActiveFullScreenEffect) return;
317 const ir = window.iconGeometry;
318 if (!ir || ir.width == 0 || ir.height == 0) return; // no taskbar entry
319 const old = this.takeAll(window);
320 const f = this.fallPlan(window, ir);
321 this.applyTint(window, false);
322 const morph = this.duration + this.pause;
323 const total = morph + f.T;
324 effect.setUniform(this.shader, "uForOpening", 0.0);
325 effect.setUniform(this.shader, "uIsFullscreen", window.fullScreen ? 1.0 : 0.0);
326 effect.setUniform(this.shader, "uDuration", total * 0.001);
327 effect.setUniform(this.shader, "uCrumpleEnd", this.duration / Math.max(1, total));
328 // one shader animation, deliberately longer; cancelled after the invisible tail (flash fix)
329 window.bmwMinAnimation = animate({
330 window: window, curve: QEasingCurve.Linear, duration: total + 3000,
331 animations: [{ type: Effect.ShaderUniform, fragmentShader: this.shader, uniform: "uProgress", from: this.prog(window, 0.0), to: this.prog(window, (total + 3000) / Math.max(1, this.duration)) },
332 { type: Effect.Opacity, from: 1.0, to: 1.0 }]
333 });
334 window.bmwMarbleDone = animate({
335 window: window, curve: QEasingCurve.Linear, duration: morph,
336 animations: [{ type: Effect.Translation, from: {value1: 0.0, value2: 0.0}, to: {value1: 0.0, value2: 0.0} }]
337 });
338 window.bmwFall = f; window.bmwMode = "morph"; window.bmwSegEnd = Date.now() + morph - 8;
339 this.cancelIds(old); // after the new shader animation exists (keeps the snapshot)
340 }
341
342 slotWindowUnminimized(window) {
343 if (effects.hasActiveFullScreenEffect) return;
344 const ir = window.iconGeometry;
345 const old = this.takeAll(window);
346 if (!ir || ir.width == 0 || ir.height == 0) { this.cancelIds(old); return; }
347 // reverse: rise from the icon (same curves reversed), rest, unfold
348 const f = this.fallPlan(window, ir);
349 this.applyTint(window, true);
350 const total = this.duration + this.pause + f.T;
351 effect.setUniform(this.shader, "uForOpening", 0.0);
352 effect.setUniform(this.shader, "uIsFullscreen", window.fullScreen ? 1.0 : 0.0);
353 effect.setUniform(this.shader, "uDuration", total * 0.001);
354 effect.setUniform(this.shader, "uCrumpleEnd", this.duration / Math.max(1, total));
355 window.bmwUnminAnimation = animate({
356 window: window, curve: QEasingCurve.Linear, duration: total,
357 animations: [{ type: Effect.ShaderUniform, fragmentShader: this.shader, uniform: "uProgress", from: this.prog(window, total / Math.max(1, this.duration)), to: this.prog(window, 0.0) }]
358 });
359 this.fallAnims(window, f, -1);
360 window.bmwFadeInAnimation = animate({ window: window, curve: QEasingCurve.InExpo, duration: 80,
361 animations: [{ type: Effect.Opacity, from: 0.0, to: 1.0 }] });
362 this.cancelIds(old); // after the new shader animation exists (keeps the snapshot)
363 }
364
365 // Detach the running animations of this window without cancelling them yet. They are cancelled
366 // (cancelIds) only after the new animations exist: KWin's scripted shader animations draw a
367 // one-time snapshot of the window, and a snapshot taken while this effect is already active
368 // comes out empty (black/invisible marble). Keeping one shader animation alive makes KWin
369 // reuse the existing, valid snapshot for the new animation.
370 takeAll(window) {
371 window.bmwMode = null;
372 const ids = [];
373 for (const k of ["bmwMinAnimation", "bmwMarbleDone", "bmwXAnimation", "bmwYAnimation", "bmwScaleAnimation", "bmwScale2Animation", "bmwCompAnimation",
374 "bmwTailAnimation", "bmwUnminAnimation", "bmwFadeInAnimation"]) {
375 if (window[k]) { ids.push(window[k]); delete window[k]; }
376 }
377 return ids;
378 }
379
380 cancelIds(ids) {
381 for (const id of ids) cancel(id);
382 this.repaintAll();
383 }
384
385 stopAll(window) { this.cancelIds(this.takeAll(window)); }
386
387 // KWin reports ids as 0 here, so we use our own state + end times.
388 slotAnimationEnded(window, id) {
389 // marble is drawn outside the window's own damage region: repaint all on every end
390 this.repaintAll();
391 if (!window || !window.bmwMode) return;
392 if (window.bmwSegEnd && Date.now() < window.bmwSegEnd) return; // another animation ended
393 const f = window.bmwFall;
394 if (window.bmwMode == "morph") { // morph + pause done -> fall (one shot)
395 this.fallAnims(window, f, 1);
396 window.bmwMode = "fall"; window.bmwSegEnd = Date.now() + f.T - 8;
397 } else if (window.bmwMode == "fall") { // arrived: invisible hold at the icon
398 window.bmwTailAnimation = animate({
399 window: window, curve: QEasingCurve.Linear, duration: 250,
400 animations: [{ type: Effect.Translation, from: {value1: f.dx, value2: f.dy}, to: {value1: f.dx, value2: f.dy} },
401 { type: Effect.Scale, from: {value1: 0.001, value2: 0.001}, to: {value1: 0.001, value2: 0.001} },
402 { type: Effect.Opacity, from: 0.0, to: 0.0 }]
403 });
404 window.bmwMode = "tail"; window.bmwSegEnd = Date.now() + 250 - 8;
405 this.repaintAll();
406 } else if (window.bmwMode == "tail") { // now stop the shader; window is hidden
407 window.bmwMode = null;
408 if (window.bmwMinAnimation) { cancel(window.bmwMinAnimation); delete window.bmwMinAnimation; }
409 this.repaintAll();
410 }
411 }
412
413 repaintAll() {
414 try { effects.addRepaintFull(); } catch (e) {
415 if (!this.bmwWarned) { this.bmwWarned = true; console.warn("marble: addRepaintFull unavailable: " + e); }
416 }
417 }
418
419 slotWindowDataChanged(window, role) {
420 if (role == Effect.WindowAddedGrabRole) {
421 if (window.bmwInAnimation && effect.isGrabbed(window, role)) {
422 cancel(window.bmwInAnimation);
423 delete window.bmwInAnimation;
424 this.cleanupForcedRoles(window);
425 }
426 } else if (role == Effect.WindowClosedGrabRole) {
427 if (window.bmwOutAnimation && effect.isGrabbed(window, role)) {
428 cancel(window.bmwOutAnimation);
429 delete window.bmwOutAnimation;
430 this.cleanupForcedRoles(window);
431 }
432 }
433 }
434}
435
436new BurnMyWindowsMarbleMinimizeEffect();