4
* An OpenGL based 'interactive canvas' library.
6
* Copyright (C) 2010 Intel Corporation
8
* This library is free software; you can redistribute it and/or
9
* modify it under the terms of the GNU Lesser General Public
10
* License as published by the Free Software Foundation; either
11
* version 2 of the License, or (at your option) any later version.
13
* This library is distributed in the hope that it will be useful,
14
* but WITHOUT ANY WARRANTY; without even the implied warranty of
15
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16
* Lesser General Public License for more details.
18
* You should have received a copy of the GNU Lesser General Public
19
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
22
* Øyvind Kolås <pippin@linux.intel.com>
26
* SECTION:clutter-animator
27
* @short_description: Multi-actor tweener
28
* @See_Also: #ClutterAnimatable, #ClutterInterval, #ClutterAlpha,
31
* #ClutterAnimator is an object providing declarative animations for
32
* #GObject properties belonging to one or more #GObject<!-- -->s to
35
* #ClutterAnimator is used to build and describe complex animations
36
* in terms of "key frames". #ClutterAnimator is meant to be used
37
* through the #ClutterScript definition format, but it comes with a
40
* #ClutterAnimator is available since Clutter 1.2
42
* #ClutterAnimator has been deprecated in Clutter 1.12. If you
43
* want to combine multiple transitions using key frames, use
44
* #ClutterKeyframeTransition and #ClutterTransitionGroup instead.
48
* Every animation handled by a #ClutterAnimator can be
49
* described in terms of "key frames". For each #GObject property
50
* there can be multiple key frames, each one defined by the end
51
* value for the property to be computed starting from the current
52
* value to a specific point in time, using a given easing
55
* The point in time is defined using a value representing
56
* the progress in the normalized interval of [ 0, 1 ]. This maps
57
* the value returned by clutter_timeline_get_duration().
59
* ## ClutterAnimator description for ClutterScript
61
* #ClutterAnimator defines a custom "properties" key
62
* which allows describing the key frames for objects as
63
* an array of key frames.
65
* The `properties` array has the following syntax:
71
* "object" : object_id
72
* "name" : property_name
73
* "ease-in" : true_or_false
74
* "interpolation" : interpolation_value
76
* [ progress, easing_mode, final_value ]
82
* The following JSON fragment defines a #ClutterAnimator
83
* with the duration of 1 second and operating on the x and y
84
* properties of a #ClutterActor named "rect-01", with two frames
85
* for each property. The first frame will linearly move the actor
86
* from its current position to the 100, 100 position in 20 percent
87
* of the duration of the animation; the second will using a cubic
88
* easing to move the actor to the 200, 200 coordinates.
92
* "type" : "ClutterAnimator",
96
* "object" : "rect-01",
100
* [ 0.2, "linear", 100.0 ],
101
* [ 1.0, "easeOutCubic", 200.0 ]
105
* "object" : "rect-01",
109
* [ 0.2, "linear", 100.0 ],
110
* [ 1.0, "easeOutCubic", 200.0 ]
125
#include <gobject/gvaluecollector.h>
127
#define CLUTTER_DISABLE_DEPRECATION_WARNINGS
129
#include "clutter-animator.h"
131
#include "clutter-alpha.h"
132
#include "clutter-debug.h"
133
#include "clutter-enum-types.h"
134
#include "clutter-interval.h"
135
#include "clutter-private.h"
136
#include "clutter-script-private.h"
137
#include "clutter-scriptable.h"
139
/* progress values varying by less than this are considered equal */
140
#define PROGRESS_EPSILON 0.00001
142
struct _ClutterAnimatorPrivate
144
ClutterTimeline *timeline;
145
ClutterTimeline *slave_timeline;
149
GHashTable *properties;
152
struct _ClutterAnimatorKey
155
const gchar *property_name;
160
/* normalized progress, between 0.0 and 1.0 */
163
/* back-pointer to the animator which owns the key */
164
ClutterAnimator *animator;
166
/* interpolation mode */
167
ClutterInterpolation interpolation;
169
/* ease from the current object state into the animation when it starts */
172
/* This key is already being destroyed and shouldn't
173
* trigger additional weak unrefs
190
static GParamSpec *obj_props[PROP_LAST];
192
static void clutter_scriptable_init (ClutterScriptableIface *iface);
194
G_DEFINE_TYPE_WITH_CODE (ClutterAnimator,
197
G_ADD_PRIVATE (ClutterAnimator)
198
G_IMPLEMENT_INTERFACE (CLUTTER_TYPE_SCRIPTABLE,
199
clutter_scriptable_init));
201
* clutter_animator_new:
203
* Creates a new #ClutterAnimator instance
205
* Return value: a new #ClutterAnimator.
209
* Deprecated: 1.12: Use #ClutterKeyframeTransition instead
212
clutter_animator_new (void)
214
return g_object_new (CLUTTER_TYPE_ANIMATOR, NULL);
219
typedef struct _PropObjectKey {
221
const gchar *property_name;
226
/* Iterator that walks the keys of a property*/
227
typedef struct _PropertyIter {
229
ClutterInterval *interval;
234
gdouble start; /* the progress of current */
235
gdouble end; /* until which progress it is valid */
236
ClutterInterpolation interpolation;
241
static PropObjectKey *
242
prop_actor_key_new (GObject *object,
243
const gchar *property_name)
245
PropObjectKey *key = g_slice_new0 (PropObjectKey);
247
key->object = object;
248
key->property_name = g_intern_string (property_name);
254
prop_actor_key_free (gpointer key)
257
g_slice_free (PropObjectKey, key);
261
property_iter_free (gpointer key)
265
PropertyIter *property_iter = key;
267
g_object_unref (property_iter->interval);
268
g_object_unref (property_iter->alpha);
270
g_slice_free (PropertyIter, property_iter);
274
static PropertyIter *
275
property_iter_new (ClutterAnimator *animator,
279
ClutterAnimatorPrivate *priv = animator->priv;
280
PropertyIter *property_iter = g_slice_new (PropertyIter);
281
ClutterInterval *interval = g_object_new (CLUTTER_TYPE_INTERVAL,
285
/* we own this interval */
286
g_object_ref_sink (interval);
288
property_iter->interval = interval;
289
property_iter->key = key;
290
property_iter->alpha = clutter_alpha_new ();
291
clutter_alpha_set_timeline (property_iter->alpha, priv->slave_timeline);
293
/* as well as the alpha */
294
g_object_ref_sink (property_iter->alpha);
296
return property_iter;
300
prop_actor_hash (gconstpointer value)
302
const PropObjectKey *info = value;
304
return GPOINTER_TO_INT (info->property_name)
305
^ GPOINTER_TO_INT (info->object);
309
prop_actor_equal (gconstpointer a, gconstpointer b)
311
const PropObjectKey *infoa = a;
312
const PropObjectKey *infob = b;
314
/* property name strings are interned so we can just compare pointers */
315
if (infoa->object == infob->object &&
316
(infoa->property_name == infob->property_name))
323
sort_actor_prop_progress_func (gconstpointer a,
326
const ClutterAnimatorKey *pa = a;
327
const ClutterAnimatorKey *pb = b;
329
if (pa->object == pb->object)
331
gint pdiff = pb->property_name - pa->property_name;
336
if (fabs (pa->progress - pb->progress) < PROGRESS_EPSILON)
339
if (pa->progress > pb->progress)
345
return pa->object - pb->object;
349
sort_actor_prop_func (gconstpointer a,
352
const ClutterAnimatorKey *pa = a;
353
const ClutterAnimatorKey *pb = b;
355
if (pa->object == pb->object)
356
return pa->property_name - pb->property_name;
358
return pa->object - pb->object;
362
clutter_animator_remove_key_internal (ClutterAnimator *animator,
364
const gchar *property_name,
369
object_disappeared (gpointer data,
370
GObject *where_the_object_was)
372
clutter_animator_remove_key_internal (data, where_the_object_was, NULL, -1.0,
376
static ClutterAnimatorKey *
377
clutter_animator_key_new (ClutterAnimator *animator,
379
const gchar *property_name,
383
ClutterAnimatorKey *animator_key;
385
animator_key = g_slice_new (ClutterAnimatorKey);
387
animator_key->ref_count = 1;
388
animator_key->animator = animator;
389
animator_key->object = object;
390
animator_key->mode = mode;
391
memset (&(animator_key->value), 0, sizeof (GValue));
392
animator_key->progress = progress;
393
animator_key->property_name = g_intern_string (property_name);
394
animator_key->interpolation = CLUTTER_INTERPOLATION_LINEAR;
395
animator_key->ease_in = FALSE;
396
animator_key->is_inert = FALSE;
398
/* keep a weak reference on the animator, so that we can release the
399
* back-pointer when needed
401
g_object_weak_ref (object, object_disappeared,
402
animator_key->animator);
408
clutter_animator_key_copy (gpointer boxed)
410
ClutterAnimatorKey *key = boxed;
419
clutter_animator_key_free (gpointer boxed)
421
ClutterAnimatorKey *key = boxed;
428
if (key->ref_count > 0)
432
g_object_weak_unref (key->object, object_disappeared, key->animator);
434
g_slice_free (ClutterAnimatorKey, key);
438
clutter_animator_dispose (GObject *object)
440
ClutterAnimator *animator = CLUTTER_ANIMATOR (object);
441
ClutterAnimatorPrivate *priv = animator->priv;
443
clutter_animator_set_timeline (animator, NULL);
444
g_object_unref (priv->slave_timeline);
446
G_OBJECT_CLASS (clutter_animator_parent_class)->dispose (object);
450
clutter_animator_finalize (GObject *object)
452
ClutterAnimator *animator = CLUTTER_ANIMATOR (object);
453
ClutterAnimatorPrivate *priv = animator->priv;
455
g_list_foreach (priv->score, (GFunc) clutter_animator_key_free, NULL);
456
g_list_free (priv->score);
459
g_hash_table_destroy (priv->properties);
461
G_OBJECT_CLASS (clutter_animator_parent_class)->finalize (object);
464
/* XXX: this is copied and slightly modified from glib,
465
* there is only one way to do this. */
467
list_find_custom_reverse (GList *list,
473
if (! func (list->data, data))
482
/* Ensures that the interval provided by the animator is correct
483
* for the requested progress value.
486
animation_animator_ensure_animator (ClutterAnimator *animator,
487
PropertyIter *property_iter,
492
if (progress > property_iter->end)
494
while (progress > property_iter->end)
496
ClutterAnimatorKey *initial_key, *next_key;
497
GList *initial, *next;
499
initial = g_list_find_custom (property_iter->current->next,
501
sort_actor_prop_func);
505
initial_key = initial->data;
507
clutter_interval_set_initial_value (property_iter->interval,
508
&initial_key->value);
509
property_iter->current = initial;
510
property_iter->start = initial_key->progress;
512
next = g_list_find_custom (initial->next,
514
sort_actor_prop_func);
517
next_key = next->data;
519
property_iter->end = next_key->progress;
523
next_key = initial_key;
525
property_iter->end = property_iter->start;
528
clutter_interval_set_final_value (property_iter->interval,
531
if ((clutter_alpha_get_mode (property_iter->alpha) != next_key->mode))
532
clutter_alpha_set_mode (property_iter->alpha, next_key->mode);
534
else /* no relevant interval */
536
ClutterAnimatorKey *current_key = property_iter->current->data;
537
clutter_interval_set_initial_value (property_iter->interval,
538
¤t_key->value);
539
clutter_interval_set_final_value (property_iter->interval,
540
¤t_key->value);
545
else if (progress < property_iter->start)
547
while (progress < property_iter->start)
549
ClutterAnimatorKey *initial_key, *next_key;
551
GList *old = property_iter->current;
553
initial = list_find_custom_reverse (property_iter->current->prev,
555
sort_actor_prop_func);
559
initial_key = initial->data;
561
clutter_interval_set_initial_value (property_iter->interval,
562
&initial_key->value);
563
property_iter->current = initial;
564
property_iter->end = property_iter->start;
565
property_iter->start = initial_key->progress;
569
next_key = old->data;
571
property_iter->end = next_key->progress;
575
next_key = initial_key;
577
property_iter->end = 1.0;
580
clutter_interval_set_final_value (property_iter->interval,
582
if ((clutter_alpha_get_mode (property_iter->alpha) != next_key->mode))
583
clutter_alpha_set_mode (property_iter->alpha, next_key->mode);
591
/* XXX - this might be useful as an internal function exposed somewhere */
593
cubic_interpolation (const gdouble dx,
597
const gdouble nextnext)
599
return (((( - prev + 3 * j - 3 * next + nextnext ) * dx +
600
( 2 * prev - 5 * j + 4 * next - nextnext ) ) * dx +
601
( - prev + next ) ) * dx + (j + j) ) / 2.0;
604
/* try to get a floating point key value from a key for a property,
605
* failing use the closest key in that direction or the starting point.
608
list_try_get_rel (GList *list,
611
ClutterAnimatorKey *key;
617
while (count -- && iter != NULL)
619
iter = g_list_find_custom (iter->next, list->data,
620
sort_actor_prop_func);
627
while (count ++ < 0 && iter != NULL)
629
iter = list_find_custom_reverse (iter->prev, list->data,
630
sort_actor_prop_func);
636
if (best != NULL && best->data != NULL)
640
return g_value_get_float (&(key->value));
647
animation_animator_new_frame (ClutterTimeline *timeline,
649
ClutterAnimator *animator)
655
progress = 1.0 * msecs / clutter_timeline_get_duration (timeline);
657
/* for each property that is managed figure out the GValue to set,
658
* avoid creating new ClutterInterval's for each interval crossed
660
g_hash_table_iter_init (&iter, animator->priv->properties);
663
while (g_hash_table_iter_next (&iter, &key, &value))
665
PropObjectKey *prop_actor_key = key;
666
PropertyIter *property_iter = value;
667
ClutterAnimatorKey *start_key;
668
gdouble sub_progress;
670
animation_animator_ensure_animator (animator, property_iter,
673
start_key = property_iter->current->data;
675
if (property_iter->end == property_iter->start)
676
sub_progress = 0.0; /* we're past the final value */
678
sub_progress = (progress - property_iter->start)
679
/ (property_iter->end - property_iter->start);
681
/* only change values if we active (delayed start) */
682
if (sub_progress >= 0.0 && sub_progress <= 1.0)
684
GValue tmp_value = G_VALUE_INIT;
687
g_value_init (&tmp_value, G_VALUE_TYPE (&start_key->value));
689
clutter_timeline_advance (animator->priv->slave_timeline,
690
sub_progress * 10000);
692
sub_progress = clutter_alpha_get_alpha (property_iter->alpha);
693
int_type = clutter_interval_get_value_type (property_iter->interval);
695
if (property_iter->interpolation == CLUTTER_INTERPOLATION_CUBIC &&
696
int_type == G_TYPE_FLOAT)
698
gdouble prev, current, next, nextnext;
701
if ((property_iter->ease_in == FALSE ||
702
(property_iter->ease_in &&
703
list_find_custom_reverse (property_iter->current->prev,
704
property_iter->current->data,
705
sort_actor_prop_func))))
707
current = g_value_get_float (&start_key->value);
708
prev = list_try_get_rel (property_iter->current, -1);
712
/* interpolated and easing in */
713
clutter_interval_get_initial_value (property_iter->interval,
715
prev = current = g_value_get_float (&tmp_value);
718
next = list_try_get_rel (property_iter->current, 1);
719
nextnext = list_try_get_rel (property_iter->current, 2);
720
res = cubic_interpolation (sub_progress, prev, current, next,
723
g_value_set_float (&tmp_value, res);
726
clutter_interval_compute_value (property_iter->interval,
730
g_object_set_property (prop_actor_key->object,
731
prop_actor_key->property_name,
734
g_value_unset (&tmp_value);
740
animation_animator_started (ClutterTimeline *timeline,
741
ClutterAnimator *animator)
745
/* Ensure that animators exist for all involved properties */
746
for (k = animator->priv->score; k != NULL; k = k->next)
748
ClutterAnimatorKey *key = k->data;
749
PropertyIter *property_iter;
750
PropObjectKey *prop_actor_key;
752
prop_actor_key = prop_actor_key_new (key->object, key->property_name);
753
property_iter = g_hash_table_lookup (animator->priv->properties,
757
prop_actor_key_free (prop_actor_key);
761
GObjectClass *klass = G_OBJECT_GET_CLASS (key->object);
764
pspec = g_object_class_find_property (klass, key->property_name);
766
property_iter = property_iter_new (animator, prop_actor_key,
767
G_PARAM_SPEC_VALUE_TYPE (pspec));
768
g_hash_table_insert (animator->priv->properties,
774
/* initialize animator with initial list pointers */
779
g_hash_table_iter_init (&iter, animator->priv->properties);
780
while (g_hash_table_iter_next (&iter, &key, &value))
782
PropertyIter *property_iter = value;
783
ClutterAnimatorKey *initial_key, *next_key;
787
initial = g_list_find_custom (animator->priv->score,
789
sort_actor_prop_func);
790
g_assert (initial != NULL);
791
initial_key = initial->data;
792
clutter_interval_set_initial_value (property_iter->interval,
793
&initial_key->value);
795
property_iter->current = initial;
796
property_iter->start = initial_key->progress;
797
property_iter->ease_in = initial_key->ease_in;
798
property_iter->interpolation = initial_key->interpolation;
800
if (property_iter->ease_in)
802
GValue tmp_value = G_VALUE_INIT;
805
int_type = clutter_interval_get_value_type (property_iter->interval);
806
g_value_init (&tmp_value, int_type);
808
g_object_get_property (initial_key->object,
809
initial_key->property_name,
812
clutter_interval_set_initial_value (property_iter->interval,
815
g_value_unset (&tmp_value);
818
next = g_list_find_custom (initial->next, key, sort_actor_prop_func);
821
next_key = next->data;
822
property_iter->end = next_key->progress;
826
next_key = initial_key;
827
property_iter->end = 1.0;
830
clutter_interval_set_final_value (property_iter->interval,
832
if ((clutter_alpha_get_mode (property_iter->alpha) != next_key->mode))
833
clutter_alpha_set_mode (property_iter->alpha, next_key->mode);
839
* clutter_animator_compute_value:
840
* @animator: a #ClutterAnimator
841
* @object: a #GObject
842
* @property_name: the name of the property on object to check
843
* @progress: a value between 0.0 and 1.0
844
* @value: an initialized value to store the computed result
846
* Compute the value for a managed property at a given progress.
848
* If the property is an ease-in property, the current value of the property
849
* on the object will be used as the starting point for computation.
851
* Return value: %TRUE if the computation yields has a value, otherwise (when
852
* an error occurs or the progress is before any of the keys) %FALSE is
853
* returned and the #GValue is left untouched
856
* Deprecated: 1.12: Use #ClutterKeyframeTransition instead
859
clutter_animator_compute_value (ClutterAnimator *animator,
861
const gchar *property_name,
865
ClutterAnimatorPrivate *priv;
866
ClutterAnimatorKey key;
867
ClutterAnimatorKey *previous;
868
ClutterAnimatorKey *next = NULL;
874
ClutterInterpolation interpolation;
876
g_return_val_if_fail (CLUTTER_IS_ANIMATOR (animator), FALSE);
877
g_return_val_if_fail (G_IS_OBJECT (object), FALSE);
878
g_return_val_if_fail (property_name, FALSE);
879
g_return_val_if_fail (value, FALSE);
881
priv = animator->priv;
883
ease_in = clutter_animator_property_get_ease_in (animator, object,
885
interpolation = clutter_animator_property_get_interpolation (animator,
886
object, property_name);
888
property_name = g_intern_string (property_name);
890
pspec = g_object_class_find_property (G_OBJECT_GET_CLASS (object),
894
key.property_name = property_name;
896
initial_l = g_list_find_custom (animator->priv->score, &key,
897
sort_actor_prop_func);
898
if (initial_l == NULL)
901
/* first find the interval we belong in, that is the first interval
902
* existing between keys
905
for (previous_l = initial_l, next_l = previous_l->next ;
907
previous_l = previous_l->next, next_l = previous_l->next)
909
previous = previous_l->data;
913
if (next->object != object ||
914
next->property_name != property_name)
923
if (progress < previous->progress)
925
/* we are before the defined values */
927
/* value has not been set */
931
if (!next && previous->progress <= progress)
933
/* we only had one key for this object/property */
934
/* and we are past it, that is our value */
935
g_value_copy (&previous->value, value);
939
if (next && next->progress >= progress)
941
ClutterInterval *interval;
944
gdouble sub_progress = (progress - previous->progress)
945
/ (next->progress - previous->progress);
946
/* this should be our interval */
947
interval = g_object_new (CLUTTER_TYPE_INTERVAL,
948
"value-type", pspec->value_type,
951
if (ease_in && previous_l == initial_l)
953
GValue tmp_value = {0, };
954
g_value_init (&tmp_value, pspec->value_type);
955
g_object_get_property (object, property_name, &tmp_value);
956
clutter_interval_set_initial_value (interval, &tmp_value);
957
g_value_unset (&tmp_value);
960
clutter_interval_set_initial_value (interval, &previous->value);
962
clutter_interval_set_final_value (interval, &next->value);
964
alpha = clutter_alpha_new ();
965
clutter_alpha_set_timeline (alpha, priv->slave_timeline);
966
clutter_alpha_set_mode (alpha, next->mode);
968
clutter_timeline_advance (priv->slave_timeline,
969
sub_progress * 10000);
970
sub_progress = clutter_alpha_get_alpha (alpha);
972
if (interpolation == CLUTTER_INTERPOLATION_CUBIC &&
973
pspec->value_type == G_TYPE_FLOAT)
975
gdouble prev, current, nextv, nextnext;
978
if ((ease_in == FALSE ||
980
list_find_custom_reverse (previous_l->prev,
982
sort_actor_prop_func))))
984
current = g_value_get_float (&previous->value);
985
prev = list_try_get_rel (previous_l, -1);
989
/* interpolated and easing in */
990
GValue tmp_value = {0, };
991
g_value_init (&tmp_value, pspec->value_type);
992
clutter_interval_get_initial_value (interval,
994
prev = current = g_value_get_float (&tmp_value);
995
g_value_unset (&tmp_value);
998
nextv = list_try_get_rel (previous_l, 1);
999
nextnext = list_try_get_rel (previous_l, 2);
1000
res = cubic_interpolation (sub_progress, prev, current, nextv,
1002
g_value_set_float (value, res);
1005
clutter_interval_compute_value (interval,
1009
g_object_ref_sink (interval);
1010
g_object_unref (interval);
1011
g_object_ref_sink (alpha);
1012
g_object_unref (alpha);
1022
/* We're at, or past the end, use the last value */
1023
g_value_copy (&next->value, value);
1030
* clutter_animator_set_timeline:
1031
* @animator: a #ClutterAnimator
1032
* @timeline: a #ClutterTimeline
1034
* Sets an external timeline that will be used for driving the animation
1037
* Deprecated: 1.12: Use #ClutterKeyframeTransition instead
1040
clutter_animator_set_timeline (ClutterAnimator *animator,
1041
ClutterTimeline *timeline)
1043
ClutterAnimatorPrivate *priv;
1045
g_return_if_fail (CLUTTER_IS_ANIMATOR (animator));
1047
priv = animator->priv;
1049
if (priv->timeline != NULL)
1051
g_signal_handlers_disconnect_by_func (priv->timeline,
1052
animation_animator_new_frame,
1054
g_signal_handlers_disconnect_by_func (priv->timeline,
1055
animation_animator_started,
1057
g_object_unref (priv->timeline);
1060
priv->timeline = timeline;
1061
if (timeline != NULL)
1063
g_object_ref (priv->timeline);
1065
g_signal_connect (priv->timeline, "new-frame",
1066
G_CALLBACK (animation_animator_new_frame),
1068
g_signal_connect (priv->timeline, "started",
1069
G_CALLBACK (animation_animator_started),
1075
* clutter_animator_get_timeline:
1076
* @animator: a #ClutterAnimator
1078
* Get the timeline hooked up for driving the #ClutterAnimator
1080
* Return value: (transfer none): the #ClutterTimeline that drives the animator
1083
* Deprecated: 1.12: Use #ClutterKeyframeTransition instead
1086
clutter_animator_get_timeline (ClutterAnimator *animator)
1088
g_return_val_if_fail (CLUTTER_IS_ANIMATOR (animator), NULL);
1089
return animator->priv->timeline;
1093
* clutter_animator_start:
1094
* @animator: a #ClutterAnimator
1096
* Start the ClutterAnimator, this is a thin wrapper that rewinds
1097
* and starts the animators current timeline.
1099
* Return value: (transfer none): the #ClutterTimeline that drives
1100
* the animator. The returned timeline is owned by the #ClutterAnimator
1101
* and it should not be unreferenced
1104
* Deprecated: 1.12: Use #ClutterKeyframeTransition instead
1107
clutter_animator_start (ClutterAnimator *animator)
1109
ClutterAnimatorPrivate *priv;
1111
g_return_val_if_fail (CLUTTER_IS_ANIMATOR (animator), NULL);
1113
priv = animator->priv;
1115
clutter_timeline_rewind (priv->timeline);
1116
clutter_timeline_start (priv->timeline);
1118
return priv->timeline;
1122
* clutter_animator_set_duration:
1123
* @animator: a #ClutterAnimator
1124
* @duration: milliseconds a run of the animator should last.
1126
* Runs the timeline of the #ClutterAnimator with a duration in msecs
1130
* Deprecated: 1.12: Use #ClutterKeyframeTransition instead
1133
clutter_animator_set_duration (ClutterAnimator *animator,
1136
g_return_if_fail (CLUTTER_IS_ANIMATOR (animator));
1138
clutter_timeline_set_duration (animator->priv->timeline, duration);
1142
* clutter_animator_get_duration:
1143
* @animator: a #ClutterAnimator
1145
* Retrieves the current duration of an animator
1147
* Return value: the duration of the animation, in milliseconds
1150
* Deprecated: 1.12: Use #ClutterKeyframeTransition instead
1153
clutter_animator_get_duration (ClutterAnimator *animator)
1155
g_return_val_if_fail (CLUTTER_IS_ANIMATOR (animator), 0);
1157
return clutter_timeline_get_duration (animator->priv->timeline);
1161
* clutter_animator_set:
1162
* @animator: a #ClutterAnimator
1163
* @first_object: a #GObject
1164
* @first_property_name: the property to specify a key for
1165
* @first_mode: the id of the alpha function to use
1166
* @first_progress: at which stage of the animation this value applies; the
1167
* range is a normalized floating point value between 0 and 1
1168
* @...: the value first_property_name should have for first_object
1169
* at first_progress, followed by more (object, property_name, mode,
1170
* progress, value) tuples, followed by %NULL
1172
* Adds multiple keys to a #ClutterAnimator, specifying the value a given
1173
* property should have at a given progress of the animation. The mode
1174
* specified is the mode used when going to this key from the previous key of
1175
* the @property_name
1177
* If a given (object, property, progress) tuple already exist the mode and
1178
* value will be replaced with the new values.
1181
* Deprecated: 1.12: Use #ClutterKeyframeTransition instead
1184
clutter_animator_set (ClutterAnimator *animator,
1185
gpointer first_object,
1186
const gchar *first_property_name,
1188
gdouble first_progress,
1192
const gchar *property_name;
1197
g_return_if_fail (CLUTTER_IS_ANIMATOR (animator));
1199
object = first_object;
1200
property_name = first_property_name;
1202
g_return_if_fail (object);
1203
g_return_if_fail (property_name);
1206
progress = first_progress;
1208
va_start (args, first_progress);
1210
while (object != NULL)
1213
GObjectClass *klass;
1214
GValue value = G_VALUE_INIT;
1215
gchar *error = NULL;
1217
klass = G_OBJECT_GET_CLASS (object);
1218
pspec = g_object_class_find_property (klass, property_name);
1222
g_warning ("Cannot bind property '%s': object of type '%s' "
1223
"do not have this property",
1224
property_name, G_OBJECT_TYPE_NAME (object));
1228
G_VALUE_COLLECT_INIT (&value, G_PARAM_SPEC_VALUE_TYPE (pspec),
1234
g_warning ("%s: %s", G_STRLOC, error);
1239
clutter_animator_set_key (animator,
1246
object= va_arg (args, GObject *);
1249
property_name = va_arg (args, gchar*);
1252
g_warning ("%s: expected a property name", G_STRLOC);
1255
mode = va_arg (args, guint);
1256
progress = va_arg (args, gdouble);
1264
clutter_animator_set_key_internal (ClutterAnimator *animator,
1265
ClutterAnimatorKey *key)
1267
ClutterAnimatorPrivate *priv = animator->priv;
1269
GList *initial_item;
1270
ClutterAnimatorKey *initial_key = NULL;
1272
if ((initial_item = g_list_find_custom (animator->priv->score, key,
1273
sort_actor_prop_func)))
1274
initial_key = initial_item->data;
1276
/* The first key for a property specifies ease-in and interpolation,
1277
* if we are replacing; or becoming a new first key we should
1278
* inherit the old flags.
1281
initial_key->progress >= key->progress)
1283
key->interpolation = initial_key->interpolation;
1284
key->ease_in = initial_key->ease_in;
1287
old_item = g_list_find_custom (priv->score, key,
1288
sort_actor_prop_progress_func);
1290
/* replace the key if we already have a similar one */
1291
if (old_item != NULL)
1293
ClutterAnimatorKey *old_key = old_item->data;
1295
clutter_animator_key_free (old_key);
1297
priv->score = g_list_remove (priv->score, old_key);
1300
priv->score = g_list_insert_sorted (priv->score, key,
1301
sort_actor_prop_progress_func);
1303
/* if the animator is already running reinitialize internal iterators */
1304
if (clutter_timeline_is_playing (priv->timeline))
1305
animation_animator_started (priv->timeline, animator);
1309
* clutter_animator_set_key:
1310
* @animator: a #ClutterAnimator
1311
* @object: a #GObject
1312
* @property_name: the property to specify a key for
1313
* @mode: the id of the alpha function to use
1314
* @progress: the normalized range at which stage of the animation this
1316
* @value: the value property_name should have at progress.
1318
* Sets a single key in the #ClutterAnimator for the @property_name of
1319
* @object at @progress.
1321
* See also: clutter_animator_set()
1323
* Return value: (transfer none): The animator instance
1326
* Deprecated: 1.12: Use #ClutterKeyframeTransition instead
1329
clutter_animator_set_key (ClutterAnimator *animator,
1331
const gchar *property_name,
1334
const GValue *value)
1336
ClutterAnimatorKey *animator_key;
1338
g_return_val_if_fail (CLUTTER_IS_ANIMATOR (animator), NULL);
1339
g_return_val_if_fail (G_IS_OBJECT (object), NULL);
1340
g_return_val_if_fail (property_name, NULL);
1341
g_return_val_if_fail (value, NULL);
1343
property_name = g_intern_string (property_name);
1345
animator_key = clutter_animator_key_new (animator,
1346
object, property_name,
1350
g_value_init (&animator_key->value, G_VALUE_TYPE (value));
1351
g_value_copy (value, &animator_key->value);
1353
clutter_animator_set_key_internal (animator, animator_key);
1359
* clutter_animator_get_keys:
1360
* @animator: a #ClutterAnimator instance
1361
* @object: (allow-none): a #GObject to search for, or %NULL for all objects
1362
* @property_name: (allow-none): a specific property name to query for,
1363
* or %NULL for all properties
1364
* @progress: a specific progress to search for, or a negative value for all
1367
* Returns a list of pointers to opaque structures with accessor functions
1368
* that describe the keys added to an animator.
1370
* Return value: (transfer container) (element-type Clutter.AnimatorKey): a
1371
* list of #ClutterAnimatorKey<!-- -->s; the contents of the list are owned
1372
* by the #ClutterAnimator, but you should free the returned list when done,
1373
* using g_list_free()
1376
* Deprecated: 1.12: Use #ClutterKeyframeTransition instead
1379
clutter_animator_get_keys (ClutterAnimator *animator,
1381
const gchar *property_name,
1387
g_return_val_if_fail (CLUTTER_IS_ANIMATOR (animator), NULL);
1388
g_return_val_if_fail (object == NULL || G_IS_OBJECT (object), NULL);
1390
property_name = g_intern_string (property_name);
1392
for (k = animator->priv->score; k; k = k->next)
1394
ClutterAnimatorKey *key = k->data;
1396
if ((object == NULL || (object == key->object)) &&
1397
(property_name == NULL || (property_name == key->property_name)) &&
1398
(progress < 0 || fabs (progress - key->progress) < PROGRESS_EPSILON))
1400
keys = g_list_prepend (keys, key);
1404
return g_list_reverse (keys);
1408
clutter_animator_remove_key_internal (ClutterAnimator *animator,
1410
const gchar *property_name,
1414
ClutterAnimatorPrivate *priv;
1417
g_return_if_fail (CLUTTER_IS_ANIMATOR (animator));
1418
g_return_if_fail (object == NULL || G_IS_OBJECT (object));
1420
property_name = g_intern_string (property_name);
1422
priv = animator->priv;
1425
for (k = priv->score; k != NULL; k = k->next)
1427
ClutterAnimatorKey *key = k->data;
1429
if ((object == NULL || (object == key->object)) &&
1430
(property_name == NULL || ((property_name == key->property_name))) &&
1431
(progress < 0 || fabs (progress - key->progress) < PROGRESS_EPSILON)
1434
ClutterAnimatorKey *prev_key = NULL;
1435
key->is_inert = is_inert;
1438
/* FIXME: non performant since we reiterate the list many times */
1440
prev_key = k->prev ? k->prev->data : NULL;
1442
if (!prev_key || prev_key->object != key->object ||
1443
prev_key->property_name != key->property_name)
1444
{ /* We are removing the first key for a property ... */
1445
ClutterAnimatorKey *next_key = k->next ? k->next->data : NULL;
1446
if (next_key && next_key->object == key->object &&
1447
next_key->property_name == key->property_name)
1449
/* ... and there is a key of our own type following us,
1450
* copy interpolation/ease_in flags to the new first key
1452
next_key->interpolation = key->interpolation;
1453
next_key->ease_in = key->ease_in;
1457
clutter_animator_key_free (key);
1458
priv->score = g_list_remove (priv->score, key);
1463
/* clear off cached state for all properties, this is regenerated in a
1464
* correct state by animation_animator_started
1466
g_hash_table_remove_all (priv->properties);
1468
/* if the animator is already running reinitialize internal iterators */
1469
if (priv->timeline != NULL && clutter_timeline_is_playing (priv->timeline))
1470
animation_animator_started (priv->timeline, animator);
1474
* clutter_animator_remove_key:
1475
* @animator: a #ClutterAnimator
1476
* @object: (allow-none): a #GObject to search for, or %NULL for all
1477
* @property_name: (allow-none): a specific property name to query for,
1479
* @progress: a specific progress to search for or a negative value
1482
* Removes all keys matching the conditions specificed in the arguments.
1485
* Deprecated: 1.12: Use #ClutterKeyframeTransition instead
1488
clutter_animator_remove_key (ClutterAnimator *animator,
1490
const gchar *property_name,
1493
clutter_animator_remove_key_internal (animator, object, property_name,
1500
typedef struct _ParseClosure {
1501
ClutterAnimator *animator;
1502
ClutterScript *script;
1509
static ClutterInterpolation
1510
resolve_interpolation (JsonNode *node)
1512
if ((JSON_NODE_TYPE (node) != JSON_NODE_VALUE))
1513
return CLUTTER_INTERPOLATION_LINEAR;
1515
if (json_node_get_value_type (node) == G_TYPE_INT64)
1517
return json_node_get_int (node);
1519
else if (json_node_get_value_type (node) == G_TYPE_STRING)
1521
const gchar *str = json_node_get_string (node);
1525
res = _clutter_script_enum_from_string (CLUTTER_TYPE_INTERPOLATION,
1532
return CLUTTER_INTERPOLATION_LINEAR;
1536
parse_animator_property (JsonArray *array,
1541
ParseClosure *clos = data;
1545
const gchar *id_, *pname;
1546
GObjectClass *klass;
1548
GSList *valid_keys = NULL;
1549
GList *array_keys, *k;
1550
ClutterInterpolation interpolation = CLUTTER_INTERPOLATION_LINEAR;
1551
gboolean ease_in = FALSE;
1553
if (JSON_NODE_TYPE (element) != JSON_NODE_OBJECT)
1555
g_warning ("The 'properties' member of a ClutterAnimator description "
1556
"should be an array of objects, but the element %d of the "
1557
"array is of type '%s'. The element will be ignored.",
1559
json_node_type_name (element));
1563
object = json_node_get_object (element);
1565
if (!json_object_has_member (object, "object") ||
1566
!json_object_has_member (object, "name") ||
1567
!json_object_has_member (object, "keys"))
1569
g_warning ("The property description at index %d is missing one of "
1570
"the mandatory fields: object, name and keys",
1575
id_ = json_object_get_string_member (object, "object");
1576
gobject = clutter_script_get_object (clos->script, id_);
1577
if (gobject == NULL)
1579
g_warning ("No object with id '%s' has been defined.", id_);
1583
pname = json_object_get_string_member (object, "name");
1584
klass = G_OBJECT_GET_CLASS (gobject);
1585
pspec = g_object_class_find_property (klass, pname);
1588
g_warning ("The object of type '%s' and name '%s' has no "
1589
"property named '%s'",
1590
G_OBJECT_TYPE_NAME (gobject),
1596
if (json_object_has_member (object, "ease-in"))
1597
ease_in = json_object_get_boolean_member (object, "ease-in");
1599
if (json_object_has_member (object, "interpolation"))
1601
JsonNode *node = json_object_get_member (object, "interpolation");
1603
interpolation = resolve_interpolation (node);
1606
keys = json_object_get_array_member (object, "keys");
1609
g_warning ("The property description at index %d has an invalid "
1610
"key field of type '%s' when an array was expected.",
1612
json_node_type_name (json_object_get_member (object, "keys")));
1616
if (G_IS_VALUE (clos->value))
1617
valid_keys = g_slist_reverse (g_value_get_pointer (clos->value));
1619
g_value_init (clos->value, G_TYPE_POINTER);
1621
array_keys = json_array_get_elements (keys);
1622
for (k = array_keys; k != NULL; k = k->next)
1624
JsonNode *node = k->data;
1625
JsonArray *key = json_node_get_array (node);
1626
ClutterAnimatorKey *animator_key;
1631
progress = json_array_get_double_element (key, 0);
1632
mode = _clutter_script_resolve_animation_mode (json_array_get_element (key, 1));
1634
animator_key = clutter_animator_key_new (clos->animator,
1640
res = _clutter_script_parse_node (clos->script,
1641
&(animator_key->value),
1643
json_array_get_element (key, 2),
1647
g_warning ("Unable to parse the key value for the "
1648
"property '%s' (progress: %.2f) at index %d",
1655
animator_key->ease_in = ease_in;
1656
animator_key->interpolation = interpolation;
1658
valid_keys = g_slist_prepend (valid_keys, animator_key);
1661
g_list_free (array_keys);
1663
g_value_set_pointer (clos->value, g_slist_reverse (valid_keys));
1665
clos->result = TRUE;
1669
clutter_animator_parse_custom_node (ClutterScriptable *scriptable,
1670
ClutterScript *script,
1675
ParseClosure parse_closure;
1677
if (strcmp (name, "properties") != 0)
1680
if (JSON_NODE_TYPE (node) != JSON_NODE_ARRAY)
1683
parse_closure.animator = CLUTTER_ANIMATOR (scriptable);
1684
parse_closure.script = script;
1685
parse_closure.value = value;
1686
parse_closure.result = FALSE;
1688
json_array_foreach_element (json_node_get_array (node),
1689
parse_animator_property,
1692
/* we return TRUE if we had at least one key parsed */
1694
return parse_closure.result;
1698
clutter_animator_set_custom_property (ClutterScriptable *scriptable,
1699
ClutterScript *script,
1701
const GValue *value)
1703
if (strcmp (name, "properties") == 0)
1705
ClutterAnimator *animator = CLUTTER_ANIMATOR (scriptable);
1706
GSList *keys = g_value_get_pointer (value);
1709
for (k = keys; k != NULL; k = k->next)
1710
clutter_animator_set_key_internal (animator, k->data);
1712
g_slist_free (keys);
1715
g_object_set_property (G_OBJECT (scriptable), name, value);
1719
clutter_scriptable_init (ClutterScriptableIface *iface)
1721
iface->parse_custom_node = clutter_animator_parse_custom_node;
1722
iface->set_custom_property = clutter_animator_set_custom_property;
1726
clutter_animator_set_property (GObject *gobject,
1728
const GValue *value,
1731
ClutterAnimator *self = CLUTTER_ANIMATOR (gobject);
1736
clutter_animator_set_duration (self, g_value_get_uint (value));
1740
clutter_animator_set_timeline (self, g_value_get_object (value));
1744
G_OBJECT_WARN_INVALID_PROPERTY_ID (gobject, prop_id, pspec);
1750
clutter_animator_get_property (GObject *gobject,
1755
ClutterAnimatorPrivate *priv = CLUTTER_ANIMATOR (gobject)->priv;
1760
g_value_set_uint (value, clutter_timeline_get_duration (priv->timeline));
1764
g_value_set_object (value, priv->timeline);
1768
G_OBJECT_WARN_INVALID_PROPERTY_ID (gobject, prop_id, pspec);
1774
clutter_animator_class_init (ClutterAnimatorClass *klass)
1776
GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
1778
gobject_class->set_property = clutter_animator_set_property;
1779
gobject_class->get_property = clutter_animator_get_property;
1780
gobject_class->dispose = clutter_animator_dispose;
1781
gobject_class->finalize = clutter_animator_finalize;
1784
* ClutterAnimator:duration:
1786
* The duration of the #ClutterTimeline used by the #ClutterAnimator
1787
* to drive the animation
1790
* Deprecated: 1.12: Use #ClutterKeyframeTransition instead
1792
obj_props[PROP_DURATION] =
1793
g_param_spec_uint ("duration",
1795
P_("The duration of the animation"),
1798
CLUTTER_PARAM_READWRITE);
1801
* ClutterAnimator:timeline:
1803
* The #ClutterTimeline used by the #ClutterAnimator to drive the
1807
* Deprecated: 1.12: Use #ClutterKeyframeTransition instead
1809
obj_props[PROP_TIMELINE] =
1810
g_param_spec_object ("timeline",
1812
P_("The timeline of the animation"),
1813
CLUTTER_TYPE_TIMELINE,
1814
CLUTTER_PARAM_READWRITE);
1816
g_object_class_install_properties (gobject_class,
1822
clutter_animator_init (ClutterAnimator *animator)
1824
ClutterAnimatorPrivate *priv;
1825
ClutterTimeline *timeline;
1827
animator->priv = priv = clutter_animator_get_instance_private (animator);
1829
priv->properties = g_hash_table_new_full (prop_actor_hash,
1831
prop_actor_key_free,
1832
property_iter_free);
1834
timeline = clutter_timeline_new (2000);
1835
clutter_animator_set_timeline (animator, timeline);
1836
g_object_unref (timeline);
1838
priv->slave_timeline = clutter_timeline_new (10000);
1843
* clutter_animator_property_get_ease_in:
1844
* @animator: a #ClutterAnimatorKey
1845
* @object: a #GObject
1846
* @property_name: the name of a property on object
1848
* Checks if a property value is to be eased into the animation.
1850
* Return value: %TRUE if the property is eased in
1853
* Deprecated: 1.12: Use #ClutterKeyframeTransition instead
1856
clutter_animator_property_get_ease_in (ClutterAnimator *animator,
1858
const gchar *property_name)
1860
ClutterAnimatorKey key, *initial_key;
1863
g_return_val_if_fail (CLUTTER_IS_ANIMATOR (animator), FALSE);
1864
g_return_val_if_fail (G_IS_OBJECT (object), FALSE);
1865
g_return_val_if_fail (property_name, FALSE);
1867
key.object = object;
1868
key.property_name = g_intern_string (property_name);
1869
initial = g_list_find_custom (animator->priv->score, &key,
1870
sort_actor_prop_func);
1871
if (initial != NULL)
1873
initial_key = initial->data;
1875
return initial_key->ease_in;
1882
* clutter_animator_property_set_ease_in:
1883
* @animator: a #ClutterAnimatorKey
1884
* @object: a #GObject
1885
* @property_name: the name of a property on object
1886
* @ease_in: we are going to be easing in this property
1888
* Sets whether a property value is to be eased into the animation.
1891
* Deprecated: 1.12: Use #ClutterKeyframeTransition instead
1894
clutter_animator_property_set_ease_in (ClutterAnimator *animator,
1896
const gchar *property_name,
1899
ClutterAnimatorKey key, *initial_key;
1902
g_return_if_fail (CLUTTER_IS_ANIMATOR (animator));
1903
g_return_if_fail (G_IS_OBJECT (object));
1904
g_return_if_fail (property_name);
1906
key.object = object;
1907
key.property_name = g_intern_string (property_name);
1908
initial = g_list_find_custom (animator->priv->score, &key,
1909
sort_actor_prop_func);
1912
initial_key = initial->data;
1913
initial_key->ease_in = ease_in;
1916
g_warning ("The animator has no object of type '%s' with a "
1917
"property named '%s'",
1918
G_OBJECT_TYPE_NAME (object),
1924
* clutter_animator_property_get_interpolation:
1925
* @animator: a #ClutterAnimatorKey
1926
* @object: a #GObject
1927
* @property_name: the name of a property on object
1929
* Get the interpolation used by animator for a property on a particular
1932
* Returns: a ClutterInterpolation value.
1934
* Deprecated: 1.12: Use #ClutterKeyframeTransition instead
1936
ClutterInterpolation
1937
clutter_animator_property_get_interpolation (ClutterAnimator *animator,
1939
const gchar *property_name)
1942
ClutterAnimatorKey key, *initial_key;
1944
g_return_val_if_fail (CLUTTER_IS_ANIMATOR (animator),
1945
CLUTTER_INTERPOLATION_LINEAR);
1946
g_return_val_if_fail (G_IS_OBJECT (object),
1947
CLUTTER_INTERPOLATION_LINEAR);
1948
g_return_val_if_fail (property_name,
1949
CLUTTER_INTERPOLATION_LINEAR);
1951
key.object = object;
1952
key.property_name = g_intern_string (property_name);
1953
initial = g_list_find_custom (animator->priv->score, &key,
1954
sort_actor_prop_func);
1957
initial_key = initial->data;
1959
return initial_key->interpolation;
1962
return CLUTTER_INTERPOLATION_LINEAR;
1966
* clutter_animator_property_set_interpolation:
1967
* @animator: a #ClutterAnimatorKey
1968
* @object: a #GObject
1969
* @property_name: the name of a property on object
1970
* @interpolation: the #ClutterInterpolation to use
1972
* Set the interpolation method to use, %CLUTTER_INTERPOLATION_LINEAR causes
1973
* the values to linearly change between the values, and
1974
* %CLUTTER_INTERPOLATION_CUBIC causes the values to smoothly change between
1978
* Deprecated: 1.12: Use #ClutterKeyframeTransition instead
1981
clutter_animator_property_set_interpolation (ClutterAnimator *animator,
1983
const gchar *property_name,
1984
ClutterInterpolation interpolation)
1987
ClutterAnimatorKey key, *initial_key;
1989
g_return_if_fail (CLUTTER_IS_ANIMATOR (animator));
1990
g_return_if_fail (G_IS_OBJECT (object));
1991
g_return_if_fail (property_name);
1993
key.object = object;
1994
key.property_name = g_intern_string (property_name);
1995
initial = g_list_find_custom (animator->priv->score, &key,
1996
sort_actor_prop_func);
1999
initial_key = initial->data;
2000
initial_key->interpolation = interpolation;
2004
G_DEFINE_BOXED_TYPE (ClutterAnimatorKey, clutter_animator_key,
2005
clutter_animator_key_copy,
2006
clutter_animator_key_free);
2009
* clutter_animator_key_get_object:
2010
* @key: a #ClutterAnimatorKey
2012
* Retrieves the object a key applies to.
2014
* Return value: (transfer none): the object an animator_key exist for.
2017
* Deprecated: 1.12: Use #ClutterKeyframeTransition instead
2020
clutter_animator_key_get_object (const ClutterAnimatorKey *key)
2022
g_return_val_if_fail (key != NULL, NULL);
2028
* clutter_animator_key_get_property_name:
2029
* @key: a #ClutterAnimatorKey
2031
* Retrieves the name of the property a key applies to.
2033
* Return value: the name of the property an animator_key exist for.
2036
* Deprecated: 1.12: Use #ClutterKeyframeTransition instead
2039
clutter_animator_key_get_property_name (const ClutterAnimatorKey *key)
2041
g_return_val_if_fail (key != NULL, NULL);
2043
return key->property_name;
2047
* clutter_animator_key_get_property_type:
2048
* @key: a #ClutterAnimatorKey
2050
* Retrieves the #GType of the property a key applies to
2052
* You can use this type to initialize the #GValue to pass to
2053
* clutter_animator_key_get_value()
2055
* Return value: the #GType of the property
2058
* Deprecated: 1.12: Use #ClutterKeyframeTransition instead
2061
clutter_animator_key_get_property_type (const ClutterAnimatorKey *key)
2063
g_return_val_if_fail (key != NULL, G_TYPE_INVALID);
2065
return G_VALUE_TYPE (&key->value);
2069
* clutter_animator_key_get_mode:
2070
* @key: a #ClutterAnimatorKey
2072
* Retrieves the mode of a #ClutterAnimator key, for the first key of a
2073
* property for an object this represents the whether the animation is
2074
* open ended and or curved for the remainding keys for the property it
2075
* represents the easing mode.
2077
* Return value: the mode of a #ClutterAnimatorKey
2080
* Deprecated: 1.12: Use #ClutterKeyframeTransition instead
2083
clutter_animator_key_get_mode (const ClutterAnimatorKey *key)
2085
g_return_val_if_fail (key != NULL, 0);
2091
* clutter_animator_key_get_progress:
2092
* @key: a #ClutterAnimatorKey
2094
* Retrieves the progress of an clutter_animator_key
2096
* Return value: the progress defined for a #ClutterAnimator key.
2099
* Deprecated: 1.12: Use #ClutterKeyframeTransition instead
2102
clutter_animator_key_get_progress (const ClutterAnimatorKey *key)
2104
g_return_val_if_fail (key != NULL, 0.0);
2106
return key->progress;
2110
* clutter_animator_key_get_value:
2111
* @key: a #ClutterAnimatorKey
2112
* @value: a #GValue initialized with the correct type for the animator key
2114
* Retrieves a copy of the value for a #ClutterAnimatorKey.
2116
* The passed in #GValue needs to be already initialized for the value
2117
* type of the key or to a type that allow transformation from the value
2120
* Use g_value_unset() when done.
2122
* Return value: %TRUE if the passed #GValue was successfully set, and
2126
* Deprecated: 1.12: Use #ClutterKeyframeTransition instead
2129
clutter_animator_key_get_value (const ClutterAnimatorKey *key,
2132
g_return_val_if_fail (key != NULL, FALSE);
2133
g_return_val_if_fail (value != NULL, FALSE);
2134
g_return_val_if_fail (G_VALUE_TYPE (value) != G_TYPE_INVALID, FALSE);
2136
if (!g_type_is_a (G_VALUE_TYPE (&key->value), G_VALUE_TYPE (value)))
2138
if (g_value_type_compatible (G_VALUE_TYPE (&key->value),
2139
G_VALUE_TYPE (value)))
2141
g_value_copy (&key->value, value);
2145
if (g_value_type_transformable (G_VALUE_TYPE (&key->value),
2146
G_VALUE_TYPE (value)))
2148
if (g_value_transform (&key->value, value))
2152
g_warning ("%s: Unable to convert from %s to %s for the "
2153
"property '%s' of object %s in the animator key",
2155
g_type_name (G_VALUE_TYPE (&key->value)),
2156
g_type_name (G_VALUE_TYPE (value)),
2158
G_OBJECT_TYPE_NAME (key->object));
2163
g_value_copy (&key->value, value);
added
removed
clutter/clutter/deprecated/clutter-animator.c
