clutter/clutter-snap-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_SNAP_CONSTRAINT_H__
  30 #define __CLUTTER_SNAP_CONSTRAINT_H__
  31
  32 #include <clutter/clutter-constraint.h>
  33
  34 G_BEGIN_DECLS
  35
  36 #define CLUTTER_TYPE_SNAP_CONSTRAINT    (clutter_snap_constraint_get_type ())
  37 #define CLUTTER_SNAP_CONSTRAINT(obj)    (G_TYPE_CHECK_INSTANCE_CAST ((obj), CLUTTER_TYPE_SNAP_CONSTRAINT, ClutterSnapConstraint))
  38 #define CLUTTER_IS_SNAP_CONSTRAINT(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), CLUTTER_TYPE_SNAP_CONSTRAINT))
  39
  40 /**
  41  * ClutterSnapConstraint:
  42  *
  43  * <structname>ClutterSnapConstraint</structname> is an opaque structure
  44  * whose members cannot be directly accesses
  45  *
  46  * Since: 1.6
  47  */
  48 typedef struct _ClutterSnapConstraint           ClutterSnapConstraint;
  49 typedef struct _ClutterSnapConstraintClass      ClutterSnapConstraintClass;
  50
  51 GType clutter_snap_constraint_get_type (void) G_GNUC_CONST;
  52
  53 ClutterConstraint *     clutter_snap_constraint_new             (ClutterActor          *source,
  54                                                                  ClutterSnapEdge        from_edge,
  55                                                                  ClutterSnapEdge        to_edge,
  56                                                                  gfloat                 offset);
  57
  58 void                    clutter_snap_constraint_set_source      (ClutterSnapConstraint *constraint,
  59                                                                  ClutterActor          *source);
  60 ClutterActor *          clutter_snap_constraint_get_source      (ClutterSnapConstraint *constraint);
  61 void                    clutter_snap_constraint_set_edges       (ClutterSnapConstraint *constraint,
  62                                                                  ClutterSnapEdge        from_edge,
  63                                                                  ClutterSnapEdge        to_edge);
  64 void                    clutter_snap_constraint_get_edges       (ClutterSnapConstraint *constraint,
  65                                                                  ClutterSnapEdge       *from_edge,
  66                                                                  ClutterSnapEdge       *to_edge);
  67 void                    clutter_snap_constraint_set_offset      (ClutterSnapConstraint *constraint,
  68                                                                  gfloat                 offset);
  69 gfloat                  clutter_snap_constraint_get_offset      (ClutterSnapConstraint *constraint);
  70
  71 G_END_DECLS
  72
  73 #endif /* __CLUTTER_SNAP_CONSTRAINT_H__ */