src/ATC/ATCutils.hxx

   1 // ATCutils.hxx - Utility functions for the ATC / AI subsytem
   2 //
   3 // Written by David Luff, started March 2002.
   4 //
   5 // Copyright (C) 2002  David C Luff - david.luff@nottingham.ac.uk
   6 //
   7 // This program is free software; you can redistribute it and/or
   8 // modify it under the terms of the GNU General Public License as
   9 // published by the Free Software Foundation; either version 2 of the
  10 // License, or (at your option) any later version.
  11 //
  12 // This program is distributed in the hope that it will be useful, but
  13 // WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 // General Public License for more details.
  16 //
  17 // You should have received a copy of the GNU General Public License
  18 // along with this program; if not, write to the Free Software
  19 // Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20
  21 #include <Airports/simple.hxx>
  22 #include <Airports/runways.hxx>
  23
  24 #include <math.h>
  25 #include <simgear/math/point3d.hxx>
  26 #include <string>
  27 SG_USING_STD(string);
  28
  29 // These are defined here because I had a problem with SG_DEGREES_TO_RADIANS
  30 #define DCL_PI  3.1415926535f
  31 #define DCL_DEGREES_TO_RADIANS  (DCL_PI/180.0)
  32 #define DCL_RADIANS_TO_DEGREES  (180.0/DCL_PI)
  33
  34 /*******************************
  35 *
  36 *  Communication functions
  37 *
  38 ********************************/
  39
  40 // Convert any number to spoken digits
  41 string ConvertNumToSpokenDigits(string n);
  42
  43 // Convert a 2 digit rwy number to a spoken-style string
  44 string ConvertRwyNumToSpokenString(int n);
  45
  46 // Convert rwy number string to a spoken-style string
  47 // eg "05L" to "zero five left"
  48 // Assumes we get a two-digit string optionally appended with R or L
  49 // eg 01 07L 29R 36
  50 // Anything else is not guaranteed to be handled correctly!
  51 string ConvertRwyNumToSpokenString(string s);
  52
  53 // Return the phonetic letter of a letter represented as an integer 1->26
  54 string GetPhoneticIdent(int i);
  55
  56
  57 /*******************************
  58 *
  59 *  Positional functions
  60 *
  61 ********************************/
  62
  63 // Given two positions (lat & lon in degrees), get the HORIZONTAL separation (in meters)
  64 double dclGetHorizontalSeparation(Point3D pos1, Point3D pos2);
  65
  66 // Given a point and a line, get the HORIZONTAL shortest distance from the point to a point on the line.
  67 // Expects to be fed orthogonal co-ordinates, NOT lat & lon !
  68 double dclGetLinePointSeparation(double px, double py, double x1, double y1, double x2, double y2);
  69
  70 // Given a position (lat/lon/elev), heading, vertical angle, and distance, calculate the new position.
  71 // Assumes that the ground is not hit!!!  Expects heading and angle in degrees, distance in meters.
  72 Point3D dclUpdatePosition(Point3D pos, double heading, double angle, double distance);
  73
  74 // Get a heading from one lat/lon to another (in degrees)
  75 double GetHeadingFromTo(Point3D A, Point3D B);
  76
  77 // Given a heading (in degrees), bound it from 0 -> 360
  78 void dclBoundHeading(double &hdg);
  79
  80 // smallest difference between two angles in degrees
  81 // difference is negative if a1 > a2 and positive if a2 > a1
  82 double GetAngleDiff_deg( const double &a1, const double &a2);
  83
  84
  85 /*******************************
  86 *
  87 *       Airport-related functions
  88 *
  89 ********************************/
  90
  91 // The next two functions are straight copies of their fg.... equivalents
  92 // in fg_init.cxx, and are just here temporarily until some rationalisation occurs.
  93
  94 // find basic airport location info from airport database
  95 bool dclFindAirportID( const string& id, FGAirport *a );
  96
  97 // get airport elevation
  98 double dclGetAirportElev( const string& id );
  99
 100 /****************
 101 *
 102 *   Runways
 103 *
 104 ****************/
 105
 106 // Given a Point3D (lon/lat/elev) and an FGRunway struct, determine if the point lies on the runway
 107 bool OnRunway(Point3D pt, const FGRunway& rwy);
 108