src/Navaids/routePath.hxx

   1 /**
   2  * routePath.hxx - convert a route to straight line segments, for graphical
   3  * output or display.
   4  */
   5
   6 // Written by James Turner, started 2010.
   7 //
   8 // Copyright (C) 2010  Curtis L. Olson
   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 #ifndef FG_ROUTE_PATH_HXX
  25 #define FG_ROUTE_PATH_HXX
  26
  27 #include <Navaids/route.hxx>
  28
  29 namespace flightgear
  30 {
  31   class Hold;
  32 }
  33
  34 typedef std::vector<SGGeod> SGGeodVec;
  35
  36 class RoutePath
  37 {
  38 public:
  39   RoutePath(const flightgear::WayptVec& wpts);
  40
  41   SGGeodVec pathForIndex(int index) const;
  42
  43   SGGeod positionForIndex(int index) const;
  44
  45 private:
  46   class PathCtx;
  47
  48   SGGeodVec pathForHold(flightgear::Hold* hold) const;
  49
  50   bool computedPositionForIndex(int index, SGGeod& pos) const;
  51   double computeAltitudeForIndex(int index) const;
  52   double computeTrackForIndex(int index) const;
  53
  54   /**
  55    * Find the distance (in Nm) to climb/descend a height in feet
  56    */
  57   double distanceForClimb(double climbFt) const;
  58
  59   double magVarFor(const SGGeod& gd) const;
  60
  61   flightgear::WayptVec _waypts;
  62
  63   int _pathClimbFPM; ///< climb-rate to use for pathing
  64   int _pathDescentFPM; ///< descent rate to use (feet-per-minute)
  65   int _pathIAS; ///< IAS (knots) to use for pathing
  66   double _pathTurnRate; ///< degrees-per-second, defaults to 3, i.e 180 in a minute
  67 };
  68
  69 #endif