View source for KWin/Animations

There are many different animations in the KWin effects. The animations differ in animation duration and the kind of animation. The idea is to have this in a more consistent way by e.g. all fade animations having the same duration and animation behavior.

To be able to do so, it is first required to gather all the animation data.

== How to Find the Animation ==
All animations are defined in the effects source code which are located in {{path|kwin/effects}} in the [http://quickgit.kde.org/index.php?p=kde-workspace.git&a=summary kde-workspace git repository]. Most of the animations use one or many [http://qt-project.org/doc/qt-4.8/qtimeline.html QTimeLine] for controlling the animation. These are mostly defined in variables called ''timeline''. To find the animations which are going on one can look into a method called ''prePaintScreen'' which gets the time since the last rendered frame. There is some code which adds the time to the QTimeLine. For example in the DimScreenEffect this looks like the following:
<syntaxhighlight lang="cpp">
void DimScreenEffect::prePaintScreen(ScreenPrePaintData& data, int time)
{
    if (mActivated && activateAnimation && !effects->activeFullScreenEffect())
        timeline.setCurrentTime(timeline.currentTime() + time);
    if (mActivated && deactivateAnimation)
        timeline.setCurrentTime(timeline.currentTime() - time);
    if (mActivated && effects->activeFullScreenEffect())
        timeline.setCurrentTime(timeline.currentTime() - time);
    if (mActivated && !activateAnimation && !deactivateAnimation && !effects->activeFullScreenEffect() && timeline.currentValue() != 1.0)
        timeline.setCurrentTime(timeline.currentTime() + time);
    effects->prePaintScreen(data, time);
}
</syntaxhighlight>

From this we see that only one animation in variable "timeline" is defined.

== Finding the Animation Duration ==
The animation duration is somewhere in the effect defined. In most cases it is either a hardcoded value or comes from a configuration value, which also includes the default hardcoded. If you have your variable look for a code section like:
<syntaxhighlight lang="cpp">
variableName.setDuration(animationTime(250));
</syntaxhighlight>
Which would tell us that the duration is 250 msec. For a configurable duration it can look like:
<syntaxhighlight lang="cpp">
rotationDuration = animationTime(CubeConfig::rotationDuration() != 0 ? CubeConfig::rotationDuration() : 500);
timeLine.setDuration(rotationDuration);
</syntaxhighlight>
This would tell us that the default animation duration is 500 msec.

== Finding the Curve Shape ==
Each [http://qt-project.org/doc/qt-4.8/qtimeline.html QTimeLine] has either a CurveShape or a [http://qt-project.org/doc/qt-4.8/qeasingcurve.html QEasingCurve] assigned which describes how the animation looks like over time. If the animation uses a CurveShape you can find a code fragment looking like:
<syntaxhighlight lang="cpp">
variableName.setCurveShape(QTimeLine::EaseInOutCurve);
</syntaxhighlight>
This would tell us, that it is using an EaseInOutCurve.

If it uses a QEasingCurve it should look like:
<syntaxhighlight lang="cpp">
variableName.setEasingCurve(QEasingCurve::InOutQuad);
</syntaxhighlight>
This would tell us it is using an InOutQuad.

If there is no call for setting either the CurveShape or the EasingCurve on the QTimeLine the default behavior is a EaseInOutCurve.

== Effects ==
Please use the following table if an effect uses an animation:
{| class="wikitable"
|-
! Animation
! Duration
! Shape
|-
| What gets animated (e.g. fade windows, dim windows)
| Duration in msec
| CurveShape or EasingCurve
|}

=== blur ===
none
=== boxswitch ===
Can be ignored, scheduled for removal
=== coverswitch ===
{| class="wikitable"
|-
! Animation
! Duration
! Shape
|-
| Switch Windows
| 200
| EaseInOutCurve
|}

=== cube ===
{| class="wikitable"
|-
! Animation
! Duration
! Shape
|-
| Horizontal Rotation
| 500
| EaseInOutCurve
|-
| Vertical Rotation
| 500
| EaseInOutCurve
|}

=== cubeslide ===
{| class="wikitable"
|-
! Animation
! Duration
! Shape
|-
| Slide Rotation
| 500
| EaseInOutCurve
|}

=== dashboard ===
{| class="wikitable"
|-
! Animation
! Duration
! Shape
|-
| Show dashboard
| 500
| EaseInOutCurve
|-
| Hide dashboard
| 500
| EaseInOutCurve
|}

=== desktopgrid ===
{| class="wikitable"
|-
! Animation
! Duration
! Shape
|-
| Zoom duration
| 300
| EaseInOutCurve
|}

=== dialogparent ===
{| class="wikitable"
|-
! Animation
! Duration
! Shape
|-
| Darken parent window
| 300
| EaseInOutCurve
|}

=== diminactive ===
{| class="wikitable"
|-
! Animation
! Duration
! Shape
|-
| Darken inactive windows
| 250
| EaseInOutCurve
|}

=== dimscreen ===
{| class="wikitable"
|-
! Animation
! Duration
! Shape
|-
| Dim windows
| 250
| EaseInOutCurve
|-
| Undim windows
| 250
| EaseInOutCurve
|}
=== explosion ===

=== fade ===
=== fadedesktop ===
=== fallapart ===
{| class="wikitable"
|-
! Animation
! Duration
! Shape
|-
| Close windows
| 1000
| EaseInOutCurve
|}

=== flipswitch ===
{| class="wikitable"
|-
! Animation
! Duration
! Shape
|-
| Show/Hide flip effect
| 200
| EaseInOutCurve
|-
| Switch windows
| 200
| EaseInCurve
|}

=== glide ===
{| class="wikitable"
|-
! Animation
! Duration
! Shape
|-
| Open window
| 350
| EaseOutCurve
|-
| Close window
| 350
| EaseInCurve
|}

=== highlightwindow ===
=== invert ===
=== login ===
{| class="wikitable"
|-
! Animation
! Duration
! Shape
|-
| Fade desktop in
| 2000
| EaseInOutCurve
|}

=== logout ===
=== lookingglass ===
{| class="wikitable"
|-
! Animation
! Duration
! Shape
|-
| magnifies screen
| 500
| EaseInOutCurve
|}

=== magiclamp ===
{| class="wikitable"
|-
! Animation
! Duration
! Shape
|-
| Minimize window
| 250
| LinearCurve
|-
| Unminimize window
| 250
| LinearCurve
|}

=== magnifier ===
=== minimizeanimation ===
{| class="wikitable"
|-
! Animation
! Duration
! Shape
|-
| Minimize window
| 250
| EaseInOutCurve
|-
| Unminimize window
| 250
| EaseInOutCurve
|}

=== mousemark ===
=== outline ===
=== presentwindows ===
=== resize ===
=== scalein ===
{| class="wikitable"
|-
! Animation
! Duration
! Shape
|-
| Scale windows in
| 250
| EaseInOutCurve
|}
=== screenshot ===
=== sheet ===
{| class="wikitable"
|-
! Animation
! Duration
! Shape
|-
| show modal dialogs
| 500
| EaseInOutCurve
|}
=== showfps ===
=== showpaint ===
=== slide ===
{| class="wikitable"
|-
! Animation
! Duration
! Shape
|-
| Slide windows
| 250
| EaseInOutCurve
|}

=== slideback ===
=== slidingpopups ===
{| class="wikitable"
|-
! Animation
! Duration
! Shape
|-
| Slide popup in
| 250
| EaseInOutCurve
|-
| Slide popup out
| 250
| EaseInOutCurve
|}
=== snaphelper ===
{| class="wikitable"
|-
! Animation
! Duration
! Shape
|-
| Show Snap Helper
| 250
| LinearCurve
|-
| Hide Snap Helper
| 250
| LinearCurve
|}

=== startupfeedback ===
=== taskbarthumbnail ===
=== thumbnailaside ===
=== trackmouse ===
=== translucency ===
=== windowgeometry ===
=== windowstrip ===
=== wobblywindows ===
=== zoom ===
{| class="wikitable"
|-
! Animation
! Duration
! Shape
|-
| Zoom effect
| 500
| EaseInOutCurve
|}