1 /* grr_board_view - GTK+ widget for displaying an rr_board
3 * Copyright © 2003 Carl Worth
5 * Permission to use, copy, modify, distribute, and sell this software
6 * and its documentation for any purpose is hereby granted without
7 * fee, provided that the above copyright notice appear in all copies
8 * and that both that copyright notice and this permission notice
9 * appear in supporting documentation, and that the name of Carl Worth
10 * not be used in advertising or publicity pertaining to distribution
11 * of the software without specific, written prior permission.
12 * Carl Worth makes no representations about the suitability of this
13 * software for any purpose. It is provided "as is" without express
14 * or implied warranty.
16 * CARL WORTH DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
17 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN
18 * NO EVENT SHALL CARL WORTH BE LIABLE FOR ANY SPECIAL, INDIRECT OR
19 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
20 * OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
21 * NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
22 * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
24 * Author: Carl Worth <carl@theworths.org>
35 #include <gtk/gtkmain.h>
36 #include <gtk/gtksignal.h>
39 #include "grr_board_view.h"
43 #define SCROLL_DELAY_LENGTH 300
44 #define GRR_BOARD_VIEW_DEFAULT_SIZE 100
46 #define GRR_SVG_ASSUMED_WIDTH 32.0
47 #define GRR_SVG_ASSUMED_HEIGHT 32.0
49 /* Forward declarations */
51 static void grr_board_view_class_init (grr_board_view_class_t *klass);
52 static void grr_board_view_init (grr_board_view_t *view);
53 static void grr_board_view_destroy (GtkObject *object);
54 static void grr_board_view_realize (GtkWidget *widget);
55 static void grr_board_view_size_request (GtkWidget *widget,
56 GtkRequisition *requisition);
57 static void grr_board_view_size_allocate (GtkWidget *widget,
58 GtkAllocation *allocation);
59 static gint grr_board_view_expose (GtkWidget *widget,
60 GdkEventExpose *event);
61 static gint grr_board_view_button_press (GtkWidget *widget,
62 GdkEventButton *event);
63 static gint grr_board_view_button_release (GtkWidget *widget,
64 GdkEventButton *event);
65 static gint grr_board_view_motion_notify (GtkWidget *widget,
66 GdkEventMotion *event);
68 static void grr_board_view_update_mouse (grr_board_view_t *view, gint x, gint y);
72 static GtkWidgetClass *parent_class = NULL;
75 grr_board_view_get_type ()
77 static GType view_type = 0;
81 static const GTypeInfo view_info =
83 sizeof (grr_board_view_class_t),
86 (GClassInitFunc) grr_board_view_class_init,
89 sizeof (grr_board_view_t),
91 (GInstanceInitFunc) grr_board_view_init,
94 view_type = g_type_register_static (GTK_TYPE_WIDGET, "grr_board_view", &view_info, 0);
101 grr_board_view_class_init (grr_board_view_class_t *class)
103 GtkObjectClass *object_class;
104 GtkWidgetClass *widget_class;
106 object_class = (GtkObjectClass*) class;
107 widget_class = (GtkWidgetClass*) class;
109 parent_class = gtk_type_class (gtk_widget_get_type ());
111 object_class->destroy = grr_board_view_destroy;
113 widget_class->realize = grr_board_view_realize;
114 widget_class->expose_event = grr_board_view_expose;
115 widget_class->size_request = grr_board_view_size_request;
116 widget_class->size_allocate = grr_board_view_size_allocate;
117 widget_class->button_press_event = grr_board_view_button_press;
118 widget_class->button_release_event = grr_board_view_button_release;
119 widget_class->motion_notify_event = grr_board_view_motion_notify;
123 grr_board_view_init (grr_board_view_t *view)
135 view->drift_correct = 0.0;
138 view->cell_width = 0;
139 view->cell_height = 0;
141 view->cell1_icon = grr_icon_create ("cell1");
142 view->cell2_icon = grr_icon_create ("cell2");
143 view->wall_icon = grr_icon_create ("wall");
145 for (i=0; i < RR_NUM_ROBOTS; i++) {
146 robot = rr_robot_from_idx (i);
147 view->robot_icon[i] = grr_icon_create (grr_icon_robot_name (robot));
150 for (i=0; i < RR_NUM_TARGETS; i++) {
151 target = rr_target_from_idx (i);
152 view->target_icon[i] = grr_icon_create (grr_icon_target_name (target));
157 grr_board_view_new (rr_board_t *board)
159 grr_board_view_t *view;
162 view = g_object_new (grr_board_view_get_type (), NULL);
165 rr_board_get_size (board, &view->board_width, &view->board_height);
167 view->damaged = malloc (view->board_height * sizeof (int *));
168 for (y = 0; y < view->board_height; y++) {
169 view->damaged[y] = malloc (view->board_width * sizeof (int));
170 for (x = 0; x< view->board_width; x++) {
171 view->damaged[y][x] = 1;
175 gtk_widget_queue_draw (GTK_WIDGET (view));
181 grr_board_view_set_client (grr_board_view_t *view, rr_client_t *client)
183 g_return_if_fail (view != NULL);
185 view->client = client;
189 grr_board_view_set_active_robot (grr_board_view_t *view, rr_robot_t robot)
191 g_return_if_fail (view != NULL);
193 view->active_robot = robot;
197 grr_board_view_move_active (grr_board_view_t *view, rr_direction_t dir)
200 rr_client_move (view->client, view->active_robot, dir);
202 rr_board_move (view->board, view->active_robot, dir);
203 gtk_widget_queue_draw (GTK_WIDGET (view));
208 grr_board_view_undo (grr_board_view_t *view)
211 rr_client_undo (view->client);
213 rr_board_undo (view->board);
214 gtk_widget_queue_draw (GTK_WIDGET (view));
219 grr_board_view_destroy (GtkObject *object)
221 grr_board_view_t *view;
223 g_return_if_fail (object != NULL);
224 g_return_if_fail (GRR_IS_BOARD_VIEW (object));
226 view = GRR_BOARD_VIEW (object);
231 if (GTK_OBJECT_CLASS (parent_class)->destroy)
232 (* GTK_OBJECT_CLASS (parent_class)->destroy) (object);
236 grr_board_view_realize (GtkWidget *widget)
238 grr_board_view_t *view;
239 GdkWindowAttr attributes;
240 gint attributes_mask;
242 g_return_if_fail (widget != NULL);
243 g_return_if_fail (GRR_IS_BOARD_VIEW (widget));
245 GTK_WIDGET_SET_FLAGS (widget, GTK_REALIZED);
246 view = GRR_BOARD_VIEW (widget);
248 attributes.x = widget->allocation.x;
249 attributes.y = widget->allocation.y;
250 attributes.width = widget->allocation.width;
251 attributes.height = widget->allocation.height;
252 attributes.wclass = GDK_INPUT_OUTPUT;
253 attributes.window_type = GDK_WINDOW_CHILD;
254 attributes.event_mask = gtk_widget_get_events (widget) |
255 GDK_EXPOSURE_MASK | GDK_BUTTON_PRESS_MASK |
256 GDK_BUTTON_RELEASE_MASK | GDK_POINTER_MOTION_MASK |
257 GDK_POINTER_MOTION_HINT_MASK;
258 attributes.visual = gtk_widget_get_visual (widget);
259 attributes.colormap = gtk_widget_get_colormap (widget);
261 attributes_mask = GDK_WA_X | GDK_WA_Y | GDK_WA_VISUAL | GDK_WA_COLORMAP;
262 widget->window = gdk_window_new (widget->parent->window, &attributes, attributes_mask);
264 widget->style = gtk_style_attach (widget->style, widget->window);
266 gdk_window_set_user_data (widget->window, widget);
268 gtk_style_set_background (widget->style, widget->window, GTK_STATE_ACTIVE);
272 grr_board_view_size_request (GtkWidget *widget,
273 GtkRequisition *requisition)
275 requisition->width = GRR_BOARD_VIEW_DEFAULT_SIZE;
276 requisition->height = GRR_BOARD_VIEW_DEFAULT_SIZE;
280 grr_board_view_size_allocate (GtkWidget *widget,
281 GtkAllocation *allocation)
283 grr_board_view_t *view;
285 g_return_if_fail (widget != NULL);
286 g_return_if_fail (GRR_IS_BOARD_VIEW (widget));
287 g_return_if_fail (allocation != NULL);
289 widget->allocation = *allocation;
290 view = GRR_BOARD_VIEW (widget);
292 if (GTK_WIDGET_REALIZED (widget)) {
293 gdk_window_move_resize (widget->window,
294 allocation->x, allocation->y,
295 allocation->width, allocation->height);
300 grr_board_view_draw_walls (grr_board_view_t *view,
304 if (wall == RR_WALL_NONE)
307 if (wall & RR_WALL_ABOVE) {
308 grr_icon_draw (view->wall_icon, xrs);
310 if (wall & RR_WALL_LEFT) {
312 cairo_rotate (xrs, M_PI_2);
313 grr_icon_draw (view->wall_icon, xrs);
316 if (wall & RR_WALL_RIGHT) {
318 cairo_translate (xrs, GRR_SVG_ASSUMED_WIDTH, 0);
319 cairo_rotate (xrs, M_PI_2);
320 grr_icon_draw (view->wall_icon, xrs);
323 if (wall & RR_WALL_BELOW) {
325 cairo_translate (xrs, 0, GRR_SVG_ASSUMED_HEIGHT);
326 grr_icon_draw (view->wall_icon, xrs);
332 grr_board_view_expose (GtkWidget *widget,
333 GdkEventExpose *event)
335 grr_board_view_t *view;
340 GdkDrawable *real_drawable;
343 rr_target_t goal_target;
344 int new_cell_width, new_cell_height;
346 g_return_val_if_fail (widget != NULL, FALSE);
347 g_return_val_if_fail (GRR_IS_BOARD_VIEW (widget), FALSE);
348 g_return_val_if_fail (event != NULL, FALSE);
350 view = GRR_BOARD_VIEW (widget);
353 /* Unabstract X from GTK+ */
354 gdk_window_get_internal_paint_info (widget->window, &real_drawable, &x_off, &y_off);
355 dpy = gdk_x11_drawable_get_xdisplay (real_drawable);
356 drawable = gdk_x11_drawable_get_xid (real_drawable);
358 /* Ignore GTK+ and use Cairo for drawing. */
359 xrs = cairo_create ();
360 cairo_set_target_drawable (xrs, dpy, drawable);
362 new_cell_width = widget->allocation.width / view->board_width;
363 if (new_cell_width == 0)
365 new_cell_height = widget->allocation.height / view->board_height;
366 if (new_cell_height == 0)
369 if (new_cell_width != view->cell_width
370 || new_cell_height != view->cell_height) {
375 view->cell_width = new_cell_width;
376 view->cell_height = new_cell_height;
380 view->cell_width / GRR_SVG_ASSUMED_WIDTH,
381 view->cell_height / GRR_SVG_ASSUMED_HEIGHT);
383 grr_icon_predraw (view->cell1_icon, xrs,
384 view->cell_width, view->cell_height);
385 grr_icon_predraw (view->cell2_icon, xrs,
386 view->cell_width, view->cell_height);
388 grr_icon_predraw (view->wall_icon, xrs,
389 view->cell_width, view->cell_height);
391 for (i=0; i < RR_NUM_ROBOTS; i++) {
392 robot = rr_robot_from_idx (i);
393 grr_icon_predraw (view->robot_icon[i], xrs,
394 view->cell_width, view->cell_height);
397 for (i=0; i < RR_NUM_TARGETS; i++) {
398 target = rr_target_from_idx (i);
399 grr_icon_predraw (view->target_icon[i], xrs,
400 view->cell_width, view->cell_height);
406 view->cell_width = new_cell_width;
407 view->cell_height = new_cell_height;
409 if (event->area.width) {
410 int x_start, y_start;
413 grr_board_view_transform_pixel_to_cell (view,
414 event->area.x, event->area.y,
416 grr_board_view_transform_pixel_to_cell (view,
417 event->area.x + event->area.width - 1,
418 event->area.y + event->area.height - 1,
420 for (y = y_start; y <= y_stop; y++)
421 for (x = x_start; x <= x_stop; x++)
422 view->damaged[y][x] = 1;
425 if (event->count > 0)
428 cairo_translate (xrs, -x_off, -y_off);
430 view->board_pad_x = (widget->allocation.width - view->board_width * view->cell_width) / 2;
431 view->board_pad_y = (widget->allocation.height - view->board_height * view->cell_height) / 2;
433 cairo_translate (xrs, view->board_pad_x, view->board_pad_y);
435 goal_target = rr_board_get_goal_target (board);
437 /* Draw cell contents */
438 for (j=0; j < view->board_height; j++) {
439 for (i=0; i < view->board_width; i++) {
440 if (! view->damaged[j][i])
442 rr_cell_t cell = rr_board_get_cell (board, i, j);
443 rr_target_t target = RR_CELL_GET_TARGET (cell);
444 rr_robot_t robot = RR_CELL_GET_ROBOT (cell);
447 cairo_translate (xrs, i * view->cell_width, j * view->cell_height);
450 grr_icon_draw_predrawn (view->cell1_icon, xrs);
452 grr_icon_draw_predrawn (view->cell2_icon, xrs);
455 if (target && target != goal_target) {
457 cairo_set_alpha (xrs, 0.25);
458 grr_icon_draw_predrawn (view->target_icon[rr_target_idx (target)], xrs);
461 grr_icon_draw_predrawn (view->target_icon[rr_target_idx (target)], xrs);
466 grr_icon_draw_predrawn (view->robot_icon[rr_robot_idx (robot)], xrs);
472 /* Draw goal target in center of board */
473 /* XXX: Not a perfect heuristic. Should check for the vacant box too. */
474 if (view->board_width == 16 && view->board_height == 16) {
476 cairo_translate (xrs,
477 (view->board_width / 2 - 1) * view->cell_width,
478 (view->board_height / 2 - 1) * view->cell_height);
480 2 * view->cell_width / GRR_SVG_ASSUMED_WIDTH,
481 2 * view->cell_height / GRR_SVG_ASSUMED_HEIGHT);
482 cairo_rectangle (xrs, 0, 0, GRR_SVG_ASSUMED_WIDTH, GRR_SVG_ASSUMED_HEIGHT);
483 cairo_set_rgb_color (xrs, 1, 1, 1);
485 grr_icon_draw (view->target_icon[rr_target_idx (goal_target)], xrs);
489 if (view->time < 60.0) {
491 cairo_new_path (xrs);
493 (double) view->board_width / 2 * view->cell_width,
494 (double) view->board_height / 2 * view->cell_height);
496 (double) view->board_width / 2 * view->cell_width,
497 (double) view->board_height / 2 * view->cell_height,
498 .9 * view->cell_width,
500 2 * M_PI * (60.0 - view->time) / 60.0 - M_PI_2);
501 cairo_close_path (xrs);
503 cairo_set_rgb_color (xrs, 0.0, 0.0, 0.0);
504 cairo_set_alpha (xrs, 0.5);
512 for (j=0; j < view->board_height; j++) {
513 for (i=0; i < view->board_width; i++) {
514 if (! view->damaged[j][i])
516 view->damaged[j][i] = 0;
518 cairo_translate (xrs, i * view->cell_width, j * view->cell_height);
520 view->cell_width / GRR_SVG_ASSUMED_WIDTH,
521 view->cell_height / GRR_SVG_ASSUMED_HEIGHT);
522 grr_board_view_draw_walls (view, xrs, RR_CELL_GET_WALLS (rr_board_get_cell(board, i, j)));
533 grr_board_view_transform_pixel_to_cell (grr_board_view_t *view,
534 int pixel_x, int pixel_y,
535 int *cell_x, int *cell_y)
538 x = (pixel_x - view->board_pad_x) / view->cell_width;
539 y = (pixel_y - view->board_pad_y) / view->cell_height;
542 if (x >= view->board_width)
543 x = view->board_width - 1;
546 if (y >= view->board_height)
547 y = view->board_height - 1;
553 grr_board_view_transform_cell_to_pixel (grr_board_view_t *view,
554 int cell_x, int cell_y,
555 int *pixel_x, int *pixel_y)
557 *pixel_x = view->cell_width * cell_x + view->board_pad_x;
558 *pixel_y = view->cell_height * cell_y + view->board_pad_y;
562 grr_board_view_button_press (GtkWidget *widget,
563 GdkEventButton *event)
565 grr_board_view_t *view;
569 g_return_val_if_fail (widget != NULL, FALSE);
570 g_return_val_if_fail (GRR_IS_BOARD_VIEW (widget), FALSE);
571 g_return_val_if_fail (event != NULL, FALSE);
573 view = GRR_BOARD_VIEW (widget);
575 grr_board_view_transform_pixel_to_cell (view,
579 cell = rr_board_get_cell (view->board, x, y);
580 if (!view->button && RR_CELL_GET_ROBOT (cell)) {
582 gtk_grab_add (widget);
584 view->button = event->button;
585 grr_board_view_set_active_robot (view, RR_CELL_GET_ROBOT (cell));
587 grr_board_view_update_mouse (view, event->x, event->y);
594 grr_board_view_button_release (GtkWidget *widget,
595 GdkEventButton *event)
597 grr_board_view_t *view;
600 int robot_x, robot_y;
603 g_return_val_if_fail (widget != NULL, FALSE);
604 g_return_val_if_fail (GRR_IS_BOARD_VIEW (widget), FALSE);
605 g_return_val_if_fail (event != NULL, FALSE);
607 view = GRR_BOARD_VIEW (widget);
609 if (view->button == event->button) {
610 gtk_grab_remove (widget);
614 grr_board_view_transform_pixel_to_cell (view, event->x, event->y, &x, &y);
616 rr_board_find_robot (view->board, view->active_robot, &robot_x, &robot_y);
619 if (dx == 0 && dy == 0)
622 if (abs(dx) > abs(dy))
624 dir = RR_DIRECTION_EAST;
626 dir = RR_DIRECTION_WEST;
629 dir = RR_DIRECTION_SOUTH;
631 dir = RR_DIRECTION_NORTH;
633 grr_board_view_move_active (view, dir);
639 grr_board_view_motion_notify (GtkWidget *widget,
640 GdkEventMotion *event)
642 grr_board_view_t *view;
643 GdkModifierType mods;
646 g_return_val_if_fail (widget != NULL, FALSE);
647 g_return_val_if_fail (GRR_IS_BOARD_VIEW (widget), FALSE);
648 g_return_val_if_fail (event != NULL, FALSE);
650 view = GRR_BOARD_VIEW (widget);
652 if (view->button != 0) {
656 if (event->is_hint || (event->window != widget->window))
657 gdk_window_get_pointer (widget->window, &x, &y, &mods);
659 switch (view->button) {
661 mask = GDK_BUTTON1_MASK;
664 mask = GDK_BUTTON2_MASK;
667 mask = GDK_BUTTON3_MASK;
675 grr_board_view_update_mouse (view, x,y);
682 grr_board_view_update_mouse (grr_board_view_t *view, gint x, gint y)
684 g_return_if_fail (view != NULL);
685 g_return_if_fail (GRR_IS_BOARD_VIEW (view));
687 /* XXX: Perhaps should draw a robot here */
691 grr_board_view_mark_damage (grr_board_view_t *view, int i, int j)
695 grr_board_view_transform_cell_to_pixel (view, i, j, &x, &y);
696 gtk_widget_queue_draw_area (GTK_WIDGET (view), x, y, view->cell_width, view->cell_height);
699 #define TIMER_INTERVAL_MS 100
702 grr_board_view_refresh_timer (grr_board_view_t *view)
706 grr_board_view_transform_cell_to_pixel (view,
707 view->board_width / 2 - 1,
708 view->board_height / 2 -1,
710 gtk_widget_queue_draw_area (GTK_WIDGET (view),
712 2 * view->cell_width,
713 2 * view->cell_height);
717 grr_board_view_decrement_timer (void *widget)
719 grr_board_view_t *view = widget;
721 view->time -= TIMER_INTERVAL_MS / 1000.0;
722 view->time += view->drift_correct;
724 grr_board_view_refresh_timer (view);
730 grr_board_view_start_timer (grr_board_view_t *view, double time)
732 /* XXX: It would be good to adjust the clock for latency somewhere... */
733 /* Correct any drift within the next 10 seconds, or half the
734 remaining time --- whichever is less. */
736 double correction_time;
738 correction_time = 10.0;
740 correction_time = time / 2.0;
741 view->drift_correct = (time - view->time) / (correction_time * TIMER_INTERVAL_MS);
745 view->timer = gtk_timeout_add (TIMER_INTERVAL_MS, grr_board_view_decrement_timer, view);
750 grr_board_view_stop_timer (grr_board_view_t *view)
752 if (view->timer == 0)
755 gtk_timeout_remove (view->timer);
759 grr_board_view_refresh_timer (view);
763 grr_board_view_reset_timer (grr_board_view_t *view)
765 grr_board_view_stop_timer (view);
768 view->drift_correct = 0.0;