BlueGit

timfa kwin-marble

Files

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

main.js

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