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_x: the fixed position of the actor, set using clutter_actor_set_x()
 151  * @fixed_y: the fixed position of the actor, set using clutter_actor_set_y()
 152  * @margin: the composed margin of the actor
 153  * @x_align: the horizontal alignment, if the actor expands horizontally
 154  * @y_align: the vertical alignment, if the actor expands vertically
 155  * @min_width: the minimum width, set using clutter_actor_set_min_width()
 156  * @min_height: the minimum height, set using clutter_actor_set_min_height()
 157  * @natural_width: the natural width, set using clutter_actor_set_natural_width()
 158  * @natural_height: the natural height, set using clutter_actor_set_natural_height()
 159  *
 160  * Ancillary layout information for an actor.
 161  */
 162 struct _ClutterLayoutInfo
 163 {
 164   /* fixed position coordinates */
 165   float fixed_x;
 166   float fixed_y;
 167
 168   ClutterMargin margin;
 169
 170   guint x_align : 4;
 171   guint y_align : 4;
 172
 173   float min_width;
 174   float min_height;
 175   float natural_width;
 176   float natural_height;
 177 };
 178
 179 const ClutterLayoutInfo *       _clutter_actor_get_layout_info_or_defaults      (ClutterActor *self);
 180 ClutterLayoutInfo *             _clutter_actor_get_layout_info                  (ClutterActor *self);
 181
 182 struct _ClutterTransformInfo
 183 {
 184   /* rotation (angle and center) */
 185   gdouble rx_angle;
 186   AnchorCoord rx_center;
 187
 188   gdouble ry_angle;
 189   AnchorCoord ry_center;
 190
 191   gdouble rz_angle;
 192   AnchorCoord rz_center;
 193
 194   /* scaling */
 195   gdouble scale_x;
 196   gdouble scale_y;
 197   AnchorCoord scale_center;
 198
 199   /* anchor point */
 200   AnchorCoord anchor;
 201
 202   /* depth */
 203   gfloat depth;
 204 };
 205
 206 const ClutterTransformInfo *    _clutter_actor_get_transform_info_or_defaults   (ClutterActor *self);
 207 ClutterTransformInfo *          _clutter_actor_get_transform_info               (ClutterActor *self);
 208
 209 typedef struct _AState {
 210   guint easing_duration;
 211   guint easing_delay;
 212   ClutterAnimationMode easing_mode;
 213 } AState;
 214
 215 struct _ClutterAnimationInfo
 216 {
 217   GArray *states;
 218   AState *cur_state;
 219
 220   GHashTable *transitions;
 221 };
 222
 223 const ClutterAnimationInfo *    _clutter_actor_get_animation_info_or_defaults   (ClutterActor *self);
 224 ClutterAnimationInfo *          _clutter_actor_get_animation_info               (ClutterActor *self);
 225
 226 ClutterTransition *             _clutter_actor_create_transition                (ClutterActor *self,
 227                                                                                  GParamSpec   *pspec,
 228                                                                                  ...);
 229 ClutterTransition *             _clutter_actor_get_transition                   (ClutterActor *self,
 230                                                                                  GParamSpec   *pspec);
 231 void                            _clutter_actor_update_transition                (ClutterActor *self,
 232                                                                                  GParamSpec   *pspec,
 233                                                                                  ...);
 234
 235 gboolean      _clutter_actor_foreach_child              (ClutterActor *self,
 236                                                          ClutterForeachCallback callback,
 237                                                          gpointer user_data);
 238 void          _clutter_actor_traverse                   (ClutterActor *actor,
 239                                                          ClutterActorTraverseFlags flags,
 240                                                          ClutterTraverseCallback before_children_callback,
 241                                                          ClutterTraverseCallback after_children_callback,
 242                                                          gpointer user_data);
 243 ClutterActor *_clutter_actor_get_stage_internal         (ClutterActor *actor);
 244
 245 void _clutter_actor_apply_modelview_transform           (ClutterActor *self,
 246                                                          CoglMatrix *matrix);
 247 void _clutter_actor_apply_relative_transformation_matrix (ClutterActor *self,
 248                                                           ClutterActor *ancestor,
 249                                                           CoglMatrix *matrix);
 250
 251 void _clutter_actor_rerealize (ClutterActor    *self,
 252                                ClutterCallback  callback,
 253                                gpointer         data);
 254
 255 void _clutter_actor_set_opacity_override (ClutterActor *self,
 256                                           gint          opacity);
 257 gint _clutter_actor_get_opacity_override (ClutterActor *self);
 258 void _clutter_actor_set_in_clone_paint (ClutterActor *self,
 259                                         gboolean      is_in_clone_paint);
 260
 261 void _clutter_actor_set_enable_model_view_transform (ClutterActor *self,
 262                                                      gboolean      enable);
 263
 264 void _clutter_actor_set_enable_paint_unmapped (ClutterActor *self,
 265                                                gboolean      enable);
 266
 267 void _clutter_actor_set_has_pointer (ClutterActor *self,
 268                                      gboolean      has_pointer);
 269
 270 void _clutter_actor_queue_redraw_with_clip   (ClutterActor              *self,
 271                                               ClutterRedrawFlags         flags,
 272                                               ClutterPaintVolume        *clip_volume);
 273 void _clutter_actor_queue_redraw_full        (ClutterActor              *self,
 274                                               ClutterRedrawFlags         flags,
 275                                               ClutterPaintVolume        *volume,
 276                                               ClutterEffect             *effect);
 277
 278 ClutterPaintVolume *_clutter_actor_get_queue_redraw_clip (ClutterActor *self);
 279 void _clutter_actor_set_queue_redraw_clip     (ClutterActor             *self,
 280                                                ClutterPaintVolume *clip_volume);
 281 void _clutter_actor_finish_queue_redraw       (ClutterActor             *self,
 282                                                ClutterPaintVolume       *clip);
 283
 284 gboolean        _clutter_actor_set_default_paint_volume (ClutterActor *self,
 285                                                          GType         check_gtype,
 286                                                          ClutterPaintVolume *volume);
 287
 288 const gchar *   _clutter_actor_get_debug_name (ClutterActor *self);
 289
 290 void _clutter_actor_push_clone_paint (void);
 291 void _clutter_actor_pop_clone_paint  (void);
 292
 293 guint32 _clutter_actor_get_pick_id (ClutterActor *self);
 294
 295 void    _clutter_actor_shader_pre_paint         (ClutterActor *actor,
 296                                                  gboolean      repeat);
 297 void    _clutter_actor_shader_post_paint        (ClutterActor *actor);
 298
 299 G_END_DECLS
 300
 301 #endif /* __CLUTTER_ACTOR_PRIVATE_H__ */