BlueGit

timfa kwin-marble

Files

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

main.js

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