simgear/route/route.hxx

   1 /**
   2  * \file route.hxx
   3  * Provides a class to manage a list of waypoints (i.e. a route).
   4  */
   5
   6 // Written by Curtis Olson, started October 2000.
   7 //
   8 // Copyright (C) 2000  Curtis L. Olson  - curt@hfrl.umn.edu
   9 //
  10 // This program is free software; you can redistribute it and/or
  11 // modify it under the terms of the GNU General Public License as
  12 // published by the Free Software Foundation; either version 2 of the
  13 // License, or (at your option) any later version.
  14 //
  15 // This program is distributed in the hope that it will be useful, but
  16 // WITHOUT ANY WARRANTY; without even the implied warranty of
  17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18 // General Public License for more details.
  19 //
  20 // You should have received a copy of the GNU General Public License
  21 // along with this program; if not, write to the Free Software
  22 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  23 //
  24 // $Id$
  25
  26
  27 #ifndef _ROUTE_HXX
  28 #define _ROUTE_HXX
  29
  30
  31 #ifndef __cplusplus
  32 # error This library requires C++
  33 #endif
  34
  35 #include <simgear/compiler.h>
  36
  37 #include <vector>
  38
  39 using std::vector;
  40
  41 #include <simgear/route/waypoint.hxx>
  42
  43 /**
  44  * A class to manage a list of waypoints (i.e. a route).
  45  */
  46
  47 class SGRoute {
  48
  49 private:
  50
  51     typedef vector < SGWayPoint > route_list;
  52     route_list route;
  53     int current_wp;
  54
  55     void update_distance(int index);
  56
  57 public:
  58
  59     /** Constructor */
  60     SGRoute();
  61
  62     /** Destructor */
  63     ~SGRoute();
  64
  65     /** Clear the entire route */
  66     inline void clear() {
  67         route.clear();
  68         current_wp = 0;
  69     }
  70
  71     /**
  72      * Add waypoint (default), or insert waypoint at position n.
  73      * @param wp a waypoint
  74      */
  75     void add_waypoint( const SGWayPoint &wp, int n = -1 );
  76     /**
  77      * Get the number of waypoints (i.e. route length )
  78      * @return route length
  79      */
  80     inline int size() const { return route.size(); }
  81
  82     /**
  83      * Get the front waypoint.
  84      * @return the first waypoint.
  85      */
  86     inline SGWayPoint get_first() const {
  87         if ( route.size() ) {
  88             return route[0];
  89         } else {
  90             return SGWayPoint( 0.0, 0.0, 0.0, SGWayPoint::WGS84, "invalid" );
  91         }
  92     }
  93
  94     /**
  95      * Get the current waypoint
  96      * @return the current waypoint
  97      */
  98     inline SGWayPoint get_current() const {
  99         if ( current_wp < (int)route.size() ) {
 100             return route[current_wp];
 101         } else {
 102             return SGWayPoint( 0.0, 0.0, 0.0, SGWayPoint::WGS84, "invalid" );
 103         }
 104     }
 105
 106     /**
 107      * Set the current waypoint
 108      * @param number of waypoint to make current.
 109      */
 110     inline void set_current( int n ) {
 111         if ( n >= 0 && n < (int)route.size() ) {
 112             current_wp = n;
 113         }
 114     }
 115
 116     /** Increment the current waypoint pointer. */
 117     inline void increment_current() {
 118         if ( current_wp < (int)route.size() - 1 ) {
 119             ++current_wp;
 120         }
 121     }
 122
 123     /**
 124      * Get the nth waypoint
 125      * @param n waypoint number
 126      * @return the nth waypoint
 127      */
 128     inline SGWayPoint get_waypoint( const int n ) const {
 129         if ( n < (int)route.size() ) {
 130             return route[n];
 131         } else {
 132             return SGWayPoint( 0.0, 0.0, 0.0, SGWayPoint::WGS84, "invalid" );
 133         }
 134     }
 135
 136     /** Delete the front waypoint */
 137     inline void delete_first() { delete_waypoint(0); }
 138
 139     /** Delete waypoint waypoint with index n  (last one if n < 0) */
 140     void delete_waypoint( int n = 0 );
 141
 142     /**
 143      * Calculate perpendicular distance from the current route segment
 144      * This routine assumes all points are laying on a flat plane and
 145      * ignores the altitude (or Z) dimension.  For most accurate
 146      * results, use with CARTESIAN way points.
 147      */
 148     double distance_off_route( double x, double y ) const;
 149 };
 150
 151
 152 #endif // _ROUTE_HXX