2 * viking -- GPS Data and Topo Analyzer, Explorer, and Manager
4 * Copyright (C) 2003-2005, Evan Battaglia <gtoevan@gmx.net>
5 * Copyright (c) 2011-2013, Rob Norris <rw_norris@hotmail.com>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23 #ifndef _VIKING_TRWLAYER_H
24 #define _VIKING_TRWLAYER_H
27 #include "vikviewport.h"
28 #include "vikwaypoint.h"
30 #include "viklayerspanel.h"
34 #define VIK_TRW_LAYER_TYPE (vik_trw_layer_get_type ())
35 #define VIK_TRW_LAYER(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), VIK_TRW_LAYER_TYPE, VikTrwLayer))
36 #define VIK_TRW_LAYER_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), VIK_TRW_LAYER_TYPE, VikTrwLayerClass))
37 #define IS_VIK_TRW_LAYER(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), VIK_TRW_LAYER_TYPE))
38 #define IS_VIK_TRW_LAYER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), VIK_TRW_LAYER_TYPE))
41 VIK_TRW_LAYER_SUBLAYER_TRACKS,
42 VIK_TRW_LAYER_SUBLAYER_WAYPOINTS,
43 VIK_TRW_LAYER_SUBLAYER_TRACK,
44 VIK_TRW_LAYER_SUBLAYER_WAYPOINT,
45 VIK_TRW_LAYER_SUBLAYER_ROUTES,
46 VIK_TRW_LAYER_SUBLAYER_ROUTE
49 typedef struct _VikTrwLayerClass VikTrwLayerClass;
50 struct _VikTrwLayerClass
52 VikLayerClass object_class;
56 GType vik_trw_layer_get_type ();
58 typedef struct _VikTrwLayer VikTrwLayer;
64 gchar *timestamp; // TODO: Consider storing as proper time_t.
65 gchar *keywords; // TODO: handling/storing a GList of individual tags?
68 VikTRWMetadata *vik_trw_metadata_new();
69 void vik_trw_metadata_free ( VikTRWMetadata *metadata);
70 VikTRWMetadata *vik_trw_layer_get_metadata ( VikTrwLayer *vtl );
71 void vik_trw_layer_set_metadata ( VikTrwLayer *vtl, VikTRWMetadata *metadata);
73 gboolean vik_trw_layer_find_date ( VikTrwLayer *vtl, const gchar *date_str, VikCoord *position, VikViewport *vvp, gboolean do_tracks, gboolean select );
75 /* These are meant for use in file loaders (gpspoint.c, gpx.c, etc).
76 * These copy the name, so you should free it if necessary. */
77 void vik_trw_layer_filein_add_waypoint ( VikTrwLayer *vtl, gchar *name, VikWaypoint *wp );
78 void vik_trw_layer_filein_add_track ( VikTrwLayer *vtl, gchar *name, VikTrack *tr );
80 gint vik_trw_layer_get_property_tracks_line_thickness ( VikTrwLayer *vtl );
82 void vik_trw_layer_add_waypoint ( VikTrwLayer *vtl, gchar *name, VikWaypoint *wp );
83 void vik_trw_layer_add_track ( VikTrwLayer *vtl, gchar *name, VikTrack *t );
84 void vik_trw_layer_add_route ( VikTrwLayer *vtl, gchar *name, VikTrack *t );
86 // Waypoint returned is the first one
87 VikWaypoint *vik_trw_layer_get_waypoint ( VikTrwLayer *vtl, const gchar *name );
89 // Track returned is the first one
90 VikTrack *vik_trw_layer_get_track ( VikTrwLayer *vtl, const gchar *name );
91 gboolean vik_trw_layer_delete_track ( VikTrwLayer *vtl, VikTrack *trk );
92 gboolean vik_trw_layer_delete_route ( VikTrwLayer *vtl, VikTrack *trk );
94 gboolean vik_trw_layer_auto_set_view ( VikTrwLayer *vtl, VikViewport *vvp );
95 gboolean vik_trw_layer_find_center ( VikTrwLayer *vtl, VikCoord *dest );
96 GHashTable *vik_trw_layer_get_tracks ( VikTrwLayer *l );
97 GHashTable *vik_trw_layer_get_routes ( VikTrwLayer *l );
98 GHashTable *vik_trw_layer_get_waypoints ( VikTrwLayer *l );
99 gboolean vik_trw_layer_is_empty ( VikTrwLayer *vtl );
101 gboolean vik_trw_layer_new_waypoint ( VikTrwLayer *vtl, GtkWindow *w, const VikCoord *def_coord );
103 VikCoordMode vik_trw_layer_get_coord_mode ( VikTrwLayer *vtl );
105 gboolean vik_trw_layer_uniquify ( VikTrwLayer *vtl, VikLayersPanel *vlp );
107 void vik_trw_layer_delete_all_waypoints ( VikTrwLayer *vtl );
108 void vik_trw_layer_delete_all_tracks ( VikTrwLayer *vtl );
109 void vik_trw_layer_delete_all_routes ( VikTrwLayer *vtl );
110 void trw_layer_cancel_tps_of_track ( VikTrwLayer *vtl, VikTrack *trk );
112 void vik_trw_layer_reset_waypoints ( VikTrwLayer *vtl );
114 void vik_trw_layer_draw_highlight ( VikTrwLayer *vtl, VikViewport *vvp );
115 void vik_trw_layer_draw_highlight_item ( VikTrwLayer *vtl, VikTrack *trk, VikWaypoint *wpt, VikViewport *vvp );
116 void vik_trw_layer_draw_highlight_items ( VikTrwLayer *vtl, GHashTable *trks, GHashTable *wpts, VikViewport *vvp );
118 // For creating a list of tracks with the corresponding layer it is in
119 // (thus a selection of tracks may be from differing layers)
123 } vik_trw_track_list_t;
125 typedef GList* (*VikTrwlayerGetTracksAndLayersFunc) (VikLayer*, gpointer);
126 GList *vik_trw_layer_build_track_list_t ( VikTrwLayer *vtl, GList *tracks );
128 // For creating a list of waypoints with the corresponding layer it is in
129 // (thus a selection of waypoints may be from differing layers)
133 } vik_trw_waypoint_list_t;
135 typedef GList* (*VikTrwlayerGetWaypointsAndLayersFunc) (VikLayer*, gpointer);
136 GList *vik_trw_layer_build_waypoint_list_t ( VikTrwLayer *vtl, GList *waypoints );
138 GdkPixbuf* get_wp_sym_small ( gchar *symbol );
140 /* Exposed Layer Interface function definitions */
141 // Intended only for use by other trw_layer subwindows
142 void trw_layer_verify_thumbnails ( VikTrwLayer *vtl, GtkWidget *vp );
143 // Other functions only for use by other trw_layer subwindows
144 gchar *trw_layer_new_unique_sublayer_name ( VikTrwLayer *vtl, gint sublayer_type, const gchar *name );
145 void trw_layer_waypoint_rename ( VikTrwLayer *vtl, VikWaypoint *wp, const gchar *new_name );
146 void trw_layer_waypoint_reset_icon ( VikTrwLayer *vtl, VikWaypoint *wp );
147 void trw_layer_calculate_bounds_waypoints ( VikTrwLayer *vtl );
148 void trw_layer_calculate_bounds_tracks ( VikTrwLayer *vtl );
150 gboolean vik_trw_layer_get_tracks_visibility ( VikTrwLayer *vtl );
151 gboolean vik_trw_layer_get_routes_visibility ( VikTrwLayer *vtl );
152 gboolean vik_trw_layer_get_waypoints_visibility ( VikTrwLayer *vtl );
154 void trw_layer_update_treeview ( VikTrwLayer *vtl, VikTrack *trk );
156 void trw_layer_dialog_shift ( VikTrwLayer *vtl, GtkWindow *dialog, VikCoord *coord, gboolean vertical );
159 VikTrack *trk; // input
160 gpointer uuid; // output
162 gboolean trw_layer_track_find_uuid ( const gpointer id, const VikTrack *trk, gpointer udata );
165 VikWaypoint *wp; // input
166 gpointer uuid; // output
168 gboolean trw_layer_waypoint_find_uuid ( const gpointer id, const VikWaypoint *wp, gpointer udata );
170 void trw_layer_zoom_to_show_latlons ( VikTrwLayer *vtl, VikViewport *vvp, struct LatLon maxmin[2] );
172 GHashTable *vik_trw_layer_get_tracks_iters ( VikTrwLayer *vtl );
173 GHashTable *vik_trw_layer_get_routes_iters ( VikTrwLayer *vtl );
174 GHashTable *vik_trw_layer_get_waypoints_iters ( VikTrwLayer *vtl );
176 #define VIK_SETTINGS_LIST_DATE_FORMAT "list_date_format"