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 switch (event->keyval) {
106 case GDK_Left: case GDK_h: gis_viewer_pan(viewer, 0, -pan, 0); break;
107 case GDK_Down: case GDK_j: gis_viewer_pan(viewer, -pan, 0, 0); break;
108 case GDK_Up: case GDK_k: gis_viewer_pan(viewer, pan, 0, 0); break;
109 case GDK_Right: case GDK_l: gis_viewer_pan(viewer, 0, pan, 0); break;
110 case GDK_minus: case GDK_o: gis_viewer_zoom(viewer, 10./9); break;
111 case GDK_plus: case GDK_i: gis_viewer_zoom(viewer, 9./10); break;
112 case GDK_H: gis_viewer_rotate(viewer, 0, 0, -2); break;
113 case GDK_J: gis_viewer_rotate(viewer, 2, 0, 0); break;
114 case GDK_K: gis_viewer_rotate(viewer, -2, 0, 0); break;
115 case GDK_L: gis_viewer_rotate(viewer, 0, 0, 2); break;
120 static gboolean on_scroll(GisViewer *viewer, GdkEventScroll *event, gpointer _)
122 switch (event->direction) {
123 case GDK_SCROLL_DOWN: gis_viewer_zoom(viewer, 10./9); break;
124 case GDK_SCROLL_UP: gis_viewer_zoom(viewer, 9./10); break;
137 static gboolean on_button_press(GisViewer *viewer, GdkEventButton *event, gpointer _)
139 g_debug("GisViewer: on_button_press - %d", event->button);
140 gtk_widget_grab_focus(GTK_WIDGET(viewer));
141 switch (event->button) {
142 case 1: viewer->drag_mode = GIS_DRAG_PAN; break;
143 case 2: viewer->drag_mode = GIS_DRAG_ZOOM; break;
144 case 3: viewer->drag_mode = GIS_DRAG_TILT; break;
145 default: viewer->drag_mode = GIS_DRAG_NONE; break;
147 viewer->drag_x = event->x;
148 viewer->drag_y = event->y;
152 static gboolean on_button_release(GisViewer *viewer, GdkEventButton *event, gpointer _)
154 g_debug("GisViewer: on_button_release");
155 viewer->drag_mode = GIS_DRAG_NONE;
159 static gboolean on_motion_notify(GisViewer *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;
164 gis_viewer_get_location(GIS_VIEWER(viewer), &lat, &lon, &elev);
165 scale = elev/EARTH_R/15;
166 switch (viewer->drag_mode) {
167 case GIS_DRAG_PAN: gis_viewer_pan(viewer, -y*scale, x*scale, 0); break;
168 case GIS_DRAG_ZOOM: gis_viewer_zoom(viewer, pow(2, -y/500)); break;
169 case GIS_DRAG_TILT: gis_viewer_rotate(viewer, y/10, 0, x/10); break;
171 viewer->drag_x = event->x;
172 viewer->drag_y = event->y;
176 static void on_view_changed(GisViewer *viewer,
177 gdouble _1, gdouble _2, gdouble _3)
179 gtk_widget_queue_draw(GTK_WIDGET(viewer));
182 static void on_realize(GisViewer *viewer)
184 GdkCursor *cursor = gdk_cursor_new(GDK_FLEUR);
185 GdkWindow *window = gtk_widget_get_window(GTK_WIDGET(viewer));
186 gdk_window_set_cursor(window, cursor);
194 * @viewer: the viewer
195 * @plugins: a plugins store
196 * @prefs: a prefs store
198 * This should be called by objects which implement GisViewer somewhere in their
201 void gis_viewer_setup(GisViewer *viewer, GisPlugins *plugins, GisPrefs *prefs)
203 viewer->plugins = plugins;
204 viewer->prefs = prefs;
205 viewer->offline = gis_prefs_get_boolean(prefs, "gis/offline", NULL);
209 * gis_viewer_set_time:
210 * @viewer: the viewer
211 * @time: the time to set the view to
213 * Set the current time for the view
215 void gis_viewer_set_time(GisViewer *viewer, time_t time)
217 g_assert(GIS_IS_VIEWER(viewer));
218 g_debug("GisViewer: set_time - time=%ld", time);
220 _gis_viewer_emit_time_changed(viewer);
224 * gis_viewer_get_time:
225 * @viewer: the viewer
227 * Get the time that is being viewed
229 * Returns: the current time
231 time_t gis_viewer_get_time(GisViewer *viewer)
233 g_assert(GIS_IS_VIEWER(viewer));
234 g_debug("GisViewer: get_time");
239 * gis_viewer_set_location:
240 * @viewer: the viewer
241 * @lat: the new latitude
242 * @lon: the new longitude
243 * @elev: the new elevation
245 * Set the location for the camera
247 void gis_viewer_set_location(GisViewer *viewer, gdouble lat, gdouble lon, gdouble elev)
249 g_assert(GIS_IS_VIEWER(viewer));
250 g_debug("GisViewer: set_location");
251 viewer->location[0] = lat;
252 viewer->location[1] = lon;
253 viewer->location[2] = elev;
254 _gis_viewer_fix_location(viewer);
255 _gis_viewer_emit_location_changed(viewer);
259 * gis_viewer_get_location:
260 * @viewer: the viewer
261 * @lat: the location to store the latitude
262 * @lon: the location to store the longitude
263 * @elev: the location to store the elevation
265 * Get the location of the camera
267 void gis_viewer_get_location(GisViewer *viewer, gdouble *lat, gdouble *lon, gdouble *elev)
269 g_assert(GIS_IS_VIEWER(viewer));
270 //g_debug("GisViewer: get_location");
271 *lat = viewer->location[0];
272 *lon = viewer->location[1];
273 *elev = viewer->location[2];
278 * @viewer: the viewer
279 * @forward: distance to move forward in meters
280 * @right: distance to move right in meters
281 * @up: distance to move up in meters
283 * Pan the location by a number of meters long the surface.
285 * Bugs: the distances are not in meters
286 * Bugs: panning does not move in strait lines
288 void gis_viewer_pan(GisViewer *viewer, gdouble forward, gdouble sideways, gdouble up)
290 g_assert(GIS_IS_VIEWER(viewer));
291 g_debug("GisViewer: pan - forward=%8.3f, sideways=%8.3f, up=%8.3f",
292 forward, sideways, up);
293 gdouble dist = sqrt(forward*forward + sideways*sideways);
294 gdouble angle1 = deg2rad(viewer->rotation[2]);
295 gdouble angle2 = atan2(sideways, forward);
296 gdouble angle = angle1 + angle2;
297 /* This isn't accurate, but it's usable */
298 viewer->location[0] += dist*cos(angle);
299 viewer->location[1] += dist*sin(angle);
300 viewer->location[2] += up;
301 _gis_viewer_fix_location(viewer);
302 _gis_viewer_emit_location_changed(viewer);
307 * @viewer: the viewer
308 * @scale: the scale to multiple the elevation by
310 * Multiple the elevation by a scale.
312 void gis_viewer_zoom(GisViewer *viewer, gdouble scale)
314 g_assert(GIS_IS_VIEWER(viewer));
315 g_debug("GisViewer: zoom");
316 viewer->location[2] *= scale;
317 _gis_viewer_emit_location_changed(viewer);
321 * gis_viewer_set_rotation:
322 * @viewer: the viewer
323 * @x: rotation new around the x axes
324 * @y: rotation new around the y axes
325 * @z: rotation new around the z axes
327 * Set the rotations in degrees around the x, y, and z axes.
329 void gis_viewer_set_rotation(GisViewer *viewer, gdouble x, gdouble y, gdouble z)
331 g_assert(GIS_IS_VIEWER(viewer));
332 g_debug("GisViewer: set_rotation");
333 viewer->rotation[0] = x;
334 viewer->rotation[1] = y;
335 viewer->rotation[2] = z;
336 _gis_viewer_emit_rotation_changed(viewer);
340 * gis_viewer_get_rotation:
341 * @viewer: the viewer
342 * @x: rotation around the x axes
343 * @y: rotation around the y axes
344 * @z: rotation around the z axes
346 * Get the rotations in degrees around the x, y, and z axes.
348 void gis_viewer_get_rotation(GisViewer *viewer, gdouble *x, gdouble *y, gdouble *z)
350 g_assert(GIS_IS_VIEWER(viewer));
351 g_debug("GisViewer: get_rotation");
352 *x = viewer->rotation[0];
353 *y = viewer->rotation[1];
354 *z = viewer->rotation[2];
359 * @viewer: the viewer
360 * @x: rotation around the x axes
361 * @y: rotation around the y axes
362 * @z: rotation around the z axes
364 * Add to the rotation around the x, y, and z axes.
366 void gis_viewer_rotate(GisViewer *viewer, gdouble x, gdouble y, gdouble z)
368 g_assert(GIS_IS_VIEWER(viewer));
369 g_debug("GisViewer: rotate - x=%.0f, y=%.0f, z=%.0f", x, y, z);
370 viewer->rotation[0] += x;
371 viewer->rotation[1] += y;
372 viewer->rotation[2] += z;
373 _gis_viewer_emit_rotation_changed(viewer);
377 * gis_viewer_refresh:
378 * @viewer: the viewer
380 * Trigger the refresh signal. This will cause any remote data to be checked for
383 void gis_viewer_refresh(GisViewer *viewer)
385 g_debug("GisViewer: refresh");
386 _gis_viewer_emit_refresh(viewer);
390 * gis_viewer_set_offline:
391 * @viewer: the viewer
392 * @offline: %TRUE to enter offline mode
394 * Set the offline mode. If @offline is %TRUE, only locally cached data will be
397 void gis_viewer_set_offline(GisViewer *viewer, gboolean offline)
399 g_assert(GIS_IS_VIEWER(viewer));
400 g_debug("GisViewer: set_offline - %d", offline);
401 gis_prefs_set_boolean(viewer->prefs, "gis/offline", offline);
402 viewer->offline = offline;
403 _gis_viewer_emit_offline(viewer);
407 * gis_viewer_get_offline:
408 * @viewer: the viewer
410 * Check if the viewer is in offline mode.
412 * Returns: %TRUE if the viewer is in offline mode.
414 gboolean gis_viewer_get_offline(GisViewer *viewer)
416 g_assert(GIS_IS_VIEWER(viewer));
417 g_debug("GisViewer: get_offline - %d", viewer->offline);
418 return viewer->offline;
421 /***********************************
422 * To be implemented by subclasses *
423 ***********************************/
425 * gis_viewer_center_position:
426 * @viewer: the viewer
428 * @lon: the longitude
429 * @elev: the elevation
431 * Center the viewer on a point. This can be used before drawing operations to
432 * center the items a particular location.
434 void gis_viewer_center_position(GisViewer *viewer,
435 gdouble lat, gdouble lon, gdouble elev)
437 GisViewerClass *klass = GIS_VIEWER_GET_CLASS(viewer);
438 if (!klass->center_position)
439 g_warning("GisViewer: center_position - Unimplemented");
440 klass->center_position(viewer, lat, lon, elev);
444 * gis_viewer_project:
445 * @viewer: the viewer
448 * @elev: the latitude
449 * @px: the project x coordinate
450 * @py: the project y coordinate
451 * @pz: the project z coordinate
453 * Project a latitude, longitude, elevation point to to x, y, and z coordinates
454 * in screen space. Useful for drawing orthographic data over a particular point
455 * in space. E.g. #GisMarker.
457 void gis_viewer_project(GisViewer *viewer,
458 gdouble lat, gdouble lon, gdouble elev,
459 gdouble *px, gdouble *py, gdouble *pz)
461 GisViewerClass *klass = GIS_VIEWER_GET_CLASS(viewer);
463 g_warning("GisViewer: project - Unimplemented");
464 klass->project(viewer, lat, lon, elev, px, py, pz);
468 * gis_viewer_clear_height_func:
469 * @viewer: the viewer
471 * Clears the height function for the entire viewer. Useful when an elevation
472 * plugin is unloaded.
474 void gis_viewer_clear_height_func(GisViewer *viewer)
476 GisViewerClass *klass = GIS_VIEWER_GET_CLASS(viewer);
477 if (!klass->clear_height_func)
478 g_warning("GisViewer: clear_height_func - Unimplemented");
479 klass->clear_height_func(viewer);
483 * gis_viewer_set_height_func:
484 * @viewer: the viewer
485 * @bounds: the area to set the height function for
486 * @height_func: the height function
487 * @user_data: user data to pass to the height function
488 * @update: %TRUE if the heights inside the bounds should be updated.
490 * Set the height function to be used for a given part of the surface..
492 void gis_viewer_set_height_func(GisViewer *viewer, GisBounds *bounds,
493 GisHeightFunc height_func, gpointer user_data,
496 GisViewerClass *klass = GIS_VIEWER_GET_CLASS(viewer);
497 if (!klass->set_height_func)
498 g_warning("GisViewer: set_height_func - Unimplemented");
499 klass->set_height_func(viewer, bounds, height_func, user_data, update);
504 * @viewer: the viewer
505 * @object: the object to add
506 * @level: the level to add the object to
507 * @sort: %TRUE if the object should be depth-sorted prior to being drawn
509 * Objects which are added to the viewer will be drawn on subsequent renderings
510 * if their level of details is adequate.
512 * The @level represents the order the object should be drawn in, this is
513 * unrelated to the objects actual position in the world.
515 * Semi-transparent objects should set @sort to %TRUE so that they are rendered
516 * correctly when they overlap other semi-transparent objects.
518 * The viewer steals the objects reference. Call g_object_ref if you plan on
519 * holding a reference as well.
521 * Returns: a handle to be pass to gis_viewer_remove()
523 gpointer gis_viewer_add(GisViewer *viewer, GisObject *object,
524 gint level, gboolean sort)
526 GisViewerClass *klass = GIS_VIEWER_GET_CLASS(viewer);
528 g_warning("GisViewer: add - Unimplemented");
529 return klass->add(viewer, object, level, sort);
534 * @viewer: the viewer
535 * @ref: the handle obtained from gis_viewer_add()
537 * Remove an object from the viewer. The objects reference count is decremented
538 * prior to being removed.
540 * Returns: the #GisObject referenced by the handle
542 GisObject *gis_viewer_remove(GisViewer *viewer, gpointer ref)
544 GisViewerClass *klass = GIS_VIEWER_GET_CLASS(viewer);
546 g_warning("GisViewer: remove - Unimplemented");
547 return klass->remove(viewer, ref);
553 G_DEFINE_ABSTRACT_TYPE(GisViewer, gis_viewer, GTK_TYPE_DRAWING_AREA);
554 static void gis_viewer_init(GisViewer *viewer)
556 g_debug("GisViewer: init");
558 viewer->time = time(NULL);
559 viewer->location[0] = 40;
560 viewer->location[1] = -100;
561 viewer->location[2] = 1.5*EARTH_R;
562 viewer->rotation[0] = 0;
563 viewer->rotation[1] = 0;
564 viewer->rotation[2] = 0;
566 g_object_set(viewer, "can-focus", TRUE, NULL);
567 gtk_widget_add_events(GTK_WIDGET(viewer),
568 GDK_BUTTON_PRESS_MASK |
569 GDK_BUTTON_RELEASE_MASK |
570 GDK_POINTER_MOTION_MASK |
573 g_signal_connect(viewer, "key-press-event", G_CALLBACK(on_key_press), NULL);
574 g_signal_connect(viewer, "scroll-event", G_CALLBACK(on_scroll), NULL);
576 g_signal_connect(viewer, "button-press-event", G_CALLBACK(on_button_press), NULL);
577 g_signal_connect(viewer, "button-release-event", G_CALLBACK(on_button_release), NULL);
578 g_signal_connect(viewer, "motion-notify-event", G_CALLBACK(on_motion_notify), NULL);
580 g_signal_connect(viewer, "location-changed", G_CALLBACK(on_view_changed), NULL);
581 g_signal_connect(viewer, "rotation-changed", G_CALLBACK(on_view_changed), NULL);
583 g_signal_connect(viewer, "realize", G_CALLBACK(on_realize), NULL);
585 static void gis_viewer_finalize(GObject *gobject)
587 g_debug("GisViewer: finalize");
588 G_OBJECT_CLASS(gis_viewer_parent_class)->finalize(gobject);
590 static void gis_viewer_class_init(GisViewerClass *klass)
592 g_debug("GisViewer: class_init");
593 GObjectClass *gobject_class = G_OBJECT_CLASS(klass);
594 gobject_class->finalize = gis_viewer_finalize;
597 * GisViewer::time-changed:
598 * @viewer: the viewer.
599 * @time: the new time.
601 * The ::time-changed signal is emitted when the viewers current time
604 signals[SIG_TIME_CHANGED] = g_signal_new(
606 G_TYPE_FROM_CLASS(gobject_class),
611 g_cclosure_marshal_VOID__LONG,
617 * GisViewer::location-changed:
618 * @viewer: the viewer.
619 * @lat: the new latitude.
620 * @lon: the new longitude.
621 * @elev: the new elevation.
623 * The ::location-changed signal is emitted when the viewers camera
626 signals[SIG_LOCATION_CHANGED] = g_signal_new(
628 G_TYPE_FROM_CLASS(gobject_class),
633 gis_cclosure_marshal_VOID__DOUBLE_DOUBLE_DOUBLE,
641 * GisViewer::rotation-changed:
642 * @viewer: the viewer.
643 * @x: rotation new around the x axes.
644 * @y: rotation new around the y axes.
645 * @z: rotation new around the z axes.
647 * The ::rotation-changed signal is emitted when the viewers cameras
650 signals[SIG_ROTATION_CHANGED] = g_signal_new(
652 G_TYPE_FROM_CLASS(gobject_class),
657 gis_cclosure_marshal_VOID__DOUBLE_DOUBLE_DOUBLE,
665 * GisViewer::refresh:
666 * @viewer: the viewer.
668 * The ::refresh signal is emitted when a refresh is needed. If you are
669 * using real-time data from a remote server, you should connect to the
670 * refresh signal and update the data when necessary.
672 signals[SIG_REFRESH] = g_signal_new(
674 G_TYPE_FROM_CLASS(gobject_class),
679 g_cclosure_marshal_VOID__VOID,
684 * GisViewer::offline:
685 * @viewer: the viewer.
686 * @offline: %TRUE if the viewer going offline.
688 * The ::offline signal is emitted when the viewers offline mode
691 signals[SIG_OFFLINE] = g_signal_new(
693 G_TYPE_FROM_CLASS(gobject_class),
698 g_cclosure_marshal_VOID__BOOLEAN,