brl/mutter
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
40d703a005
mutter/clutter/clutter-animatable.h

128 lines
5.6 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
#ifndef __CLUTTER_ANIMATABLE_H__
#define __CLUTTER_ANIMATABLE_H__
#if !defined(__CLUTTER_H_INSIDE__) && !defined(CLUTTER_COMPILATION)
#error "Only <clutter/clutter.h> can be included directly."
#endif
#include <clutter/clutter-animation.h>
G_BEGIN_DECLS
#define CLUTTER_TYPE_ANIMATABLE (clutter_animatable_get_type ())
#define CLUTTER_ANIMATABLE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), CLUTTER_TYPE_ANIMATABLE, ClutterAnimatable))
#define CLUTTER_IS_ANIMATABLE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), CLUTTER_TYPE_ANIMATABLE))
#define CLUTTER_ANIMATABLE_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), CLUTTER_TYPE_ANIMATABLE, ClutterAnimatableIface))
typedef struct _ClutterAnimatableIface ClutterAnimatableIface;
docs: Documentation fixes Let's see if we can get a 100% coverage for Clutter too.
2010-03-02 09:53:55 +00:00
/**
* ClutterAnimatable:
*
* #ClutterAnimatable is an opaque structure whose members cannot be directly
* accessed
*
* Since: 1.0
*/
[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
/**
* ClutterAnimatableIface:
Miscellaneous documentation fixes
2010-05-19 15:10:05 +00:00
* @animate_property: virtual function for custom interpolation of a
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
* property. This virtual function is deprecated
Miscellaneous documentation fixes
2010-05-19 15:10:05 +00:00
* @find_property: virtual function for retrieving the #GParamSpec of
* an animatable property
* @get_initial_state: virtual function for retrieving the initial
* state of an animatable property
* @set_final_state: virtual function for setting the state of an
* animatable property
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
* @interpolate_value: virtual function for interpolating the progress
* of a property
[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
*
* Base interface for #GObject<!-- -->s that can be animated by a
* a #ClutterAnimation.
*
* Since: 1.0
*/
struct _ClutterAnimatableIface
{
/*< private >*/
GTypeInterface parent_iface;
/*< public >*/
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
gboolean (* animate_property) (ClutterAnimatable *animatable,
ClutterAnimation *animation,
const gchar *property_name,
const GValue *initial_value,
const GValue *final_value,
gdouble progress,
GValue *value);
GParamSpec *(* find_property) (ClutterAnimatable *animatable,
const gchar *property_name);
void (* get_initial_state) (ClutterAnimatable *animatable,
const gchar *property_name,
GValue *value);
void (* set_final_state) (ClutterAnimatable *animatable,
const gchar *property_name,
const 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
gboolean (* interpolate_value) (ClutterAnimatable *animatable,
const gchar *property_name,
ClutterInterval *interval,
gdouble progress,
GValue *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
};
GType clutter_animatable_get_type (void) G_GNUC_CONST;
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
#ifndef CLUTTER_DISABLE_DEPRECATED
Add a Clutter-specific deprecation macro for symbols Just like GLIB_DEPRECATED and GLIB_DEPRECATED_FOR, Clutter should have its own wrappers for G_DEPRECATED and G_DEPRECATED_FOR, to allow opting out of deprecation warnings. Deprecation warnings are enabled by default, now, even when building Clutter.
2011-10-11 22:03:09 +00:00
CLUTTER_DEPRECATED_FOR(clutter_animatable_interpolate_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
gboolean 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
#endif /* CLUTTER_DISABLE_DEPRECATED */
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);
void clutter_animatable_get_initial_state (ClutterAnimatable *animatable,
const gchar *property_name,
Miscellaneous documentation fixes
2010-05-19 15:10:05 +00:00
GValue *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
void clutter_animatable_set_final_state (ClutterAnimatable *animatable,
const gchar *property_name,
Miscellaneous documentation fixes
2010-05-19 15:10:05 +00:00
const 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
gboolean clutter_animatable_interpolate_value (ClutterAnimatable *animatable,
const gchar *property_name,
ClutterInterval *interval,
gdouble progress,
GValue *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
G_END_DECLS
#endif /* __CLUTTER_ANIMATABLE_H__ */
Reference in New Issue Copy Permalink