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
30 /* todo important: put these in their own header file, maybe.probably also rename */
32 #define VIK_TRACK(x) ((VikTrack *)(x))
33 #define VIK_TRACKPOINT(x) ((VikTrackpoint *)(x))
35 typedef struct _VikTrackpoint VikTrackpoint;
36 struct _VikTrackpoint {
39 gboolean has_timestamp;
41 gdouble altitude; /* only in 3D fixes */
42 /* Most GPSs provide this in realtime mode (NMEA) but not in data mode */
44 gdouble speed; /* only in 3D fixes */
46 guint nsats; /* number of satellites used */
47 #define VIK_GPS_MODE_NOT_SEEN 0 /* mode update not seen yet */
48 #define VIK_GPS_MODE_NO_FIX 1 /* none */
49 #define VIK_GPS_MODE_2D 2 /* good for latitude/longitude */
50 #define VIK_GPS_MODE_3D 3 /* good for altitude/climb too */
54 typedef struct _VikTrack VikTrack;
62 VikTrack *vik_track_new();
63 void vik_track_set_comment(VikTrack *wp, const gchar *comment);
64 void vik_track_ref(VikTrack *tr);
65 void vik_track_free(VikTrack *tr);
66 VikTrack *vik_track_copy ( const VikTrack *tr );
67 void vik_track_set_comment_no_copy(VikTrack *tr, gchar *comment);
68 VikTrackpoint *vik_trackpoint_new();
69 void vik_trackpoint_free(VikTrackpoint *tp);
70 VikTrackpoint *vik_trackpoint_copy(VikTrackpoint *tp);
71 gdouble vik_track_get_length(const VikTrack *tr);
72 gdouble vik_track_get_length_including_gaps(const VikTrack *tr);
73 gulong vik_track_get_tp_count(const VikTrack *tr);
74 guint vik_track_get_segment_count(const VikTrack *tr);
75 VikTrack **vik_track_split_into_segments(VikTrack *tr, guint *ret_len);
76 void vik_track_reverse(VikTrack *tr);
78 gulong vik_track_get_dup_point_count ( const VikTrack *vt );
79 void vik_track_remove_dup_points ( VikTrack *vt );
81 gdouble vik_track_get_max_speed(const VikTrack *tr);
82 gdouble vik_track_get_average_speed(const VikTrack *tr);
84 void vik_track_convert ( VikTrack *tr, VikCoordMode dest_mode );
85 gdouble *vik_track_make_elevation_map ( const VikTrack *tr, guint16 num_chunks );
86 void vik_track_get_total_elevation_gain(const VikTrack *tr, gdouble *up, gdouble *down);
87 VikTrackpoint *vik_track_get_closest_tp_by_percentage_dist ( VikTrack *tr, gdouble reldist, gdouble *meters_from_start );
88 VikTrackpoint *vik_track_get_closest_tp_by_percentage_time ( VikTrack *tr, gdouble reldist, time_t *seconds_from_start );
89 gdouble *vik_track_make_speed_map ( const VikTrack *tr, guint16 num_chunks );
90 gboolean vik_track_get_minmax_alt ( const VikTrack *tr, gdouble *min_alt, gdouble *max_alt );
91 void vik_track_marshall ( VikTrack *tr, guint8 **data, guint *len);
92 VikTrack *vik_track_unmarshall (guint8 *data, guint datalen);
94 void vik_track_apply_dem_data ( VikTrack *tr);
96 /* appends t2 to t1, leaving t2 with no trackpoints */
97 void vik_track_steal_and_append_trackpoints ( VikTrack *t1, VikTrack *t2 );
99 /* starting at the end, looks backwards for the last "double point", a duplicate trackpoint.
100 * this is indicative of magic scissors continued use. If there is no double point,
101 * deletes all the trackpoints. returns new end of the track (or the start if
102 * there are no double points)
104 VikCoord *vik_track_cut_back_to_double_point ( VikTrack *tr );