Release Clutter 1.11.4 (snapshot)
[profile/ivi/clutter.git] / clutter / clutter-path-constraint.h
1 /*
2  * Clutter.
3  *
4  * An OpenGL based 'interactive canvas' library.
5  *
6  * Copyright (C) 2010  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:
22  *   Emmanuele Bassi <ebassi@linux.intel.com>
23  */
24
25 #if !defined(__CLUTTER_H_INSIDE__) && !defined(CLUTTER_COMPILATION)
26 #error "Only <clutter/clutter.h> can be included directly."
27 #endif
28
29 #ifndef __CLUTTER_PATH_CONSTRAINT_H__
30 #define __CLUTTER_PATH_CONSTRAINT_H__
31
32 #include <clutter/clutter-constraint.h>
33 #include <clutter/clutter-path.h>
34
35 G_BEGIN_DECLS
36
37 #define CLUTTER_TYPE_PATH_CONSTRAINT    (clutter_path_constraint_get_type ())
38 #define CLUTTER_PATH_CONSTRAINT(obj)    (G_TYPE_CHECK_INSTANCE_CAST ((obj), CLUTTER_TYPE_PATH_CONSTRAINT, ClutterPathConstraint))
39 #define CLUTTER_IS_PATH_CONSTRAINT(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), CLUTTER_TYPE_PATH_CONSTRAINT))
40
41 /**
42  * ClutterPathConstraint:
43  *
44  * <structname>ClutterPathConstraint</structname> is an opaque structure
45  * whose members cannot be directly accessed
46  *
47  * Since: 1.6
48  */
49 typedef struct _ClutterPathConstraint           ClutterPathConstraint;
50 typedef struct _ClutterPathConstraintClass      ClutterPathConstraintClass;
51
52 GType clutter_path_constraint_get_type (void) G_GNUC_CONST;
53
54 ClutterConstraint *clutter_path_constraint_new        (ClutterPath           *path,
55                                                        gfloat                 offset);
56
57 void               clutter_path_constraint_set_path   (ClutterPathConstraint *constraint,
58                                                        ClutterPath           *path);
59 ClutterPath *      clutter_path_constraint_get_path   (ClutterPathConstraint *constraint);
60 void               clutter_path_constraint_set_offset (ClutterPathConstraint *constraint,
61                                                        gfloat                 offset);
62 gfloat             clutter_path_constraint_get_offset (ClutterPathConstraint *constraint);
63
64 G_END_DECLS
65
66 #endif /* __CLUTTER_PATH_CONSTRAINT_H__ */