2 * Copyright (C) 2009-2010 Andy Spencer <andy753421@gmail.com>
4 * This program is free software: you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation, either version 3 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program. If not, see <http://www.gnu.org/licenses/>.
19 * SECTION:grits-viewer
20 * @short_description: Virtual globe base class
22 * #GritsViewer is the base class for the virtual globe widget. It handles
23 * everything not directly related to drawing the globe. Plugins and
24 * applications using the viewer should normally talk to the viewer and not care
25 * how it is implemented.
31 #include <gdk/gdkkeysyms.h>
33 #include "grits-marshal.h"
34 #include "grits-viewer.h"
36 #include "grits-util.h"
48 static guint signals[NUM_SIGNALS];
55 static void _grits_viewer_fix_location(GritsViewer *viewer)
57 while (viewer->location[0] < -90) viewer->location[0] += 180;
58 while (viewer->location[0] > 90) viewer->location[0] -= 180;
59 while (viewer->location[1] < -180) viewer->location[1] += 360;
60 while (viewer->location[1] > 180) viewer->location[1] -= 360;
61 viewer->location[2] = ABS(viewer->location[2]);
65 static void _grits_viewer_emit_location_changed(GritsViewer *viewer)
67 g_signal_emit(viewer, signals[SIG_LOCATION_CHANGED], 0,
72 static void _grits_viewer_emit_rotation_changed(GritsViewer *viewer)
74 g_signal_emit(viewer, signals[SIG_ROTATION_CHANGED], 0,
79 static void _grits_viewer_emit_time_changed(GritsViewer *viewer)
81 g_signal_emit(viewer, signals[SIG_TIME_CHANGED], 0,
84 static void _grits_viewer_emit_refresh(GritsViewer *viewer)
86 g_signal_emit(viewer, signals[SIG_REFRESH], 0);
88 static void _grits_viewer_emit_offline(GritsViewer *viewer)
90 g_signal_emit(viewer, signals[SIG_OFFLINE], 0,
97 static gboolean on_key_press(GritsViewer *viewer, GdkEventKey *event, gpointer _)
99 g_debug("GritsViewer: on_key_press - key=%x, state=%x, plus=%x",
100 event->keyval, event->state, GDK_plus);
102 double lat, lon, elev, pan;
103 grits_viewer_get_location(viewer, &lat, &lon, &elev);
104 pan = MIN(elev/(EARTH_R/2), 30);
105 switch (event->keyval) {
106 case GDK_Left: case GDK_h: grits_viewer_pan(viewer, 0, -pan, 0); break;
107 case GDK_Down: case GDK_j: grits_viewer_pan(viewer, -pan, 0, 0); break;
108 case GDK_Up: case GDK_k: grits_viewer_pan(viewer, pan, 0, 0); break;
109 case GDK_Right: case GDK_l: grits_viewer_pan(viewer, 0, pan, 0); break;
110 case GDK_minus: case GDK_o: grits_viewer_zoom(viewer, 10./9); break;
111 case GDK_plus: case GDK_i: grits_viewer_zoom(viewer, 9./10); break;
112 case GDK_H: grits_viewer_rotate(viewer, 0, 0, -2); break;
113 case GDK_J: grits_viewer_rotate(viewer, 2, 0, 0); break;
114 case GDK_K: grits_viewer_rotate(viewer, -2, 0, 0); break;
115 case GDK_L: grits_viewer_rotate(viewer, 0, 0, 2); break;
120 static gboolean on_scroll(GritsViewer *viewer, GdkEventScroll *event, gpointer _)
122 switch (event->direction) {
123 case GDK_SCROLL_DOWN: grits_viewer_zoom(viewer, 10./9); break;
124 case GDK_SCROLL_UP: grits_viewer_zoom(viewer, 9./10); break;
137 static gboolean on_button_press(GritsViewer *viewer, GdkEventButton *event, gpointer _)
139 g_debug("GritsViewer: on_button_press - %d", event->button);
140 gtk_widget_grab_focus(GTK_WIDGET(viewer));
141 switch (event->button) {
142 case 1: viewer->drag_mode = GRITS_DRAG_PAN; break;
143 case 2: viewer->drag_mode = GRITS_DRAG_ZOOM; break;
144 case 3: viewer->drag_mode = GRITS_DRAG_TILT; break;
145 default: viewer->drag_mode = GRITS_DRAG_NONE; break;
147 viewer->drag_x = event->x;
148 viewer->drag_y = event->y;
152 static gboolean on_button_release(GritsViewer *viewer, GdkEventButton *event, gpointer _)
154 g_debug("GritsViewer: on_button_release");
155 viewer->drag_mode = GRITS_DRAG_NONE;
159 static gboolean on_motion_notify(GritsViewer *viewer, GdkEventMotion *event, gpointer _)
161 gdouble x = viewer->drag_x - event->x;
162 gdouble y = viewer->drag_y - event->y;
163 gdouble lat, lon, elev, scale, rx, ry, rz;
164 grits_viewer_get_location(GRITS_VIEWER(viewer), &lat, &lon, &elev);
165 grits_viewer_get_rotation(GRITS_VIEWER(viewer), &rx, &ry, &rz);
166 scale = (elev/EARTH_R/15) * (sin(deg2rad(ABS(rx)))*4+1);
167 switch (viewer->drag_mode) {
168 case GRITS_DRAG_PAN: grits_viewer_pan(viewer, -y*scale, x*scale, 0); break;
169 case GRITS_DRAG_ZOOM: grits_viewer_zoom(viewer, pow(2, -y/500)); break;
170 case GRITS_DRAG_TILT: grits_viewer_rotate(viewer, y/10, 0, x/10); break;
172 viewer->drag_x = event->x;
173 viewer->drag_y = event->y;
177 static void on_view_changed(GritsViewer *viewer,
178 gdouble _1, gdouble _2, gdouble _3)
180 gtk_widget_queue_draw(GTK_WIDGET(viewer));
183 static void on_realize(GritsViewer *viewer)
185 GdkCursor *cursor = gdk_cursor_new(GDK_FLEUR);
186 GdkWindow *window = gtk_widget_get_window(GTK_WIDGET(viewer));
187 gdk_window_set_cursor(window, cursor);
194 * grits_viewer_setup:
195 * @viewer: the viewer
196 * @plugins: a plugins store
197 * @prefs: a prefs store
199 * This should be called by objects which implement GritsViewer somewhere in their
202 void grits_viewer_setup(GritsViewer *viewer, GritsPlugins *plugins, GritsPrefs *prefs)
204 viewer->plugins = plugins;
205 viewer->prefs = prefs;
206 viewer->offline = grits_prefs_get_boolean(prefs, "grits/offline", NULL);
210 * grits_viewer_set_time:
211 * @viewer: the viewer
212 * @time: the time to set the view to
214 * Set the current time for the view
216 void grits_viewer_set_time(GritsViewer *viewer, time_t time)
218 g_assert(GRITS_IS_VIEWER(viewer));
219 g_debug("GritsViewer: set_time - time=%ld", time);
221 _grits_viewer_emit_time_changed(viewer);
225 * grits_viewer_get_time:
226 * @viewer: the viewer
228 * Get the time that is being viewed
230 * Returns: the current time
232 time_t grits_viewer_get_time(GritsViewer *viewer)
234 g_assert(GRITS_IS_VIEWER(viewer));
235 g_debug("GritsViewer: get_time");
240 * grits_viewer_set_location:
241 * @viewer: the viewer
242 * @lat: the new latitude
243 * @lon: the new longitude
244 * @elev: the new elevation
246 * Set the location for the camera
248 void grits_viewer_set_location(GritsViewer *viewer, gdouble lat, gdouble lon, gdouble elev)
250 g_assert(GRITS_IS_VIEWER(viewer));
251 g_debug("GritsViewer: set_location");
252 viewer->location[0] = lat;
253 viewer->location[1] = lon;
254 viewer->location[2] = elev;
255 _grits_viewer_fix_location(viewer);
256 _grits_viewer_emit_location_changed(viewer);
260 * grits_viewer_get_location:
261 * @viewer: the viewer
262 * @lat: the location to store the latitude
263 * @lon: the location to store the longitude
264 * @elev: the location to store the elevation
266 * Get the location of the camera
268 void grits_viewer_get_location(GritsViewer *viewer, gdouble *lat, gdouble *lon, gdouble *elev)
270 g_assert(GRITS_IS_VIEWER(viewer));
271 //g_debug("GritsViewer: get_location");
272 *lat = viewer->location[0];
273 *lon = viewer->location[1];
274 *elev = viewer->location[2];
279 * @viewer: the viewer
280 * @forward: distance to move forward in meters
281 * @right: distance to move right in meters
282 * @up: distance to move up in meters
284 * Pan the location by a number of meters long the surface.
286 * Bugs: the distances are not in meters
287 * Bugs: panning does not move in strait lines
289 void grits_viewer_pan(GritsViewer *viewer, gdouble forward, gdouble sideways, gdouble up)
291 g_assert(GRITS_IS_VIEWER(viewer));
292 g_debug("GritsViewer: pan - forward=%8.3f, sideways=%8.3f, up=%8.3f",
293 forward, sideways, up);
294 gdouble dist = sqrt(forward*forward + sideways*sideways);
295 gdouble angle1 = deg2rad(viewer->rotation[2]);
296 gdouble angle2 = atan2(sideways, forward);
297 gdouble angle = angle1 + angle2;
298 /* This isn't accurate, but it's usable */
299 viewer->location[0] += dist*cos(angle);
300 viewer->location[1] += dist*sin(angle);
301 viewer->location[2] += up;
302 _grits_viewer_fix_location(viewer);
303 _grits_viewer_emit_location_changed(viewer);
308 * @viewer: the viewer
309 * @scale: the scale to multiple the elevation by
311 * Multiple the elevation by a scale.
313 void grits_viewer_zoom(GritsViewer *viewer, gdouble scale)
315 g_assert(GRITS_IS_VIEWER(viewer));
316 g_debug("GritsViewer: zoom");
317 viewer->location[2] *= scale;
318 _grits_viewer_emit_location_changed(viewer);
322 * grits_viewer_set_rotation:
323 * @viewer: the viewer
324 * @x: rotation new around the x axes
325 * @y: rotation new around the y axes
326 * @z: rotation new around the z axes
328 * Set the rotations in degrees around the x, y, and z axes.
330 void grits_viewer_set_rotation(GritsViewer *viewer, gdouble x, gdouble y, gdouble z)
332 g_assert(GRITS_IS_VIEWER(viewer));
333 g_debug("GritsViewer: set_rotation");
334 viewer->rotation[0] = x;
335 viewer->rotation[1] = y;
336 viewer->rotation[2] = z;
337 _grits_viewer_emit_rotation_changed(viewer);
341 * grits_viewer_get_rotation:
342 * @viewer: the viewer
343 * @x: rotation around the x axes
344 * @y: rotation around the y axes
345 * @z: rotation around the z axes
347 * Get the rotations in degrees around the x, y, and z axes.
349 void grits_viewer_get_rotation(GritsViewer *viewer, gdouble *x, gdouble *y, gdouble *z)
351 g_assert(GRITS_IS_VIEWER(viewer));
352 g_debug("GritsViewer: get_rotation");
353 *x = viewer->rotation[0];
354 *y = viewer->rotation[1];
355 *z = viewer->rotation[2];
359 * grits_viewer_rotate:
360 * @viewer: the viewer
361 * @x: rotation around the x axes
362 * @y: rotation around the y axes
363 * @z: rotation around the z axes
365 * Add to the rotation around the x, y, and z axes.
367 void grits_viewer_rotate(GritsViewer *viewer, gdouble x, gdouble y, gdouble z)
369 g_assert(GRITS_IS_VIEWER(viewer));
370 g_debug("GritsViewer: rotate - x=%.0f, y=%.0f, z=%.0f", x, y, z);
371 viewer->rotation[0] += x;
372 viewer->rotation[1] += y;
373 viewer->rotation[2] += z;
374 _grits_viewer_emit_rotation_changed(viewer);
378 * grits_viewer_refresh:
379 * @viewer: the viewer
381 * Trigger the refresh signal. This will cause any remote data to be checked for
384 void grits_viewer_refresh(GritsViewer *viewer)
386 g_debug("GritsViewer: refresh");
387 _grits_viewer_emit_refresh(viewer);
391 * grits_viewer_set_offline:
392 * @viewer: the viewer
393 * @offline: %TRUE to enter offline mode
395 * Set the offline mode. If @offline is %TRUE, only locally cached data will be
398 void grits_viewer_set_offline(GritsViewer *viewer, gboolean offline)
400 g_assert(GRITS_IS_VIEWER(viewer));
401 g_debug("GritsViewer: set_offline - %d", offline);
402 grits_prefs_set_boolean(viewer->prefs, "grits/offline", offline);
403 viewer->offline = offline;
404 _grits_viewer_emit_offline(viewer);
408 * grits_viewer_get_offline:
409 * @viewer: the viewer
411 * Check if the viewer is in offline mode.
413 * Returns: %TRUE if the viewer is in offline mode.
415 gboolean grits_viewer_get_offline(GritsViewer *viewer)
417 g_assert(GRITS_IS_VIEWER(viewer));
418 g_debug("GritsViewer: get_offline - %d", viewer->offline);
419 return viewer->offline;
422 /***********************************
423 * To be implemented by subclasses *
424 ***********************************/
426 * grits_viewer_center_position:
427 * @viewer: the viewer
429 * @lon: the longitude
430 * @elev: the elevation
432 * Center the viewer on a point. This can be used before drawing operations to
433 * center the items a particular location.
435 void grits_viewer_center_position(GritsViewer *viewer,
436 gdouble lat, gdouble lon, gdouble elev)
438 GritsViewerClass *klass = GRITS_VIEWER_GET_CLASS(viewer);
439 if (!klass->center_position)
440 g_warning("GritsViewer: center_position - Unimplemented");
441 klass->center_position(viewer, lat, lon, elev);
445 * grits_viewer_project:
446 * @viewer: the viewer
449 * @elev: the latitude
450 * @px: the project x coordinate
451 * @py: the project y coordinate
452 * @pz: the project z coordinate
454 * Project a latitude, longitude, elevation point to to x, y, and z coordinates
455 * in screen space. Useful for drawing orthographic data over a particular point
456 * in space. E.g. #GritsMarker.
458 void grits_viewer_project(GritsViewer *viewer,
459 gdouble lat, gdouble lon, gdouble elev,
460 gdouble *px, gdouble *py, gdouble *pz)
462 GritsViewerClass *klass = GRITS_VIEWER_GET_CLASS(viewer);
464 g_warning("GritsViewer: project - Unimplemented");
465 klass->project(viewer, lat, lon, elev, px, py, pz);
469 * grits_viewer_clear_height_func:
470 * @viewer: the viewer
472 * Clears the height function for the entire viewer. Useful when an elevation
473 * plugin is unloaded.
475 void grits_viewer_clear_height_func(GritsViewer *viewer)
477 GritsViewerClass *klass = GRITS_VIEWER_GET_CLASS(viewer);
478 if (!klass->clear_height_func)
479 g_warning("GritsViewer: clear_height_func - Unimplemented");
480 klass->clear_height_func(viewer);
484 * grits_viewer_set_height_func:
485 * @viewer: the viewer
486 * @bounds: the area to set the height function for
487 * @height_func: the height function
488 * @user_data: user data to pass to the height function
489 * @update: %TRUE if the heights inside the bounds should be updated.
491 * Set the height function to be used for a given part of the surface..
493 void grits_viewer_set_height_func(GritsViewer *viewer, GritsBounds *bounds,
494 GritsHeightFunc height_func, gpointer user_data,
497 GritsViewerClass *klass = GRITS_VIEWER_GET_CLASS(viewer);
498 if (!klass->set_height_func)
499 g_warning("GritsViewer: set_height_func - Unimplemented");
500 klass->set_height_func(viewer, bounds, height_func, user_data, update);
505 * @viewer: the viewer
506 * @object: the object to add
507 * @level: the level to add the object to
508 * @sort: %TRUE if the object should be depth-sorted prior to being drawn
510 * Objects which are added to the viewer will be drawn on subsequent renderings
511 * if their level of details is adequate.
513 * The @level represents the order the object should be drawn in, this is
514 * unrelated to the objects actual position in the world.
516 * Semi-transparent objects should set @sort to %TRUE so that they are rendered
517 * correctly when they overlap other semi-transparent objects.
519 * The viewer steals the objects reference. Call g_object_ref if you plan on
520 * holding a reference as well.
522 * Returns: a handle to be pass to grits_viewer_remove()
524 gpointer grits_viewer_add(GritsViewer *viewer, GritsObject *object,
525 gint level, gboolean sort)
527 GritsViewerClass *klass = GRITS_VIEWER_GET_CLASS(viewer);
529 g_warning("GritsViewer: add - Unimplemented");
530 object->ref = klass->add(viewer, object, level, sort);
531 object->viewer = viewer;
536 * grits_viewer_remove:
537 * @viewer: the viewer
538 * @ref: the handle obtained from grits_viewer_add()
540 * Remove an object from the viewer. The objects reference count is decremented
541 * prior to being removed.
543 * Returns: the #GritsObject referenced by the handle
545 GritsObject *grits_viewer_remove(GritsViewer *viewer, gpointer _object)
547 GritsObject *object = _object;
548 GritsViewerClass *klass = GRITS_VIEWER_GET_CLASS(viewer);
550 g_warning("GritsViewer: remove - Unimplemented");
551 klass->remove(viewer, object->ref);
553 object->viewer = NULL;
560 G_DEFINE_ABSTRACT_TYPE(GritsViewer, grits_viewer, GTK_TYPE_DRAWING_AREA);
561 static void grits_viewer_init(GritsViewer *viewer)
563 g_debug("GritsViewer: init");
565 viewer->time = time(NULL);
566 viewer->location[0] = 40;
567 viewer->location[1] = -100;
568 viewer->location[2] = 1.5*EARTH_R;
569 viewer->rotation[0] = 0;
570 viewer->rotation[1] = 0;
571 viewer->rotation[2] = 0;
573 g_object_set(viewer, "can-focus", TRUE, NULL);
574 gtk_widget_add_events(GTK_WIDGET(viewer),
575 GDK_BUTTON_PRESS_MASK |
576 GDK_BUTTON_RELEASE_MASK |
577 GDK_POINTER_MOTION_MASK |
580 g_signal_connect(viewer, "key-press-event", G_CALLBACK(on_key_press), NULL);
581 g_signal_connect(viewer, "scroll-event", G_CALLBACK(on_scroll), NULL);
583 g_signal_connect(viewer, "button-press-event", G_CALLBACK(on_button_press), NULL);
584 g_signal_connect(viewer, "button-release-event", G_CALLBACK(on_button_release), NULL);
585 g_signal_connect(viewer, "motion-notify-event", G_CALLBACK(on_motion_notify), NULL);
587 g_signal_connect(viewer, "location-changed", G_CALLBACK(on_view_changed), NULL);
588 g_signal_connect(viewer, "rotation-changed", G_CALLBACK(on_view_changed), NULL);
590 g_signal_connect(viewer, "realize", G_CALLBACK(on_realize), NULL);
592 static void grits_viewer_finalize(GObject *gobject)
594 g_debug("GritsViewer: finalize");
595 G_OBJECT_CLASS(grits_viewer_parent_class)->finalize(gobject);
596 g_debug("GritsViewer: finalize - done");
598 static void grits_viewer_class_init(GritsViewerClass *klass)
600 g_debug("GritsViewer: class_init");
601 GObjectClass *gobject_class = G_OBJECT_CLASS(klass);
602 gobject_class->finalize = grits_viewer_finalize;
605 * GritsViewer::time-changed:
606 * @viewer: the viewer.
607 * @time: the new time.
609 * The ::time-changed signal is emitted when the viewers current time
612 signals[SIG_TIME_CHANGED] = g_signal_new(
614 G_TYPE_FROM_CLASS(gobject_class),
619 g_cclosure_marshal_VOID__LONG,
625 * GritsViewer::location-changed:
626 * @viewer: the viewer.
627 * @lat: the new latitude.
628 * @lon: the new longitude.
629 * @elev: the new elevation.
631 * The ::location-changed signal is emitted when the viewers camera
634 signals[SIG_LOCATION_CHANGED] = g_signal_new(
636 G_TYPE_FROM_CLASS(gobject_class),
641 grits_cclosure_marshal_VOID__DOUBLE_DOUBLE_DOUBLE,
649 * GritsViewer::rotation-changed:
650 * @viewer: the viewer.
651 * @x: rotation new around the x axes.
652 * @y: rotation new around the y axes.
653 * @z: rotation new around the z axes.
655 * The ::rotation-changed signal is emitted when the viewers cameras
658 signals[SIG_ROTATION_CHANGED] = g_signal_new(
660 G_TYPE_FROM_CLASS(gobject_class),
665 grits_cclosure_marshal_VOID__DOUBLE_DOUBLE_DOUBLE,
673 * GritsViewer::refresh:
674 * @viewer: the viewer.
676 * The ::refresh signal is emitted when a refresh is needed. If you are
677 * using real-time data from a remote server, you should connect to the
678 * refresh signal and update the data when necessary.
680 signals[SIG_REFRESH] = g_signal_new(
682 G_TYPE_FROM_CLASS(gobject_class),
687 g_cclosure_marshal_VOID__VOID,
692 * GritsViewer::offline:
693 * @viewer: the viewer.
694 * @offline: %TRUE if the viewer going offline.
696 * The ::offline signal is emitted when the viewers offline mode
699 signals[SIG_OFFLINE] = g_signal_new(
701 G_TYPE_FROM_CLASS(gobject_class),
706 g_cclosure_marshal_VOID__BOOLEAN,