From 40bcbf9c0d5db711b2bce47459cca40e2cf27266 Mon Sep 17 00:00:00 2001 From: Emmanuele Bassi Date: Thu, 15 Mar 2012 11:06:00 +0000 Subject: [PATCH] Add ClutterPropertyTransition ClutterPropertyTransition is a ClutterTransition that animates a property of a ClutterAnimatable implementation. --- clutter/Makefile.am | 2 + clutter/clutter-property-transition.c | 291 ++++++++++++++++++++++++++ clutter/clutter-property-transition.h | 88 ++++++++ clutter/clutter.h | 1 + 4 files changed, 382 insertions(+) create mode 100644 clutter/clutter-property-transition.c create mode 100644 clutter/clutter-property-transition.h diff --git a/clutter/Makefile.am b/clutter/Makefile.am index 4cdcfc614..b1c9e0598 100644 --- a/clutter/Makefile.am +++ b/clutter/Makefile.am @@ -102,6 +102,7 @@ source_h = \ $(srcdir)/clutter-page-turn-effect.h \ $(srcdir)/clutter-path-constraint.h \ $(srcdir)/clutter-path.h \ + $(srcdir)/clutter-property-transition.h \ $(srcdir)/clutter-script.h \ $(srcdir)/clutter-scriptable.h \ $(srcdir)/clutter-settings.h \ @@ -174,6 +175,7 @@ source_c = \ $(srcdir)/clutter-page-turn-effect.c \ $(srcdir)/clutter-path-constraint.c \ $(srcdir)/clutter-path.c \ + $(srcdir)/clutter-property-transition.c \ $(srcdir)/clutter-script.c \ $(srcdir)/clutter-script-parser.c \ $(srcdir)/clutter-scriptable.c \ diff --git a/clutter/clutter-property-transition.c b/clutter/clutter-property-transition.c new file mode 100644 index 000000000..0bd32bdd3 --- /dev/null +++ b/clutter/clutter-property-transition.c @@ -0,0 +1,291 @@ +/* + * Clutter. + * + * An OpenGL based 'interactive canvas' library. + * + * Copyright (C) 2012 Intel Corporation + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library. If not, see . + */ + +/** + * SECTION:clutter-property-transition + * @Title: ClutterPropertyTransition + * @Short_Description: Property transitions + * + * #ClutterPropertyTransition is a specialized #ClutterTransition that + * can be used to tween a property of a #ClutterAnimatable instance. + * + * #ClutterPropertyTransition is available since Clutter 1.10 + */ + +#ifdef HAVE_CONFIG_H +#include "config.h" +#endif + +#include "clutter-property-transition.h" + +#include "clutter-animatable.h" +#include "clutter-debug.h" +#include "clutter-interval.h" +#include "clutter-private.h" +#include "clutter-transition.h" + +struct _ClutterPropertyTransitionPrivate +{ + char *property_name; + + GParamSpec *pspec; +}; + +enum +{ + PROP_0, + + PROP_PROPERTY_NAME, + + PROP_LAST +}; + +static GParamSpec *obj_props[PROP_LAST] = { NULL, }; + +G_DEFINE_TYPE (ClutterPropertyTransition, clutter_property_transition, CLUTTER_TYPE_TRANSITION) + +static void +clutter_property_transition_attached (ClutterTransition *transition, + ClutterAnimatable *animatable) +{ + ClutterPropertyTransition *self = CLUTTER_PROPERTY_TRANSITION (transition); + ClutterPropertyTransitionPrivate *priv = self->priv; + + if (priv->property_name == NULL) + return; + + priv->pspec = clutter_animatable_find_property (animatable, + priv->property_name); +} + +static void +clutter_property_transition_detached (ClutterTransition *transition, + ClutterAnimatable *animatable) +{ + ClutterPropertyTransition *self = CLUTTER_PROPERTY_TRANSITION (transition); + ClutterPropertyTransitionPrivate *priv = self->priv; + + priv->pspec = NULL; +} + +static void +clutter_property_transition_compute_value (ClutterTransition *transition, + ClutterAnimatable *animatable, + ClutterInterval *interval, + gdouble progress) +{ + ClutterPropertyTransition *self = CLUTTER_PROPERTY_TRANSITION (transition); + ClutterPropertyTransitionPrivate *priv = self->priv; + GValue value = G_VALUE_INIT; + gboolean res; + + if (priv->pspec == NULL) + return; + + g_value_init (&value, clutter_interval_get_value_type (interval)); + + res = clutter_animatable_interpolate_value (animatable, + priv->property_name, + interval, + progress, + &value); + + if (res) + clutter_animatable_set_final_state (animatable, + priv->property_name, + &value); + + g_value_unset (&value); +} + +static void +clutter_property_transition_set_property (GObject *gobject, + guint prop_id, + const GValue *value, + GParamSpec *pspec) +{ + ClutterPropertyTransition *self = CLUTTER_PROPERTY_TRANSITION (gobject); + + switch (prop_id) + { + case PROP_PROPERTY_NAME: + clutter_property_transition_set_property_name (self, + g_value_get_string (value)); + break; + + default: + G_OBJECT_WARN_INVALID_PROPERTY_ID (gobject, prop_id, pspec); + } +} + +static void +clutter_property_transition_get_property (GObject *gobject, + guint prop_id, + GValue *value, + GParamSpec *pspec) +{ + ClutterPropertyTransitionPrivate *priv = CLUTTER_PROPERTY_TRANSITION (gobject)->priv; + + switch (prop_id) + { + case PROP_PROPERTY_NAME: + g_value_set_string (value, priv->property_name); + break; + + default: + G_OBJECT_WARN_INVALID_PROPERTY_ID (gobject, prop_id, pspec); + } +} + +static void +clutter_property_transition_finalize (GObject *gobject) +{ + ClutterPropertyTransitionPrivate *priv; + + priv = CLUTTER_PROPERTY_TRANSITION (gobject)->priv; + + g_free (priv->property_name); + + G_OBJECT_CLASS (clutter_property_transition_parent_class)->finalize (gobject); +} + +static void +clutter_property_transition_class_init (ClutterPropertyTransitionClass *klass) +{ + ClutterTransitionClass *transition_class = CLUTTER_TRANSITION_CLASS (klass); + GObjectClass *gobject_class = G_OBJECT_CLASS (klass); + + g_type_class_add_private (klass, sizeof (ClutterPropertyTransitionPrivate)); + + transition_class->attached = clutter_property_transition_attached; + transition_class->detached = clutter_property_transition_detached; + transition_class->compute_value = clutter_property_transition_compute_value; + + gobject_class->set_property = clutter_property_transition_set_property; + gobject_class->get_property = clutter_property_transition_get_property; + gobject_class->finalize = clutter_property_transition_finalize; + + /** + * ClutterPropertyTransition:property-name: + * + * The name of the property of a #ClutterAnimatable to animate. + * + * Since: 1.10 + */ + obj_props[PROP_PROPERTY_NAME] = + g_param_spec_string ("property-name", + P_("Property Name"), + P_("The name of the property to animate"), + NULL, + G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS); + + g_object_class_install_properties (gobject_class, PROP_LAST, obj_props); +} + +static void +clutter_property_transition_init (ClutterPropertyTransition *self) +{ + self->priv = + G_TYPE_INSTANCE_GET_PRIVATE (self, CLUTTER_TYPE_PROPERTY_TRANSITION, + ClutterPropertyTransitionPrivate); +} + +/** + * clutter_property_transition_new: + * @animatable: (allow-none): a #ClutterAnimatable, or %NULL + * @property_name: (allow-none): a property of @animatable, or %NULL + * + * Creates a new #ClutterPropertyTransition for @animatable. + * + * Return value: (transfer full): the newly created #ClutterPropertyTransition. + * Use g_object_unref() when done + * + * Since: 1.10 + */ +ClutterTransition * +clutter_property_transition_new (ClutterAnimatable *animatable, + const char *property_name) +{ + return g_object_new (CLUTTER_TYPE_PROPERTY_TRANSITION, + "animatable", animatable, + "property-name", property_name, + NULL); +} + +/** + * clutter_property_transition_set_property_name: + * @transition: a #ClutterPropertyTransition + * @property_name: (allow-none): a property name + * + * Sets the #ClutterPropertyTransition:property-name property of @transition. + * + * Since: 1.10 + */ +void +clutter_property_transition_set_property_name (ClutterPropertyTransition *transition, + const char *property_name) +{ + ClutterPropertyTransitionPrivate *priv; + ClutterAnimatable *animatable; + + g_return_if_fail (CLUTTER_IS_PROPERTY_TRANSITION (transition)); + + priv = transition->priv; + + if (g_strcmp0 (priv->property_name, property_name) == 0) + return; + + g_free (priv->property_name); + priv->property_name = g_strdup (property_name); + priv->pspec = NULL; + + animatable = + clutter_transition_get_animatable (CLUTTER_TRANSITION (transition)); + if (animatable != NULL) + { + priv->pspec = clutter_animatable_find_property (animatable, + priv->property_name); + } + + g_object_notify_by_pspec (G_OBJECT (transition), + obj_props[PROP_PROPERTY_NAME]); +} + +/** + * clutter_property_transition_get_property_name: + * @transition: a #ClutterPropertyTransition + * + * Retrieves the value of the #ClutterPropertyTransition:property-name + * property. + * + * Return value: the name of the property being animated, or %NULL if + * none is set. The returned string is owned by the @transition and + * it should not be freed. + * + * Since: 1.10 + */ +const char * +clutter_property_transition_get_property_name (ClutterPropertyTransition *transition) +{ + g_return_val_if_fail (CLUTTER_IS_PROPERTY_TRANSITION (transition), NULL); + + return transition->priv->property_name; +} diff --git a/clutter/clutter-property-transition.h b/clutter/clutter-property-transition.h new file mode 100644 index 000000000..fae3636fe --- /dev/null +++ b/clutter/clutter-property-transition.h @@ -0,0 +1,88 @@ +/* + * Clutter. + * + * An OpenGL based 'interactive canvas' library. + * + * Copyright (C) 2012 Intel Corporation + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library. If not, see . + * + * Author: Emmanuele Bassi + */ + +#if !defined(__CLUTTER_H_INSIDE__) && !defined(CLUTTER_COMPILATION) +#error "Only can be included directly." +#endif + +#ifndef __CLUTTER_PROPERTY_TRANSITION_H__ +#define __CLUTTER_PROPERTY_TRANSITION_H__ + +#include +#include + +G_BEGIN_DECLS + +#define CLUTTER_TYPE_PROPERTY_TRANSITION (clutter_property_transition_get_type ()) +#define CLUTTER_PROPERTY_TRANSITION(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), CLUTTER_TYPE_PROPERTY_TRANSITION, ClutterPropertyTransition)) +#define CLUTTER_IS_PROPERTY_TRANSITION(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), CLUTTER_TYPE_PROPERTY_TRANSITION)) +#define CLUTTER_PROPERTY_TRANSITION_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), CLUTTER_TYPE_PROPERTY_TRANSITION, ClutterPropertyTransitionClass)) +#define CLUTTER_IS_PROPERTY_TRANSITION_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), CLUTTER_TYPE_PROPERTY_TRANSITION)) +#define CLUTTER_PROPERTY_TRANSITION_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), CLUTTER_TYPE_PROPERTY_TRANSITION, ClutterPropertyTransitionClass)) + +typedef struct _ClutterPropertyTransitionPrivate ClutterPropertyTransitionPrivate; +typedef struct _ClutterPropertyTransitionClass ClutterPropertyTransitionClass; + +/** + * ClutterPropertyTransition: + * + * The ClutterPropertyTransition structure contains + * private data and should only be accessed using the provided API. + * + * Since: 1.10 + */ +struct _ClutterPropertyTransition +{ + /*< private >*/ + ClutterTransition parent_instance; + + ClutterPropertyTransitionPrivate *priv; +}; + +/** + * ClutterPropertyTransitionClass: + * + * The ClutterPropertyTransitionClass structure + * contains private data. + * + * Since: 1.10 + */ +struct _ClutterPropertyTransitionClass +{ + /*< private >*/ + ClutterTransitionClass parent_class; + + gpointer _padding[8]; +}; + +GType clutter_property_transition_get_type (void) G_GNUC_CONST; + +ClutterTransition * clutter_property_transition_new (ClutterAnimatable *animatable, + const char *property_name); +void clutter_property_transition_set_property_name (ClutterPropertyTransition *transition, + const char *property_name); +const char * clutter_property_transition_get_property_name (ClutterPropertyTransition *transition); + +G_END_DECLS + +#endif /* __CLUTTER_PROPERTY_TRANSITION_H__ */ diff --git a/clutter/clutter.h b/clutter/clutter.h index 533b3190a..0d8befff9 100644 --- a/clutter/clutter.h +++ b/clutter/clutter.h @@ -82,6 +82,7 @@ #include "clutter-page-turn-effect.h" #include "clutter-path-constraint.h" #include "clutter-path.h" +#include "clutter-property-transition.h" #include "clutter-scriptable.h" #include "clutter-script.h" #include "clutter-settings.h"