isa/mutter
1
0
Fork 0
mirror of https://github.com/brl/mutter.git synced 2024-11-10 07:56:14 -05:00
Code Issues Packages Projects Releases Wiki Activity

[docs] Clarify clutter_actor_animate() behaviour

Browse Source 
When calling clutter_actor_animate() on an actor that is being
currently animated the default behaviour is to update the duration
of the animation; the easing mode; update all the common properties;
and finally add the new properties.

This:

  clutter_actor_animate (actor, 500, CLUTTER_LINEAR,
                         "width", 100,
                         "height", 100,
                         NULL);

  clutter_actor_animate (actor, 250, CLUTTER_EASE_IN_CUBIC,
                         "x", 100,
                         "y", 100,
                         "height", 200,
                         NULL);

Is logically equivalent to:

  clutter_actor_animate (actor, 250, CLUTTER_EASE_IN_CUBIC,
                         "x", 100,
                         "y", 100,
                         "width", 100,
                         "height", 200,
                         NULL);

The documentation of the function should be slightly more verbose
in describing the default behaviour.
This commit is contained in:
Emmanuele Bassi 2009-02-26 15:35:20 +00:00
parent a3839296c4
commit c0adf4582c
1 changed files with 25 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
clutter/clutter-animation.c
View File

@ -1418,7 +1418,31 @@ clutter_actor_animate_with_timeline (ClutterActor *actor,
* completed.
*
* Calling this function on an actor that is already being animated
* will cause the current animation to change with the new final value.
* will cause the current animation to change with the new final values,
* the new easing mode and the new duration - that is, this code:
*
* |[
* clutter_actor_animate (actor, 250, CLUTTER_LINEAR,
* "width", 100,
* "height", 100,
* NULL);
* clutter_actor_animate (actor, 500, CLUTTER_EASE_IN_CUBIC,
* "x", 100,
* "y", 100,
* "width", 200,
* NULL);
* ]|
*
* is the equivalent of:
*
* |[
* clutter_actor_animate (actor, 500, CLUTTER_EASE_IN_CUBIC,
* "x", 100,
* "y", 100,
* "width", 200,
* "height", 100,
* NULL);
* ]|
*
* <note>Unless the animation is looping, it will become invalid as soon
* as it is complete. To avoid this, you should keep a reference on the