Differential D16452 Diff 45656 effects/dimscreen/package/contents/code/main.js

Changeset View

Standalone View

View Options

effects/dimscreen/package/contents/code/main.js

  • This file was added.
1​/********************************************************************
2​ This file is part of the KDE project.
3​
4​Copyright (C) 2018 Vlad Zagorodniy <vladzzag@gmail.com>
5​
6​This program is free software; you can redistribute it and/or modify
7​it under the terms of the GNU General Public License as published by
8​the Free Software Foundation; either version 2 of the License, or
9​(at your option) any later version.
10​
11​This program is distributed in the hope that it will be useful,
12​but WITHOUT ANY WARRANTY; without even the implied warranty of
13​MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14​GNU General Public License for more details.
15​
16​You should have received a copy of the GNU General Public License
17​along with this program. If not, see <http://www.gnu.org/licenses/>.
18​*********************************************************************/
19​
20​"use strict";
21​
22​var authenticationAgents = [
23​ "kdesu kdesu",
24​ "kdesudo kdesudo",
25​ "pinentry pinentry",
26​ "polkit-kde-authentication-agent-1 polkit-kde-authentication-agent-1",
27​ "polkit-kde-manager polkit-kde-manager",
28​
29​ // On Wayland, the resource name is filename of executable. It's empty for
30​ // authentication agents because KWayland can't get their executable paths.
31​ " org.kde.kdesu",
32​ " org.kde.polkit-kde-authentication-agent-1"
33​];
34​
35​function activeAuthenticationAgent() {
36​ var activeWindow = effects.activeWindow;
37​ if (!activeWindow) {
38​ return null;
39​ }
40​
41​ if (authenticationAgents.indexOf(activeWindow.windowClass) == -1) {
42​ return null;
43​ }
44​
45​ return activeWindow;
46​}
47​
48​var dimScreenEffect = {
49​ loadConfig: function () {
50​ dimScreenEffect.duration = animationTime(250);
51​ dimScreenEffect.brightness = 0.67;
davidedmundsonUnsubmitted
Not Done

This used to be:

data.multiplyBrightness((1.0 - 0.33 * timeline.currentValue()));

so this should be ~0.67?

davidedmundson: This used to be: data.multiplyBrightness((1.0 - 0.33 * timeline.currentValue())); so this…
zzagAuthorUnsubmitted
Not Done

Oh my God, this is so embarrassing. Yes, it should be 0.67.

zzag: Oh my God, this is so embarrassing. Yes, it should be 0.67.
52​ dimScreenEffect.saturation = 0.67;
53​ },
54​ startAnimation: function (window) {
55​ if (!window.visible) {
56​ return;
57​ }
58​ if (window.popupWindow) {
59​ return;
60​ }
61​ if (window.x11Client && !window.managed) {
zzagAuthorUnsubmitted
Not Done

That's a typo, it should be window.popupWindow.

zzag: That's a typo, it should be window.popupWindow.
62​ return;
63​ }
64​ if (window.dimAnimation) {
65​ if (redirect(window.dimAnimation, Effect.Forward)) {
66​ return;
67​ }
68​ cancel(window.dimAnimation);
davidedmundsonUnsubmitted
Not Done

I'd rather we cleaned the animation ID when it ends rather than leaving dangling IDs everywhere and having to work round it - but I won't insist on it if you disagree.

davidedmundson: I'd rather we cleaned the animation ID when it ends rather than leaving dangling IDs everywhere…
zzagAuthorUnsubmitted
Not Done

... cleaned the animation ID when it ends rather than leaving dangling IDs

Makes sense.

zzag: > ... cleaned the animation ID when it ends rather than leaving dangling IDs Makes sense.
zzagAuthorUnsubmitted
Not Done

Well, currently, we need to do more work to implement it: set() doesn't return a JavaScript Array object(so, we can't use indexOf, for example), and animationEnded doesn't pass actual animation id (it's always 0).

So, I'd like to postpone the cleanup of dangling animation ids.

Personally, I'd prefer to pass a closure to animate() and set() to get notified when the animation is completed, so the cleanup is more simpler, but I don't think we'll be able to implement something like this any time soon.

zzag: Well, currently, we need to do more work to implement it: set() doesn't return a JavaScript…
69​ }
70​ window.dimAnimation = set({
71​ window: window,
72​ curve: QEasingCurve.InOutSine,
73​ duration: dimScreenEffect.duration,
74​ keepAlive: false,
75​ animations: [
76​ {
77​ type: Effect.Saturation,
78​ to: dimScreenEffect.saturation
79​ },
80​ {
81​ type: Effect.Brightness,
82​ to: dimScreenEffect.brightness
83​ }
84​ ]
85​ });
86​ },
87​ startAnimationSmooth: function (window) {
88​ dimScreenEffect.startAnimation(window);
89​ },
90​ startAnimationInstant: function (window) {
91​ dimScreenEffect.startAnimation(window);
92​
93​ if (window.dimAnimation) {
94​ complete(window.dimAnimation);
95​ }
96​ },
97​ cancelAnimationSmooth: function (window) {
98​ if (!window.dimAnimation) {
99​ return;
100​ }
101​ if (redirect(window.dimAnimation, Effect.Backward)) {
102​ return;
103​ }
104​ cancel(window.dimAnimation);
105​ delete window.dimAnimation;
106​ },
107​ cancelAnimationInstant: function (window) {
108​ if (window.dimAnimation) {
109​ cancel(window.dimAnimation);
110​ delete window.dimAnimation;
111​ }
112​ },
113​ dimScreen: function (agent, animationFunc, cancelFunc) {
114​ // Keep track of currently active authentication agent so we don't have
115​ // to re-scan the stacking order in brightenScreen each time when some
116​ // window is activated.
117​ dimScreenEffect.authenticationAgent = agent;
118​
119​ var windows = effects.stackingOrder;
120​ for (var i = 0; i < windows.length; ++i) {
121​ var window = windows[i];
122​ if (window == agent) {
123​ // The agent might have been dimmed before (because there are
124​ // several authentication agents on the screen), so we need to
125​ // cancel previous animations for it if there are any.
126​ cancelFunc(agent);
127​ continue;
128​ }
129​ animationFunc(window);
130​ }
131​ },
132​ dimScreenSmooth: function (agent) {
133​ dimScreenEffect.dimScreen(
134​ agent,
135​ dimScreenEffect.startAnimationSmooth,
136​ dimScreenEffect.cancelAnimationSmooth
137​ );
138​ },
139​ dimScreenInstant: function (agent) {
140​ dimScreenEffect.dimScreen(
141​ agent,
142​ dimScreenEffect.startAnimationInstant,
143​ dimScreenEffect.cancelAnimationInstant
144​ );
145​ },
146​ brightenScreen: function (cancelFunc) {
147​ if (!dimScreenEffect.authenticationAgent) {
148​ return;
149​ }
150​ dimScreenEffect.authenticationAgent = null;
151​
152​ var windows = effects.stackingOrder;
153​ for (var i = 0; i < windows.length; ++i) {
154​ cancelFunc(windows[i]);
155​ }
156​ },
157​ brightenScreenSmooth: function () {
158​ dimScreenEffect.brightenScreen(dimScreenEffect.cancelAnimationSmooth);
159​ },
160​ brightenScreenInstant: function () {
161​ dimScreenEffect.brightenScreen(dimScreenEffect.cancelAnimationInstant);
162​ },
163​ slotWindowActivated: function (window) {
164​ if (!window) {
165​ return;
166​ }
167​ if (authenticationAgents.indexOf(window.windowClass) != -1) {
168​ dimScreenEffect.dimScreenSmooth(window);
169​ } else {
170​ dimScreenEffect.brightenScreenSmooth();
171​ }
172​ },
173​ slotWindowAdded: function (window) {
174​ // Don't dim authentication agents that just opened.
175​ var agent = activeAuthenticationAgent();
176​ if (agent == window) {
177​ return;
178​ }
179​
180​ // If a window appeared while the screen is dimmed, dim the window too.
181​ if (agent) {
182​ dimScreenEffect.startAnimationInstant(window);
183​ }
184​ },
185​ slotActiveFullScreenEffectChanged: function () {
186​ // If some full screen effect has been activated, for example the desktop
187​ // cube effect, then brighten screen back. We need to do that because the
188​ // full screen effect can dim windows on its own.
189​ if (effects.hasActiveFullScreenEffect) {
190​ dimScreenEffect.brightenScreenSmooth();
191​ return;
192​ }
193​
194​ // If user left the full screen effect, try to dim screen back.
195​ var agent = activeAuthenticationAgent();
196​ if (agent) {
197​ dimScreenEffect.dimScreenSmooth(agent);
198​ }
199​ },
200​ slotDesktopChanged: function () {
201​ // If there is an active full screen effect, then try smoothly dim/brighten
202​ // the screen. Keep in mind that in order for this to work properly, this
203​ // effect has to come after the full screen effect in the effect chain,
204​ // otherwise this slot will be invoked before the full screen effect can mark
205​ // itself as a full screen effect.
206​ if (effects.hasActiveFullScreenEffect) {
207​ return;
208​ }
209​
210​ // Try to brighten windows on the previous virtual desktop.
211​ dimScreenEffect.brightenScreenInstant();
212​
213​ // Try to dim windows on the current virtual desktop.
214​ var agent = activeAuthenticationAgent();
215​ if (agent) {
216​ dimScreenEffect.dimScreenInstant(agent);
217​ }
218​ },
219​ restartAnimation: function (window) {
220​ if (activeAuthenticationAgent()) {
221​ dimScreenEffect.startAnimationInstant(window);
222​ }
223​ },
224​ init: function () {
225​ dimScreenEffect.loadConfig();
226​
227​ effect.configChanged.connect(dimScreenEffect.loadConfig);
228​ effects.windowActivated.connect(dimScreenEffect.slotWindowActivated);
229​ effects.windowAdded.connect(dimScreenEffect.slotWindowAdded);
230​ effects.windowMinimized.connect(dimScreenEffect.cancelAnimationInstant);
231​ effects.windowUnminimized.connect(dimScreenEffect.restartAnimation);
232​ effects.activeFullScreenEffectChanged.connect(
233​ dimScreenEffect.slotActiveFullScreenEffectChanged);
234​ effects['desktopChanged(int,int)'].connect(dimScreenEffect.slotDesktopChanged);
235​ }
236​};
237​
238​dimScreenEffect.init();