src/viktrack.h

   1 /*
   2  * viking -- GPS Data and Topo Analyzer, Explorer, and Manager
   3  *
   4  * Copyright (C) 2003-2005, Evan Battaglia <gtoevan@gmx.net>
   5  *
   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.
  10  *
  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.
  15  *
  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
  19  *
  20  */
  21
  22 #ifndef _VIKING_TRACK_H
  23 #define _VIKING_TRACK_H
  24
  25 #include <time.h>
  26 #include <glib.h>
  27 #include <gtk/gtk.h>
  28
  29 #include "vikcoord.h"
  30
  31 /* todo important: put these in their own header file, maybe.probably also rename */
  32
  33 #define VIK_TRACK(x) ((VikTrack *)(x))
  34 #define VIK_TRACKPOINT(x) ((VikTrackpoint *)(x))
  35
  36 typedef struct _VikTrackpoint VikTrackpoint;
  37 struct _VikTrackpoint {
  38   VikCoord coord;
  39   gboolean newsegment;
  40   gboolean has_timestamp;
  41   time_t timestamp;
  42   gdouble altitude;     /* only in 3D fixes */
  43   /* Most GPSs provide this in realtime mode (NMEA) but not in data mode */
  44   gboolean extended;
  45   gdouble speed;        /* only in 3D fixes */
  46   gdouble course;
  47   guint nsats;          /* number of satellites used */
  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;
  53 };
  54
  55 typedef struct _VikTrack VikTrack;
  56 struct _VikTrack {
  57   GList *trackpoints;
  58   gboolean visible;
  59   gchar *comment;
  60   guint8 ref_count;
  61   GtkWidget *property_dialog;
  62 };
  63
  64 VikTrack *vik_track_new();
  65 void vik_track_set_comment(VikTrack *wp, const gchar *comment);
  66 void vik_track_ref(VikTrack *tr);
  67 void vik_track_free(VikTrack *tr);
  68 VikTrack *vik_track_copy ( const VikTrack *tr );
  69 void vik_track_set_comment_no_copy(VikTrack *tr, gchar *comment);
  70 VikTrackpoint *vik_trackpoint_new();
  71 void vik_trackpoint_free(VikTrackpoint *tp);
  72 VikTrackpoint *vik_trackpoint_copy(VikTrackpoint *tp);
  73 gdouble vik_track_get_length(const VikTrack *tr);
  74 gdouble vik_track_get_length_including_gaps(const VikTrack *tr);
  75 gulong vik_track_get_tp_count(const VikTrack *tr);
  76 guint vik_track_get_segment_count(const VikTrack *tr);
  77 VikTrack **vik_track_split_into_segments(VikTrack *tr, guint *ret_len);
  78 void vik_track_reverse(VikTrack *tr);
  79
  80 gulong vik_track_get_dup_point_count ( const VikTrack *vt );
  81 void vik_track_remove_dup_points ( VikTrack *vt );
  82
  83 gdouble vik_track_get_max_speed(const VikTrack *tr);
  84 gdouble vik_track_get_average_speed(const VikTrack *tr);
  85
  86 void vik_track_convert ( VikTrack *tr, VikCoordMode dest_mode );
  87 gdouble *vik_track_make_elevation_map ( const VikTrack *tr, guint16 num_chunks );
  88 void vik_track_get_total_elevation_gain(const VikTrack *tr, gdouble *up, gdouble *down);
  89 VikTrackpoint *vik_track_get_closest_tp_by_percentage_dist ( VikTrack *tr, gdouble reldist, gdouble *meters_from_start );
  90 VikTrackpoint *vik_track_get_closest_tp_by_percentage_time ( VikTrack *tr, gdouble reldist, time_t *seconds_from_start );
  91 gdouble *vik_track_make_speed_map ( const VikTrack *tr, guint16 num_chunks );
  92 gboolean vik_track_get_minmax_alt ( const VikTrack *tr, gdouble *min_alt, gdouble *max_alt );
  93 void vik_track_marshall ( VikTrack *tr, guint8 **data, guint *len);
  94 VikTrack *vik_track_unmarshall (guint8 *data, guint datalen);
  95
  96 void vik_track_apply_dem_data ( VikTrack *tr);
  97
  98 /* appends t2 to t1, leaving t2 with no trackpoints */
  99 void vik_track_steal_and_append_trackpoints ( VikTrack *t1, VikTrack *t2 );
 100
 101 /* starting at the end, looks backwards for the last "double point", a duplicate trackpoint.
 102  * this is indicative of magic scissors continued use. If there is no double point,
 103  * deletes all the trackpoints. returns new end of the track (or the start if
 104  * there are no double points)
 105  */
 106 VikCoord *vik_track_cut_back_to_double_point ( VikTrack *tr );
 107
 108 void vik_track_set_property_dialog(VikTrack *tr, GtkWidget *dialog);
 109 void vik_track_clear_property_dialog(VikTrack *tr);
 110
 111 #endif