git.maemo.org Git - clutter-gtk/blob - clutter-gtk/gtk-clutter-embed.c

   1 /* gtk-clutter-embed.c: Embeddable ClutterStage
   2  *
   3  * Copyright (C) 2007 OpenedHand
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General Public
  16  * License along with this library. If not see <http://www.fsf.org/licensing>.
  17  *
  18  * Authors:
  19  *   Iain Holmes  <iain@openedhand.com>
  20  *   Emmanuele Bassi  <ebassi@openedhand.com>
  21  */
  22
  23 /**
  24  * SECTION:gtk-clutter-embed
  25  * @short_description: Widget for embedding a Clutter scene
  26  *
  27  * #GtkClutterEmbed is a GTK+ widget embedding a #ClutterStage. Using
  28  * a #GtkClutterEmbed widget is possible to build, show and interact with
  29  * a scene built using Clutter inside a GTK+ application.
  30  *
  31  * <note>To avoid flickering on show, you should call gtk_widget_show()
  32  * or gtk_widget_realize() before calling clutter_actor_show() on the
  33  * embedded #ClutterStage actor. This is needed for Clutter to be able
  34  * to paint on the #GtkClutterEmbed widget.</note>
  35  *
  36  * Since: 0.6
  37  */
  38
  39 #ifdef HAVE_CONFIG_H
  40 #include "config.h"
  41 #endif
  42
  43 #include "gtk-clutter-embed.h"
  44
  45 #include <glib-object.h>
  46
  47 #include <gdk/gdk.h>
  48
  49 #if defined(HAVE_CLUTTER_GTK_X11)
  50
  51 #include <clutter/x11/clutter-x11.h>
  52 #include <gdk/gdkx.h>
  53
  54 #elif defined(HAVE_CLUTTER_GTK_WIN32)
  55
  56 #include <clutter/clutter-win32.h>
  57 #include <gdk/gdkwin32.h>
  58
  59 #endif /* HAVE_CLUTTER_GTK_{X11,WIN32} */
  60
  61 G_DEFINE_TYPE (GtkClutterEmbed, gtk_clutter_embed, GTK_TYPE_WIDGET);
  62
  63 #define GTK_CLUTTER_EMBED_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), GTK_CLUTTER_TYPE_EMBED, GtkClutterEmbedPrivate))
  64
  65 struct _GtkClutterEmbedPrivate
  66 {
  67   ClutterActor *stage;
  68
  69   guint queue_redraw_id;
  70 };
  71
  72 static void
  73 gtk_clutter_embed_send_configure (GtkClutterEmbed *embed)
  74 {
  75   GtkWidget *widget;
  76   GdkEvent *event = gdk_event_new (GDK_CONFIGURE);
  77
  78   widget = GTK_WIDGET (embed);
  79
  80   event->configure.window = g_object_ref (widget->window);
  81   event->configure.send_event = TRUE;
  82   event->configure.x = widget->allocation.x;
  83   event->configure.y = widget->allocation.y;
  84   event->configure.width = widget->allocation.width;
  85   event->configure.height = widget->allocation.height;
  86
  87   gtk_widget_event (widget, event);
  88   gdk_event_free (event);
  89 }
  90
  91 static void
  92 on_stage_queue_redraw (ClutterStage *stage,
  93                        gboolean      queue_origin,
  94                        gpointer      user_data)
  95 {
  96   GtkWidget *embed = user_data;
  97
  98   /* we stop the emission of the Stage::queue-redraw signal to prevent
  99    * the default handler from running; then we queue a redraw on the
 100    * GtkClutterEmbed widget which will cause an expose event to be
 101    * emitted. the Stage is redrawn in the expose event handler, thus
 102    * "slaving" the Clutter redraw cycle to GTK+'s own
 103    */
 104   g_signal_stop_emission_by_name (stage, "queue-redraw");
 105
 106   gtk_widget_queue_draw (embed);
 107 }
 108
 109 static void
 110 gtk_clutter_embed_dispose (GObject *gobject)
 111 {
 112   GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (gobject)->priv;
 113
 114   if (priv->queue_redraw_id)
 115     {
 116       g_signal_handler_disconnect (priv->stage, priv->queue_redraw_id);
 117       priv->queue_redraw_id = 0;
 118     }
 119
 120   if (priv->stage)
 121     {
 122       clutter_actor_destroy (priv->stage);
 123       priv->stage = NULL;
 124     }
 125
 126   G_OBJECT_CLASS (gtk_clutter_embed_parent_class)->dispose (gobject);
 127 }
 128
 129 static void
 130 gtk_clutter_embed_show (GtkWidget *widget)
 131 {
 132   GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (widget)->priv;
 133
 134   if (GTK_WIDGET_REALIZED (widget))
 135     clutter_actor_show (priv->stage);
 136
 137   GTK_WIDGET_CLASS (gtk_clutter_embed_parent_class)->show (widget);
 138 }
 139
 140 static void
 141 gtk_clutter_embed_hide (GtkWidget *widget)
 142 {
 143   GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (widget)->priv;
 144
 145   clutter_actor_hide (priv->stage);
 146
 147   GTK_WIDGET_CLASS (gtk_clutter_embed_parent_class)->hide (widget);
 148 }
 149
 150 static void
 151 gtk_clutter_embed_realize (GtkWidget *widget)
 152 {
 153   GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (widget)->priv;
 154   GdkWindowAttr attributes;
 155   int attributes_mask;
 156
 157   /* we must realize the stage to get it ready for embedding */
 158   clutter_actor_realize (priv->stage);
 159
 160 #ifdef HAVE_CLUTTER_GTK_X11
 161   {
 162     const XVisualInfo *xvinfo;
 163     GdkVisual *visual;
 164     GdkColormap *colormap;
 165
 166     /* We need to use the colormap from the Clutter visual */
 167     xvinfo = clutter_x11_get_stage_visual (CLUTTER_STAGE (priv->stage));
 168     visual = gdk_x11_screen_lookup_visual (gtk_widget_get_screen (widget),
 169                                            xvinfo->visualid);
 170     colormap = gdk_colormap_new (visual, FALSE);
 171     gtk_widget_set_colormap (widget, colormap);
 172   }
 173 #endif
 174
 175   GTK_WIDGET_SET_FLAGS (widget, GTK_REALIZED);
 176
 177   attributes.window_type = GDK_WINDOW_CHILD;
 178   attributes.x = widget->allocation.x;
 179   attributes.y = widget->allocation.y;
 180   attributes.width = widget->allocation.width;
 181   attributes.height = widget->allocation.height;
 182   attributes.wclass = GDK_INPUT_OUTPUT;
 183   attributes.visual = gtk_widget_get_visual (widget);
 184   attributes.colormap = gtk_widget_get_colormap (widget);
 185
 186   /* NOTE: GDK_MOTION_NOTIFY above should be safe as Clutter does its own
 187    *       throtling.
 188   */
 189   attributes.event_mask = gtk_widget_get_events (widget)
 190                         | GDK_EXPOSURE_MASK
 191                         | GDK_BUTTON_PRESS_MASK
 192                         | GDK_BUTTON_RELEASE_MASK
 193                         | GDK_KEY_PRESS_MASK
 194                         | GDK_KEY_RELEASE_MASK
 195                         | GDK_POINTER_MOTION_MASK;
 196
 197   attributes_mask = GDK_WA_X | GDK_WA_Y | GDK_WA_VISUAL | GDK_WA_COLORMAP;
 198
 199   widget->window = gdk_window_new (gtk_widget_get_parent_window (widget),
 200                                    &attributes,
 201                                    attributes_mask);
 202   gdk_window_set_user_data (widget->window, widget);
 203
 204   widget->style = gtk_style_attach (widget->style, widget->window);
 205   gtk_style_set_background (widget->style, widget->window, GTK_STATE_NORMAL);
 206
 207   gdk_window_set_back_pixmap (widget->window, NULL, FALSE);
 208
 209 #if defined(HAVE_CLUTTER_GTK_X11)
 210   clutter_x11_set_stage_foreign (CLUTTER_STAGE (priv->stage),
 211                                  GDK_WINDOW_XID (widget->window));
 212 #elif defined(HAVE_CLUTTER_GTK_WIN32)
 213   clutter_win32_set_stage_foreign (CLUTTER_STAGE (priv->stage),
 214                                    GDK_WINDOW_HWND (widget->window));
 215 #endif /* HAVE_CLUTTER_GTK_{X11,WIN32} */
 216
 217   if (GTK_WIDGET_VISIBLE (widget))
 218     clutter_actor_show (priv->stage);
 219
 220   clutter_actor_queue_redraw (CLUTTER_ACTOR (priv->stage));
 221
 222   gtk_clutter_embed_send_configure (GTK_CLUTTER_EMBED (widget));
 223 }
 224
 225 static void
 226 gtk_clutter_embed_size_allocate (GtkWidget     *widget,
 227                                  GtkAllocation *allocation)
 228 {
 229   GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (widget)->priv;
 230
 231   widget->allocation = *allocation;
 232
 233   if (GTK_WIDGET_REALIZED (widget))
 234     {
 235       gdk_window_move_resize (widget->window,
 236                               allocation->x, allocation->y,
 237                               allocation->width, allocation->height);
 238
 239       gtk_clutter_embed_send_configure (GTK_CLUTTER_EMBED (widget));
 240     }
 241
 242   /* change the size of the stage and ensure that the viewport
 243    * has been updated as well
 244    */
 245   clutter_actor_set_size (priv->stage,
 246                           allocation->width,
 247                           allocation->height);
 248
 249   clutter_stage_ensure_viewport (CLUTTER_STAGE (priv->stage));
 250 }
 251
 252 static gboolean
 253 gtk_clutter_embed_expose_event (GtkWidget *widget,
 254                                 GdkEventExpose *event)
 255 {
 256   GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (widget)->priv;
 257
 258   /* force a redraw on expose */
 259   clutter_redraw (CLUTTER_STAGE (priv->stage));
 260
 261   return FALSE;
 262 }
 263
 264 static gboolean
 265 gtk_clutter_embed_motion_notify_event (GtkWidget      *widget,
 266                                        GdkEventMotion *event)
 267 {
 268   GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (widget)->priv;
 269   ClutterEvent cevent = { 0, };
 270
 271   cevent.type = CLUTTER_MOTION;
 272   cevent.any.stage = CLUTTER_STAGE (priv->stage);
 273   cevent.motion.x = event->x;
 274   cevent.motion.y = event->y;
 275   cevent.motion.time = event->time;
 276   cevent.motion.modifier_state = event->state;
 277
 278   clutter_do_event (&cevent);
 279
 280   /* doh - motion events can push ENTER/LEAVE events onto Clutters
 281    * internal event queue which we do really ever touch (essentially
 282    * proxying from gtks queue). The below pumps them back out and
 283    * processes.
 284    * *could* be side effects with below though doubful as no other
 285    * events reach the queue (we shut down event collection). Maybe
 286    * a peek_mask type call could be even safer.
 287   */
 288   while (clutter_events_pending())
 289     {
 290       ClutterEvent *ev = clutter_event_get ();
 291       if (ev)
 292         {
 293           clutter_do_event (ev);
 294           clutter_event_free (ev);
 295         }
 296     }
 297
 298   return FALSE;
 299 }
 300
 301 static gboolean
 302 gtk_clutter_embed_button_event (GtkWidget      *widget,
 303                                 GdkEventButton *event)
 304 {
 305   GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (widget)->priv;
 306   ClutterEvent cevent = { 0, };
 307
 308   if (event->type == GDK_BUTTON_PRESS ||
 309       event->type == GDK_2BUTTON_PRESS ||
 310       event->type == GDK_3BUTTON_PRESS)
 311     cevent.type = cevent.button.type = CLUTTER_BUTTON_PRESS;
 312   else if (event->type == GDK_BUTTON_RELEASE)
 313     cevent.type = cevent.button.type = CLUTTER_BUTTON_RELEASE;
 314   else
 315     return FALSE;
 316
 317   cevent.any.stage = CLUTTER_STAGE (priv->stage);
 318   cevent.button.x = event->x;
 319   cevent.button.y = event->y;
 320   cevent.button.time = event->time;
 321   cevent.button.click_count =
 322     (event->type == GDK_BUTTON_PRESS ? 1
 323                                      : (event->type == GDK_2BUTTON_PRESS ? 2
 324                                                                          : 3));
 325   cevent.button.modifier_state = event->state;
 326   cevent.button.button = event->button;
 327
 328   clutter_do_event (&cevent);
 329
 330   return FALSE;
 331 }
 332
 333 static gboolean
 334 gtk_clutter_embed_key_event (GtkWidget   *widget,
 335                              GdkEventKey *event)
 336 {
 337   GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (widget)->priv;
 338   ClutterEvent cevent = { 0, };
 339
 340   if (event->type == GDK_KEY_PRESS)
 341     cevent.type = cevent.key.type = CLUTTER_KEY_PRESS;
 342   else if (event->type == GDK_KEY_RELEASE)
 343     cevent.type = cevent.key.type = CLUTTER_KEY_RELEASE;
 344   else
 345     return FALSE;
 346
 347   cevent.any.stage = CLUTTER_STAGE (priv->stage);
 348   cevent.key.time = event->time;
 349   cevent.key.modifier_state = event->state;
 350   cevent.key.keyval = event->keyval;
 351   cevent.key.hardware_keycode = event->hardware_keycode;
 352   cevent.key.unicode_value = gdk_keyval_to_unicode (event->keyval);
 353
 354   clutter_do_event (&cevent);
 355
 356   return FALSE;
 357 }
 358
 359 static gboolean
 360 gtk_clutter_embed_map_event (GtkWidget   *widget,
 361                              GdkEventAny *event)
 362 {
 363   GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (widget)->priv;
 364
 365   /* The backend wont get the XEvent as we go strait to do_event().
 366    * So we have to make sure we set the event here.
 367   */
 368   CLUTTER_ACTOR_SET_FLAGS (priv->stage, CLUTTER_ACTOR_MAPPED);
 369
 370   return FALSE;
 371 }
 372
 373 static gboolean
 374 gtk_clutter_embed_focus_in (GtkWidget *widget,
 375                             GdkEventFocus *event)
 376 {
 377   GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (widget)->priv;
 378
 379   g_signal_emit_by_name (priv->stage, "activate");
 380
 381   return FALSE;
 382 }
 383
 384 static gboolean
 385 gtk_clutter_embed_focus_out (GtkWidget     *widget,
 386                              GdkEventFocus *event)
 387 {
 388   GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (widget)->priv;
 389
 390   g_signal_emit_by_name (priv->stage, "deactivate");
 391
 392   /* give back key focus to the stage */
 393   clutter_stage_set_key_focus (CLUTTER_STAGE (priv->stage), NULL);
 394
 395   return FALSE;
 396 }
 397
 398 static gboolean
 399 gtk_clutter_embed_scroll_event (GtkWidget      *widget,
 400                                 GdkEventScroll *event)
 401 {
 402   GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (widget)->priv;
 403
 404   ClutterEvent cevent = { 0, };
 405
 406   if (event->type == GDK_SCROLL)
 407     cevent.type = cevent.scroll.type = CLUTTER_SCROLL;
 408   else
 409     return FALSE;
 410
 411   cevent.any.stage = CLUTTER_STAGE (priv->stage);
 412   cevent.scroll.x = (gint) event->x;
 413   cevent.scroll.y = (gint) event->y;
 414   cevent.scroll.time = event->time;
 415   cevent.scroll.direction = event->direction;
 416   cevent.scroll.modifier_state = event->state;
 417
 418   clutter_do_event (&cevent);
 419
 420   return FALSE;
 421 }
 422
 423 static void
 424 gtk_clutter_embed_style_set (GtkWidget *widget,
 425                              GtkStyle  *old_style)
 426 {
 427   GdkScreen *screen;
 428   GtkSettings *settings;
 429   gdouble dpi;
 430   gchar *font_name;
 431   const cairo_font_options_t *font_options;
 432   gint double_click_time, double_click_distance;
 433   ClutterBackend *backend;
 434
 435   GTK_WIDGET_CLASS (gtk_clutter_embed_parent_class)->style_set (widget,
 436                                                                 old_style);
 437
 438   if (gtk_widget_has_screen (widget))
 439     screen = gtk_widget_get_screen (widget);
 440   else
 441     screen = gdk_screen_get_default ();
 442
 443   dpi = gdk_screen_get_resolution (screen);
 444   if (dpi < 0)
 445     dpi = 96.0;
 446
 447   font_options = gdk_screen_get_font_options (screen);
 448
 449   settings = gtk_settings_get_for_screen (screen);
 450   g_object_get (G_OBJECT (settings),
 451                 "gtk-font-name", &font_name,
 452                 "gtk-double-click-time", &double_click_time,
 453                 "gtk-double-click-distance", &double_click_distance,
 454                 NULL);
 455
 456   /* copy all settings and values coming from GTK+ into
 457    * the ClutterBackend; this way, a scene embedded into
 458    * a GtkClutterEmbed will not look completely alien
 459    */
 460   backend = clutter_get_default_backend ();
 461   clutter_backend_set_resolution (backend, dpi);
 462   clutter_backend_set_font_options (backend, font_options);
 463   clutter_backend_set_font_name (backend, font_name);
 464   clutter_backend_set_double_click_time (backend, double_click_time);
 465   clutter_backend_set_double_click_distance (backend, double_click_distance);
 466
 467   g_free (font_name);
 468 }
 469
 470 static void
 471 gtk_clutter_embed_class_init (GtkClutterEmbedClass *klass)
 472 {
 473   GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
 474   GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (klass);
 475
 476   g_type_class_add_private (klass, sizeof (GtkClutterEmbedPrivate));
 477
 478   gobject_class->dispose = gtk_clutter_embed_dispose;
 479
 480   widget_class->style_set = gtk_clutter_embed_style_set;
 481   widget_class->size_allocate = gtk_clutter_embed_size_allocate;
 482   widget_class->realize = gtk_clutter_embed_realize;
 483   widget_class->show = gtk_clutter_embed_show;
 484   widget_class->hide = gtk_clutter_embed_hide;
 485   widget_class->expose_event = gtk_clutter_embed_expose_event;
 486   widget_class->button_press_event = gtk_clutter_embed_button_event;
 487   widget_class->button_release_event = gtk_clutter_embed_button_event;
 488   widget_class->key_press_event = gtk_clutter_embed_key_event;
 489   widget_class->key_release_event = gtk_clutter_embed_key_event;
 490   widget_class->motion_notify_event = gtk_clutter_embed_motion_notify_event;
 491   widget_class->expose_event = gtk_clutter_embed_expose_event;
 492   widget_class->map_event = gtk_clutter_embed_map_event;
 493   widget_class->focus_in_event = gtk_clutter_embed_focus_in;
 494   widget_class->focus_out_event = gtk_clutter_embed_focus_out;
 495   widget_class->scroll_event = gtk_clutter_embed_scroll_event;
 496 }
 497
 498 static void
 499 gtk_clutter_embed_init (GtkClutterEmbed *embed)
 500 {
 501   GtkClutterEmbedPrivate *priv;
 502
 503   embed->priv = priv = GTK_CLUTTER_EMBED_GET_PRIVATE (embed);
 504
 505   GTK_WIDGET_SET_FLAGS (embed, GTK_CAN_FOCUS);
 506
 507   /* disable double-buffering: it's automatically provided
 508    * by OpenGL
 509    */
 510   gtk_widget_set_double_buffered (GTK_WIDGET (embed), FALSE);
 511
 512   /* we always create new stages rather than use the default */
 513   priv->stage = clutter_stage_new ();
 514
 515   /* intercept the queue-redraw signal of the stage to know when
 516    * Clutter-side requests a redraw; this way we can also request
 517    * a redraw GTK-side
 518    */
 519   priv->queue_redraw_id =
 520     g_signal_connect (priv->stage,
 521                       "queue-redraw", G_CALLBACK (on_stage_queue_redraw),
 522                       embed);
 523 }
 524
 525 /**
 526  * gtk_clutter_embed_new:
 527  *
 528  * Creates a new #GtkClutterEmbed widget. This widget can be
 529  * used to build a scene using Clutter API into a GTK+ application.
 530  *
 531  * Return value: the newly created #GtkClutterEmbed
 532  *
 533  * Since: 0.6
 534  */
 535 GtkWidget *
 536 gtk_clutter_embed_new (void)
 537 {
 538   return g_object_new (GTK_CLUTTER_TYPE_EMBED, NULL);
 539 }
 540
 541 /**
 542  * gtk_clutter_embed_get_stage:
 543  * @embed: a #GtkClutterEmbed
 544  *
 545  * Retrieves the #ClutterStage from @embed. The returned stage can be
 546  * used to add actors to the Clutter scene.
 547  *
 548  * Return value: the Clutter stage. You should never destroy or unref
 549  *   the returned actor.
 550  *
 551  * Since: 0.6
 552  */
 553 ClutterActor *
 554 gtk_clutter_embed_get_stage (GtkClutterEmbed *embed)
 555 {
 556   g_return_val_if_fail (GTK_CLUTTER_IS_EMBED (embed), NULL);
 557
 558   return embed->priv->stage;
 559 }