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/>.
20 * @short_description: Virtual globe base class
22 * #GisViewer 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 "gis-marshal.h"
34 #include "gis-viewer.h"
48 static guint signals[NUM_SIGNALS];
55 static void _gis_viewer_fix_location(GisViewer *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 _gis_viewer_emit_location_changed(GisViewer *viewer)
67 g_signal_emit(viewer, signals[SIG_LOCATION_CHANGED], 0,
72 static void _gis_viewer_emit_rotation_changed(GisViewer *viewer)
74 g_signal_emit(viewer, signals[SIG_ROTATION_CHANGED], 0,
79 static void _gis_viewer_emit_time_changed(GisViewer *viewer)
81 g_signal_emit(viewer, signals[SIG_TIME_CHANGED], 0,
84 static void _gis_viewer_emit_refresh(GisViewer *viewer)
86 g_signal_emit(viewer, signals[SIG_REFRESH], 0);
88 static void _gis_viewer_emit_offline(GisViewer *viewer)
90 g_signal_emit(viewer, signals[SIG_OFFLINE], 0,
97 static gboolean on_key_press(GisViewer *viewer, GdkEventKey *event, gpointer _)
99 g_debug("GisViewer: on_key_press - key=%x, state=%x, plus=%x",
100 event->keyval, event->state, GDK_plus);
102 double lat, lon, elev, pan;
103 gis_viewer_get_location(viewer, &lat, &lon, &elev);
104 pan = MIN(elev/(EARTH_R/2), 30);
105 guint kv = event->keyval;
107 if (kv == GDK_Left || kv == GDK_h) gis_viewer_pan(viewer, 0, -pan, 0);
108 else if (kv == GDK_Down || kv == GDK_j) gis_viewer_pan(viewer, -pan, 0, 0);
109 else if (kv == GDK_Up || kv == GDK_k) gis_viewer_pan(viewer, pan, 0, 0);
110 else if (kv == GDK_Right || kv == GDK_l) gis_viewer_pan(viewer, 0, pan, 0);
111 else if (kv == GDK_minus || kv == GDK_o) gis_viewer_zoom(viewer, 10./9);
112 else if (kv == GDK_plus || kv == GDK_i) gis_viewer_zoom(viewer, 9./10);
113 else if (kv == GDK_H) gis_viewer_rotate(viewer, 0, 0, -2);
114 else if (kv == GDK_J) gis_viewer_rotate(viewer, 2, 0, 0);
115 else if (kv == GDK_K) gis_viewer_rotate(viewer, -2, 0, 0);
116 else if (kv == GDK_L) gis_viewer_rotate(viewer, 0, 0, 2);
127 static gboolean on_button_press(GisViewer *viewer, GdkEventButton *event, gpointer _)
129 g_debug("GisViewer: on_button_press - %d", event->button);
130 gtk_widget_grab_focus(GTK_WIDGET(viewer));
131 switch (event->button) {
132 case 1: viewer->drag_mode = GIS_DRAG_PAN; break;
133 case 2: viewer->drag_mode = GIS_DRAG_ZOOM; break;
134 case 3: viewer->drag_mode = GIS_DRAG_TILT; break;
135 defualt: viewer->drag_mode = GIS_DRAG_NONE; break;
137 viewer->drag_x = event->x;
138 viewer->drag_y = event->y;
142 static gboolean on_button_release(GisViewer *viewer, GdkEventButton *event, gpointer _)
144 g_debug("GisViewer: on_button_release");
145 viewer->drag_mode = GIS_DRAG_NONE;
149 static gboolean on_motion_notify(GisViewer *viewer, GdkEventMotion *event, gpointer _)
151 gdouble x_dist = viewer->drag_x - event->x;
152 gdouble y_dist = viewer->drag_y - event->y;
153 gdouble lat, lon, elev, scale;
154 gis_viewer_get_location(GIS_VIEWER(viewer), &lat, &lon, &elev);
155 scale = elev/EARTH_R/15;
156 switch (viewer->drag_mode) {
158 gis_viewer_pan(viewer, -y_dist*scale, x_dist*scale, 0);
161 gis_viewer_zoom(viewer, pow(2, -y_dist/500));
164 gis_viewer_rotate(viewer, y_dist/10, 0, x_dist/10);
167 viewer->drag_x = event->x;
168 viewer->drag_y = event->y;
172 static void on_view_changed(GisViewer *viewer,
173 gdouble _1, gdouble _2, gdouble _3)
175 gtk_widget_queue_draw(GTK_WIDGET(viewer));
183 * @viewer: the viewer
184 * @plugins: a plugins store
185 * @prefs: a prefs store
187 * This should be called by objects which implement GisViewer somewhere in their
190 void gis_viewer_setup(GisViewer *viewer, GisPlugins *plugins, GisPrefs *prefs)
192 viewer->plugins = plugins;
193 viewer->prefs = prefs;
194 viewer->offline = gis_prefs_get_boolean(prefs, "gis/offline", NULL);
198 * gis_viewer_set_time:
199 * @viewer: the viewer
200 * @time: the time to set the view to
202 * Set the current time for the view
204 void gis_viewer_set_time(GisViewer *viewer, const char *time)
206 g_assert(GIS_IS_VIEWER(viewer));
207 g_debug("GisViewer: set_time - time=%s", time);
208 g_free(viewer->time);
209 viewer->time = g_strdup(time);
210 _gis_viewer_emit_time_changed(viewer);
214 * gis_viewer_get_time:
215 * @viewer: the viewer
217 * Get the time that is being viewed
219 * Returns: the current time
221 gchar *gis_viewer_get_time(GisViewer *viewer)
223 g_assert(GIS_IS_VIEWER(viewer));
224 g_debug("GisViewer: get_time");
229 * gis_viewer_set_location:
230 * @viewer: the viewer
231 * @lat: the new latitude
232 * @lon: the new longitude
233 * @elev: the new elevation
235 * Set the location for the camera
237 void gis_viewer_set_location(GisViewer *viewer, gdouble lat, gdouble lon, gdouble elev)
239 g_assert(GIS_IS_VIEWER(viewer));
240 g_debug("GisViewer: set_location");
241 viewer->location[0] = lat;
242 viewer->location[1] = lon;
243 viewer->location[2] = elev;
244 _gis_viewer_fix_location(viewer);
245 _gis_viewer_emit_location_changed(viewer);
249 * gis_viewer_get_location:
250 * @viewer: the viewer
251 * @lat: the location to store the latitude
252 * @lon: the location to store the longitude
253 * @elev: the location to store the elevation
255 * Get the location of the camera
257 void gis_viewer_get_location(GisViewer *viewer, gdouble *lat, gdouble *lon, gdouble *elev)
259 g_assert(GIS_IS_VIEWER(viewer));
260 //g_debug("GisViewer: get_location");
261 *lat = viewer->location[0];
262 *lon = viewer->location[1];
263 *elev = viewer->location[2];
268 * @viewer: the viewer
269 * @forward: distance to move forward in meters
270 * @right: distance to move right in meters
271 * @up: distance to move up in meters
273 * Pan the location by a number of meters long the surface.
275 * Bugs: the distances are not in meters
276 * Bugs: panning does not move in strait lines
278 void gis_viewer_pan(GisViewer *viewer, gdouble forward, gdouble sideways, gdouble up)
280 g_assert(GIS_IS_VIEWER(viewer));
281 g_debug("GisViewer: pan - forward=%8.3f, sideways=%8.3f, up=%8.3f",
282 forward, sideways, up);
283 gdouble dist = sqrt(forward*forward + sideways*sideways);
284 gdouble angle1 = deg2rad(viewer->rotation[2]);
285 gdouble angle2 = atan2(sideways, forward);
286 gdouble angle = angle1 + angle2;
287 /* This isn't accurate, but it's usable */
288 viewer->location[0] += dist*cos(angle);
289 viewer->location[1] += dist*sin(angle);
290 viewer->location[2] += up;
291 _gis_viewer_fix_location(viewer);
292 _gis_viewer_emit_location_changed(viewer);
297 * @viewer: the viewer
298 * @scale: the scale to multiple the elevation by
300 * Multiple the elevation by a scale.
302 void gis_viewer_zoom(GisViewer *viewer, gdouble scale)
304 g_assert(GIS_IS_VIEWER(viewer));
305 g_debug("GisViewer: zoom");
306 viewer->location[2] *= scale;
307 _gis_viewer_emit_location_changed(viewer);
311 * gis_viewer_set_rotation:
312 * @viewer: the viewer
313 * @x: rotation new around the x axes
314 * @y: rotation new around the y axes
315 * @z: rotation new around the z axes
317 * Set the rotations in degrees around the x, y, and z axes.
319 void gis_viewer_set_rotation(GisViewer *viewer, gdouble x, gdouble y, gdouble z)
321 g_assert(GIS_IS_VIEWER(viewer));
322 g_debug("GisViewer: set_rotation");
323 viewer->rotation[0] = x;
324 viewer->rotation[1] = y;
325 viewer->rotation[2] = z;
326 _gis_viewer_emit_rotation_changed(viewer);
330 * gis_viewer_get_rotation:
331 * @viewer: the viewer
332 * @x: rotation around the x axes
333 * @y: rotation around the y axes
334 * @z: rotation around the z axes
336 * Get the rotations in degrees around the x, y, and z axes.
338 void gis_viewer_get_rotation(GisViewer *viewer, gdouble *x, gdouble *y, gdouble *z)
340 g_assert(GIS_IS_VIEWER(viewer));
341 g_debug("GisViewer: get_rotation");
342 *x = viewer->rotation[0];
343 *y = viewer->rotation[1];
344 *z = viewer->rotation[2];
349 * @viewer: the viewer
350 * @x: rotation around the x axes
351 * @y: rotation around the y axes
352 * @z: rotation around the z axes
354 * Add to the rotation around the x, y, and z axes.
356 void gis_viewer_rotate(GisViewer *viewer, gdouble x, gdouble y, gdouble z)
358 g_assert(GIS_IS_VIEWER(viewer));
359 g_debug("GisViewer: rotate - x=%.0f, y=%.0f, z=%.0f", x, y, z);
360 viewer->rotation[0] += x;
361 viewer->rotation[1] += y;
362 viewer->rotation[2] += z;
363 _gis_viewer_emit_rotation_changed(viewer);
367 * gis_viewer_refresh:
368 * @viewer: the viewer
370 * Trigger the refresh signal. This will cause any remote data to be checked for
373 void gis_viewer_refresh(GisViewer *viewer)
375 g_debug("GisViewer: refresh");
376 _gis_viewer_emit_refresh(viewer);
380 * gis_viewer_set_offline:
381 * @viewer: the viewer
382 * @offline: %TRUE to enter offline mode
384 * Set the offline mode. If @offline is %TRUE, only locally cached data will be
387 void gis_viewer_set_offline(GisViewer *viewer, gboolean offline)
389 g_assert(GIS_IS_VIEWER(viewer));
390 g_debug("GisViewer: set_offline - %d", offline);
391 gis_prefs_set_boolean(viewer->prefs, "gis/offline", offline);
392 viewer->offline = offline;
393 _gis_viewer_emit_offline(viewer);
397 * gis_viewer_get_offline:
398 * @viewer: the viewer
400 * Check if the viewer is in offline mode.
402 * Returns: %TRUE if the viewer is in offline mode.
404 gboolean gis_viewer_get_offline(GisViewer *viewer)
406 g_assert(GIS_IS_VIEWER(viewer));
407 g_debug("GisViewer: get_offline - %d", viewer->offline);
408 return viewer->offline;
411 /***********************************
412 * To be implemented by subclasses *
413 ***********************************/
415 * gis_viewer_center_position:
416 * @viewer: the viewer
418 * @lon: the longitude
419 * @elev: the elevation
421 * Center the viewer on a point. This can be used before drawing operations to
422 * center the items a particular location.
424 void gis_viewer_center_position(GisViewer *viewer,
425 gdouble lat, gdouble lon, gdouble elev)
427 GisViewerClass *klass = GIS_VIEWER_GET_CLASS(viewer);
428 if (!klass->center_position)
429 g_warning("GisViewer: center_position - Unimplemented");
430 klass->center_position(viewer, lat, lon, elev);
434 * gis_viewer_project:
435 * @viewer: the viewer
438 * @elev: the latitude
439 * @px: the project x coordinate
440 * @py: the project y coordinate
441 * @pz: the project z coordinate
443 * Project a latitude, longitude, elevation point to to x, y, and z coordinates
444 * in screen space. Useful for drawing orthographic data over a particular point
445 * in space. E.g. #GisMarker.
447 void gis_viewer_project(GisViewer *viewer,
448 gdouble lat, gdouble lon, gdouble elev,
449 gdouble *px, gdouble *py, gdouble *pz)
451 GisViewerClass *klass = GIS_VIEWER_GET_CLASS(viewer);
453 g_warning("GisViewer: project - Unimplemented");
454 klass->project(viewer, lat, lon, elev, px, py, pz);
458 * gis_viewer_clear_height_func:
459 * @viewer: the viewer
461 * Clears the height function for the entire viewer. Useful when an elevation
462 * plugin is unloaded.
464 void gis_viewer_clear_height_func(GisViewer *viewer)
466 GisViewerClass *klass = GIS_VIEWER_GET_CLASS(viewer);
467 if (!klass->clear_height_func)
468 g_warning("GisViewer: clear_height_func - Unimplemented");
469 klass->clear_height_func(viewer);
473 * gis_viewer_set_height_func:
474 * @viewer: the viewer
475 * @tile: the area to set the height function for
476 * @height_func: the height function
477 * @user_data: user data to pass to the height function
478 * @update: %TRUE if the heights inside the tile should be updated.
480 * Set the height function to be used for a given part of the surface..
482 void gis_viewer_set_height_func(GisViewer *viewer, GisTile *tile,
483 GisHeightFunc height_func, gpointer user_data,
486 GisViewerClass *klass = GIS_VIEWER_GET_CLASS(viewer);
487 if (!klass->set_height_func)
488 g_warning("GisViewer: set_height_func - Unimplemented");
489 klass->set_height_func(viewer, tile, height_func, user_data, update);
494 * @viewer: the viewer
495 * @object: the object to add
496 * @level: the level to add the object to
497 * @sort: %TRUE if the object should be depth-sorted prior to being drawn
499 * Objects which are added to the viewer will be drawn on subsequent renderings
500 * if their level of details is adequate.
502 * The @level represents the order the object should be drawn in, this is
503 * unrelated to the objects actual position in the world.
505 * Semi-transparent objects should set @sort to %TRUE so that they are rendered
506 * correctly when they overlap other semi-transparent objects.
508 * The viewer steals the objects reference. Call g_object_ref if you plan on
509 * holding a reference as well.
511 * Returns: a handle to be pass to gis_viewer_remove()
513 gpointer gis_viewer_add(GisViewer *viewer, GisObject *object,
514 gint level, gboolean sort)
516 GisViewerClass *klass = GIS_VIEWER_GET_CLASS(viewer);
518 g_warning("GisViewer: add - Unimplemented");
519 return klass->add(viewer, object, level, sort);
524 * @viewer: the viewer
525 * @ref: the handle obtained from gis_viewer_add()
527 * Remove an object from the viewer. The objects reference count is decremented
528 * prior to being removed.
530 * Returns: the #GisObject referenced by the handle
532 GisObject *gis_viewer_remove(GisViewer *viewer, gpointer ref)
534 GisViewerClass *klass = GIS_VIEWER_GET_CLASS(viewer);
536 g_warning("GisViewer: remove - Unimplemented");
537 return klass->remove(viewer, ref);
543 G_DEFINE_ABSTRACT_TYPE(GisViewer, gis_viewer, GTK_TYPE_DRAWING_AREA);
544 static void gis_viewer_init(GisViewer *viewer)
546 g_debug("GisViewer: init");
548 viewer->time = g_strdup("");
549 viewer->location[0] = 40;
550 viewer->location[1] = -100;
551 viewer->location[2] = 1.5*EARTH_R;
552 viewer->rotation[0] = 0;
553 viewer->rotation[1] = 0;
554 viewer->rotation[2] = 0;
556 g_object_set(viewer, "can-focus", TRUE, NULL);
557 gtk_widget_add_events(GTK_WIDGET(viewer),
558 GDK_BUTTON_PRESS_MASK |
559 GDK_BUTTON_RELEASE_MASK |
560 GDK_POINTER_MOTION_MASK |
563 g_signal_connect(viewer, "key-press-event", G_CALLBACK(on_key_press), NULL);
565 g_signal_connect(viewer, "button-press-event", G_CALLBACK(on_button_press), NULL);
566 g_signal_connect(viewer, "button-release-event", G_CALLBACK(on_button_release), NULL);
567 g_signal_connect(viewer, "motion-notify-event", G_CALLBACK(on_motion_notify), NULL);
569 g_signal_connect(viewer, "location-changed", G_CALLBACK(on_view_changed), NULL);
570 g_signal_connect(viewer, "rotation-changed", G_CALLBACK(on_view_changed), NULL);
572 static void gis_viewer_finalize(GObject *gobject)
574 g_debug("GisViewer: finalize");
575 GisViewer *viewer = GIS_VIEWER(gobject);
576 g_free(viewer->time);
577 G_OBJECT_CLASS(gis_viewer_parent_class)->finalize(gobject);
579 static void gis_viewer_class_init(GisViewerClass *klass)
581 g_debug("GisViewer: class_init");
582 GObjectClass *gobject_class = G_OBJECT_CLASS(klass);
583 gobject_class->finalize = gis_viewer_finalize;
586 * GisViewer::time-changed:
587 * @viewer: the viewer.
588 * @time: a string representation of the time.
590 * The ::time-changed signal is emitted when the viewers current time
593 signals[SIG_TIME_CHANGED] = g_signal_new(
595 G_TYPE_FROM_CLASS(gobject_class),
600 g_cclosure_marshal_VOID__STRING,
606 * GisViewer::location-changed:
607 * @viewer: the viewer.
608 * @lat: the new latitude.
609 * @lon: the new longitude.
610 * @elev: the new elevation.
612 * The ::location-changed signal is emitted when the viewers camera
615 signals[SIG_LOCATION_CHANGED] = g_signal_new(
617 G_TYPE_FROM_CLASS(gobject_class),
622 gis_cclosure_marshal_VOID__DOUBLE_DOUBLE_DOUBLE,
630 * GisViewer::rotation-changed:
631 * @viewer: the viewer.
632 * @x: rotation new around the x axes.
633 * @y: rotation new around the y axes.
634 * @z: rotation new around the z axes.
636 * The ::rotation-changed signal is emitted when the viewers cameras
639 signals[SIG_ROTATION_CHANGED] = g_signal_new(
641 G_TYPE_FROM_CLASS(gobject_class),
646 gis_cclosure_marshal_VOID__DOUBLE_DOUBLE_DOUBLE,
654 * GisViewer::refresh:
655 * @viewer: the viewer.
657 * The ::refresh signal is emitted when a refresh is needed. If you are
658 * using real-time data from a remote server, you should connect to the
659 * refresh signal and update the data when necessary.
661 signals[SIG_REFRESH] = g_signal_new(
663 G_TYPE_FROM_CLASS(gobject_class),
668 g_cclosure_marshal_VOID__VOID,
673 * GisViewer::offline:
674 * @viewer: the viewer.
675 * @offline: %TRUE if the viewer going offline.
677 * The ::offline signal is emitted when the viewers offline mode
680 signals[SIG_OFFLINE] = g_signal_new(
682 G_TYPE_FROM_CLASS(gobject_class),
687 g_cclosure_marshal_VOID__BOOLEAN,