h1. Animation

{{>toc}} 

libavg contains a powerful animation framework that allows you to quickly author time and event-based changes in nodes. Animations can change the values of all numeric node attributes. They can be combined to execute in parallel or in series, they can switch states when some external event occurs, and callbacks can be registered that are called when animations start or stop.

> (!) *Note:* (!) 

> The animation framework is present in libavg since version 0.9. Some earlier (incompatible) animation classes are still present in the namespace anim; they will be removed future libavg versions.

h1. Linear Animations

It is very simple to animate node attributes:

_anim1.py_

<pre><code class="python">

#!/usr/bin/env python

# -*- coding: utf-8 -*-

from libavg import *

def startAnim():

    animObj.start()

player = avg.Player.get()

canvas = player.createMainCanvas(size=(640,480))

rootNode = canvas.getRootNode()

node = avg.WordsNode(pos=(10,10), font="arial",

        text="Hello World", parent=rootNode)

animObj = LinearAnim(node, "x", 2000, 0, 200)

player.setTimeout(0, startAnim)

player.play()

</code></pre>

This creates an animation that moves the node from x=0 to x=200 over a course of 2000 milliseconds. The framework takes care of updating the position each frame. Point attributes (such as pos and size) can be animated in the same way. LinearAnim has a few additional optional parameters, which are described in detail in the [[reference]]. Using this class, you are independent of the framerate: if you change the framerate (maybe because you're running the code on a different computer with a different refresh rate), the animation will still take the same amount of time to complete. It'll just display more or less frames. There is another advantage: If something happens while the animation is running (the user presses a cancel button, for instance), you can just call @animObj.abort()@ and it'll stop dead in it's tracks. The animation framework also makes sure that only one animation per attribute is running at one time. If a second one is started, the first one is aborted.

There are convenience functions that handle fading the opacity of nodes called @fadeIn()@ and @fadeOut()@.

h1. Easein/out

LinearAnim moves the attribute at a constant speed with no accelleration or decelleration. The EaseInOutAnim class encapsulates an animation that proceeds in three phases: ease-in, linear and ease-out. Constructor parameters determine the length of each phase. Start and end speed are zero. Ease-in and ease-out phases have the shape of one quadrant of the sine curve. Less mathematically put: The animation will accellerate and decellerate at the beginning and end and look a lot smoother because of this.

h1. ParallelAnim

In many cases, you will want to start several animations at once. This can be accomplished using the ParallelAnim class:

_anim2.py_

<pre><code class="python">

#!/usr/bin/env python

# -*- coding: utf-8 -*-

from libavg import *

def startAnim():

    animObj.start()

player = avg.Player.get()

canvas = player.createMainCanvas(size=(640,480))

rootNode = canvas.getRootNode()

node = avg.WordsNode(pos=(10,10), font="arial", 

        text="Hello World", parent=rootNode)

animObj = ParallelAnim(

    [LinearAnim(node, "x", 2000, 0, 200),

     LinearAnim(node, "y", 2000, 0, 10)])

player.setTimeout(0, startAnim)

player.play()

</code></pre>

The example code moves the node down and to the right over a course of 2 seconds (Note that in this case, just running a @LinearAnim@ on the pos attribute of the node would have been enough). Calling @abort()@ on a @ParallelAnim@ will stop all child animations. @ParallelAnim@ is sometimes useful on its own, but it's really powerful in combination with @StateAnim@.

h1. StateAnim

More complex animations can be scripted using @StateAnim@. Objects of this class contain a number of animations (so-called "states") that can be executed in an arbitrary sequence. At most one of these animations is active at once. The end of one animation can trigger the start of another one, and states can be set from a python script. A simple use for a @StateAnim@ is as a predetermined sequence of animations, but animations that take different routes depending on user input events are also possible. There is support for debugging animation states by calling @StateAnim.setDebug(True)@. This causes all state changes to be dumped to the console.

To make sure there are no discontinuities between two states, @Anim.start()@ has an optional parameter @keepAttr@. If this is set to True, the attribute is not changed at the beginning of the animation and the animation runs only for an appropriate part of the time that the duration parameter specifies. So, suppose that in _anim2.py_ above, @start(True)@ is called and x=50 before the animation start. Since this is one-quarter into the range 0-200, the animation will run for 1500 ms (=2000*0.75) and the node will move from 50 to 200 in this time.

Note that changing the state of a @StateAnim@ during an animation callback is not supported. An attempt to do so is silently ignored.

h1. Other Animations

@WaitAnim@ does nothing for a predetermined amount of time. @ContinuonsAnim@ continually changes one attribute and doesn't stop by itself.