[effects] Re-implement the Minimize Animation effect in JavaScript
Summary: There were several reasons to rewrite the Minimize Animation effect in JavaScript: to simplify code and to get rid of full repaints. One could say that nothing prevents us from calculating the dirty region in postPaintScreen or postPaintWindow and it is correct, but with the scripting effects API the dirty region will be calculated for us, so we can focus more on "what we want" instead of "how". Visually, the "old" effect and the rewritten one look quite the same. Except one tiny bit: if a window doesn't have an icon in the task manager, it won't be animated. The reason for that is the purpose of this effect is to show where the window will be after it's minimized, if the window doesn't have icon in the task manager, one can't click at the center of the screen to unminimize the window. There is one significant change, the name of the effect was changed to "Squash". If we put this effect and the Magic lamp effect under "Window Minimize Animation" category (or if we add some "heading" label), then the old name and the name of the category would "conflict". The new name was suggested by Nate Graham and it very closely describes what the effect does. "Scale" doesn't fit this effect because while a window is being animated, its aspect ratio is not preserved. Reviewers: #kwin, #plasma, davidedmundson Reviewed By: #kwin, #plasma, davidedmundson Subscribers: davidedmundson, kwin Tags: #kwin Differential Revision: https://phabricator.kde.org/D16372master
Vlad Zagorodniy
6 years ago
parent
c32ffcab46
commit
eb78b1ca3a
@ -1,7 +0,0 @@
|
||||
#######################################
|
||||
# Effect
|
||||
|
||||
# Source files
|
||||
set( kwin4_effect_builtins_sources ${kwin4_effect_builtins_sources}
|
||||
minimizeanimation/minimizeanimation.cpp
|
||||
)
|
||||
@ -1,165 +0,0 @@
|
||||
/********************************************************************
|
||||
KWin - the KDE window manager
|
||||
This file is part of the KDE project.
|
||||
|
||||
Copyright (C) 2007 Rivo Laks <rivolaks@hot.ee>
|
||||
|
||||
This program is free software; you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation; either version 2 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*********************************************************************/
|
||||
|
||||
#include "minimizeanimation.h"
|
||||
|
||||
#include <QVector2D>
|
||||
|
||||
namespace KWin
|
||||
{
|
||||
|
||||
MinimizeAnimationEffect::MinimizeAnimationEffect()
|
||||
{
|
||||
reconfigure(ReconfigureAll);
|
||||
|
||||
connect(effects, &EffectsHandler::windowDeleted, this, &MinimizeAnimationEffect::windowDeleted);
|
||||
connect(effects, &EffectsHandler::windowMinimized, this, &MinimizeAnimationEffect::windowMinimized);
|
||||
connect(effects, &EffectsHandler::windowUnminimized, this, &MinimizeAnimationEffect::windowUnminimized);
|
||||
}
|
||||
|
||||
void MinimizeAnimationEffect::reconfigure(ReconfigureFlags flags)
|
||||
{
|
||||
Q_UNUSED(flags)
|
||||
|
||||
m_duration = std::chrono::milliseconds(static_cast<int>(animationTime(250)));
|
||||
}
|
||||
|
||||
bool MinimizeAnimationEffect::supported()
|
||||
{
|
||||
return effects->animationsSupported();
|
||||
}
|
||||
|
||||
void MinimizeAnimationEffect::prePaintScreen(ScreenPrePaintData &data, int time)
|
||||
{
|
||||
const std::chrono::milliseconds delta(time);
|
||||
|
||||
auto animationIt = m_animations.begin();
|
||||
while (animationIt != m_animations.end()) {
|
||||
(*animationIt).update(delta);
|
||||
++animationIt;
|
||||
}
|
||||
|
||||
// We need to mark the screen windows as transformed. Otherwise the
|
||||
// whole screen won't be repainted, resulting in artefacts.
|
||||
data.mask |= PAINT_SCREEN_WITH_TRANSFORMED_WINDOWS;
|
||||
|
||||
effects->prePaintScreen(data, time);
|
||||
}
|
||||
|
||||
void MinimizeAnimationEffect::prePaintWindow(EffectWindow *w, WindowPrePaintData &data, int time)
|
||||
{
|
||||
if (m_animations.contains(w)) {
|
||||
data.setTransformed();
|
||||
w->enablePainting(EffectWindow::PAINT_DISABLED_BY_MINIMIZE);
|
||||
}
|
||||
|
||||
effects->prePaintWindow(w, data, time);
|
||||
}
|
||||
|
||||
void MinimizeAnimationEffect::paintWindow(EffectWindow *w, int mask, QRegion region, WindowPaintData &data)
|
||||
{
|
||||
const auto animationIt = m_animations.constFind(w);
|
||||
if (animationIt != m_animations.constEnd()) {
|
||||
// 0 = not minimized, 1 = fully minimized
|
||||
const qreal progress = (*animationIt).value();
|
||||
|
||||
QRect geo = w->geometry();
|
||||
QRect icon = w->iconGeometry();
|
||||
// If there's no icon geometry, minimize to the center of the screen
|
||||
if (!icon.isValid()) {
|
||||
icon = QRect(effects->virtualScreenGeometry().center(), QSize(0, 0));
|
||||
}
|
||||
|
||||
data *= QVector2D(interpolate(1.0, icon.width() / (double)geo.width(), progress),
|
||||
interpolate(1.0, icon.height() / (double)geo.height(), progress));
|
||||
data.setXTranslation(interpolate(data.xTranslation(), icon.x() - geo.x(), progress));
|
||||
data.setYTranslation(interpolate(data.yTranslation(), icon.y() - geo.y(), progress));
|
||||
data.multiplyOpacity(interpolate(1.0, 0.1, progress));
|
||||
}
|
||||
|
||||
effects->paintWindow(w, mask, region, data);
|
||||
}
|
||||
|
||||
void MinimizeAnimationEffect::postPaintScreen()
|
||||
{
|
||||
auto animationIt = m_animations.begin();
|
||||
while (animationIt != m_animations.end()) {
|
||||
if ((*animationIt).done()) {
|
||||
animationIt = m_animations.erase(animationIt);
|
||||
} else {
|
||||
++animationIt;
|
||||
}
|
||||
}
|
||||
|
||||
effects->addRepaintFull();
|
||||
|
||||
effects->postPaintScreen();
|
||||
}
|
||||
|
||||
void MinimizeAnimationEffect::windowDeleted(EffectWindow *w)
|
||||
{
|
||||
m_animations.remove(w);
|
||||
}
|
||||
|
||||
void MinimizeAnimationEffect::windowMinimized(EffectWindow *w)
|
||||
{
|
||||
if (effects->activeFullScreenEffect()) {
|
||||
return;
|
||||
}
|
||||
|
||||
TimeLine &timeLine = m_animations[w];
|
||||
|
||||
if (timeLine.running()) {
|
||||
timeLine.toggleDirection();
|
||||
} else {
|
||||
timeLine.setDirection(TimeLine::Forward);
|
||||
timeLine.setDuration(m_duration);
|
||||
timeLine.setEasingCurve(QEasingCurve::InOutSine);
|
||||
}
|
||||
|
||||
effects->addRepaintFull();
|
||||
}
|
||||
|
||||
void MinimizeAnimationEffect::windowUnminimized(EffectWindow *w)
|
||||
{
|
||||
if (effects->activeFullScreenEffect()) {
|
||||
return;
|
||||
}
|
||||
|
||||
TimeLine &timeLine = m_animations[w];
|
||||
|
||||
if (timeLine.running()) {
|
||||
timeLine.toggleDirection();
|
||||
} else {
|
||||
timeLine.setDirection(TimeLine::Backward);
|
||||
timeLine.setDuration(m_duration);
|
||||
timeLine.setEasingCurve(QEasingCurve::InOutSine);
|
||||
}
|
||||
|
||||
effects->addRepaintFull();
|
||||
}
|
||||
|
||||
bool MinimizeAnimationEffect::isActive() const
|
||||
{
|
||||
return !m_animations.isEmpty();
|
||||
}
|
||||
|
||||
} // namespace
|
||||
|
||||
@ -1,66 +0,0 @@
|
||||
/********************************************************************
|
||||
KWin - the KDE window manager
|
||||
This file is part of the KDE project.
|
||||
|
||||
Copyright (C) 2007 Rivo Laks <rivolaks@hot.ee>
|
||||
|
||||
This program is free software; you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation; either version 2 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*********************************************************************/
|
||||
|
||||
#ifndef KWIN_MINIMIZEANIMATION_H
|
||||
#define KWIN_MINIMIZEANIMATION_H
|
||||
|
||||
// Include with base class for effects.
|
||||
#include <kwineffects.h>
|
||||
|
||||
namespace KWin
|
||||
{
|
||||
|
||||
/**
|
||||
* Animates minimize/unminimize
|
||||
**/
|
||||
class MinimizeAnimationEffect : public Effect
|
||||
{
|
||||
Q_OBJECT
|
||||
|
||||
public:
|
||||
MinimizeAnimationEffect();
|
||||
|
||||
void reconfigure(ReconfigureFlags flags) override;
|
||||
|
||||
void prePaintScreen(ScreenPrePaintData &data, int time) override;
|
||||
void prePaintWindow(EffectWindow *w, WindowPrePaintData &data, int time) override;
|
||||
void paintWindow(EffectWindow *w, int mask, QRegion region, WindowPaintData &data) override;
|
||||
void postPaintScreen() override;
|
||||
bool isActive() const override;
|
||||
|
||||
int requestedEffectChainPosition() const override {
|
||||
return 50;
|
||||
}
|
||||
|
||||
static bool supported();
|
||||
|
||||
private Q_SLOTS:
|
||||
void windowDeleted(EffectWindow *w);
|
||||
void windowMinimized(EffectWindow *w);
|
||||
void windowUnminimized(EffectWindow *w);
|
||||
|
||||
private:
|
||||
std::chrono::milliseconds m_duration;
|
||||
QHash<const EffectWindow*, TimeLine> m_animations;
|
||||
};
|
||||
|
||||
} // namespace
|
||||
|
||||
#endif
|
||||
@ -0,0 +1 @@
|
||||
add_subdirectory(package)
|
||||
@ -0,0 +1,9 @@
|
||||
install(DIRECTORY contents
|
||||
DESTINATION ${DATA_INSTALL_DIR}/${KWIN_NAME}/effects/kwin4_effect_squash)
|
||||
|
||||
install(FILES metadata.desktop
|
||||
DESTINATION ${DATA_INSTALL_DIR}/${KWIN_NAME}/effects/kwin4_effect_squash)
|
||||
|
||||
install(FILES metadata.desktop
|
||||
DESTINATION ${SERVICES_INSTALL_DIR}/${KWIN_NAME}
|
||||
RENAME kwin4_effect_squash.desktop)
|
||||
@ -0,0 +1,150 @@
|
||||
/********************************************************************
|
||||
This file is part of the KDE project.
|
||||
|
||||
Copyright (C) 2018 Vlad Zagorodniy <vladzzag@gmail.com>
|
||||
|
||||
This program is free software; you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation; either version 2 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*********************************************************************/
|
||||
|
||||
var squashEffect = {
|
||||
duration: animationTime(250),
|
||||
loadConfig: function () {
|
||||
"use strict";
|
||||
squashEffect.duration = animationTime(250);
|
||||
},
|
||||
slotWindowMinimized: function (window) {
|
||||
"use strict";
|
||||
if (effects.hasActiveFullScreenEffect) {
|
||||
return;
|
||||
}
|
||||
|
||||
// If the window doesn't have an icon in the task manager,
|
||||
// don't animate it.
|
||||
var iconRect = window.iconGeometry;
|
||||
if (iconRect.width == 0 || iconRect.height == 0) {
|
||||
return;
|
||||
}
|
||||
|
||||
if (window.unminimizeAnimation) {
|
||||
// TODO: Try to reverse it instead.
|
||||
cancel(window.unminimizeAnimation);
|
||||
delete window.unminimizeAnimation;
|
||||
}
|
||||
|
||||
var windowRect = window.geometry;
|
||||
|
||||
window.minimizeAnimation = animate({
|
||||
window: window,
|
||||
curve: QEasingCurve.InOutSine,
|
||||
duration: squashEffect.duration,
|
||||
animations: [
|
||||
{
|
||||
type: Effect.Size,
|
||||
from: {
|
||||
value1: windowRect.width,
|
||||
value2: windowRect.height
|
||||
},
|
||||
to: {
|
||||
value1: iconRect.width,
|
||||
value2: iconRect.height
|
||||
}
|
||||
},
|
||||
{
|
||||
type: Effect.Translation,
|
||||
from: {
|
||||
value1: 0.0,
|
||||
value2: 0.0
|
||||
},
|
||||
to: {
|
||||
value1: iconRect.x - windowRect.x -
|
||||
(windowRect.width - iconRect.width) / 2,
|
||||
value2: iconRect.y - windowRect.y -
|
||||
(windowRect.height - iconRect.height) / 2,
|
||||
}
|
||||
},
|
||||
{
|
||||
type: Effect.Opacity,
|
||||
from: 1.0,
|
||||
to: 0.0
|
||||
}
|
||||
]
|
||||
});
|
||||
},
|
||||
slotWindowUnminimized: function (window) {
|
||||
"use strict";
|
||||
if (effects.hasActiveFullScreenEffect) {
|
||||
return;
|
||||
}
|
||||
|
||||
// If the window doesn't have an icon in the task manager,
|
||||
// don't animate it.
|
||||
var iconRect = window.iconGeometry;
|
||||
if (iconRect.width == 0 || iconRect.height == 0) {
|
||||
return;
|
||||
}
|
||||
|
||||
if (window.minimizeAnimation) {
|
||||
// TODO: Try to reverse it instead.
|
||||
cancel(window.minimizeAnimation);
|
||||
delete window.minimizeAnimation;
|
||||
}
|
||||
|
||||
var windowRect = window.geometry;
|
||||
|
||||
window.unminimizeAnimation = animate({
|
||||
window: window,
|
||||
curve: QEasingCurve.InOutSine,
|
||||
duration: squashEffect.duration,
|
||||
animations: [
|
||||
{
|
||||
type: Effect.Size,
|
||||
from: {
|
||||
value1: iconRect.width,
|
||||
value2: iconRect.height
|
||||
},
|
||||
to: {
|
||||
value1: windowRect.width,
|
||||
value2: windowRect.height
|
||||
}
|
||||
},
|
||||
{
|
||||
type: Effect.Translation,
|
||||
from: {
|
||||
value1: iconRect.x - windowRect.x -
|
||||
(windowRect.width - iconRect.width) / 2,
|
||||
value2: iconRect.y - windowRect.y -
|
||||
(windowRect.height - iconRect.height) / 2,
|
||||
},
|
||||
to: {
|
||||
value1: 0.0,
|
||||
value2: 0.0
|
||||
}
|
||||
},
|
||||
{
|
||||
type: Effect.Opacity,
|
||||
from: 0.0,
|
||||
to: 1.0
|
||||
}
|
||||
]
|
||||
});
|
||||
},
|
||||
init: function () {
|
||||
"use strict";
|
||||
effect.configChanged.connect(squashEffect.loadConfig);
|
||||
effects.windowMinimized.connect(squashEffect.slotWindowMinimized);
|
||||
effects.windowUnminimized.connect(squashEffect.slotWindowUnminimized);
|
||||
}
|
||||
};
|
||||
|
||||
squashEffect.init();
|
||||
@ -0,0 +1,21 @@
|
||||
[Desktop Entry]
|
||||
Comment=Squash windows when they are minimized
|
||||
Icon=preferences-system-windows-effect-squash
|
||||
Name=Squash
|
||||
|
||||
Type=Service
|
||||
X-KDE-ParentApp=
|
||||
X-KDE-PluginInfo-Author=Rivo Laks, Vlad Zagorodniy
|
||||
X-KDE-PluginInfo-Category=Appearance
|
||||
X-KDE-PluginInfo-Email=rivolaks@hot.ee, vladzzag@gmail.com
|
||||
X-KDE-PluginInfo-License=GPL
|
||||
X-KDE-PluginInfo-Name=kwin4_effect_squash
|
||||
X-KDE-PluginInfo-Version=1
|
||||
X-KDE-PluginInfo-Website=
|
||||
X-KDE-ServiceTypes=KWin/Effect
|
||||
X-KDE-PluginInfo-EnabledByDefault=true
|
||||
X-KDE-Ordering=60
|
||||
X-Plasma-API=javascript
|
||||
X-Plasma-MainScript=code/main.js
|
||||
X-KWin-Exclusive-Category=minimize
|
||||
X-KWin-Video-Url=http://files.kde.org/plasma/kwin/effect-videos/minimize.ogv
|
||||
Loading…
Reference in New Issue