2 * Copyright (C) 2009-2011 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]);
64 static void _grits_viewer_fix_rotation(GritsViewer *viewer)
66 while (viewer->rotation[0] < -180) viewer->rotation[0] += 360;
67 while (viewer->rotation[0] > 180) viewer->rotation[0] -= 360;
68 while (viewer->rotation[1] < -180) viewer->rotation[1] += 360;
69 while (viewer->rotation[1] > 180) viewer->rotation[1] -= 360;
70 while (viewer->rotation[2] < -180) viewer->rotation[2] += 360;
71 while (viewer->rotation[2] > 180) viewer->rotation[2] -= 360;
75 static void _grits_viewer_emit_location_changed(GritsViewer *viewer)
77 g_signal_emit(viewer, signals[SIG_LOCATION_CHANGED], 0,
82 static void _grits_viewer_emit_rotation_changed(GritsViewer *viewer)
84 g_signal_emit(viewer, signals[SIG_ROTATION_CHANGED], 0,
89 static void _grits_viewer_emit_time_changed(GritsViewer *viewer)
91 g_signal_emit(viewer, signals[SIG_TIME_CHANGED], 0,
94 static void _grits_viewer_emit_refresh(GritsViewer *viewer)
96 g_signal_emit(viewer, signals[SIG_REFRESH], 0);
98 static void _grits_viewer_emit_offline(GritsViewer *viewer)
100 g_signal_emit(viewer, signals[SIG_OFFLINE], 0,
107 static gboolean on_key_press(GritsViewer *viewer, GdkEventKey *event, gpointer _)
109 g_debug("GritsViewer: on_key_press - key=%x, state=%x, plus=%x",
110 event->keyval, event->state, GDK_plus);
112 double lat, lon, elev, pan;
113 grits_viewer_get_location(viewer, &lat, &lon, &elev);
114 pan = MIN(elev/(EARTH_R/2), 30);
115 switch (event->keyval) {
116 case GDK_Left: case GDK_h: grits_viewer_pan(viewer, 0, -pan, 0); break;
117 case GDK_Down: case GDK_j: grits_viewer_pan(viewer, -pan, 0, 0); break;
118 case GDK_Up: case GDK_k: grits_viewer_pan(viewer, pan, 0, 0); break;
119 case GDK_Right: case GDK_l: grits_viewer_pan(viewer, 0, pan, 0); break;
120 case GDK_minus: case GDK_o: grits_viewer_zoom(viewer, 10./9); break;
121 case GDK_plus: case GDK_i: grits_viewer_zoom(viewer, 9./10); break;
122 case GDK_H: grits_viewer_rotate(viewer, 0, 0, -2); break;
123 case GDK_J: grits_viewer_rotate(viewer, 2, 0, 0); break;
124 case GDK_K: grits_viewer_rotate(viewer, -2, 0, 0); break;
125 case GDK_L: grits_viewer_rotate(viewer, 0, 0, 2); break;
130 static gboolean on_scroll(GritsViewer *viewer, GdkEventScroll *event, gpointer _)
132 switch (event->direction) {
133 case GDK_SCROLL_DOWN: grits_viewer_zoom(viewer, 10./9); break;
134 case GDK_SCROLL_UP: grits_viewer_zoom(viewer, 9./10); break;
147 static gboolean on_button_press(GritsViewer *viewer, GdkEventButton *event, gpointer _)
149 g_debug("GritsViewer: on_button_press - %d", event->button);
150 gtk_widget_grab_focus(GTK_WIDGET(viewer));
151 switch (event->button) {
152 case 1: viewer->drag_mode = GRITS_DRAG_PAN; break;
153 case 2: viewer->drag_mode = GRITS_DRAG_ZOOM; break;
154 case 3: viewer->drag_mode = GRITS_DRAG_TILT; break;
155 default: viewer->drag_mode = GRITS_DRAG_NONE; break;
157 viewer->drag_x = event->x;
158 viewer->drag_y = event->y;
162 static gboolean on_button_release(GritsViewer *viewer, GdkEventButton *event, gpointer _)
164 g_debug("GritsViewer: on_button_release");
165 viewer->drag_mode = GRITS_DRAG_NONE;
169 static gboolean on_motion_notify(GritsViewer *viewer, GdkEventMotion *event, gpointer _)
171 gdouble x = viewer->drag_x - event->x;
172 gdouble y = viewer->drag_y - event->y;
173 gdouble lat, lon, elev, scale, rx, ry, rz;
174 grits_viewer_get_location(GRITS_VIEWER(viewer), &lat, &lon, &elev);
175 grits_viewer_get_rotation(GRITS_VIEWER(viewer), &rx, &ry, &rz);
176 scale = (elev/EARTH_R/14.1) * (sin(deg2rad(ABS(rx)))*4+1);
177 switch (viewer->drag_mode) {
178 case GRITS_DRAG_PAN: grits_viewer_pan(viewer, -y*scale*0.782, x*scale, 0); break;
179 case GRITS_DRAG_ZOOM: grits_viewer_zoom(viewer, pow(2, -y/500)); break;
180 case GRITS_DRAG_TILT: grits_viewer_rotate(viewer, y/10, 0, x/10); break;
182 viewer->drag_x = event->x;
183 viewer->drag_y = event->y;
187 static void on_view_changed(GritsViewer *viewer,
188 gdouble _1, gdouble _2, gdouble _3)
190 gtk_widget_queue_draw(GTK_WIDGET(viewer));
197 * grits_viewer_setup:
198 * @viewer: the viewer
199 * @plugins: a plugins store
200 * @prefs: a prefs store
202 * This should be called by objects which implement GritsViewer somewhere in their
205 void grits_viewer_setup(GritsViewer *viewer, GritsPlugins *plugins, GritsPrefs *prefs)
207 viewer->plugins = plugins;
208 viewer->prefs = prefs;
209 viewer->offline = grits_prefs_get_boolean(prefs, "grits/offline", NULL);
213 * grits_viewer_set_time:
214 * @viewer: the viewer
215 * @time: the time to set the view to
217 * Set the current time for the view
219 void grits_viewer_set_time(GritsViewer *viewer, time_t time)
221 g_assert(GRITS_IS_VIEWER(viewer));
222 g_debug("GritsViewer: set_time - time=%ld", time);
224 _grits_viewer_emit_time_changed(viewer);
228 * grits_viewer_get_time:
229 * @viewer: the viewer
231 * Get the time that is being viewed
233 * Returns: the current time
235 time_t grits_viewer_get_time(GritsViewer *viewer)
237 g_assert(GRITS_IS_VIEWER(viewer));
238 g_debug("GritsViewer: get_time");
243 * grits_viewer_set_location:
244 * @viewer: the viewer
245 * @lat: the new latitude
246 * @lon: the new longitude
247 * @elev: the new elevation
249 * Set the location for the camera
251 void grits_viewer_set_location(GritsViewer *viewer, gdouble lat, gdouble lon, gdouble elev)
253 g_assert(GRITS_IS_VIEWER(viewer));
254 g_debug("GritsViewer: set_location");
255 viewer->location[0] = lat;
256 viewer->location[1] = lon;
257 viewer->location[2] = elev;
258 _grits_viewer_fix_location(viewer);
259 _grits_viewer_emit_location_changed(viewer);
263 * grits_viewer_get_location:
264 * @viewer: the viewer
265 * @lat: the location to store the latitude
266 * @lon: the location to store the longitude
267 * @elev: the location to store the elevation
269 * Get the location of the camera
271 void grits_viewer_get_location(GritsViewer *viewer, gdouble *lat, gdouble *lon, gdouble *elev)
273 g_assert(GRITS_IS_VIEWER(viewer));
274 //g_debug("GritsViewer: get_location");
275 *lat = viewer->location[0];
276 *lon = viewer->location[1];
277 *elev = viewer->location[2];
282 * @viewer: the viewer
283 * @forward: distance to move forward in meters
284 * @right: distance to move right in meters
285 * @up: distance to move up in meters
287 * Pan the location by a number of meters long the surface.
289 * Bugs: the distances are not in meters
290 * Bugs: panning does not move in strait lines
292 void grits_viewer_pan(GritsViewer *viewer, gdouble forward, gdouble sideways, gdouble up)
294 g_assert(GRITS_IS_VIEWER(viewer));
295 g_debug("GritsViewer: pan - forward=%8.3f, sideways=%8.3f, up=%8.3f",
296 forward, sideways, up);
297 gdouble dist = sqrt(forward*forward + sideways*sideways);
298 gdouble angle1 = deg2rad(viewer->rotation[2]);
299 gdouble angle2 = atan2(sideways, forward);
300 gdouble angle = angle1 + angle2;
301 /* This isn't accurate, but it's usable */
302 viewer->location[0] += dist*cos(angle);
303 viewer->location[1] += dist*sin(angle);
304 viewer->location[2] += up;
305 _grits_viewer_fix_location(viewer);
306 _grits_viewer_emit_location_changed(viewer);
311 * @viewer: the viewer
312 * @scale: the scale to multiple the elevation by
314 * Multiple the elevation by a scale.
316 void grits_viewer_zoom(GritsViewer *viewer, gdouble scale)
318 g_assert(GRITS_IS_VIEWER(viewer));
319 g_debug("GritsViewer: zoom");
320 viewer->location[2] *= scale;
321 _grits_viewer_emit_location_changed(viewer);
325 * grits_viewer_set_rotation:
326 * @viewer: the viewer
327 * @x: rotation new around the x axes
328 * @y: rotation new around the y axes
329 * @z: rotation new around the z axes
331 * Set the rotations in degrees around the x, y, and z axes.
333 void grits_viewer_set_rotation(GritsViewer *viewer, gdouble x, gdouble y, gdouble z)
335 g_assert(GRITS_IS_VIEWER(viewer));
336 g_debug("GritsViewer: set_rotation");
337 viewer->rotation[0] = x;
338 viewer->rotation[1] = y;
339 viewer->rotation[2] = z;
340 _grits_viewer_fix_rotation(viewer);
341 _grits_viewer_emit_rotation_changed(viewer);
345 * grits_viewer_get_rotation:
346 * @viewer: the viewer
347 * @x: rotation around the x axes
348 * @y: rotation around the y axes
349 * @z: rotation around the z axes
351 * Get the rotations in degrees around the x, y, and z axes.
353 void grits_viewer_get_rotation(GritsViewer *viewer, gdouble *x, gdouble *y, gdouble *z)
355 g_assert(GRITS_IS_VIEWER(viewer));
356 //g_debug("GritsViewer: get_rotation");
357 *x = viewer->rotation[0];
358 *y = viewer->rotation[1];
359 *z = viewer->rotation[2];
363 * grits_viewer_rotate:
364 * @viewer: the viewer
365 * @x: rotation around the x axes
366 * @y: rotation around the y axes
367 * @z: rotation around the z axes
369 * Add to the rotation around the x, y, and z axes.
371 void grits_viewer_rotate(GritsViewer *viewer, gdouble x, gdouble y, gdouble z)
373 g_assert(GRITS_IS_VIEWER(viewer));
374 g_debug("GritsViewer: rotate - x=%.0f, y=%.0f, z=%.0f", x, y, z);
375 viewer->rotation[0] += x;
376 viewer->rotation[1] += y;
377 viewer->rotation[2] += z;
378 _grits_viewer_fix_rotation(viewer);
379 _grits_viewer_emit_rotation_changed(viewer);
383 * grits_viewer_refresh:
384 * @viewer: the viewer
386 * Trigger the refresh signal. This will cause any remote data to be checked for
389 void grits_viewer_refresh(GritsViewer *viewer)
391 g_debug("GritsViewer: refresh");
392 _grits_viewer_emit_refresh(viewer);
396 * grits_viewer_set_offline:
397 * @viewer: the viewer
398 * @offline: %TRUE to enter offline mode
400 * Set the offline mode. If @offline is %TRUE, only locally cached data will be
403 void grits_viewer_set_offline(GritsViewer *viewer, gboolean offline)
405 g_assert(GRITS_IS_VIEWER(viewer));
406 g_debug("GritsViewer: set_offline - %d", offline);
407 grits_prefs_set_boolean(viewer->prefs, "grits/offline", offline);
408 viewer->offline = offline;
409 _grits_viewer_emit_offline(viewer);
413 * grits_viewer_get_offline:
414 * @viewer: the viewer
416 * Check if the viewer is in offline mode.
418 * Returns: %TRUE if the viewer is in offline mode.
420 gboolean grits_viewer_get_offline(GritsViewer *viewer)
422 g_assert(GRITS_IS_VIEWER(viewer));
423 g_debug("GritsViewer: get_offline - %d", viewer->offline);
424 return viewer->offline;
427 /***********************************
428 * To be implemented by subclasses *
429 ***********************************/
431 * grits_viewer_center_position:
432 * @viewer: the viewer
434 * @lon: the longitude
435 * @elev: the elevation
437 * Center the viewer on a point. This can be used before drawing operations to
438 * center the items a particular location.
440 void grits_viewer_center_position(GritsViewer *viewer,
441 gdouble lat, gdouble lon, gdouble elev)
443 GritsViewerClass *klass = GRITS_VIEWER_GET_CLASS(viewer);
444 if (!klass->center_position)
445 g_warning("GritsViewer: center_position - Unimplemented");
446 klass->center_position(viewer, lat, lon, elev);
450 * grits_viewer_project:
451 * @viewer: the viewer
453 * @lon: the longitude
454 * @elev: the elevation
455 * @px: the project x coordinate
456 * @py: the project y coordinate
457 * @pz: the project z coordinate
459 * Project a latitude, longitude, elevation point to to x, y, and z coordinates
460 * in screen space. Useful for drawing orthographic data over a particular point
461 * in space. E.g. #GritsMarker.
463 void grits_viewer_project(GritsViewer *viewer,
464 gdouble lat, gdouble lon, gdouble elev,
465 gdouble *px, gdouble *py, gdouble *pz)
467 GritsViewerClass *klass = GRITS_VIEWER_GET_CLASS(viewer);
469 g_warning("GritsViewer: project - Unimplemented");
470 klass->project(viewer, lat, lon, elev, px, py, pz);
474 * grits_viewer_unproject:
475 * @viewer: the viewer
476 * @x: x coordinate in screen space
477 * @y: y coordinate in screen space
478 * @z: z coordinate in screen space, or -1 to use the value
479 * from the depth buffer at x and y as the z value
481 * @lon: the longitude
482 * @elev: the elevation
484 * Project a x, y point in screen space to a latitude, longitude, and elevation
485 * point. Useful for finding the position of the cursor or another on-screen
486 * object in world coordinates.
488 void grits_viewer_unproject(GritsViewer *viewer,
489 gdouble px, gdouble py, gdouble pz,
490 gdouble *lat, gdouble *lon, gdouble *elev)
492 GritsViewerClass *klass = GRITS_VIEWER_GET_CLASS(viewer);
493 if (!klass->unproject)
494 g_warning("GritsViewer: unproject - Unimplemented");
495 klass->unproject(viewer, px, py, pz, lat, lon, elev);
499 * grits_viewer_clear_height_func:
500 * @viewer: the viewer
502 * Clears the height function for the entire viewer. Useful when an elevation
503 * plugin is unloaded.
505 void grits_viewer_clear_height_func(GritsViewer *viewer)
507 GritsViewerClass *klass = GRITS_VIEWER_GET_CLASS(viewer);
508 if (!klass->clear_height_func)
509 g_warning("GritsViewer: clear_height_func - Unimplemented");
510 klass->clear_height_func(viewer);
514 * grits_viewer_set_height_func:
515 * @viewer: the viewer
516 * @bounds: the area to set the height function for
517 * @height_func: the height function
518 * @user_data: user data to pass to the height function
519 * @update: %TRUE if the heights inside the bounds should be updated.
521 * Set the height function to be used for a given part of the surface..
523 void grits_viewer_set_height_func(GritsViewer *viewer, GritsBounds *bounds,
524 GritsHeightFunc height_func, gpointer user_data,
527 GritsViewerClass *klass = GRITS_VIEWER_GET_CLASS(viewer);
528 if (!klass->set_height_func)
529 g_warning("GritsViewer: set_height_func - Unimplemented");
530 klass->set_height_func(viewer, bounds, height_func, user_data, update);
535 * @viewer: the viewer
536 * @object: the object to add
537 * @level: the level to add the object to
538 * @sort: %TRUE if the object should be depth-sorted prior to being drawn
540 * Objects which are added to the viewer will be drawn on subsequent renderings
541 * if their level of details is adequate.
543 * The @level represents the order the object should be drawn in, this is
544 * unrelated to the objects actual position in the world.
546 * Semi-transparent objects should set @sort to %TRUE so that they are rendered
547 * correctly when they overlap other semi-transparent objects.
549 * The viewer steals the objects reference. Call g_object_ref if you plan on
550 * holding a reference as well.
552 * Returns: a handle to be pass to grits_viewer_remove()
554 gpointer grits_viewer_add(GritsViewer *viewer, GritsObject *object,
555 gint level, gboolean sort)
557 GritsViewerClass *klass = GRITS_VIEWER_GET_CLASS(viewer);
559 g_warning("GritsViewer: add - Unimplemented");
560 object->ref = klass->add(viewer, object, level, sort);
561 object->viewer = viewer;
566 * grits_viewer_remove:
567 * @viewer: the viewer
568 * @ref: the handle obtained from grits_viewer_add()
570 * Remove an object from the viewer. The objects reference count is decremented
571 * prior to being removed.
573 * Returns: the #GritsObject referenced by the handle
575 GritsObject *grits_viewer_remove(GritsViewer *viewer, GritsObject *object)
577 GritsViewerClass *klass = GRITS_VIEWER_GET_CLASS(viewer);
579 g_warning("GritsViewer: remove - Unimplemented");
580 klass->remove(viewer, object);
587 G_DEFINE_ABSTRACT_TYPE(GritsViewer, grits_viewer, GTK_TYPE_DRAWING_AREA);
588 static void grits_viewer_init(GritsViewer *viewer)
590 g_debug("GritsViewer: init");
592 viewer->time = time(NULL);
593 viewer->location[0] = 40;
594 viewer->location[1] = -100;
595 viewer->location[2] = EARTH_R;
596 viewer->rotation[0] = 0;
597 viewer->rotation[1] = 0;
598 viewer->rotation[2] = 0;
600 g_object_set(viewer, "can-focus", TRUE, NULL);
601 gtk_widget_add_events(GTK_WIDGET(viewer),
602 GDK_BUTTON_PRESS_MASK |
603 GDK_BUTTON_RELEASE_MASK |
604 GDK_POINTER_MOTION_MASK |
607 g_signal_connect(viewer, "key-press-event", G_CALLBACK(on_key_press), NULL);
608 g_signal_connect(viewer, "scroll-event", G_CALLBACK(on_scroll), NULL);
610 g_signal_connect(viewer, "button-press-event", G_CALLBACK(on_button_press), NULL);
611 g_signal_connect(viewer, "button-release-event", G_CALLBACK(on_button_release), NULL);
612 g_signal_connect(viewer, "motion-notify-event", G_CALLBACK(on_motion_notify), NULL);
614 g_signal_connect(viewer, "location-changed", G_CALLBACK(on_view_changed), NULL);
615 g_signal_connect(viewer, "rotation-changed", G_CALLBACK(on_view_changed), NULL);
617 static void grits_viewer_finalize(GObject *gobject)
619 g_debug("GritsViewer: finalize");
620 G_OBJECT_CLASS(grits_viewer_parent_class)->finalize(gobject);
621 g_debug("GritsViewer: finalize - done");
623 static void grits_viewer_class_init(GritsViewerClass *klass)
625 g_debug("GritsViewer: class_init");
626 GObjectClass *gobject_class = G_OBJECT_CLASS(klass);
627 gobject_class->finalize = grits_viewer_finalize;
630 * GritsViewer::time-changed:
631 * @viewer: the viewer.
632 * @time: the new time.
634 * The ::time-changed signal is emitted when the viewers current time
637 signals[SIG_TIME_CHANGED] = g_signal_new(
639 G_TYPE_FROM_CLASS(gobject_class),
644 g_cclosure_marshal_VOID__LONG,
650 * GritsViewer::location-changed:
651 * @viewer: the viewer.
652 * @lat: the new latitude.
653 * @lon: the new longitude.
654 * @elev: the new elevation.
656 * The ::location-changed signal is emitted when the viewers camera
659 signals[SIG_LOCATION_CHANGED] = g_signal_new(
661 G_TYPE_FROM_CLASS(gobject_class),
666 grits_cclosure_marshal_VOID__DOUBLE_DOUBLE_DOUBLE,
674 * GritsViewer::rotation-changed:
675 * @viewer: the viewer.
676 * @x: rotation new around the x axes.
677 * @y: rotation new around the y axes.
678 * @z: rotation new around the z axes.
680 * The ::rotation-changed signal is emitted when the viewers cameras
683 signals[SIG_ROTATION_CHANGED] = g_signal_new(
685 G_TYPE_FROM_CLASS(gobject_class),
690 grits_cclosure_marshal_VOID__DOUBLE_DOUBLE_DOUBLE,
698 * GritsViewer::refresh:
699 * @viewer: the viewer.
701 * The ::refresh signal is emitted when a refresh is needed. If you are
702 * using real-time data from a remote server, you should connect to the
703 * refresh signal and update the data when necessary.
705 signals[SIG_REFRESH] = g_signal_new(
707 G_TYPE_FROM_CLASS(gobject_class),
712 g_cclosure_marshal_VOID__VOID,
717 * GritsViewer::offline:
718 * @viewer: the viewer.
719 * @offline: %TRUE if the viewer going offline.
721 * The ::offline signal is emitted when the viewers offline mode
724 signals[SIG_OFFLINE] = g_signal_new(
726 G_TYPE_FROM_CLASS(gobject_class),
731 g_cclosure_marshal_VOID__BOOLEAN,