flightgear/src/Navaids/routePath.hxx

/**
 * routePath.hxx - convert a route to straight line segments, for graphical
 * output or display.
 */
 
// Written by James Turner, started 2010.
//
// Copyright (C) 2010  Curtis L. Olson
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License as
// published by the Free Software Foundation; either version 2 of the
// License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

#ifndef FG_ROUTE_PATH_HXX
#define FG_ROUTE_PATH_HXX

#include <Navaids/route.hxx>

namespace flightgear
{
  class Hold;
  class FlightPlan;
}

typedef std::vector<SGGeod> SGGeodVec;

class RoutePath
{
public:
  RoutePath(const flightgear::WayptVec& wpts);
  RoutePath(const flightgear::FlightPlan* fp);
  
  SGGeodVec pathForIndex(int index) const;
  
  SGGeod positionForIndex(int index) const;
  
  double computeDistanceForIndex(int index) const;
  double computeTrackForIndex(int index) const;

private:
  void commonInit();
  
  class PathCtx;
  
  SGGeodVec pathForHold(flightgear::Hold* hold) const;
  
  bool computedPositionForIndex(int index, SGGeod& pos) const;
  double computeAltitudeForIndex(int index) const;
  
  void interpolateGreatCircle(const SGGeod& aFrom, const SGGeod& aTo, SGGeodVec& r) const;
  
  /**
   * Find the distance (in Nm) to climb/descend a height in feet
   */
  double distanceForClimb(double climbFt) const;
  
  double magVarFor(const SGGeod& gd) const; 
  
  flightgear::WayptVec _waypts;

  int _pathClimbFPM; ///< climb-rate to use for pathing
  int _pathDescentFPM; ///< descent rate to use (feet-per-minute)
  int _pathIAS; ///< IAS (knots) to use for pathing
  double _pathTurnRate; ///< degrees-per-second, defaults to 3, i.e 180 in a minute
};

#endif