BlueGit

timfa kwin-marble

Files

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

main.js

main.js 11.6 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 effect.setUniform(this.shader, 'uMixOuter', Math.min(100, Math.max(0, Number(effect.readConfig('BlackMixOuter', 80)))) / 100);
97 effect.setUniform(this.shader, 'uMixCenter', Math.min(100, Math.max(0, Number(effect.readConfig('BlackMixCenter', 5)))) / 100);
98 effect.setUniform(this.shader, 'uCrumpleEnd', this.duration / Math.max(1, this.duration + this.pause + this.fallDuration));
99 }
100
101 // Mix target colour. tintMode 11 = random; with reuse, a random colour picked for this
102 // window (e.g. at minimize) is used again (e.g. at unminimize) and then forgotten.
103 applyTint(window, reuse) {
104 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]];
105 let c;
106 if (this.tintMode < C.length) c = C[this.tintMode];
107 else if (window && reuse && window.bmwTint) { c = window.bmwTint; window.bmwTint = null; }
108 else { c = C[Math.floor(Math.random() * C.length)]; if (window) window.bmwTint = c; }
109 effect.setUniform(this.shader, 'uTintR', c[0]);
110 effect.setUniform(this.shader, 'uTintG', c[1]);
111 effect.setUniform(this.shader, 'uTintB', c[2]);
112 }
113
114 static shouldAnimateWindow(window) {
115
116 // We don't want to animate most of plasmashell's windows, yet, some
117 // of them we want to, for example, Task Manager Settings window.
118 // The problem is that all those window share single window class.
119 // So, the only way to decide whether a window should be animated is
120 // to use a heuristic: if a window has decoration, then it's most
121 // likely a dialog or a settings window so we have to animate it.
122 if (window.windowClass == 'plasmashell plasmashell' ||
123 window.windowClass == 'plasmashell org.kde.plasmashell') {
124 return window.hasDecoration;
125 }
126
127 // This is primarily to avoid animating the AltTab popup.
128 // See https://github.com/Schneegans/Burn-My-Windows/issues/384 for details.
129 if (!window.hasDecoration && window.onAllDesktops) {
130 return false
131 }
132
133 if (classBlacklist.indexOf(window.windowClass) != -1) {
134 return false;
135 }
136
137 if (nameBlacklist.indexOf(window.caption) != -1) {
138 return false;
139 }
140
141 if (window.hasDecoration) {
142 return true;
143 }
144
145 // Don't animate combobox popups, tooltips, popup menus, etc.
146 if (window.popupWindow) {
147 return false;
148 }
149
150 // Dont't animate the outline and the screenlocker as it looks bad.
151 if (window.lockScreen || window.outline) {
152 return false;
153 }
154
155 // Override-redirect windows are usually used for user interface
156 // concepts that are not expected to be animated by this effect.
157 if (!window.managed) {
158 return false;
159 }
160
161 return window.normalWindow || window.dialog;
162 }
163
164 setupForcedRoles(window) {
165 // marble: no forced blur/contrast (blurred window-sized rect + cost)
166 // window.setData(Effect.WindowForceBackgroundContrastRole, true);
167 // marble: no forced blur/contrast (blurred window-sized rect + cost)
168 // window.setData(Effect.WindowForceBlurRole, true);
169 }
170
171 cleanupForcedRoles(window) {
172 window.setData(Effect.WindowForceBackgroundContrastRole, null);
173 window.setData(Effect.WindowForceBlurRole, null);
174 }
175
176 slotWindowAdded(window) {
177 if (effects.hasActiveFullScreenEffect) {
178 return;
179 }
180 if (!BurnMyWindowsMarbleEffect.shouldAnimateWindow(window)) {
181 return;
182 }
183 if (!window.visible) {
184 return;
185 }
186 if (effect.isGrabbed(window, Effect.WindowAddedGrabRole)) {
187 return;
188 }
189 this.setupForcedRoles(window);
190
191 this.applyTint(window, false);
192 effect.setUniform(this.shader, 'uForOpening', 1.0);
193 effect.setUniform(this.shader, 'uIsFullscreen', window.fullScreen ? 1.0 : 0.0);
194
195
196
197 window.bmwInAnimation = animate({
198 window: window,
199 curve: QEasingCurve.Linear,
200 duration: this.duration,
201 animations: [{
202 type: Effect.ShaderUniform,
203 fragmentShader: this.shader,
204 uniform: 'uProgress',
205 from: 0.0,
206 to: 1.0
207 }]
208 });
209 }
210
211 slotWindowClosed(window) {
212 if (effects.hasActiveFullScreenEffect) {
213 return;
214 }
215 if (!BurnMyWindowsMarbleEffect.shouldAnimateWindow(window)) {
216 return;
217 }
218 if (!window.visible || window.skipsCloseAnimation) {
219 return;
220 }
221 if (effect.isGrabbed(window, Effect.WindowClosedGrabRole)) {
222 return;
223 }
224 if (window.bmwInAnimation) {
225 cancel(window.bmwInAnimation);
226 delete window.bmwInAnimation;
227 }
228 this.setupForcedRoles(window);
229
230 this.applyTint(window, false);
231 effect.setUniform(this.shader, 'uForOpening', 0.0);
232 effect.setUniform(this.shader, 'uIsFullscreen', window.fullScreen ? 1.0 : 0.0);
233
234
235
236 // 1) marble morph (shader); runs the whole time so the marble stays drawn while falling
237 window.bmwOutAnimation = animate({
238 window: window,
239 curve: QEasingCurve.Linear,
240 duration: this.duration + this.pause + this.fallDuration,
241 animations: [{
242 type: Effect.ShaderUniform,
243 fragmentShader: this.shader,
244 uniform: 'uProgress',
245 from: 0.0,
246 to: 1.0
247 }]
248 });
249 // 2) marker animation that ends exactly when the marble is done; the fall is
250 // started from its animationEnded (KWin ignored the per-call delay).
251 window.bmwMarbleDone = animate({
252 window: window,
253 curve: QEasingCurve.Linear,
254 duration: this.duration + this.pause,
255 animations: [{ type: Effect.Translation, from: {value1: 0.0, value2: 0.0}, to: {value1: 0.0, value2: 0.0} }]
256 });
257 window.bmwFallPending = true;
258 }
259
260 slotAnimationEnded(window, id) {
261 // marble is drawn outside the window's own damage region: repaint all on every end
262 this.repaintAll();
263 if (!window || !window.bmwFallPending) return; // first end = marble marker (ids arrive as 0)
264 window.bmwFallPending = false;
265 // free fall from rest: InQuad = t^2 = constant acceleration, d = 0.5 g t^2
266 window.bmwFallAnimation = animate({
267 window: window,
268 curve: QEasingCurve.InQuad,
269 duration: this.fallDuration,
270 animations: [{ type: Effect.Translation, from: {value1: 0.0, value2: 0.0},
271 to: {value1: 0.0, value2: this.fallDistance} }]
272 });
273 }
274
275 repaintAll() {
276 try { effects.addRepaintFull(); } catch (e) {
277 if (!this.bmwWarned) { this.bmwWarned = true; console.warn("marble: addRepaintFull unavailable: " + e); }
278 }
279 }
280
281 slotWindowDataChanged(window, role) {
282 if (role == Effect.WindowAddedGrabRole) {
283 if (window.bmwInAnimation && effect.isGrabbed(window, role)) {
284 cancel(window.bmwInAnimation);
285 delete window.bmwInAnimation;
286 this.cleanupForcedRoles(window);
287 }
288 } else if (role == Effect.WindowClosedGrabRole) {
289 if (window.bmwOutAnimation && effect.isGrabbed(window, role)) {
290 cancel(window.bmwOutAnimation);
291 delete window.bmwOutAnimation;
292 this.cleanupForcedRoles(window);
293 }
294 }
295 }
296}
297
298new BurnMyWindowsMarbleEffect();