brl/mutter
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
36f8314e32
mutter/clutter/clutter-animatable.c

284 lines
9.9 KiB
C
Raw Normal View History

Add license notice to ClutterAnimation files
2009-01-08 13:18:00 +00:00
/*
* Clutter.
*
* An OpenGL based 'interactive canvas' library.
*
* Copyright (C) 2009 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 <http://www.gnu.org/licenses/>.
*
* Author:
* Emmanuele Bassi <ebassi@linux.intel.com>
*/
[animation] Add ClutterAnimatable The ClutterAnimatable interface is meant to be used by GObject classes to override the value computation for an animatable property within the boundaries of an interval. It is composed of a single virtual function, animate_property(); its implementation will receive the ClutterAnimation used to animate the object; the property name; the initial and final interval values; and the progress factor as retrieved by the Alpha object bound to the Animation instance.
2009-01-08 12:56:46 +00:00
/**
* SECTION:clutter-animatable
* @short_description: Interface for animatable classes
*
* #ClutterAnimatable is an interface that allows a #GObject class
* to control how a #ClutterAnimation will animate a property.
*
docs: Fixes for cross-references
2011-09-12 12:12:14 +00:00
* Each #ClutterAnimatable should implement the
* <function>animate_property</function> virtual function of the interface
* to compute the animation state between two values of an interval depending
* on a progress factor, expressed as a floating point value.
[animation] Add ClutterAnimatable The ClutterAnimatable interface is meant to be used by GObject classes to override the value computation for an animatable property within the boundaries of an interval. It is composed of a single virtual function, animate_property(); its implementation will receive the ClutterAnimation used to animate the object; the property name; the initial and final interval values; and the progress factor as retrieved by the Alpha object bound to the Animation instance.
2009-01-08 12:56:46 +00:00
*
* If a #ClutterAnimatable is animated by a #ClutterAnimation
* instance, the #ClutterAnimation will call
* clutter_animatable_animate_property() passing the name of the
* currently animated property; the initial and final values of
* the animation interval; the progress factor. The #ClutterAnimatable
* implementation should return the computed value for the animated
* property.
*
* #ClutterAnimatable is available since Clutter 1.0
*/
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
#include "clutter-animatable.h"
Add deprecated header for ClutterAnimation
2012-02-27 15:29:50 +00:00
#include "clutter-interval.h"
[animation] Add ClutterAnimatable The ClutterAnimatable interface is meant to be used by GObject classes to override the value computation for an animatable property within the boundaries of an interval. It is composed of a single virtual function, animate_property(); its implementation will receive the ClutterAnimation used to animate the object; the property name; the initial and final interval values; and the progress factor as retrieved by the Alpha object bound to the Animation instance.
2009-01-08 12:56:46 +00:00
#include "clutter-debug.h"
#include "clutter-private.h"
Fix missing/redundant declarations
2012-03-07 12:34:06 +00:00
#include "deprecated/clutter-animatable.h"
Use G_DEFINE_INTERFACE GObject provides us with a nice, safe macro for defining interface types.
2010-10-08 13:47:46 +00:00
typedef ClutterAnimatableIface ClutterAnimatableInterface;
G_DEFINE_INTERFACE (ClutterAnimatable, clutter_animatable, G_TYPE_OBJECT);
[animation] Add ClutterAnimatable The ClutterAnimatable interface is meant to be used by GObject classes to override the value computation for an animatable property within the boundaries of an interval. It is composed of a single virtual function, animate_property(); its implementation will receive the ClutterAnimation used to animate the object; the property name; the initial and final interval values; and the progress factor as retrieved by the Alpha object bound to the Animation instance.
2009-01-08 12:56:46 +00:00
Use G_DEFINE_INTERFACE GObject provides us with a nice, safe macro for defining interface types.
2010-10-08 13:47:46 +00:00
static void
clutter_animatable_default_init (ClutterAnimatableInterface *iface)
{
[animation] Add ClutterAnimatable The ClutterAnimatable interface is meant to be used by GObject classes to override the value computation for an animatable property within the boundaries of an interval. It is composed of a single virtual function, animate_property(); its implementation will receive the ClutterAnimation used to animate the object; the property name; the initial and final interval values; and the progress factor as retrieved by the Alpha object bound to the Animation instance.
2009-01-08 12:56:46 +00:00
}
/**
* clutter_animatable_animate_property:
* @animatable: a #ClutterAnimatable
* @animation: a #ClutterAnimation
* @property_name: the name of the animated property
* @initial_value: the initial value of the animation interval
* @final_value: the final value of the animation interval
* @progress: the progress factor
* @value: return location for the animation value
*
* Calls the animate_property() virtual function for @animatable.
*
* The @initial_value and @final_value #GValue<!-- -->s must contain
* the same type; @value must have been initialized to the same
* type of @initial_value and @final_value.
*
* All implementation of the #ClutterAnimatable interface must
* implement this function.
*
[animatable] Allow validation in ::animate_property The Animatable interface implementation will always have the computed value applied, whilst the non-Animatable objects go through the interval validation first to avoid incurring in assertions and warnings. The Animatable::animate_property() should also be able to validate the property it's supposed to interpolate, and eventually discard it. This requires adding a return value to the virtual function (and its wrapper function). The Animation code will then apply the computed value only if the animate_property() returns TRUE -- unifying the code path with the non-Animatable objects.
2009-05-27 12:01:31 +00:00
* Return value: %TRUE if the value has been validated and can
* be applied to the #ClutterAnimatable, and %FALSE otherwise
*
[animation] Add ClutterAnimatable The ClutterAnimatable interface is meant to be used by GObject classes to override the value computation for an animatable property within the boundaries of an interval. It is composed of a single virtual function, animate_property(); its implementation will receive the ClutterAnimation used to animate the object; the property name; the initial and final interval values; and the progress factor as retrieved by the Alpha object bound to the Animation instance.
2009-01-08 12:56:46 +00:00
* Since: 1.0
animatable: Deprecate and replace animate_property() The animate_property() method of the Animatable interface is far less than optimal: • it has a direct reference to ClutterAnimation; • it has an interval decomposed as two values. These issues tie the Animatable interface with the Animation object, even though it's neither necessary nor future-proof. Let's introduce a new method, interpolate_value(), which does not reference ClutterAnimation and uses a ClutterInterval to express the initial and final states.
2011-07-15 13:27:26 +00:00
*
* Deprecated: 1.8: Use clutter_animatable_interpolate_value()
* instead
[animation] Add ClutterAnimatable The ClutterAnimatable interface is meant to be used by GObject classes to override the value computation for an animatable property within the boundaries of an interval. It is composed of a single virtual function, animate_property(); its implementation will receive the ClutterAnimation used to animate the object; the property name; the initial and final interval values; and the progress factor as retrieved by the Alpha object bound to the Animation instance.
2009-01-08 12:56:46 +00:00
*/
[animatable] Allow validation in ::animate_property The Animatable interface implementation will always have the computed value applied, whilst the non-Animatable objects go through the interval validation first to avoid incurring in assertions and warnings. The Animatable::animate_property() should also be able to validate the property it's supposed to interpolate, and eventually discard it. This requires adding a return value to the virtual function (and its wrapper function). The Animation code will then apply the computed value only if the animate_property() returns TRUE -- unifying the code path with the non-Animatable objects.
2009-05-27 12:01:31 +00:00
gboolean
[animation] Add ClutterAnimatable The ClutterAnimatable interface is meant to be used by GObject classes to override the value computation for an animatable property within the boundaries of an interval. It is composed of a single virtual function, animate_property(); its implementation will receive the ClutterAnimation used to animate the object; the property name; the initial and final interval values; and the progress factor as retrieved by the Alpha object bound to the Animation instance.
2009-01-08 12:56:46 +00:00
clutter_animatable_animate_property (ClutterAnimatable *animatable,
ClutterAnimation *animation,
const gchar *property_name,
const GValue *initial_value,
const GValue *final_value,
gdouble progress,
GValue *value)
{
animatable: Deprecate and replace animate_property() The animate_property() method of the Animatable interface is far less than optimal: • it has a direct reference to ClutterAnimation; • it has an interval decomposed as two values. These issues tie the Animatable interface with the Animation object, even though it's neither necessary nor future-proof. Let's introduce a new method, interpolate_value(), which does not reference ClutterAnimation and uses a ClutterInterval to express the initial and final states.
2011-07-15 13:27:26 +00:00
ClutterAnimatableIface *iface;
[animatable] Allow validation in ::animate_property The Animatable interface implementation will always have the computed value applied, whilst the non-Animatable objects go through the interval validation first to avoid incurring in assertions and warnings. The Animatable::animate_property() should also be able to validate the property it's supposed to interpolate, and eventually discard it. This requires adding a return value to the virtual function (and its wrapper function). The Animation code will then apply the computed value only if the animate_property() returns TRUE -- unifying the code path with the non-Animatable objects.
2009-05-27 12:01:31 +00:00
gboolean res;
g_return_val_if_fail (CLUTTER_IS_ANIMATABLE (animatable), FALSE);
g_return_val_if_fail (CLUTTER_IS_ANIMATION (animation), FALSE);
g_return_val_if_fail (property_name != NULL, FALSE);
g_return_val_if_fail (initial_value != NULL && final_value != NULL, FALSE);
g_return_val_if_fail (G_VALUE_TYPE (initial_value) != G_TYPE_INVALID, FALSE);
g_return_val_if_fail (G_VALUE_TYPE (final_value) != G_TYPE_INVALID, FALSE);
g_return_val_if_fail (value != NULL, FALSE);
g_return_val_if_fail (G_VALUE_TYPE (value) == G_VALUE_TYPE (initial_value) &&
G_VALUE_TYPE (value) == G_VALUE_TYPE (final_value),
FALSE);
animatable: Deprecate and replace animate_property() The animate_property() method of the Animatable interface is far less than optimal: • it has a direct reference to ClutterAnimation; • it has an interval decomposed as two values. These issues tie the Animatable interface with the Animation object, even though it's neither necessary nor future-proof. Let's introduce a new method, interpolate_value(), which does not reference ClutterAnimation and uses a ClutterInterval to express the initial and final states.
2011-07-15 13:27:26 +00:00
iface = CLUTTER_ANIMATABLE_GET_IFACE (animatable);
if (iface->animate_property == NULL)
{
ClutterInterval *interval;
interval = clutter_animation_get_interval (animation, property_name);
if (interval == NULL)
return FALSE;
res = clutter_animatable_interpolate_value (animatable, property_name,
interval,
progress,
value);
}
else
res = iface->animate_property (animatable, animation,
property_name,
initial_value, final_value,
progress,
value);
[animation] Add ClutterAnimatable The ClutterAnimatable interface is meant to be used by GObject classes to override the value computation for an animatable property within the boundaries of an interval. It is composed of a single virtual function, animate_property(); its implementation will receive the ClutterAnimation used to animate the object; the property name; the initial and final interval values; and the progress factor as retrieved by the Alpha object bound to the Animation instance.
2009-01-08 12:56:46 +00:00
[animatable] Allow validation in ::animate_property The Animatable interface implementation will always have the computed value applied, whilst the non-Animatable objects go through the interval validation first to avoid incurring in assertions and warnings. The Animatable::animate_property() should also be able to validate the property it's supposed to interpolate, and eventually discard it. This requires adding a return value to the virtual function (and its wrapper function). The Animation code will then apply the computed value only if the animate_property() returns TRUE -- unifying the code path with the non-Animatable objects.
2009-05-27 12:01:31 +00:00
return res;
[animation] Add ClutterAnimatable The ClutterAnimatable interface is meant to be used by GObject classes to override the value computation for an animatable property within the boundaries of an interval. It is composed of a single virtual function, animate_property(); its implementation will receive the ClutterAnimation used to animate the object; the property name; the initial and final interval values; and the progress factor as retrieved by the Alpha object bound to the Animation instance.
2009-01-08 12:56:46 +00:00
}
animatable: Add custom properties to Animatable Like ClutterScriptable, it would be good to have the Animatable interface allow defining custom properties that can be animated.
2010-05-19 11:21:54 +00:00
Miscellaneous documentation fixes
2010-05-19 15:10:05 +00:00
/**
* clutter_animatable_find_property:
* @animatable: a #ClutterAnimatable
* @property_name: the name of the animatable property to find
*
* Finds the #GParamSpec for @property_name
*
* Return value: (transfer none): The #GParamSpec for the given property
* or %NULL
*
* Since: 1.4
*/
animatable: Add custom properties to Animatable Like ClutterScriptable, it would be good to have the Animatable interface allow defining custom properties that can be animated.
2010-05-19 11:21:54 +00:00
GParamSpec *
clutter_animatable_find_property (ClutterAnimatable *animatable,
const gchar *property_name)
{
ClutterAnimatableIface *iface;
g_return_val_if_fail (CLUTTER_IS_ANIMATABLE (animatable), NULL);
g_return_val_if_fail (property_name != NULL, NULL);
CLUTTER_NOTE (ANIMATION, "Looking for property '%s'", property_name);
iface = CLUTTER_ANIMATABLE_GET_IFACE (animatable);
if (iface->find_property != NULL)
animatable: Allow passing a NULL animation The Animatable interface was created specifically for the Animation class. It turns out that it might be fairly useful to others - such as ClutterAnimator and ClutterState. The newly-added API in this cycle for querying and accessing custom properties should not require that we pass a ClutterAnimation to the implementations: the Animatable itself should be enough. This is necessary to allow language bindings to wrap clutter_actor_animate() correctly and do type validation and demarshalling between native values and GValues; an Animation instance is not available until the animate() call returns, and validation must be performed before that happens. There is nothing we can do about the animate_property() virtual function - but in that case we might want to be able to access the animation from an Animatable implementation to get the Interval for the property, just like ClutterActor does in order to animate ClutterActorMeta objects.
2010-07-31 09:40:21 +00:00
return iface->find_property (animatable, property_name);
animatable: Add custom properties to Animatable Like ClutterScriptable, it would be good to have the Animatable interface allow defining custom properties that can be animated.
2010-05-19 11:21:54 +00:00
return g_object_class_find_property (G_OBJECT_GET_CLASS (animatable),
property_name);
}
Miscellaneous documentation fixes
2010-05-19 15:10:05 +00:00
/**
* clutter_animatable_get_initial_state:
* @animatable: a #ClutterAnimatable
* @property_name: the name of the animatable property to retrieve
* @value: a #GValue initialized to the type of the property to retrieve
*
* Retrieves the current state of @property_name and sets @value with it
*
* Since: 1.4
*/
animatable: Add custom properties to Animatable Like ClutterScriptable, it would be good to have the Animatable interface allow defining custom properties that can be animated.
2010-05-19 11:21:54 +00:00
void
clutter_animatable_get_initial_state (ClutterAnimatable *animatable,
const gchar *property_name,
GValue *value)
{
ClutterAnimatableIface *iface;
g_return_if_fail (CLUTTER_IS_ANIMATABLE (animatable));
g_return_if_fail (property_name != NULL);
CLUTTER_NOTE (ANIMATION, "Getting initial state of '%s'", property_name);
iface = CLUTTER_ANIMATABLE_GET_IFACE (animatable);
if (iface->get_initial_state != NULL)
animatable: Allow passing a NULL animation The Animatable interface was created specifically for the Animation class. It turns out that it might be fairly useful to others - such as ClutterAnimator and ClutterState. The newly-added API in this cycle for querying and accessing custom properties should not require that we pass a ClutterAnimation to the implementations: the Animatable itself should be enough. This is necessary to allow language bindings to wrap clutter_actor_animate() correctly and do type validation and demarshalling between native values and GValues; an Animation instance is not available until the animate() call returns, and validation must be performed before that happens. There is nothing we can do about the animate_property() virtual function - but in that case we might want to be able to access the animation from an Animatable implementation to get the Interval for the property, just like ClutterActor does in order to animate ClutterActorMeta objects.
2010-07-31 09:40:21 +00:00
iface->get_initial_state (animatable, property_name, value);
animatable: Add custom properties to Animatable Like ClutterScriptable, it would be good to have the Animatable interface allow defining custom properties that can be animated.
2010-05-19 11:21:54 +00:00
else
g_object_get_property (G_OBJECT (animatable), property_name, value);
}
Miscellaneous documentation fixes
2010-05-19 15:10:05 +00:00
/**
* clutter_animatable_set_final_state:
* @animatable: a #ClutterAnimatable
* @property_name: the name of the animatable property to set
* @value: the value of the animatable property to set
*
* Sets the current state of @property_name to @value
*
* Since: 1.4
*/
animatable: Add custom properties to Animatable Like ClutterScriptable, it would be good to have the Animatable interface allow defining custom properties that can be animated.
2010-05-19 11:21:54 +00:00
void
clutter_animatable_set_final_state (ClutterAnimatable *animatable,
const gchar *property_name,
const GValue *value)
{
ClutterAnimatableIface *iface;
g_return_if_fail (CLUTTER_IS_ANIMATABLE (animatable));
g_return_if_fail (property_name != NULL);
CLUTTER_NOTE (ANIMATION, "Setting state of property '%s'", property_name);
iface = CLUTTER_ANIMATABLE_GET_IFACE (animatable);
if (iface->set_final_state != NULL)
animatable: Allow passing a NULL animation The Animatable interface was created specifically for the Animation class. It turns out that it might be fairly useful to others - such as ClutterAnimator and ClutterState. The newly-added API in this cycle for querying and accessing custom properties should not require that we pass a ClutterAnimation to the implementations: the Animatable itself should be enough. This is necessary to allow language bindings to wrap clutter_actor_animate() correctly and do type validation and demarshalling between native values and GValues; an Animation instance is not available until the animate() call returns, and validation must be performed before that happens. There is nothing we can do about the animate_property() virtual function - but in that case we might want to be able to access the animation from an Animatable implementation to get the Interval for the property, just like ClutterActor does in order to animate ClutterActorMeta objects.
2010-07-31 09:40:21 +00:00
iface->set_final_state (animatable, property_name, value);
animatable: Add custom properties to Animatable Like ClutterScriptable, it would be good to have the Animatable interface allow defining custom properties that can be animated.
2010-05-19 11:21:54 +00:00
else
g_object_set_property (G_OBJECT (animatable), property_name, value);
}
animatable: Deprecate and replace animate_property() The animate_property() method of the Animatable interface is far less than optimal: • it has a direct reference to ClutterAnimation; • it has an interval decomposed as two values. These issues tie the Animatable interface with the Animation object, even though it's neither necessary nor future-proof. Let's introduce a new method, interpolate_value(), which does not reference ClutterAnimation and uses a ClutterInterval to express the initial and final states.
2011-07-15 13:27:26 +00:00
docs: Update with the newly added Animatable symbol
2011-07-29 10:48:13 +00:00
/**
* clutter_animatable_interpolate_value:
* @animatable: a #ClutterAnimatable
* @property_name: the name of the property to interpolate
* @interval: a #ClutterInterval with the animation range
* @progress: the progress to use to interpolate between the
* initial and final values of the @interval
* @value: (out): return location for an initialized #GValue
* using the same type of the @interval
*
* Asks a #ClutterAnimatable implementation to interpolate a
* a named property between the initial and final values of
* a #ClutterInterval, using @progress as the interpolation
* value, and store the result inside @value.
*
* This function should be used for every property animation
* involving #ClutterAnimatable<!-- -->s.
*
* This function replaces clutter_animatable_animate_property().
*
* Return value: %TRUE if the interpolation was successful,
* and %FALSE otherwise
*
* Since: 1.8
*/
animatable: Deprecate and replace animate_property() The animate_property() method of the Animatable interface is far less than optimal: • it has a direct reference to ClutterAnimation; • it has an interval decomposed as two values. These issues tie the Animatable interface with the Animation object, even though it's neither necessary nor future-proof. Let's introduce a new method, interpolate_value(), which does not reference ClutterAnimation and uses a ClutterInterval to express the initial and final states.
2011-07-15 13:27:26 +00:00
gboolean
clutter_animatable_interpolate_value (ClutterAnimatable *animatable,
const gchar *property_name,
ClutterInterval *interval,
gdouble progress,
GValue *value)
{
ClutterAnimatableIface *iface;
g_return_val_if_fail (CLUTTER_IS_ANIMATABLE (animatable), FALSE);
g_return_val_if_fail (property_name != NULL, FALSE);
g_return_val_if_fail (CLUTTER_IS_INTERVAL (interval), FALSE);
g_return_val_if_fail (value != NULL, FALSE);
CLUTTER_NOTE (ANIMATION, "Interpolating '%s' (progress: %.3f)",
property_name,
progress);
iface = CLUTTER_ANIMATABLE_GET_IFACE (animatable);
if (iface->interpolate_value != NULL)
{
return iface->interpolate_value (animatable, property_name,
interval,
progress,
value);
}
else
return clutter_interval_compute_value (interval, progress, value);
}
Reference in New Issue Copy Permalink