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 G_BEGIN_DECLS
  32
  33 /* todo important: put these in their own header file, maybe.probably also rename */
  34
  35 #define VIK_TRACK(x) ((VikTrack *)(x))
  36 #define VIK_TRACKPOINT(x) ((VikTrackpoint *)(x))
  37
  38 typedef struct _VikTrackpoint VikTrackpoint;
  39 struct _VikTrackpoint {
  40   VikCoord coord;
  41   gboolean newsegment;
  42   gboolean has_timestamp;
  43   time_t 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 */
  56 };
  57
  58 typedef struct _VikTrack VikTrack;
  59 struct _VikTrack {
  60   GList *trackpoints;
  61   gboolean visible;
  62   gchar *comment;
  63   gchar *description;
  64   guint8 ref_count;
  65   GtkWidget *property_dialog;
  66   gchar *name;
  67 };
  68
  69 VikTrack *vik_track_new();
  70 void vik_track_set_name(VikTrack *tr, const gchar *name);
  71 void vik_track_set_comment(VikTrack *tr, const gchar *comment);
  72 void vik_track_set_description(VikTrack *tr, const gchar *description);
  73 void vik_track_ref(VikTrack *tr);
  74 void vik_track_free(VikTrack *tr);
  75 VikTrack *vik_track_copy ( const VikTrack *tr );
  76 void vik_track_set_comment_no_copy(VikTrack *tr, gchar *comment);
  77 VikTrackpoint *vik_trackpoint_new();
  78 void vik_trackpoint_free(VikTrackpoint *tp);
  79 VikTrackpoint *vik_trackpoint_copy(VikTrackpoint *tp);
  80 gdouble vik_track_get_length(const VikTrack *tr);
  81 gdouble vik_track_get_length_including_gaps(const VikTrack *tr);
  82 gulong vik_track_get_tp_count(const VikTrack *tr);
  83 guint vik_track_get_segment_count(const VikTrack *tr);
  84 VikTrack **vik_track_split_into_segments(VikTrack *tr, guint *ret_len);
  85 guint vik_track_merge_segments(VikTrack *tr);
  86 void vik_track_reverse(VikTrack *tr);
  87
  88 gulong vik_track_get_dup_point_count ( const VikTrack *vt );
  89 gulong vik_track_remove_dup_points ( VikTrack *vt );
  90 gulong vik_track_get_same_time_point_count ( const VikTrack *vt );
  91 gulong vik_track_remove_same_time_points ( VikTrack *vt );
  92
  93 gdouble vik_track_get_max_speed(const VikTrack *tr);
  94 gdouble vik_track_get_average_speed(const VikTrack *tr);
  95 gdouble vik_track_get_average_speed_moving ( const VikTrack *tr, int stop_length_seconds );
  96
  97 void vik_track_convert ( VikTrack *tr, VikCoordMode dest_mode );
  98 gdouble *vik_track_make_elevation_map ( const VikTrack *tr, guint16 num_chunks );
  99 void vik_track_get_total_elevation_gain(const VikTrack *tr, gdouble *up, gdouble *down);
 100 VikTrackpoint *vik_track_get_closest_tp_by_percentage_dist ( VikTrack *tr, gdouble reldist, gdouble *meters_from_start );
 101 VikTrackpoint *vik_track_get_closest_tp_by_percentage_time ( VikTrack *tr, gdouble reldist, time_t *seconds_from_start );
 102 VikTrackpoint *vik_track_get_tp_by_max_speed ( const VikTrack *tr );
 103 VikTrackpoint *vik_track_get_tp_by_max_alt ( const VikTrack *tr );
 104 VikTrackpoint *vik_track_get_tp_by_min_alt ( const VikTrack *tr );
 105 gdouble *vik_track_make_gradient_map ( const VikTrack *tr, guint16 num_chunks );
 106 gdouble *vik_track_make_speed_map ( const VikTrack *tr, guint16 num_chunks );
 107 gdouble *vik_track_make_distance_map ( const VikTrack *tr, guint16 num_chunks );
 108 gdouble *vik_track_make_elevation_time_map ( const VikTrack *tr, guint16 num_chunks );
 109 gdouble *vik_track_make_speed_dist_map ( const VikTrack *tr, guint16 num_chunks );
 110 gboolean vik_track_get_minmax_alt ( const VikTrack *tr, gdouble *min_alt, gdouble *max_alt );
 111 void vik_track_marshall ( VikTrack *tr, guint8 **data, guint *len);
 112 VikTrack *vik_track_unmarshall (guint8 *data, guint datalen);
 113
 114 void vik_track_apply_dem_data ( VikTrack *tr);
 115 /*
 116  * Apply DEM data (if available) - to only the last trackpoint
 117  */
 118 void vik_track_apply_dem_data_last_trackpoint ( VikTrack *tr );
 119
 120 /* appends t2 to t1, leaving t2 with no trackpoints */
 121 void vik_track_steal_and_append_trackpoints ( VikTrack *t1, VikTrack *t2 );
 122
 123 /* starting at the end, looks backwards for the last "double point", a duplicate trackpoint.
 124  * If there is no double point, deletes all the trackpoints.
 125  * Returns the new end of the track (or the start if there are no double points
 126  */
 127 VikCoord *vik_track_cut_back_to_double_point ( VikTrack *tr );
 128
 129 void vik_track_set_property_dialog(VikTrack *tr, GtkWidget *dialog);
 130 void vik_track_clear_property_dialog(VikTrack *tr);
 131
 132 G_END_DECLS
 133
 134 #endif