Release Clutter 1.11.4 (snapshot)
[profile/ivi/clutter.git] / clutter / clutter-keyframe-transition.h
1 /*
2  * Clutter.
3  *
4  * An OpenGL based 'interactive canvas' library.
5  *
6  * Copyright (C) 2012 Intel Corporation
7  *
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.
12  *
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.
17  *
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/>.
20  *
21  * Author: Emmanuele Bassi <ebassi@linux.intel.com>
22  */
23
24 #if !defined(__CLUTTER_H_INSIDE__) && !defined(CLUTTER_COMPILATION)
25 #error "Only <clutter/clutter.h> can be included directly."
26 #endif
27
28 #ifndef __CLUTTER_KEYFRAME_TRANSITION_H__
29 #define __CLUTTER_KEYFRAME_TRANSITION_H__
30
31 #include <clutter/clutter-types.h>
32 #include <clutter/clutter-property-transition.h>
33
34 G_BEGIN_DECLS
35
36 #define CLUTTER_TYPE_KEYFRAME_TRANSITION                (clutter_keyframe_transition_get_type ())
37 #define CLUTTER_KEYFRAME_TRANSITION(obj)                (G_TYPE_CHECK_INSTANCE_CAST ((obj), CLUTTER_TYPE_KEYFRAME_TRANSITION, ClutterKeyframeTransition))
38 #define CLUTTER_IS_KEYFRAME_TRANSITION(obj)             (G_TYPE_CHECK_INSTANCE_TYPE ((obj), CLUTTER_TYPE_KEYFRAME_TRANSITION))
39 #define CLUTTER_KEYFRAME_TRANSITION_CLASS(klass)        (G_TYPE_CHECK_CLASS_CAST ((klass), CLUTTER_TYPE_KEYFRAME_TRANSITION, ClutterKeyframeTransitionClass))
40 #define CLUTTER_IS_KEYFRAME_TRANSITION_CLASS(klass)     (G_TYPE_CHECK_CLASS_TYPE ((klass), CLUTTER_TYPE_KEYFRAME_TRANSITION))
41 #define CLUTTER_KEYFRAME_TRANSITION_GET_CLASS(obj)      (G_TYPE_INSTANCE_GET_CLASS ((obj), CLUTTER_TYPE_KEYFRAME_TRANSITION, ClutterKeyframeTransitionClass))
42
43 typedef struct _ClutterKeyframeTransitionPrivate        ClutterKeyframeTransitionPrivate;
44 typedef struct _ClutterKeyframeTransitionClass          ClutterKeyframeTransitionClass;
45
46 /**
47  * ClutterKeyframeTransition:
48  *
49  * FIXME
50  *
51  * Since: 1.12
52  */
53 struct _ClutterKeyframeTransition
54 {
55   /*< private >*/
56   ClutterPropertyTransition parent_instance;
57
58   ClutterKeyframeTransitionPrivate *priv;
59 };
60
61 /**
62  * ClutterKeyframeTransitionClass:
63  *
64  * FIXME
65  *
66  * Since: 1.12
67  */
68 struct _ClutterKeyframeTransitionClass
69 {
70   /*< private >*/
71   ClutterPropertyTransitionClass parent_class;
72
73   gpointer _padding[8];
74 };
75
76 CLUTTER_AVAILABLE_IN_1_12
77 GType clutter_keyframe_transition_get_type (void) G_GNUC_CONST;
78
79 CLUTTER_AVAILABLE_IN_1_12
80 ClutterTransition *     clutter_keyframe_transition_new                 (const char *property_name);
81
82 CLUTTER_AVAILABLE_IN_1_12
83 void                    clutter_keyframe_transition_set_key_frames      (ClutterKeyframeTransition  *transition,
84                                                                          guint                       n_key_frames,
85                                                                          const double               *key_frames);
86 CLUTTER_AVAILABLE_IN_1_12
87 void                    clutter_keyframe_transition_set_values          (ClutterKeyframeTransition  *transition,
88                                                                          guint                       n_values,
89                                                                          const GValue               *values);
90 CLUTTER_AVAILABLE_IN_1_12
91 void                    clutter_keyframe_transition_set_modes           (ClutterKeyframeTransition  *transition,
92                                                                          guint                       n_modes,
93                                                                          const ClutterAnimationMode *modes);
94 CLUTTER_AVAILABLE_IN_1_12
95 void                    clutter_keyframe_transition_set                 (ClutterKeyframeTransition  *transition,
96                                                                          GType                       gtype,
97                                                                          guint                       n_key_frames,
98                                                                          ...);
99
100 CLUTTER_AVAILABLE_IN_1_12
101 void                    clutter_keyframe_transition_set_key_frame       (ClutterKeyframeTransition  *transition,
102                                                                          guint                       index_,
103                                                                          double                      key,
104                                                                          ClutterAnimationMode        mode,
105                                                                          const GValue               *value);
106 CLUTTER_AVAILABLE_IN_1_12
107 void                    clutter_keyframe_transition_get_key_frame       (ClutterKeyframeTransition  *transition,
108                                                                          guint                       index_,
109                                                                          double                     *key,
110                                                                          ClutterAnimationMode       *mode,
111                                                                          GValue                     *value);
112 CLUTTER_AVAILABLE_IN_1_12
113 guint                   clutter_keyframe_transition_get_n_key_frames    (ClutterKeyframeTransition  *transition);
114
115 CLUTTER_AVAILABLE_IN_1_12
116 void                    clutter_keyframe_transition_clear               (ClutterKeyframeTransition  *transition);
117
118 G_END_DECLS
119
120 #endif /* __CLUTTER_KEYFRAME_TRANSITION_H__ */