2 * viking -- GPS Data and Topo Analyzer, Explorer, and Manager
4 * Copyright (C) 2003-2005, Evan Battaglia <gtoevan@gmx.net>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22 #ifndef _VIKING_TRACK_H
23 #define _VIKING_TRACK_H
33 /* todo important: put these in their own header file, maybe.probably also rename */
35 #define VIK_TRACK(x) ((VikTrack *)(x))
36 #define VIK_TRACKPOINT(x) ((VikTrackpoint *)(x))
38 typedef struct _VikTrackpoint VikTrackpoint;
39 struct _VikTrackpoint {
42 gboolean has_timestamp;
44 gdouble altitude; /* VIK_DEFAULT_ALTITUDE if data unavailable */
45 gdouble speed; /* NAN if data unavailable */
46 gdouble course; /* NAN if data unavailable */
47 guint nsats; /* number of satellites used. 0 if data unavailable */
48 #define VIK_GPS_MODE_NOT_SEEN 0 /* mode update not seen yet */
49 #define VIK_GPS_MODE_NO_FIX 1 /* none */
50 #define VIK_GPS_MODE_2D 2 /* good for latitude/longitude */
51 #define VIK_GPS_MODE_3D 3 /* good for altitude/climb too */
52 gint fix_mode; /* VIK_GPS_MODE_NOT_SEEN if data unavailable */
53 gdouble hdop; /* VIK_DEFAULT_DOP if data unavailable */
54 gdouble vdop; /* VIK_DEFAULT_DOP if data unavailable */
55 gdouble pdop; /* VIK_DEFAULT_DOP if data unavailable */
58 // Instead of having a separate VikRoute type, routes are considered tracks
59 // Thus all track operations must cope with a 'route' version
60 // [track functions handle having no timestamps anyway - so there is no practical difference in most cases]
61 // This is simpler than having to rewrite particularly every track function for route version
62 // given that they do the same things
63 // Mostly this matters in the display in deciding where and how they are shown
64 typedef struct _VikTrack VikTrack;
72 GtkWidget *property_dialog;
76 VikTrack *vik_track_new();
77 void vik_track_set_name(VikTrack *tr, const gchar *name);
78 void vik_track_set_comment(VikTrack *tr, const gchar *comment);
79 void vik_track_set_description(VikTrack *tr, const gchar *description);
80 void vik_track_ref(VikTrack *tr);
81 void vik_track_free(VikTrack *tr);
82 VikTrack *vik_track_copy ( const VikTrack *tr );
83 void vik_track_set_comment_no_copy(VikTrack *tr, gchar *comment);
84 VikTrackpoint *vik_trackpoint_new();
85 void vik_trackpoint_free(VikTrackpoint *tp);
86 VikTrackpoint *vik_trackpoint_copy(VikTrackpoint *tp);
87 gdouble vik_track_get_length(const VikTrack *tr);
88 gdouble vik_track_get_length_including_gaps(const VikTrack *tr);
89 gulong vik_track_get_tp_count(const VikTrack *tr);
90 guint vik_track_get_segment_count(const VikTrack *tr);
91 VikTrack **vik_track_split_into_segments(VikTrack *tr, guint *ret_len);
92 guint vik_track_merge_segments(VikTrack *tr);
93 void vik_track_reverse(VikTrack *tr);
95 gulong vik_track_get_dup_point_count ( const VikTrack *vt );
96 gulong vik_track_remove_dup_points ( VikTrack *vt );
97 gulong vik_track_get_same_time_point_count ( const VikTrack *vt );
98 gulong vik_track_remove_same_time_points ( VikTrack *vt );
100 void vik_track_to_routepoints ( VikTrack *tr );
102 gdouble vik_track_get_max_speed(const VikTrack *tr);
103 gdouble vik_track_get_average_speed(const VikTrack *tr);
104 gdouble vik_track_get_average_speed_moving ( const VikTrack *tr, int stop_length_seconds );
106 void vik_track_convert ( VikTrack *tr, VikCoordMode dest_mode );
107 gdouble *vik_track_make_elevation_map ( const VikTrack *tr, guint16 num_chunks );
108 void vik_track_get_total_elevation_gain(const VikTrack *tr, gdouble *up, gdouble *down);
109 VikTrackpoint *vik_track_get_closest_tp_by_percentage_dist ( VikTrack *tr, gdouble reldist, gdouble *meters_from_start );
110 VikTrackpoint *vik_track_get_closest_tp_by_percentage_time ( VikTrack *tr, gdouble reldist, time_t *seconds_from_start );
111 VikTrackpoint *vik_track_get_tp_by_max_speed ( const VikTrack *tr );
112 VikTrackpoint *vik_track_get_tp_by_max_alt ( const VikTrack *tr );
113 VikTrackpoint *vik_track_get_tp_by_min_alt ( const VikTrack *tr );
114 gdouble *vik_track_make_gradient_map ( const VikTrack *tr, guint16 num_chunks );
115 gdouble *vik_track_make_speed_map ( const VikTrack *tr, guint16 num_chunks );
116 gdouble *vik_track_make_distance_map ( const VikTrack *tr, guint16 num_chunks );
117 gdouble *vik_track_make_elevation_time_map ( const VikTrack *tr, guint16 num_chunks );
118 gdouble *vik_track_make_speed_dist_map ( const VikTrack *tr, guint16 num_chunks );
119 gboolean vik_track_get_minmax_alt ( const VikTrack *tr, gdouble *min_alt, gdouble *max_alt );
120 void vik_track_marshall ( VikTrack *tr, guint8 **data, guint *len);
121 VikTrack *vik_track_unmarshall (guint8 *data, guint datalen);
123 void vik_track_apply_dem_data ( VikTrack *tr);
125 * Apply DEM data (if available) - to only the last trackpoint
127 void vik_track_apply_dem_data_last_trackpoint ( VikTrack *tr );
129 /* appends t2 to t1, leaving t2 with no trackpoints */
130 void vik_track_steal_and_append_trackpoints ( VikTrack *t1, VikTrack *t2 );
132 /* starting at the end, looks backwards for the last "double point", a duplicate trackpoint.
133 * If there is no double point, deletes all the trackpoints.
134 * Returns the new end of the track (or the start if there are no double points
136 VikCoord *vik_track_cut_back_to_double_point ( VikTrack *tr );
138 void vik_track_set_property_dialog(VikTrack *tr, GtkWidget *dialog);
139 void vik_track_clear_property_dialog(VikTrack *tr);