clutter-transition.h 5.49 KB
Newer Older
Emmanuele Bassi's avatar
Emmanuele Bassi committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
/*
 * 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 <http://www.gnu.org/licenses/>.
 *
 * Author: Emmanuele Bassi <ebassi@linux.intel.com>
 */

24 25 26
#ifndef __CLUTTER_TRANSITION_H__
#define __CLUTTER_TRANSITION_H__

Emmanuele Bassi's avatar
Emmanuele Bassi committed
27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48
#if !defined(__CLUTTER_H_INSIDE__) && !defined(CLUTTER_COMPILATION)
#error "Only <clutter/clutter.h> can be included directly."
#endif

#include <clutter/clutter-types.h>
#include <clutter/clutter-timeline.h>

G_BEGIN_DECLS

#define CLUTTER_TYPE_TRANSITION                 (clutter_transition_get_type ())
#define CLUTTER_TRANSITION(obj)                 (G_TYPE_CHECK_INSTANCE_CAST ((obj), CLUTTER_TYPE_TRANSITION, ClutterTransition))
#define CLUTTER_IS_TRANSITION(obj)              (G_TYPE_CHECK_INSTANCE_TYPE ((obj), CLUTTER_TYPE_TRANSITION))
#define CLUTTER_TRANSITION_CLASS(klass)         (G_TYPE_CHECK_CLASS_CAST ((klass), CLUTTER_TYPE_TRANSITION, ClutterTransitionClass))
#define CLUTTER_IS_TRANSITION_CLASS(klass)      (G_TYPE_CHECK_CLASS_TYPE ((klass), CLUTTER_TYPE_TRANSITION))
#define CLUTTER_TRANSITION_GET_CLASS(obj)       (G_TYPE_INSTANCE_GET_CLASS ((obj), CLUTTER_TYPE_TRANSITION, ClutterTransitionClass))

typedef struct _ClutterTransitionPrivate        ClutterTransitionPrivate;
typedef struct _ClutterTransitionClass          ClutterTransitionClass;

/**
 * ClutterTransition:
 *
49
 * The #ClutterTransition structure contains private
Emmanuele Bassi's avatar
Emmanuele Bassi committed
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70
 * data and should only be accessed using the provided API.
 *
 * Since: 1.10
 */
struct _ClutterTransition
{
  /*< private >*/
  ClutterTimeline parent_instance;

  ClutterTransitionPrivate *priv;
};

/**
 * ClutterTransitionClass:
 * @attached: virtual function; called when a transition is attached to
 *   a #ClutterAnimatable instance
 * @detached: virtual function; called when a transition is detached from
 *   a #ClutterAnimatable instance
 * @compute_value: virtual function; called each frame to compute and apply
 *   the interpolation of the interval
 *
71
 * The #ClutterTransitionClass structure contains
Emmanuele Bassi's avatar
Emmanuele Bassi committed
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95
 * private data.
 *
 * Since: 1.10
 */
struct _ClutterTransitionClass
{
  /*< private >*/
  ClutterTimelineClass parent_class;

  /*< public >*/
  void (* attached) (ClutterTransition *transition,
                     ClutterAnimatable *animatable);
  void (* detached) (ClutterTransition *transition,
                     ClutterAnimatable *animatable);

  void (* compute_value) (ClutterTransition *transition,
                          ClutterAnimatable *animatable,
                          ClutterInterval   *interval,
                          gdouble            progress);

  /*< private >*/
  gpointer _padding[8];
};

96
CLUTTER_AVAILABLE_IN_1_10
Emmanuele Bassi's avatar
Emmanuele Bassi committed
97 98
GType clutter_transition_get_type (void) G_GNUC_CONST;

99
CLUTTER_AVAILABLE_IN_1_10
Emmanuele Bassi's avatar
Emmanuele Bassi committed
100 101
void                    clutter_transition_set_interval                 (ClutterTransition *transition,
                                                                         ClutterInterval   *interval);
102
CLUTTER_AVAILABLE_IN_1_10
Emmanuele Bassi's avatar
Emmanuele Bassi committed
103
ClutterInterval *       clutter_transition_get_interval                 (ClutterTransition *transition);
104 105 106 107 108 109 110 111 112 113 114 115 116 117 118
CLUTTER_AVAILABLE_IN_1_12
void                    clutter_transition_set_from_value               (ClutterTransition *transition,
                                                                         const GValue      *value);
CLUTTER_AVAILABLE_IN_1_12
void                    clutter_transition_set_to_value                 (ClutterTransition *transition,
                                                                         const GValue      *value);
CLUTTER_AVAILABLE_IN_1_12
void                    clutter_transition_set_from                     (ClutterTransition *transition,
                                                                         GType              value_type,
                                                                         ...);
CLUTTER_AVAILABLE_IN_1_12
void                    clutter_transition_set_to                       (ClutterTransition *transition,
                                                                         GType              value_type,
                                                                         ...);

119
CLUTTER_AVAILABLE_IN_1_10
Emmanuele Bassi's avatar
Emmanuele Bassi committed
120 121
void                    clutter_transition_set_animatable               (ClutterTransition *transition,
                                                                         ClutterAnimatable *animatable);
122
CLUTTER_AVAILABLE_IN_1_10
Emmanuele Bassi's avatar
Emmanuele Bassi committed
123
ClutterAnimatable *     clutter_transition_get_animatable               (ClutterTransition *transition);
124
CLUTTER_AVAILABLE_IN_1_10
Emmanuele Bassi's avatar
Emmanuele Bassi committed
125 126
void                    clutter_transition_set_remove_on_complete       (ClutterTransition *transition,
                                                                         gboolean           remove_complete);
127
CLUTTER_AVAILABLE_IN_1_10
Emmanuele Bassi's avatar
Emmanuele Bassi committed
128 129 130 131 132
gboolean                clutter_transition_get_remove_on_complete       (ClutterTransition *transition);

G_END_DECLS

#endif /* __CLUTTER_TRANSITION_H__ */