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 gint fix_mode; /* VIK_GPS_MODE_NOT_SEEN if data unavailable */
55 gdouble hdop; /* VIK_DEFAULT_DOP if data unavailable */
56 gdouble vdop; /* VIK_DEFAULT_DOP if data unavailable */
57 gdouble pdop; /* VIK_DEFAULT_DOP if data unavailable */
62 TRACK_DRAWNAME_CENTRE,
65 TRACK_DRAWNAME_START_END,
66 TRACK_DRAWNAME_START_END_CENTRE,
68 } VikTrackDrawnameType;
70 // Instead of having a separate VikRoute type, routes are considered tracks
71 // Thus all track operations must cope with a 'route' version
72 // [track functions handle having no timestamps anyway - so there is no practical difference in most cases]
73 // This is simpler than having to rewrite particularly every track function for route version
74 // given that they do the same things
75 // Mostly this matters in the display in deciding where and how they are shown
76 typedef struct _VikTrack VikTrack;
81 VikTrackDrawnameType draw_name_mode;
82 guint8 max_number_dist_labels;
87 GtkWidget *property_dialog;
93 VikTrack *vik_track_new();
94 void vik_track_set_defaults(VikTrack *tr);
95 void vik_track_set_name(VikTrack *tr, const gchar *name);
96 void vik_track_set_comment(VikTrack *tr, const gchar *comment);
97 void vik_track_set_description(VikTrack *tr, const gchar *description);
98 void vik_track_ref(VikTrack *tr);
99 void vik_track_free(VikTrack *tr);
100 VikTrack *vik_track_copy ( const VikTrack *tr, gboolean copy_points );
101 void vik_track_set_comment_no_copy(VikTrack *tr, gchar *comment);
102 VikTrackpoint *vik_trackpoint_new();
103 void vik_trackpoint_free(VikTrackpoint *tp);
104 VikTrackpoint *vik_trackpoint_copy(VikTrackpoint *tp);
105 void vik_trackpoint_set_name(VikTrackpoint *tp, const gchar *name);
107 void vik_track_add_trackpoint(VikTrack *tr, VikTrackpoint *tp, gboolean recalculate);
108 gdouble vik_track_get_length_to_trackpoint (const VikTrack *tr, const VikTrackpoint *tp);
109 gdouble vik_track_get_length(const VikTrack *tr);
110 gdouble vik_track_get_length_including_gaps(const VikTrack *tr);
111 gulong vik_track_get_tp_count(const VikTrack *tr);
112 guint vik_track_get_segment_count(const VikTrack *tr);
113 VikTrack **vik_track_split_into_segments(VikTrack *tr, guint *ret_len);
114 guint vik_track_merge_segments(VikTrack *tr);
115 void vik_track_reverse(VikTrack *tr);
117 gulong vik_track_get_dup_point_count ( const VikTrack *vt );
118 gulong vik_track_remove_dup_points ( VikTrack *vt );
119 gulong vik_track_get_same_time_point_count ( const VikTrack *vt );
120 gulong vik_track_remove_same_time_points ( VikTrack *vt );
122 void vik_track_to_routepoints ( VikTrack *tr );
124 gdouble vik_track_get_max_speed(const VikTrack *tr);
125 gdouble vik_track_get_average_speed(const VikTrack *tr);
126 gdouble vik_track_get_average_speed_moving ( const VikTrack *tr, int stop_length_seconds );
128 void vik_track_convert ( VikTrack *tr, VikCoordMode dest_mode );
129 gdouble *vik_track_make_elevation_map ( const VikTrack *tr, guint16 num_chunks );
130 void vik_track_get_total_elevation_gain(const VikTrack *tr, gdouble *up, gdouble *down);
131 VikTrackpoint *vik_track_get_tp_by_dist ( VikTrack *trk, gdouble meters_from_start, gboolean get_next_point, gdouble *tp_metres_from_start );
132 VikTrackpoint *vik_track_get_closest_tp_by_percentage_dist ( VikTrack *tr, gdouble reldist, gdouble *meters_from_start );
133 VikTrackpoint *vik_track_get_closest_tp_by_percentage_time ( VikTrack *tr, gdouble reldist, time_t *seconds_from_start );
134 VikTrackpoint *vik_track_get_tp_by_max_speed ( const VikTrack *tr );
135 VikTrackpoint *vik_track_get_tp_by_max_alt ( const VikTrack *tr );
136 VikTrackpoint *vik_track_get_tp_by_min_alt ( const VikTrack *tr );
137 VikTrackpoint *vik_track_get_tp_first ( const VikTrack *tr );
138 VikTrackpoint *vik_track_get_tp_last ( const VikTrack *tr );
139 gdouble *vik_track_make_gradient_map ( const VikTrack *tr, guint16 num_chunks );
140 gdouble *vik_track_make_speed_map ( const VikTrack *tr, guint16 num_chunks );
141 gdouble *vik_track_make_distance_map ( const VikTrack *tr, guint16 num_chunks );
142 gdouble *vik_track_make_elevation_time_map ( const VikTrack *tr, guint16 num_chunks );
143 gdouble *vik_track_make_speed_dist_map ( const VikTrack *tr, guint16 num_chunks );
144 gboolean vik_track_get_minmax_alt ( const VikTrack *tr, gdouble *min_alt, gdouble *max_alt );
145 void vik_track_marshall ( VikTrack *tr, guint8 **data, guint *len);
146 VikTrack *vik_track_unmarshall (guint8 *data, guint datalen);
148 void vik_track_calculate_bounds ( VikTrack *trk );
150 void vik_track_anonymize_times ( VikTrack *tr );
151 gulong vik_track_apply_dem_data ( VikTrack *tr, gboolean skip_existing );
152 void vik_track_apply_dem_data_last_trackpoint ( VikTrack *tr );
153 gulong vik_track_smooth_missing_elevation_data ( VikTrack *tr, gboolean flat );
155 void vik_track_steal_and_append_trackpoints ( VikTrack *t1, VikTrack *t2 );
157 VikCoord *vik_track_cut_back_to_double_point ( VikTrack *tr );
159 int vik_track_compare_timestamp (const void *x, const void *y);
161 void vik_track_set_property_dialog(VikTrack *tr, GtkWidget *dialog);
162 void vik_track_clear_property_dialog(VikTrack *tr);