BlueGit

timfa kwin-marble

Files

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

main.js

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