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 * Hack alert: grits-opengl.h needs to be included before grits-viewer
20 * - GritsViewer depends on GritsObject for add/remove functions
21 * - GritsObject depends on GritsOpenGL for load/unload functions
22 * - GritsOpenGL depends on GritsViewer for inheritance
24 * The problem here is that GritsOpenGL needs the GritsViewer definition but
25 * GritsViewer only needs the typedefs (through GritsObject), so GritsViewer
26 * needs to be included after the GritsOpenGL typedefs but before the
27 * GritsOpenGL definition. This is handled internally by grits-opengl.h
29 * This should probably be fixed, but making a GritsGLObject interface seems
30 * like too much work. Merging GritsViewer and GritsOpenGL would also work, but
31 * I like the separate that that's provided by having two.
33 #include "grits-opengl.h"
35 #ifndef __GRITS_VIEWER_H__
36 #define __GRITS_VIEWER_H__
39 #include <glib-object.h>
41 /* Rendering levels */
43 * GRITS_LEVEL_BACKGROUND:
45 * The level used to draw background objects (stars, atmosphere, etc).
47 #define GRITS_LEVEL_BACKGROUND -100
52 * The level used to draw world objects. This is for both surface data as well
53 * as things in the air or underground. Most objects should use
56 #define GRITS_LEVEL_WORLD 0
59 * GRITS_LEVEL_OVERLAY:
61 * The level used to draw screen overlays. These will be drawn in front of most
62 * of ther objects. Text and markers should use %GRITS_LEVEL_OVERLAY.
64 #define GRITS_LEVEL_OVERLAY 100
69 * The level used to draw the Heads Up Display. This is for things that are not
70 * anchored at all the the world. They should be drawn in front of everything
73 #define GRITS_LEVEL_HUD 200
76 #define GRITS_TYPE_VIEWER (grits_viewer_get_type())
77 #define GRITS_VIEWER(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), GRITS_TYPE_VIEWER, GritsViewer))
78 #define GRITS_IS_VIEWER(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), GRITS_TYPE_VIEWER))
79 #define GRITS_VIEWER_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GRITS_TYPE_VIEWER, GritsViewerClass))
80 #define GRITS_IS_VIEWER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GRITS_TYPE_VIEWER))
81 #define GRITS_VIEWER_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GRITS_TYPE_VIEWER, GritsViewerClass))
83 typedef struct _GritsViewer GritsViewer;
84 typedef struct _GritsViewerClass GritsViewerClass;
88 * @lat: the target latitude
89 * @lon: the target longitude
90 * @user_data: user data passed to the function
92 * Determine the surface elevation (ground level) at a given point.
94 * Returns: the elevation in meters above sea level
96 typedef gdouble (*GritsHeightFunc)(gdouble lat, gdouble lon, gpointer user_data);
98 #include "grits-plugin.h"
99 #include "grits-prefs.h"
100 #include "objects/grits-object.h"
102 struct _GritsViewer {
103 GtkDrawingArea parent_instance;
105 /* instance members */
106 GritsPlugins *plugins;
115 gdouble drag_x, drag_y;
118 struct _GritsViewerClass {
119 GtkDrawingAreaClass parent_class;
122 void (*center_position) (GritsViewer *viewer,
123 gdouble lat, gdouble lon, gdouble elev);
125 void (*project) (GritsViewer *viewer,
126 gdouble lat, gdouble lon, gdouble elev,
127 gdouble *px, gdouble *py, gdouble *pz);
129 void (*clear_height_func)(GritsViewer *viewer);
130 void (*set_height_func) (GritsViewer *viewer, GritsBounds *bounds,
131 GritsHeightFunc height_func, gpointer user_data,
134 gpointer (*add) (GritsViewer *viewer, GritsObject *object,
135 gint level, gboolean sort);
136 GritsObject *(*remove) (GritsViewer *viewer, gpointer ref);
139 GType grits_viewer_get_type(void);
142 void grits_viewer_setup(GritsViewer *viewer, GritsPlugins *plugins, GritsPrefs *prefs);
144 void grits_viewer_set_time(GritsViewer *viewer, time_t time);
145 time_t grits_viewer_get_time(GritsViewer *viewer);
147 void grits_viewer_set_location(GritsViewer *viewer, gdouble lat, gdouble lon, gdouble elev);
148 void grits_viewer_get_location(GritsViewer *viewer, gdouble *lat, gdouble *lon, gdouble *elev);
149 void grits_viewer_pan(GritsViewer *viewer, gdouble forward, gdouble right, gdouble up);
150 void grits_viewer_zoom(GritsViewer *viewer, gdouble scale);
152 void grits_viewer_set_rotation(GritsViewer *viewer, gdouble x, gdouble y, gdouble z);
153 void grits_viewer_get_rotation(GritsViewer *viewer, gdouble *x, gdouble *y, gdouble *z);
154 void grits_viewer_rotate (GritsViewer *viewer, gdouble x, gdouble y, gdouble z);
156 void grits_viewer_refresh(GritsViewer *viewer);
158 void grits_viewer_set_offline(GritsViewer *viewer, gboolean offline);
159 gboolean grits_viewer_get_offline(GritsViewer *viewer);
161 /* To be implemented by subclasses */
162 void grits_viewer_center_position(GritsViewer *viewer,
163 gdouble lat, gdouble lon, gdouble elev);
165 void grits_viewer_project(GritsViewer *viewer,
166 gdouble lat, gdouble lon, gdouble elev,
167 gdouble *px, gdouble *py, gdouble *pz);
169 void grits_viewer_clear_height_func(GritsViewer *viewer);
170 void grits_viewer_set_height_func(GritsViewer *viewer, GritsBounds *bounds,
171 GritsHeightFunc height_func, gpointer user_data,
174 gpointer grits_viewer_add(GritsViewer *viewer, GritsObject *object,
175 gint level, gboolean sort);
176 GritsObject *grits_viewer_remove(GritsViewer *viewer, gpointer ref);