diff --git a/doc/reference/clutter/Makefile.am b/doc/reference/clutter/Makefile.am index a8de9d3d8..ac72ed06f 100644 --- a/doc/reference/clutter/Makefile.am +++ b/doc/reference/clutter/Makefile.am @@ -143,9 +143,10 @@ content_files = \ clutter-overview.xml \ building-clutter.xml \ running-clutter.xml \ + migrating-ClutterAnimation.xml \ + migrating-ClutterBehaviour.xml \ migrating-ClutterEffect.xml \ - migrating-ClutterPath.xml \ - migrating-ClutterBehaviour.xml + migrating-ClutterPath.xml # SGML files where gtk-doc abbrevations (#GtkWidget) are expanded # These files must be listed here *and* in content_files @@ -155,9 +156,10 @@ expand_content_files = \ clutter-overview.xml \ building-clutter.xml \ running-clutter.xml \ + migrating-ClutterAnimation.xml \ + migrating-ClutterBehaviour.xml \ migrating-ClutterEffect.xml \ - migrating-ClutterPath.xml \ - migrating-ClutterBehaviour.xml + migrating-ClutterPath.xml # CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library. # Only needed if you are using gtkdoc-scangobj to dynamically query widget diff --git a/doc/reference/clutter/clutter-docs.xml.in b/doc/reference/clutter/clutter-docs.xml.in index 9b4f7ac85..d78ec323b 100644 --- a/doc/reference/clutter/clutter-docs.xml.in +++ b/doc/reference/clutter/clutter-docs.xml.in @@ -235,6 +235,7 @@ + diff --git a/doc/reference/clutter/migrating-ClutterAnimation.xml b/doc/reference/clutter/migrating-ClutterAnimation.xml new file mode 100644 index 000000000..87b6ac1eb --- /dev/null +++ b/doc/reference/clutter/migrating-ClutterAnimation.xml @@ -0,0 +1,139 @@ + + + + + + + Emmanuele + Bassi + +
+ ebassi@gnome.org +
+
+
+
+ + Migrating from ClutterAnimation + + The #ClutterAnimation class, along with the #ClutterActor wrappers + clutter_actor_animate(), clutter_actor_animate_with_timeline() and + clutter_actor_animate_with_alpha(), has been deprecated in Clutter 1.12, + and should not be used in newly written code. + + The direct replacement for a #ClutterAnimation is the + #ClutterPropertyTransition class, which allows the transition of a + single #GObject property from an initial value to a final value over a + user-defined time using a user-defined easing curve. + + The #ClutterPropertyTransition class inherits from #ClutterTransition, + which allows setting the transition interval, as well as the animatable + instance to be transitioned; and from #ClutterTimeline, which allows setting + the duration and easing curve of the transition. + + For instance, the following #ClutterAnimation set up: + + + + Can be replaced by #ClutterPropertyTransition: + + + + It is important to note that only #ClutterAnimatable implementations + can be used directly with #ClutterTransition. + + A #ClutterPropertyTransition can only animate a single property; if + more than one property transition is required, you can use the + #ClutterTransitionGroup class to group the transitions together. + +
+ Migrating clutter_actor_animate() + + #ClutterActor animatable properties can use implicit transitions + through their setter functions. The duration and easing curve of the + animation is controlled by clutter_actor_set_easing_duration() and by + clutter_actor_set_easing_mode(), respectively; for instance, the + equivalent of the following clutter_actor_animate() call: + + + + Can be replaced by the following: + + + + The default easing duration for the 1.0 API series is set to 0, + which means no transition at all. + + It is possible to set the easing state of a #ClutterActor to its + default values by using clutter_actor_save_easing_state(), and return + to the previous values by calling clutter_actor_restore_easing_state() + instead. The easing state affects all the animatable properties that + are modified after changing it; so, for instance: + + + + The animation above will implicitly transition the opacity from + its current value to 255 in 500 milliseconds using the default easing + curve; at the same time, the size of the actor will be transitioned in + 500 milliseconds after a delay of 500 milliseconds to the new size + stored in the variables width and + height. + +
+ +