BlueGit

timfa kwin-marble

Files

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

main.js

main.js 13.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 BurnMyWindowsMarbleEffect {
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 effects.windowClosed.connect(this.slotWindowClosed.bind(this));
42 effects.windowDataChanged.connect(this.slotWindowDataChanged.bind(this));
43
44 this.shader = effect.addFragmentShader(Effect.MapTexture, 'marble.frag');
45
46 this.loadConfig();
47 }
48
49 // A small helper which can be used to read a hex color string (e.g. #ff3244) from the
50 // settings. This method will return an array of four floating point values
51 // [r, g, b, a]. If the settings key only refers to an rgb value, the alpha component
52 // will be set to 1.0.
53 readRGBAConfig(key) {
54 const raw = String(effect.readConfig(key, '#ffffff'));
55 const parts = raw.split(',').map(x => parseFloat(x.trim()));
56 if (parts.length >= 3 && parts.every(x => !isNaN(x))) {
57 const c = parts.map(x => x / 255);
58 return [c[0], c[1], c[2], c.length > 3 ? c[3] : 1.0];
59 }
60 const color = /^#?([a-f\d]{2})([a-f\d]{2})([a-f\d]{2})?([a-f\d]{2})?$/i
61 .exec(effect.readConfig(key, '#ffffff'))
62 .slice(1)
63 .filter(x => x !== undefined)
64 .map(x => parseInt(x, 16) / 255);
65 return color.length == 3 ? [color[0], color[1], color[2], 1.0] :
66 [color[1], color[2], color[3], color[0]];
67 }
68
69 // A small helper which can be used to read a hex color string (e.g. #ff3244) from the
70 // settings. This method will return an array of three floating point values [r, g, b]
71 // regardless of whether the settings key actually refers to an argb hex string.
72 readRGBConfig(key) {
73 const color = this.readRGBAConfig(key);
74 color.pop();
75 return color;
76 }
77
78 // This is called when the effect is loaded and whenever the settings of the effect
79 // are changed by the user.
80 loadConfig() {
81 this.duration = animationTime(effect.readConfig("Duration", 200));
82 this.pause = animationTime(Number(effect.readConfig("Pause", 400)));
83 this.gravity = Math.max(100, Number(effect.readConfig('Gravity', 4500))); // px/s^2
84 let sh = 1080;
85 try { sh = effects.virtualScreenGeometry.height || sh; } catch (e) {}
86 this.fallDistance = 1.5 * sh;
87 // free fall from rest: d = 0.5 g t^2 -> t = sqrt(2d/g); scaled by the global speed factor
88 this.fallDuration = animationTime(Math.round(1000 * Math.sqrt(2 * this.fallDistance / this.gravity)));
89 effect.setUniform(this.shader, 'uDuration', (this.duration + this.pause + this.fallDuration) * 0.001);
90 // 0..10 colours, 11 = random. Values saved by v0.3.0 (10 = white, 12 = random) fall back safely.
91 let mc = Math.floor(Number(effect.readConfig('MixColor', 0)));
92 if (!(mc >= 0)) mc = 0; else if (mc > 11) mc = 11;
93 this.tintMode = mc;
94 this.applyTint(null, false);
95 effect.setUniform(this.shader, 'uMarbleSize', Math.max(4, Number(effect.readConfig('MarbleSize', 42))));
96 this.debug = Math.max(0, Number(effect.readConfig('DebugMarble', 0)) | 0);
97 effect.setUniform(this.shader, 'uDebug', this.debug);
98 effect.setUniform(this.shader, 'uMixOuter', Math.min(100, Math.max(0, Number(effect.readConfig('BlackMixOuter', 80)))) / 100);
99 effect.setUniform(this.shader, 'uMixCenter', Math.min(100, Math.max(0, Number(effect.readConfig('BlackMixCenter', 5)))) / 100);
100 effect.setUniform(this.shader, 'uCrumpleEnd', this.duration / Math.max(1, this.duration + this.pause + this.fallDuration));
101 }
102
103 // Mix target colour. tintMode 11 = random; with reuse, a random colour picked for this
104 // window (e.g. at minimize) is used again (e.g. at unminimize) and then forgotten.
105 // uProgress value for this window: tint base + morph-normalised progress m (capped, see shader)
106 prog(window, m) {
107 const v = (window.bmwBase || 0) + Math.min(4000, Math.max(0, m));
108 if (this.debug) console.log('MARBLEDBG prog caption=' + window.caption + ' m=' + m + ' v=' + v);
109 return v;
110 }
111
112 crumpleEnd() { return Math.max(1e-4, this.duration / Math.max(1, this.duration + this.pause + this.fallDuration)); }
113
114 applyTint(window, reuse) {
115 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]];
116 let c;
117 if (this.tintMode < C.length) { c = C[this.tintMode]; if (window) window.bmwTint = null; }
118 else if (window && reuse && window.bmwTint) { c = window.bmwTint; window.bmwTint = null; }
119 else if (window) { // random: per-window number (window.internalId is undefined in scripted effects)
120 if (!(window.bmwSeq >= 1)) window.bmwSeq = (this.seq = (this.seq || 0) + 1);
121 c = C[window.bmwSeq % C.length]; window.bmwTint = c;
122 }
123 else c = C[0];
124 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
125 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);
126 effect.setUniform(this.shader, 'uTintR', c[0]);
127 effect.setUniform(this.shader, 'uTintG', c[1]);
128 effect.setUniform(this.shader, 'uTintB', c[2]);
129 }
130
131 static shouldAnimateWindow(window) {
132
133 // We don't want to animate most of plasmashell's windows, yet, some
134 // of them we want to, for example, Task Manager Settings window.
135 // The problem is that all those window share single window class.
136 // So, the only way to decide whether a window should be animated is
137 // to use a heuristic: if a window has decoration, then it's most
138 // likely a dialog or a settings window so we have to animate it.
139 if (window.windowClass == 'plasmashell plasmashell' ||
140 window.windowClass == 'plasmashell org.kde.plasmashell') {
141 return window.hasDecoration;
142 }
143
144 // This is primarily to avoid animating the AltTab popup.
145 // See https://github.com/Schneegans/Burn-My-Windows/issues/384 for details.
146 if (!window.hasDecoration && window.onAllDesktops) {
147 return false
148 }
149
150 if (classBlacklist.indexOf(window.windowClass) != -1) {
151 return false;
152 }
153
154 if (nameBlacklist.indexOf(window.caption) != -1) {
155 return false;
156 }
157
158 if (window.hasDecoration) {
159 return true;
160 }
161
162 // Don't animate combobox popups, tooltips, popup menus, etc.
163 if (window.popupWindow) {
164 return false;
165 }
166
167 // Dont't animate the outline and the screenlocker as it looks bad.
168 if (window.lockScreen || window.outline) {
169 return false;
170 }
171
172 // Override-redirect windows are usually used for user interface
173 // concepts that are not expected to be animated by this effect.
174 if (!window.managed) {
175 return false;
176 }
177
178 return window.normalWindow || window.dialog;
179 }
180
181 setupForcedRoles(window) {
182 // marble: no forced blur/contrast (blurred window-sized rect + cost)
183 // window.setData(Effect.WindowForceBackgroundContrastRole, true);
184 // marble: no forced blur/contrast (blurred window-sized rect + cost)
185 // window.setData(Effect.WindowForceBlurRole, true);
186 }
187
188 cleanupForcedRoles(window) {
189 window.setData(Effect.WindowForceBackgroundContrastRole, null);
190 window.setData(Effect.WindowForceBlurRole, null);
191 }
192
193 slotWindowAdded(window) {
194 if (effects.hasActiveFullScreenEffect) {
195 return;
196 }
197 if (!BurnMyWindowsMarbleEffect.shouldAnimateWindow(window)) {
198 return;
199 }
200 if (!window.visible) {
201 return;
202 }
203 if (effect.isGrabbed(window, Effect.WindowAddedGrabRole)) {
204 return;
205 }
206 this.setupForcedRoles(window);
207
208 this.applyTint(window, false);
209 effect.setUniform(this.shader, 'uForOpening', 1.0);
210 effect.setUniform(this.shader, 'uIsFullscreen', window.fullScreen ? 1.0 : 0.0);
211
212
213
214 window.bmwInAnimation = animate({
215 window: window,
216 curve: QEasingCurve.Linear,
217 duration: this.duration,
218 animations: [{
219 type: Effect.ShaderUniform,
220 fragmentShader: this.shader,
221 uniform: 'uProgress',
222 from: this.prog(window, 0.0),
223 to: this.prog(window, 1.0 / this.crumpleEnd())
224 }]
225 });
226 }
227
228 slotWindowClosed(window) {
229 if (effects.hasActiveFullScreenEffect) {
230 return;
231 }
232 if (!BurnMyWindowsMarbleEffect.shouldAnimateWindow(window)) {
233 return;
234 }
235 if (!window.visible || window.skipsCloseAnimation) {
236 return;
237 }
238 if (effect.isGrabbed(window, Effect.WindowClosedGrabRole)) {
239 return;
240 }
241 const oldIn = window.bmwInAnimation; // cancelled after the close animation exists (keeps the snapshot)
242 delete window.bmwInAnimation;
243 this.setupForcedRoles(window);
244
245 this.applyTint(window, false);
246 effect.setUniform(this.shader, 'uForOpening', 0.0);
247 effect.setUniform(this.shader, 'uIsFullscreen', window.fullScreen ? 1.0 : 0.0);
248
249
250
251 // 1) marble morph (shader); runs the whole time so the marble stays drawn while falling
252 window.bmwOutAnimation = animate({
253 window: window,
254 curve: QEasingCurve.Linear,
255 duration: this.duration + this.pause + this.fallDuration,
256 animations: [{
257 type: Effect.ShaderUniform,
258 fragmentShader: this.shader,
259 uniform: 'uProgress',
260 from: this.prog(window, 0.0),
261 to: this.prog(window, 1.0 / this.crumpleEnd())
262 }]
263 });
264 if (oldIn) cancel(oldIn);
265 // 2) marker animation that ends exactly when the marble is done; the fall is
266 // started from its animationEnded (KWin ignored the per-call delay).
267 window.bmwMarbleDone = animate({
268 window: window,
269 curve: QEasingCurve.Linear,
270 duration: this.duration + this.pause,
271 animations: [{ type: Effect.Translation, from: {value1: 0.0, value2: 0.0}, to: {value1: 0.0, value2: 0.0} }]
272 });
273 window.bmwFallPending = true;
274 }
275
276 slotAnimationEnded(window, id) {
277 // marble is drawn outside the window's own damage region: repaint all on every end
278 this.repaintAll();
279 if (!window || !window.bmwFallPending) return; // first end = marble marker (ids arrive as 0)
280 window.bmwFallPending = false;
281 // free fall from rest: InQuad = t^2 = constant acceleration, d = 0.5 g t^2
282 window.bmwFallAnimation = animate({
283 window: window,
284 curve: QEasingCurve.InQuad,
285 duration: this.fallDuration,
286 animations: [{ type: Effect.Translation, from: {value1: 0.0, value2: 0.0},
287 to: {value1: 0.0, value2: this.fallDistance} }]
288 });
289 }
290
291 repaintAll() {
292 try { effects.addRepaintFull(); } catch (e) {
293 if (!this.bmwWarned) { this.bmwWarned = true; console.warn("marble: addRepaintFull unavailable: " + e); }
294 }
295 }
296
297 slotWindowDataChanged(window, role) {
298 if (role == Effect.WindowAddedGrabRole) {
299 if (window.bmwInAnimation && effect.isGrabbed(window, role)) {
300 cancel(window.bmwInAnimation);
301 delete window.bmwInAnimation;
302 this.cleanupForcedRoles(window);
303 }
304 } else if (role == Effect.WindowClosedGrabRole) {
305 if (window.bmwOutAnimation && effect.isGrabbed(window, role)) {
306 cancel(window.bmwOutAnimation);
307 delete window.bmwOutAnimation;
308 this.cleanupForcedRoles(window);
309 }
310 }
311 }
312}
313
314new BurnMyWindowsMarbleEffect();