From f94a903d9ebdbc055010bb4a4c6fe7e76f418bd8 Mon Sep 17 00:00:00 2001 From: Emmanuele Bassi Date: Sat, 12 Dec 2009 00:02:43 +0000 Subject: [PATCH] layout: Add animation support to LayoutManager MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit In order to animate a fluid layout we cannot use the common animation code paths as they will override the size request and allocation paths that are handled by the layout manager itself. One way to introduce animations in the allocation sequence is to use a Timeline and an Alpha to compute a progress value and then use that value to interpolate an ActorBox between the initial and final states of the animation - with the initial state being the last allocation of the child prior to the animation start, and the final state the allocation of the child at the end; for every frame of the Timeline we then queue a relayout on the layout manager's container, which will result in an animation. ClutterLayoutManager is the most likely place to add a generic API for beginning and ending an animation, as well as the place to provide a default code path to create the ancillary Timeline and Alpha instances needed to drive the animation. A LayoutManager sub-class will need to: • call clutter_layout_manager_begin_animation() whenever it should animate between two states, for instance: whenever a layout property changes value; • eventually override begin_animation() and end_animation() in case further state needs to be set up, and then chain up to the default implementation provided by LayoutManager; • if a completely different implementation is required, the layout manager sub-class should override begin_animation(), end_animation() and get_animation_progress(). Inside the allocate() implementation the sub-class should also interpolate between the last known allocation of a child and the newly computed allocation. --- clutter/clutter-layout-manager.c | 159 ++++++++++++++++++++- clutter/clutter-layout-manager.h | 62 +++++--- doc/reference/clutter/clutter-sections.txt | 5 + 3 files changed, 204 insertions(+), 22 deletions(-) diff --git a/clutter/clutter-layout-manager.c b/clutter/clutter-layout-manager.c index 119539b6f..251f3e647 100644 --- a/clutter/clutter-layout-manager.c +++ b/clutter/clutter-layout-manager.c @@ -107,6 +107,11 @@ * child of the #ClutterContainer. * * + * + * Animating a ClutterLayoutManager + * ... + * + * * #ClutterLayoutManager is available since Clutter 1.2 */ @@ -117,11 +122,13 @@ #include #include +#include "clutter-alpha.h" #include "clutter-debug.h" #include "clutter-layout-manager.h" #include "clutter-layout-meta.h" #include "clutter-marshal.h" #include "clutter-private.h" +#include "clutter-timeline.h" #define LAYOUT_MANAGER_WARN_NOT_IMPLEMENTED(m,method) G_STMT_START { \ GObject *_obj = G_OBJECT (m); \ @@ -141,7 +148,9 @@ G_DEFINE_ABSTRACT_TYPE (ClutterLayoutManager, clutter_layout_manager, G_TYPE_INITIALLY_UNOWNED); -static GQuark quark_layout_meta = 0; +static GQuark quark_layout_meta = 0; +static GQuark quark_layout_alpha = 0; + static guint manager_signals[LAST_SIGNAL] = { 0, }; static void @@ -217,17 +226,92 @@ layout_manager_real_get_child_meta_type (ClutterLayoutManager *manager) return G_TYPE_INVALID; } +static void +layout_manager_real_begin_animation (ClutterLayoutManager *manager, + guint duration, + gulong mode) +{ + ClutterTimeline *timeline; + ClutterAlpha *alpha; + + alpha = g_object_get_qdata (G_OBJECT (manager), quark_layout_alpha); + if (alpha != NULL) + return; + + timeline = clutter_timeline_new (duration); + alpha = clutter_alpha_new_full (timeline, mode); + g_object_unref (timeline); + + g_signal_connect_swapped (timeline, "completed", + G_CALLBACK (clutter_layout_manager_end_animation), + manager); + g_signal_connect_swapped (timeline, "new-frame", + G_CALLBACK (clutter_layout_manager_layout_changed), + manager); + + g_object_set_qdata_full (G_OBJECT (manager), + quark_layout_alpha, alpha, + (GDestroyNotify) g_object_unref); + + clutter_timeline_start (timeline); +} + +static gdouble +layout_manager_real_get_animation_progress (ClutterLayoutManager *manager) +{ + ClutterAlpha *alpha; + + alpha = g_object_get_qdata (G_OBJECT (manager), quark_layout_alpha); + if (alpha == NULL) + return 1.0; + + return clutter_alpha_get_alpha (alpha); +} + +static void +layout_manager_real_end_animation (ClutterLayoutManager *manager) +{ + ClutterTimeline *timeline; + ClutterAlpha *alpha; + + alpha = g_object_get_qdata (G_OBJECT (manager), quark_layout_alpha); + if (alpha == NULL) + return; + + timeline = clutter_alpha_get_timeline (alpha); + g_assert (timeline != NULL); + + if (clutter_timeline_is_playing (timeline)) + clutter_timeline_stop (timeline); + + g_signal_handlers_disconnect_by_func (timeline, + G_CALLBACK (clutter_layout_manager_end_animation), + manager); + g_signal_handlers_disconnect_by_func (timeline, + G_CALLBACK (clutter_layout_manager_layout_changed), + manager); + + g_object_set_qdata (G_OBJECT (manager), quark_layout_alpha, NULL); + + clutter_layout_manager_layout_changed (manager); +} + static void clutter_layout_manager_class_init (ClutterLayoutManagerClass *klass) { quark_layout_meta = g_quark_from_static_string ("clutter-layout-manager-child-meta"); + quark_layout_alpha = + g_quark_from_static_string ("clutter-layout-manager-alpha"); klass->get_preferred_width = layout_manager_real_get_preferred_width; klass->get_preferred_height = layout_manager_real_get_preferred_height; klass->allocate = layout_manager_real_allocate; klass->create_child_meta = layout_manager_real_create_child_meta; klass->get_child_meta_type = layout_manager_real_get_child_meta_type; + klass->begin_animation = layout_manager_real_begin_animation; + klass->get_animation_progress = layout_manager_real_get_animation_progress; + klass->end_animation = layout_manager_real_end_animation; /** * ClutterLayoutManager::layout-changed: @@ -905,3 +989,76 @@ clutter_layout_manager_list_child_properties (ClutterLayoutManager *manager, return pspecs; } + +/** + * clutter_layout_manager_begin_animation: + * @manager: a #ClutterLayoutManager + * @duration: the duration of the animation, in milliseconds + * @mode: the easing mode of the animation + * + * Begins an animation of @duration milliseconds, using the provided + * easing @mode + * + * The easing mode can be specified either as a #ClutterAnimationMode + * or as a logical id returned by clutter_alpha_register_func() + * + * The result of this function depends on the @manager implementation + * + * Since: 1.2 + */ +void +clutter_layout_manager_begin_animation (ClutterLayoutManager *manager, + guint duration, + gulong mode) +{ + g_return_if_fail (CLUTTER_IS_LAYOUT_MANAGER (manager)); + g_return_if_fail (duration > 0 && duration < 1000); + + CLUTTER_LAYOUT_MANAGER_GET_CLASS (manager)->begin_animation (manager, + duration, + mode); +} + +/** + * clutter_layout_manager_end_animation: + * @manager: a #ClutterLayoutManager + * + * Ends an animation started by clutter_layout_manager_begin_animation() + * + * The result of this call depends on the @manager implementation + * + * Since: 1.2 + */ +void +clutter_layout_manager_end_animation (ClutterLayoutManager *manager) +{ + g_return_if_fail (CLUTTER_IS_LAYOUT_MANAGER (manager)); + + CLUTTER_LAYOUT_MANAGER_GET_CLASS (manager)->end_animation (manager); +} + +/** + * clutter_layout_manager_get_animation_progress: + * @manager: a #ClutterLayoutManager + * + * Retrieves the progress of the animation, if one has been started by + * clutter_layout_manager_begin_animation() + * + * The returned value has the same semantics of the #ClutterAlpha:alpha + * value + * + * Return value: the progress of the animation + * + * Since: 1.2 + */ +gdouble +clutter_layout_manager_get_animation_progress (ClutterLayoutManager *manager) +{ + ClutterLayoutManagerClass *klass; + + g_return_val_if_fail (CLUTTER_IS_LAYOUT_MANAGER (manager), 1.0); + + klass = CLUTTER_LAYOUT_MANAGER_GET_CLASS (manager); + + return klass->get_animation_progress (manager); +} diff --git a/clutter/clutter-layout-manager.h b/clutter/clutter-layout-manager.h index 676837dea..1271a3db4 100644 --- a/clutter/clutter-layout-manager.h +++ b/clutter/clutter-layout-manager.h @@ -82,6 +82,12 @@ struct _ClutterLayoutManager * @create_child_meta: virtual function; override to create a * #ClutterLayoutMeta instance associated to a #ClutterContainer and a * child #ClutterActor, used to maintain layout manager specific properties + * @begin_animation: virtual function; override to control the animation + * of a #ClutterLayoutManager with the given duration and easing mode + * @end_animation: virtual function; override to end an animation started + * by clutter_layout_manager_begin_animation() + * @get_animation_progress: virtual function; override to control the + * progress of the animation of a #ClutterLayoutManager * @layout_changed: class handler for the #ClutterLayoutManager::layout-changed * signal * @@ -96,30 +102,38 @@ struct _ClutterLayoutManagerClass GInitiallyUnownedClass parent_class; /*< public >*/ - void (* get_preferred_width) (ClutterLayoutManager *manager, - ClutterContainer *container, - gfloat for_height, - gfloat *minimum_width_p, - gfloat *natural_width_p); - void (* get_preferred_height) (ClutterLayoutManager *manager, - ClutterContainer *container, - gfloat for_width, - gfloat *minimum_height_p, - gfloat *natural_height_p); - void (* allocate) (ClutterLayoutManager *manager, - ClutterContainer *container, - const ClutterActorBox *allocation, - ClutterAllocationFlags flags); + /* vfuncs, not signals */ + void (* get_preferred_width) (ClutterLayoutManager *manager, + ClutterContainer *container, + gfloat for_height, + gfloat *minimum_width_p, + gfloat *natural_width_p); + void (* get_preferred_height) (ClutterLayoutManager *manager, + ClutterContainer *container, + gfloat for_width, + gfloat *minimum_height_p, + gfloat *natural_height_p); + void (* allocate) (ClutterLayoutManager *manager, + ClutterContainer *container, + const ClutterActorBox *allocation, + ClutterAllocationFlags flags); - void (* set_container) (ClutterLayoutManager *manager, - ClutterContainer *container); + void (* set_container) (ClutterLayoutManager *manager, + ClutterContainer *container); - GType (* get_child_meta_type) (ClutterLayoutManager *manager); - ClutterLayoutMeta *(* create_child_meta) (ClutterLayoutManager *manager, - ClutterContainer *container, - ClutterActor *actor); + GType (* get_child_meta_type) (ClutterLayoutManager *manager); + ClutterLayoutMeta *(* create_child_meta) (ClutterLayoutManager *manager, + ClutterContainer *container, + ClutterActor *actor); - void (* layout_changed) (ClutterLayoutManager *manager); + void (* begin_animation) (ClutterLayoutManager *manager, + guint duration, + gulong mode); + gdouble (* get_animation_progress) (ClutterLayoutManager *manager); + void (* end_animation) (ClutterLayoutManager *manager); + + /* signals */ + void (* layout_changed) (ClutterLayoutManager *manager); /*< private >*/ /* padding for future expansion */ @@ -184,6 +198,12 @@ void clutter_layout_manager_child_get_property (ClutterLayoutMa const gchar *property_name, GValue *value); +void clutter_layout_manager_begin_animation (ClutterLayoutManager *manager, + guint duration, + gulong mode); +void clutter_layout_manager_end_animation (ClutterLayoutManager *manager); +gdouble clutter_layout_manager_get_animation_progress (ClutterLayoutManager *manager); + G_END_DECLS #endif /* __CLUTTER_LAYOUT_MANAGER_H__ */ diff --git a/doc/reference/clutter/clutter-sections.txt b/doc/reference/clutter/clutter-sections.txt index d90358739..2bd5f55eb 100644 --- a/doc/reference/clutter/clutter-sections.txt +++ b/doc/reference/clutter/clutter-sections.txt @@ -1768,6 +1768,11 @@ clutter_layout_manager_child_get_property clutter_layout_manager_find_child_property clutter_layout_manager_list_child_properties + +clutter_layout_manager_begin_animation +clutter_layout_manager_end_animation +clutter_layout_manager_get_animation_progress + CLUTTER_TYPE_LAYOUT_MANAGER CLUTTER_LAYOUT_MANAGER