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]);
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/14.1) * (sin(deg2rad(ABS(rx)))*4+1);
167 switch (viewer->drag_mode) {
168 case GRITS_DRAG_PAN: grits_viewer_pan(viewer, -y*scale*0.782, 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));
187 * grits_viewer_setup:
188 * @viewer: the viewer
189 * @plugins: a plugins store
190 * @prefs: a prefs store
192 * This should be called by objects which implement GritsViewer somewhere in their
195 void grits_viewer_setup(GritsViewer *viewer, GritsPlugins *plugins, GritsPrefs *prefs)
197 viewer->plugins = plugins;
198 viewer->prefs = prefs;
199 viewer->offline = grits_prefs_get_boolean(prefs, "grits/offline", NULL);
203 * grits_viewer_set_time:
204 * @viewer: the viewer
205 * @time: the time to set the view to
207 * Set the current time for the view
209 void grits_viewer_set_time(GritsViewer *viewer, time_t time)
211 g_assert(GRITS_IS_VIEWER(viewer));
212 g_debug("GritsViewer: set_time - time=%ld", time);
214 _grits_viewer_emit_time_changed(viewer);
218 * grits_viewer_get_time:
219 * @viewer: the viewer
221 * Get the time that is being viewed
223 * Returns: the current time
225 time_t grits_viewer_get_time(GritsViewer *viewer)
227 g_assert(GRITS_IS_VIEWER(viewer));
228 g_debug("GritsViewer: get_time");
233 * grits_viewer_set_location:
234 * @viewer: the viewer
235 * @lat: the new latitude
236 * @lon: the new longitude
237 * @elev: the new elevation
239 * Set the location for the camera
241 void grits_viewer_set_location(GritsViewer *viewer, gdouble lat, gdouble lon, gdouble elev)
243 g_assert(GRITS_IS_VIEWER(viewer));
244 g_debug("GritsViewer: set_location");
245 viewer->location[0] = lat;
246 viewer->location[1] = lon;
247 viewer->location[2] = elev;
248 _grits_viewer_fix_location(viewer);
249 _grits_viewer_emit_location_changed(viewer);
253 * grits_viewer_get_location:
254 * @viewer: the viewer
255 * @lat: the location to store the latitude
256 * @lon: the location to store the longitude
257 * @elev: the location to store the elevation
259 * Get the location of the camera
261 void grits_viewer_get_location(GritsViewer *viewer, gdouble *lat, gdouble *lon, gdouble *elev)
263 g_assert(GRITS_IS_VIEWER(viewer));
264 //g_debug("GritsViewer: get_location");
265 *lat = viewer->location[0];
266 *lon = viewer->location[1];
267 *elev = viewer->location[2];
272 * @viewer: the viewer
273 * @forward: distance to move forward in meters
274 * @right: distance to move right in meters
275 * @up: distance to move up in meters
277 * Pan the location by a number of meters long the surface.
279 * Bugs: the distances are not in meters
280 * Bugs: panning does not move in strait lines
282 void grits_viewer_pan(GritsViewer *viewer, gdouble forward, gdouble sideways, gdouble up)
284 g_assert(GRITS_IS_VIEWER(viewer));
285 g_debug("GritsViewer: pan - forward=%8.3f, sideways=%8.3f, up=%8.3f",
286 forward, sideways, up);
287 gdouble dist = sqrt(forward*forward + sideways*sideways);
288 gdouble angle1 = deg2rad(viewer->rotation[2]);
289 gdouble angle2 = atan2(sideways, forward);
290 gdouble angle = angle1 + angle2;
291 /* This isn't accurate, but it's usable */
292 viewer->location[0] += dist*cos(angle);
293 viewer->location[1] += dist*sin(angle);
294 viewer->location[2] += up;
295 _grits_viewer_fix_location(viewer);
296 _grits_viewer_emit_location_changed(viewer);
301 * @viewer: the viewer
302 * @scale: the scale to multiple the elevation by
304 * Multiple the elevation by a scale.
306 void grits_viewer_zoom(GritsViewer *viewer, gdouble scale)
308 g_assert(GRITS_IS_VIEWER(viewer));
309 g_debug("GritsViewer: zoom");
310 viewer->location[2] *= scale;
311 _grits_viewer_emit_location_changed(viewer);
315 * grits_viewer_set_rotation:
316 * @viewer: the viewer
317 * @x: rotation new around the x axes
318 * @y: rotation new around the y axes
319 * @z: rotation new around the z axes
321 * Set the rotations in degrees around the x, y, and z axes.
323 void grits_viewer_set_rotation(GritsViewer *viewer, gdouble x, gdouble y, gdouble z)
325 g_assert(GRITS_IS_VIEWER(viewer));
326 g_debug("GritsViewer: set_rotation");
327 viewer->rotation[0] = x;
328 viewer->rotation[1] = y;
329 viewer->rotation[2] = z;
330 _grits_viewer_emit_rotation_changed(viewer);
334 * grits_viewer_get_rotation:
335 * @viewer: the viewer
336 * @x: rotation around the x axes
337 * @y: rotation around the y axes
338 * @z: rotation around the z axes
340 * Get the rotations in degrees around the x, y, and z axes.
342 void grits_viewer_get_rotation(GritsViewer *viewer, gdouble *x, gdouble *y, gdouble *z)
344 g_assert(GRITS_IS_VIEWER(viewer));
345 //g_debug("GritsViewer: get_rotation");
346 *x = viewer->rotation[0];
347 *y = viewer->rotation[1];
348 *z = viewer->rotation[2];
352 * grits_viewer_rotate:
353 * @viewer: the viewer
354 * @x: rotation around the x axes
355 * @y: rotation around the y axes
356 * @z: rotation around the z axes
358 * Add to the rotation around the x, y, and z axes.
360 void grits_viewer_rotate(GritsViewer *viewer, gdouble x, gdouble y, gdouble z)
362 g_assert(GRITS_IS_VIEWER(viewer));
363 g_debug("GritsViewer: rotate - x=%.0f, y=%.0f, z=%.0f", x, y, z);
364 viewer->rotation[0] += x;
365 viewer->rotation[1] += y;
366 viewer->rotation[2] += z;
367 _grits_viewer_emit_rotation_changed(viewer);
371 * grits_viewer_refresh:
372 * @viewer: the viewer
374 * Trigger the refresh signal. This will cause any remote data to be checked for
377 void grits_viewer_refresh(GritsViewer *viewer)
379 g_debug("GritsViewer: refresh");
380 _grits_viewer_emit_refresh(viewer);
384 * grits_viewer_set_offline:
385 * @viewer: the viewer
386 * @offline: %TRUE to enter offline mode
388 * Set the offline mode. If @offline is %TRUE, only locally cached data will be
391 void grits_viewer_set_offline(GritsViewer *viewer, gboolean offline)
393 g_assert(GRITS_IS_VIEWER(viewer));
394 g_debug("GritsViewer: set_offline - %d", offline);
395 grits_prefs_set_boolean(viewer->prefs, "grits/offline", offline);
396 viewer->offline = offline;
397 _grits_viewer_emit_offline(viewer);
401 * grits_viewer_get_offline:
402 * @viewer: the viewer
404 * Check if the viewer is in offline mode.
406 * Returns: %TRUE if the viewer is in offline mode.
408 gboolean grits_viewer_get_offline(GritsViewer *viewer)
410 g_assert(GRITS_IS_VIEWER(viewer));
411 g_debug("GritsViewer: get_offline - %d", viewer->offline);
412 return viewer->offline;
415 /***********************************
416 * To be implemented by subclasses *
417 ***********************************/
419 * grits_viewer_center_position:
420 * @viewer: the viewer
422 * @lon: the longitude
423 * @elev: the elevation
425 * Center the viewer on a point. This can be used before drawing operations to
426 * center the items a particular location.
428 void grits_viewer_center_position(GritsViewer *viewer,
429 gdouble lat, gdouble lon, gdouble elev)
431 GritsViewerClass *klass = GRITS_VIEWER_GET_CLASS(viewer);
432 if (!klass->center_position)
433 g_warning("GritsViewer: center_position - Unimplemented");
434 klass->center_position(viewer, lat, lon, elev);
438 * grits_viewer_project:
439 * @viewer: the viewer
441 * @lon: the longitude
442 * @elev: the elevation
443 * @px: the project x coordinate
444 * @py: the project y coordinate
445 * @pz: the project z coordinate
447 * Project a latitude, longitude, elevation point to to x, y, and z coordinates
448 * in screen space. Useful for drawing orthographic data over a particular point
449 * in space. E.g. #GritsMarker.
451 void grits_viewer_project(GritsViewer *viewer,
452 gdouble lat, gdouble lon, gdouble elev,
453 gdouble *px, gdouble *py, gdouble *pz)
455 GritsViewerClass *klass = GRITS_VIEWER_GET_CLASS(viewer);
457 g_warning("GritsViewer: project - Unimplemented");
458 klass->project(viewer, lat, lon, elev, px, py, pz);
462 * grits_viewer_unproject:
463 * @viewer: the viewer
464 * @x: x coordinate in screen space
465 * @y: y coordinate in screen space
466 * @z: z coordinate in screen space, or -1 to use the value
467 * from the depth buffer at x and y as the z value
469 * @lon: the longitude
470 * @elev: the elevation
472 * Project a x, y point in screen space to a latitude, longitude, and elevation
473 * point. Useful for finding the position of the cursor or another on-screen
474 * object in world coordinates.
476 void grits_viewer_unproject(GritsViewer *viewer,
477 gdouble px, gdouble py, gdouble pz,
478 gdouble *lat, gdouble *lon, gdouble *elev)
480 GritsViewerClass *klass = GRITS_VIEWER_GET_CLASS(viewer);
481 if (!klass->unproject)
482 g_warning("GritsViewer: unproject - Unimplemented");
483 klass->unproject(viewer, px, py, pz, lat, lon, elev);
487 * grits_viewer_clear_height_func:
488 * @viewer: the viewer
490 * Clears the height function for the entire viewer. Useful when an elevation
491 * plugin is unloaded.
493 void grits_viewer_clear_height_func(GritsViewer *viewer)
495 GritsViewerClass *klass = GRITS_VIEWER_GET_CLASS(viewer);
496 if (!klass->clear_height_func)
497 g_warning("GritsViewer: clear_height_func - Unimplemented");
498 klass->clear_height_func(viewer);
502 * grits_viewer_set_height_func:
503 * @viewer: the viewer
504 * @bounds: the area to set the height function for
505 * @height_func: the height function
506 * @user_data: user data to pass to the height function
507 * @update: %TRUE if the heights inside the bounds should be updated.
509 * Set the height function to be used for a given part of the surface..
511 void grits_viewer_set_height_func(GritsViewer *viewer, GritsBounds *bounds,
512 GritsHeightFunc height_func, gpointer user_data,
515 GritsViewerClass *klass = GRITS_VIEWER_GET_CLASS(viewer);
516 if (!klass->set_height_func)
517 g_warning("GritsViewer: set_height_func - Unimplemented");
518 klass->set_height_func(viewer, bounds, height_func, user_data, update);
523 * @viewer: the viewer
524 * @object: the object to add
525 * @level: the level to add the object to
526 * @sort: %TRUE if the object should be depth-sorted prior to being drawn
528 * Objects which are added to the viewer will be drawn on subsequent renderings
529 * if their level of details is adequate.
531 * The @level represents the order the object should be drawn in, this is
532 * unrelated to the objects actual position in the world.
534 * Semi-transparent objects should set @sort to %TRUE so that they are rendered
535 * correctly when they overlap other semi-transparent objects.
537 * The viewer steals the objects reference. Call g_object_ref if you plan on
538 * holding a reference as well.
540 * Returns: a handle to be pass to grits_viewer_remove()
542 gpointer grits_viewer_add(GritsViewer *viewer, GritsObject *object,
543 gint level, gboolean sort)
545 GritsViewerClass *klass = GRITS_VIEWER_GET_CLASS(viewer);
547 g_warning("GritsViewer: add - Unimplemented");
548 object->ref = klass->add(viewer, object, level, sort);
549 object->viewer = viewer;
554 * grits_viewer_remove:
555 * @viewer: the viewer
556 * @ref: the handle obtained from grits_viewer_add()
558 * Remove an object from the viewer. The objects reference count is decremented
559 * prior to being removed.
561 * Returns: the #GritsObject referenced by the handle
563 GritsObject *grits_viewer_remove(GritsViewer *viewer, GritsObject *object)
565 GritsViewerClass *klass = GRITS_VIEWER_GET_CLASS(viewer);
567 g_warning("GritsViewer: remove - Unimplemented");
568 klass->remove(viewer, object);
575 G_DEFINE_ABSTRACT_TYPE(GritsViewer, grits_viewer, GTK_TYPE_DRAWING_AREA);
576 static void grits_viewer_init(GritsViewer *viewer)
578 g_debug("GritsViewer: init");
580 viewer->time = time(NULL);
581 viewer->location[0] = 40;
582 viewer->location[1] = -100;
583 viewer->location[2] = EARTH_R;
584 viewer->rotation[0] = 0;
585 viewer->rotation[1] = 0;
586 viewer->rotation[2] = 0;
588 g_object_set(viewer, "can-focus", TRUE, NULL);
589 gtk_widget_add_events(GTK_WIDGET(viewer),
590 GDK_BUTTON_PRESS_MASK |
591 GDK_BUTTON_RELEASE_MASK |
592 GDK_POINTER_MOTION_MASK |
595 g_signal_connect(viewer, "key-press-event", G_CALLBACK(on_key_press), NULL);
596 g_signal_connect(viewer, "scroll-event", G_CALLBACK(on_scroll), NULL);
598 g_signal_connect(viewer, "button-press-event", G_CALLBACK(on_button_press), NULL);
599 g_signal_connect(viewer, "button-release-event", G_CALLBACK(on_button_release), NULL);
600 g_signal_connect(viewer, "motion-notify-event", G_CALLBACK(on_motion_notify), NULL);
602 g_signal_connect(viewer, "location-changed", G_CALLBACK(on_view_changed), NULL);
603 g_signal_connect(viewer, "rotation-changed", G_CALLBACK(on_view_changed), NULL);
605 static void grits_viewer_finalize(GObject *gobject)
607 g_debug("GritsViewer: finalize");
608 G_OBJECT_CLASS(grits_viewer_parent_class)->finalize(gobject);
609 g_debug("GritsViewer: finalize - done");
611 static void grits_viewer_class_init(GritsViewerClass *klass)
613 g_debug("GritsViewer: class_init");
614 GObjectClass *gobject_class = G_OBJECT_CLASS(klass);
615 gobject_class->finalize = grits_viewer_finalize;
618 * GritsViewer::time-changed:
619 * @viewer: the viewer.
620 * @time: the new time.
622 * The ::time-changed signal is emitted when the viewers current time
625 signals[SIG_TIME_CHANGED] = g_signal_new(
627 G_TYPE_FROM_CLASS(gobject_class),
632 g_cclosure_marshal_VOID__LONG,
638 * GritsViewer::location-changed:
639 * @viewer: the viewer.
640 * @lat: the new latitude.
641 * @lon: the new longitude.
642 * @elev: the new elevation.
644 * The ::location-changed signal is emitted when the viewers camera
647 signals[SIG_LOCATION_CHANGED] = g_signal_new(
649 G_TYPE_FROM_CLASS(gobject_class),
654 grits_cclosure_marshal_VOID__DOUBLE_DOUBLE_DOUBLE,
662 * GritsViewer::rotation-changed:
663 * @viewer: the viewer.
664 * @x: rotation new around the x axes.
665 * @y: rotation new around the y axes.
666 * @z: rotation new around the z axes.
668 * The ::rotation-changed signal is emitted when the viewers cameras
671 signals[SIG_ROTATION_CHANGED] = g_signal_new(
673 G_TYPE_FROM_CLASS(gobject_class),
678 grits_cclosure_marshal_VOID__DOUBLE_DOUBLE_DOUBLE,
686 * GritsViewer::refresh:
687 * @viewer: the viewer.
689 * The ::refresh signal is emitted when a refresh is needed. If you are
690 * using real-time data from a remote server, you should connect to the
691 * refresh signal and update the data when necessary.
693 signals[SIG_REFRESH] = g_signal_new(
695 G_TYPE_FROM_CLASS(gobject_class),
700 g_cclosure_marshal_VOID__VOID,
705 * GritsViewer::offline:
706 * @viewer: the viewer.
707 * @offline: %TRUE if the viewer going offline.
709 * The ::offline signal is emitted when the viewers offline mode
712 signals[SIG_OFFLINE] = g_signal_new(
714 G_TYPE_FROM_CLASS(gobject_class),
719 g_cclosure_marshal_VOID__BOOLEAN,