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
34 /* todo important: put these in their own header file, maybe.probably also rename */
36 #define VIK_TRACK(x) ((VikTrack *)(x))
37 #define VIK_TRACKPOINT(x) ((VikTrackpoint *)(x))
39 typedef struct _VikTrackpoint VikTrackpoint;
40 struct _VikTrackpoint {
44 gboolean has_timestamp;
46 gdouble altitude; /* VIK_DEFAULT_ALTITUDE if data unavailable */
47 gdouble speed; /* NAN if data unavailable */
48 gdouble course; /* NAN if data unavailable */
49 guint nsats; /* number of satellites used. 0 if data unavailable */
50 #define VIK_GPS_MODE_NOT_SEEN 0 /* mode update not seen yet */
51 #define VIK_GPS_MODE_NO_FIX 1 /* none */
52 #define VIK_GPS_MODE_2D 2 /* good for latitude/longitude */
53 #define VIK_GPS_MODE_3D 3 /* good for altitude/climb too */
54 #define VIK_GPS_MODE_DGPS 4
55 #define VIK_GPS_MODE_PPS 5 /* military signal used */
56 gint fix_mode; /* VIK_GPS_MODE_NOT_SEEN if data unavailable */
57 gdouble hdop; /* VIK_DEFAULT_DOP if data unavailable */
58 gdouble vdop; /* VIK_DEFAULT_DOP if data unavailable */
59 gdouble pdop; /* VIK_DEFAULT_DOP if data unavailable */
64 TRACK_DRAWNAME_CENTRE,
67 TRACK_DRAWNAME_START_END,
68 TRACK_DRAWNAME_START_END_CENTRE,
70 } VikTrackDrawnameType;
72 // Instead of having a separate VikRoute type, routes are considered tracks
73 // Thus all track operations must cope with a 'route' version
74 // [track functions handle having no timestamps anyway - so there is no practical difference in most cases]
75 // This is simpler than having to rewrite particularly every track function for route version
76 // given that they do the same things
77 // Mostly this matters in the display in deciding where and how they are shown
78 typedef struct _VikTrack VikTrack;
83 VikTrackDrawnameType draw_name_mode;
84 guint8 max_number_dist_labels;
89 GtkWidget *property_dialog;
95 VikTrack *vik_track_new();
96 void vik_track_set_defaults(VikTrack *tr);
97 void vik_track_set_name(VikTrack *tr, const gchar *name);
98 void vik_track_set_comment(VikTrack *tr, const gchar *comment);
99 void vik_track_set_description(VikTrack *tr, const gchar *description);
100 void vik_track_ref(VikTrack *tr);
101 void vik_track_free(VikTrack *tr);
102 VikTrack *vik_track_copy ( const VikTrack *tr, gboolean copy_points );
103 void vik_track_set_comment_no_copy(VikTrack *tr, gchar *comment);
104 VikTrackpoint *vik_trackpoint_new();
105 void vik_trackpoint_free(VikTrackpoint *tp);
106 VikTrackpoint *vik_trackpoint_copy(VikTrackpoint *tp);
107 void vik_trackpoint_set_name(VikTrackpoint *tp, const gchar *name);
109 void vik_track_add_trackpoint(VikTrack *tr, VikTrackpoint *tp, gboolean recalculate);
110 gdouble vik_track_get_length_to_trackpoint (const VikTrack *tr, const VikTrackpoint *tp);
111 gdouble vik_track_get_length(const VikTrack *tr);
112 gdouble vik_track_get_length_including_gaps(const VikTrack *tr);
113 gulong vik_track_get_tp_count(const VikTrack *tr);
114 guint vik_track_get_segment_count(const VikTrack *tr);
115 VikTrack **vik_track_split_into_segments(VikTrack *tr, guint *ret_len);
116 guint vik_track_merge_segments(VikTrack *tr);
117 void vik_track_reverse(VikTrack *tr);
118 time_t vik_track_get_duration(const VikTrack *trk);
120 gulong vik_track_get_dup_point_count ( const VikTrack *vt );
121 gulong vik_track_remove_dup_points ( VikTrack *vt );
122 gulong vik_track_get_same_time_point_count ( const VikTrack *vt );
123 gulong vik_track_remove_same_time_points ( VikTrack *vt );
125 void vik_track_to_routepoints ( VikTrack *tr );
127 gdouble vik_track_get_max_speed(const VikTrack *tr);
128 gdouble vik_track_get_average_speed(const VikTrack *tr);
129 gdouble vik_track_get_average_speed_moving ( const VikTrack *tr, int stop_length_seconds );
131 void vik_track_convert ( VikTrack *tr, VikCoordMode dest_mode );
132 gdouble *vik_track_make_elevation_map ( const VikTrack *tr, guint16 num_chunks );
133 void vik_track_get_total_elevation_gain(const VikTrack *tr, gdouble *up, gdouble *down);
134 VikTrackpoint *vik_track_get_tp_by_dist ( VikTrack *trk, gdouble meters_from_start, gboolean get_next_point, gdouble *tp_metres_from_start );
135 VikTrackpoint *vik_track_get_closest_tp_by_percentage_dist ( VikTrack *tr, gdouble reldist, gdouble *meters_from_start );
136 VikTrackpoint *vik_track_get_closest_tp_by_percentage_time ( VikTrack *tr, gdouble reldist, time_t *seconds_from_start );
137 VikTrackpoint *vik_track_get_tp_by_max_speed ( const VikTrack *tr );
138 VikTrackpoint *vik_track_get_tp_by_max_alt ( const VikTrack *tr );
139 VikTrackpoint *vik_track_get_tp_by_min_alt ( const VikTrack *tr );
140 VikTrackpoint *vik_track_get_tp_first ( const VikTrack *tr );
141 VikTrackpoint *vik_track_get_tp_last ( const VikTrack *tr );
142 VikTrackpoint *vik_track_get_tp_prev ( const VikTrack *tr, VikTrackpoint *tp );
143 gdouble *vik_track_make_gradient_map ( const VikTrack *tr, guint16 num_chunks );
144 gdouble *vik_track_make_speed_map ( const VikTrack *tr, guint16 num_chunks );
145 gdouble *vik_track_make_distance_map ( const VikTrack *tr, guint16 num_chunks );
146 gdouble *vik_track_make_elevation_time_map ( const VikTrack *tr, guint16 num_chunks );
147 gdouble *vik_track_make_speed_dist_map ( const VikTrack *tr, guint16 num_chunks );
148 gboolean vik_track_get_minmax_alt ( const VikTrack *tr, gdouble *min_alt, gdouble *max_alt );
149 void vik_track_marshall ( VikTrack *tr, guint8 **data, guint *len);
150 VikTrack *vik_track_unmarshall (guint8 *data, guint datalen);
152 void vik_track_calculate_bounds ( VikTrack *trk );
154 void vik_track_anonymize_times ( VikTrack *tr );
155 void vik_track_interpolate_times ( VikTrack *tr );
156 gulong vik_track_apply_dem_data ( VikTrack *tr, gboolean skip_existing );
157 void vik_track_apply_dem_data_last_trackpoint ( VikTrack *tr );
158 gulong vik_track_smooth_missing_elevation_data ( VikTrack *tr, gboolean flat );
160 void vik_track_steal_and_append_trackpoints ( VikTrack *t1, VikTrack *t2 );
162 VikCoord *vik_track_cut_back_to_double_point ( VikTrack *tr );
164 int vik_track_compare_timestamp (const void *x, const void *y);
166 void vik_track_set_property_dialog(VikTrack *tr, GtkWidget *dialog);
167 void vik_track_clear_property_dialog(VikTrack *tr);