clutter/clutter-actor-private.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
  22 #ifndef __CLUTTER_ACTOR_PRIVATE_H__
  23 #define __CLUTTER_ACTOR_PRIVATE_H__
  24
  25 #include <clutter/clutter-actor.h>
  26
  27 G_BEGIN_DECLS
  28
  29 /*< private >
  30  * ClutterRedrawFlags:
  31  * @CLUTTER_REDRAW_CLIPPED_TO_ALLOCATION: Tells clutter the maximum
  32  *   extents of what needs to be redrawn lies within the actors
  33  *   current allocation. (Only use this for 2D actors though because
  34  *   any actor with depth may be projected outside of its allocation)
  35  *
  36  * Flags passed to the clutter_actor_queue_redraw_with_clip ()
  37  * function
  38  *
  39  * Since: 1.6
  40  */
  41 typedef enum
  42 {
  43   CLUTTER_REDRAW_CLIPPED_TO_ALLOCATION  = 1 << 0
  44 } ClutterRedrawFlags;
  45
  46 /*< private >
  47  * ClutterActorTraverseFlags:
  48  * CLUTTER_ACTOR_TRAVERSE_DEPTH_FIRST: Traverse the graph in
  49  *   a depth first order.
  50  * CLUTTER_ACTOR_TRAVERSE_BREADTH_FIRST: Traverse the graph in a
  51  *   breadth first order.
  52  *
  53  * Controls some options for how clutter_actor_traverse() iterates
  54  * through the graph.
  55  */
  56 typedef enum {
  57   CLUTTER_ACTOR_TRAVERSE_DEPTH_FIRST   = 1L<<0,
  58   CLUTTER_ACTOR_TRAVERSE_BREADTH_FIRST = 1L<<1
  59 } ClutterActorTraverseFlags;
  60
  61 /*< private >
  62  * ClutterActorTraverseVisitFlags:
  63  * CLUTTER_ACTOR_TRAVERSE_VISIT_CONTINUE: Continue traversing as
  64  *   normal
  65  * CLUTTER_ACTOR_TRAVERSE_VISIT_SKIP_CHILDREN: Don't traverse the
  66  *   children of the last visited actor. (Not applicable when using
  67  *   %CLUTTER_ACTOR_TRAVERSE_DEPTH_FIRST_POST_ORDER since the children
  68  *   are visited before having an opportunity to bail out)
  69  * CLUTTER_ACTOR_TRAVERSE_VISIT_BREAK: Immediately bail out without
  70  *   visiting any more actors.
  71  *
  72  * Each time an actor is visited during a scenegraph traversal the
  73  * ClutterTraverseCallback can return a set of flags that may affect
  74  * the continuing traversal. It may stop traversal completely, just
  75  * skip over children for the current actor or continue as normal.
  76  */
  77 typedef enum {
  78   CLUTTER_ACTOR_TRAVERSE_VISIT_CONTINUE       = 1L<<0,
  79   CLUTTER_ACTOR_TRAVERSE_VISIT_SKIP_CHILDREN  = 1L<<1,
  80   CLUTTER_ACTOR_TRAVERSE_VISIT_BREAK          = 1L<<2
  81 } ClutterActorTraverseVisitFlags;
  82
  83 /*< private >
  84  * ClutterTraverseCallback:
  85  *
  86  * The callback prototype used with clutter_actor_traverse. The
  87  * returned flags can be used to affect the continuing traversal
  88  * either by continuing as normal, skipping over children of an
  89  * actor or bailing out completely.
  90  */
  91 typedef ClutterActorTraverseVisitFlags (*ClutterTraverseCallback) (ClutterActor *actor,
  92                                                                    gint          depth,
  93                                                                    gpointer      user_data);
  94
  95 /*< private >
  96  * ClutterForeachCallback:
  97  * @actor: The actor being iterated
  98  * @user_data: The private data specified when starting the iteration
  99  *
 100  * A generic callback for iterating over actor, such as with
 101  * _clutter_actor_foreach_child. The difference when compared to
 102  * #ClutterCallback is that it returns a boolean so it is possible to break
 103  * out of an iteration early.
 104  *
 105  * Return value: %TRUE to continue iterating or %FALSE to break iteration
 106  * early.
 107  */
 108 typedef gboolean (*ClutterForeachCallback) (ClutterActor *actor,
 109                                             gpointer      user_data);
 110
 111 typedef struct _AnchorCoord             AnchorCoord;
 112 typedef struct _SizeRequest             SizeRequest;
 113
 114 typedef struct _ClutterLayoutInfo       ClutterLayoutInfo;
 115 typedef struct _ClutterTransformInfo    ClutterTransformInfo;
 116 typedef struct _ClutterAnimationInfo    ClutterAnimationInfo;
 117
 118 /* Internal helper struct to represent a point that can be stored in
 119    either direct pixel coordinates or as a fraction of the actor's
 120    size. It is used for the anchor point, scale center and rotation
 121    centers. */
 122 struct _AnchorCoord
 123 {
 124   gboolean is_fractional;
 125
 126   union
 127   {
 128     /* Used when is_fractional == TRUE */
 129     struct
 130     {
 131       gdouble x;
 132       gdouble y;
 133     } fraction;
 134
 135     /* Use when is_fractional == FALSE */
 136     ClutterVertex units;
 137   } v;
 138 };
 139
 140 struct _SizeRequest
 141 {
 142   guint  age;
 143   gfloat for_size;
 144   gfloat min_size;
 145   gfloat natural_size;
 146 };
 147
 148 /*< private >
 149  * ClutterLayoutInfo:
 150  * @fixed_pos: the fixed position of the actor
 151  * @margin: the composed margin of the actor
 152  * @x_align: the horizontal alignment, if the actor expands horizontally
 153  * @y_align: the vertical alignment, if the actor expands vertically
 154  * @x_expand: whether the actor should expand horizontally
 155  * @y_expand: whether the actor should expand vertically
 156  * @minimum: the fixed minimum size
 157  * @natural: the fixed natural size
 158  *
 159  * Ancillary layout information for an actor.
 160  */
 161 struct _ClutterLayoutInfo
 162 {
 163   /* fixed position coordinates */
 164   ClutterPoint fixed_pos;
 165
 166   ClutterMargin margin;
 167
 168   guint x_align : 4;
 169   guint y_align : 4;
 170
 171   guint x_expand : 1;
 172   guint y_expand : 1;
 173
 174   ClutterSize minimum;
 175   ClutterSize natural;
 176 };
 177
 178 const ClutterLayoutInfo *       _clutter_actor_get_layout_info_or_defaults      (ClutterActor *self);
 179 ClutterLayoutInfo *             _clutter_actor_get_layout_info                  (ClutterActor *self);
 180
 181 struct _ClutterTransformInfo
 182 {
 183   /* rotation (angle and center) */
 184   gdouble rx_angle;
 185   AnchorCoord rx_center;
 186
 187   gdouble ry_angle;
 188   AnchorCoord ry_center;
 189
 190   gdouble rz_angle;
 191   AnchorCoord rz_center;
 192
 193   /* scaling */
 194   gdouble scale_x;
 195   gdouble scale_y;
 196   AnchorCoord scale_center;
 197
 198   /* anchor point */
 199   AnchorCoord anchor;
 200
 201   /* depth */
 202   gfloat depth;
 203 };
 204
 205 const ClutterTransformInfo *    _clutter_actor_get_transform_info_or_defaults   (ClutterActor *self);
 206 ClutterTransformInfo *          _clutter_actor_get_transform_info               (ClutterActor *self);
 207
 208 typedef struct _AState {
 209   guint easing_duration;
 210   guint easing_delay;
 211   ClutterAnimationMode easing_mode;
 212 } AState;
 213
 214 struct _ClutterAnimationInfo
 215 {
 216   GArray *states;
 217   AState *cur_state;
 218
 219   GHashTable *transitions;
 220 };
 221
 222 const ClutterAnimationInfo *    _clutter_actor_get_animation_info_or_defaults   (ClutterActor *self);
 223 ClutterAnimationInfo *          _clutter_actor_get_animation_info               (ClutterActor *self);
 224
 225 ClutterTransition *             _clutter_actor_create_transition                (ClutterActor *self,
 226                                                                                  GParamSpec   *pspec,
 227                                                                                  ...);
 228 ClutterTransition *             _clutter_actor_get_transition                   (ClutterActor *self,
 229                                                                                  GParamSpec   *pspec);
 230 void                            _clutter_actor_update_transition                (ClutterActor *self,
 231                                                                                  GParamSpec   *pspec,
 232                                                                                  ...);
 233
 234 gboolean      _clutter_actor_foreach_child              (ClutterActor *self,
 235                                                          ClutterForeachCallback callback,
 236                                                          gpointer user_data);
 237 void          _clutter_actor_traverse                   (ClutterActor *actor,
 238                                                          ClutterActorTraverseFlags flags,
 239                                                          ClutterTraverseCallback before_children_callback,
 240                                                          ClutterTraverseCallback after_children_callback,
 241                                                          gpointer user_data);
 242 ClutterActor *_clutter_actor_get_stage_internal         (ClutterActor *actor);
 243
 244 void _clutter_actor_apply_modelview_transform           (ClutterActor *self,
 245                                                          CoglMatrix *matrix);
 246 void _clutter_actor_apply_relative_transformation_matrix (ClutterActor *self,
 247                                                           ClutterActor *ancestor,
 248                                                           CoglMatrix *matrix);
 249
 250 void _clutter_actor_rerealize (ClutterActor    *self,
 251                                ClutterCallback  callback,
 252                                gpointer         data);
 253
 254 void _clutter_actor_set_opacity_override (ClutterActor *self,
 255                                           gint          opacity);
 256 gint _clutter_actor_get_opacity_override (ClutterActor *self);
 257 void _clutter_actor_set_in_clone_paint (ClutterActor *self,
 258                                         gboolean      is_in_clone_paint);
 259
 260 void _clutter_actor_set_enable_model_view_transform (ClutterActor *self,
 261                                                      gboolean      enable);
 262
 263 void _clutter_actor_set_enable_paint_unmapped (ClutterActor *self,
 264                                                gboolean      enable);
 265
 266 void _clutter_actor_set_has_pointer (ClutterActor *self,
 267                                      gboolean      has_pointer);
 268
 269 void _clutter_actor_queue_redraw_with_clip   (ClutterActor              *self,
 270                                               ClutterRedrawFlags         flags,
 271                                               ClutterPaintVolume        *clip_volume);
 272 void _clutter_actor_queue_redraw_full        (ClutterActor              *self,
 273                                               ClutterRedrawFlags         flags,
 274                                               ClutterPaintVolume        *volume,
 275                                               ClutterEffect             *effect);
 276
 277 ClutterPaintVolume *_clutter_actor_get_queue_redraw_clip (ClutterActor *self);
 278 void _clutter_actor_set_queue_redraw_clip     (ClutterActor             *self,
 279                                                ClutterPaintVolume *clip_volume);
 280 void _clutter_actor_finish_queue_redraw       (ClutterActor             *self,
 281                                                ClutterPaintVolume       *clip);
 282
 283 gboolean        _clutter_actor_set_default_paint_volume (ClutterActor *self,
 284                                                          GType         check_gtype,
 285                                                          ClutterPaintVolume *volume);
 286
 287 const gchar *   _clutter_actor_get_debug_name (ClutterActor *self);
 288
 289 void _clutter_actor_push_clone_paint (void);
 290 void _clutter_actor_pop_clone_paint  (void);
 291
 292 guint32 _clutter_actor_get_pick_id (ClutterActor *self);
 293
 294 void    _clutter_actor_shader_pre_paint         (ClutterActor *actor,
 295                                                  gboolean      repeat);
 296 void    _clutter_actor_shader_post_paint        (ClutterActor *actor);
 297
 298 ClutterActorAlign       _clutter_actor_get_effective_x_align    (ClutterActor *self);
 299
 300 G_END_DECLS
 301
 302 #endif /* __CLUTTER_ACTOR_PRIVATE_H__ */