3 * Provides a class to manage a list of waypoints (i.e. a route).
6 // Written by Curtis Olson, started October 2000.
8 // Copyright (C) 2000 Curtis L. Olson - curt@hfrl.umn.edu
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.
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.
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.
32 # error This library requires C++
36 #include <simgear/compiler.h>
44 #include <simgear/route/waypoint.hxx>
47 * A class to manage a list of waypoints (i.e. a route).
54 typedef vector < SGWayPoint > route_list;
66 /** Clear the entire route */
73 * Add waypoint (default), or insert waypoint at position n.
74 * @param wp a waypoint
76 void add_waypoint( const SGWayPoint &wp, int n = -1 ) {
77 if ( n < 0 || n >= (int)route.size() )
78 route.push_back( wp );
80 route.insert( route.begin() + n, 1, wp );
82 int size = route.size();
84 SGWayPoint next_to_last = route[ size - 2 ];
86 wp.CourseAndDistance( next_to_last, &tmpc, &tmpd );
87 route[size - 1].set_distance( tmpd );
92 * Get the number of waypoints (i.e. route length )
93 * @return route length
95 inline int size() const { return route.size(); }
98 * Get the front waypoint.
99 * @return the first waypoint.
101 inline SGWayPoint get_first() const {
102 if ( route.size() ) {
105 return SGWayPoint( 0.0, 0.0, 0.0, SGWayPoint::WGS84, "invalid" );
110 * Get the current waypoint
111 * @return the current waypoint
113 inline SGWayPoint get_current() const {
114 if ( current_wp < (int)route.size() ) {
115 return route[current_wp];
117 return SGWayPoint( 0.0, 0.0, 0.0, SGWayPoint::WGS84, "invalid" );
122 * Set the current waypoint
123 * @param number of waypoint to make current.
125 inline void set_current( int n ) {
126 if ( n >= 0 && n < (int)route.size() ) {
131 /** Increment the current waypoint pointer. */
132 inline void increment_current() {
133 if ( current_wp < (int)route.size() - 1 ) {
139 * Get the nth waypoint
140 * @param n waypoint number
141 * @return the nth waypoint
143 inline SGWayPoint get_waypoint( const int n ) const {
144 if ( n < (int)route.size() ) {
147 return SGWayPoint( 0.0, 0.0, 0.0, SGWayPoint::WGS84, "invalid" );
151 /** Delete the front waypoint */
152 inline void delete_first() { delete_waypoint(0); }
154 /** Delete waypoint waypoint with index n (last one if n < 0) */
155 void delete_waypoint( int n = 0 ) {
158 if ( n < 0 || n >= (int)route.size() )
159 n = route.size() - 1;
161 route.erase( route.begin() + n );
165 * Calculate perpendicular distance from the current route segment
166 * This routine assumes all points are laying on a flat plane and
167 * ignores the altitude (or Z) dimension. For most accurate
168 * results, use with CARTESIAN way points.
170 double distance_off_route( double x, double y ) const;