kwin/effects/glide/glide.h
Vlad Zagorodniy 6a7e780d74 [effects] Rewrite the Glide effect
Summary:
There are several reasons why I "re-wrote" the Glide effect:
* it doesn't work correctly because it suffers from undesired perspective distortions: {F5914378}
   The worst part is that windows are distorted so much on multiple monitor setups that it's hard to say whether that's glide animation.
* window close animation is not quite intuitive: if the close button is
  located at the top and I click it, I would expect that window is
  rotated around the bottom edge, not the top; (IMHO)
* it's too much distracting when working on something for quite good
  amount of time: e.g. when editing photos, which involves a big number
  of different dialogs;
* there are issues with deletion of QTimeLine;
* windows are not gracefully released if some other effect grabs them;
* its code doesn't follow common coding style in KWin.

So, the "new" Glide effect is more subtle, it's possible to have
different rotation edges for window open/close animations, it doesn't
animate special windows(like audio volume feedback), the code is simpler
and readable. Yet, there are some issues with QTimeLine, which are
common to all effects in KWin anyway.

### Demos

{F5889803}
//Window Open Animation//

{F5889804}
//Window Close Animation//

{F5889805, layout=center, size=full}
//KCM//

CCBUG: 394245

Test Plan:
* Enabled the Glide effect
* Closed System Settings
* Opened it again

Reviewers: #kwin, #plasma, #vdg, davidedmundson

Reviewed By: #kwin, #plasma, #vdg, davidedmundson

Subscribers: ngraham, kwin

Tags: #kwin

Differential Revision: https://phabricator.kde.org/D13338
2018-07-24 22:10:10 +03:00

156 lines
4 KiB
C++

/********************************************************************
KWin - the KDE window manager
This file is part of the KDE project.
Copyright (C) 2007 Philip Falkner <philip.falkner@gmail.com>
Copyright (C) 2009 Martin Gräßlin <mgraesslin@kde.org>
Copyright (C) 2010 Alexandre Pereira <pereira.alex@gmail.com>
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/>.
*********************************************************************/
#ifndef KWIN_GLIDE_H
#define KWIN_GLIDE_H
// kwineffects
#include <kwineffects.h>
namespace KWin
{
class GlideEffect : public Effect
{
Q_OBJECT
Q_PROPERTY(int duration READ duration)
Q_PROPERTY(RotationEdge inRotationEdge READ inRotationEdge)
Q_PROPERTY(qreal inRotationAngle READ inRotationAngle)
Q_PROPERTY(qreal inDistance READ inDistance)
Q_PROPERTY(qreal inOpacity READ inOpacity)
Q_PROPERTY(RotationEdge outRotationEdge READ outRotationEdge)
Q_PROPERTY(qreal outRotationAngle READ outRotationAngle)
Q_PROPERTY(qreal outDistance READ outDistance)
Q_PROPERTY(qreal outOpacity READ outOpacity)
public:
GlideEffect();
~GlideEffect() override;
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;
static bool supported();
enum RotationEdge {
Top = 0,
Right = 1,
Bottom = 2,
Left = 3
};
Q_ENUM(RotationEdge)
int duration() const;
RotationEdge inRotationEdge() const;
qreal inRotationAngle() const;
qreal inDistance() const;
qreal inOpacity() const;
RotationEdge outRotationEdge() const;
qreal outRotationAngle() const;
qreal outDistance() const;
qreal outOpacity() const;
private Q_SLOTS:
void windowAdded(EffectWindow *w);
void windowClosed(EffectWindow *w);
void windowDeleted(EffectWindow *w);
void windowDataChanged(EffectWindow *w, int role);
private:
bool isGlideWindow(EffectWindow *w) const;
std::chrono::milliseconds m_duration;
QHash<EffectWindow*, TimeLine> m_animations;
struct GlideParams {
RotationEdge edge;
struct {
qreal from;
qreal to;
} angle, distance, opacity;
};
GlideParams m_inParams;
GlideParams m_outParams;
};
inline int GlideEffect::requestedEffectChainPosition() const
{
return 50;
}
inline int GlideEffect::duration() const
{
return m_duration.count();
}
inline GlideEffect::RotationEdge GlideEffect::inRotationEdge() const
{
return m_inParams.edge;
}
inline qreal GlideEffect::inRotationAngle() const
{
return m_inParams.angle.from;
}
inline qreal GlideEffect::inDistance() const
{
return m_inParams.distance.from;
}
inline qreal GlideEffect::inOpacity() const
{
return m_inParams.opacity.from;
}
inline GlideEffect::RotationEdge GlideEffect::outRotationEdge() const
{
return m_outParams.edge;
}
inline qreal GlideEffect::outRotationAngle() const
{
return m_outParams.angle.to;
}
inline qreal GlideEffect::outDistance() const
{
return m_outParams.distance.to;
}
inline qreal GlideEffect::outOpacity() const
{
return m_outParams.opacity.to;
}
} // namespace KWin
#endif