-// Utility functions for the ATC / AI subsytem declarations
+// ATCutils.hxx - Utility functions for the ATC / AI subsytem
+//
+// Written by David Luff, started March 2002.
+//
+// Copyright (C) 2002 David C Luff - david.luff@nottingham.ac.uk
+//
+// 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., 675 Mass Ave, Cambridge, MA 02139, USA.
+
+#include <Airports/simple.hxx>
+#include <Airports/runways.hxx>
#include <math.h>
#include <simgear/math/point3d.hxx>
+#include <string>
+SG_USING_STD(string);
+
+// These are defined here because I had a problem with SG_DEGREES_TO_RADIANS
+#define DCL_PI 3.1415926535f
+#define DCL_DEGREES_TO_RADIANS (DCL_PI/180.0)
+#define DCL_RADIANS_TO_DEGREES (180.0/DCL_PI)
+
+/*******************************
+*
+* Communication functions
+*
+********************************/
+
+// Convert any number to spoken digits
+string ConvertNumToSpokenDigits(const string &n);
+
+// Convert an integer to spoken digits
+string ConvertNumToSpokenDigits(int n);
+
+// Convert a 2 digit rwy number to a spoken-style string
+string ConvertRwyNumToSpokenString(int n);
+
+// Convert rwy number string to a spoken-style string
+// eg "05L" to "zero five left"
+// Assumes we get a two-digit string optionally appended with R, L, or C
+// eg 01 07L 29R 36
+// Anything else is not guaranteed to be handled correctly!
+string ConvertRwyNumToSpokenString(const string &s);
+
+// Return the phonetic letter of a letter represented as an integer 1->26
+string GetPhoneticIdent(int i);
+
+// Return the phonetic letter of a character in the range a-z or A-Z.
+// Currently always returns prefixed by lowercase.
+string GetPhoneticIdent(char c);
+
+// Get the compass direction associated with a heading in degrees
+// Currently returns 8 direction resolution (N, NE, E etc...)
+// Might be modified in future to return 4, 8 or 16 resolution but defaulting to 8.
+string GetCompassDirection(double h);
+
+/*******************************
+*
+* Positional functions
+*
+********************************/
+
+// Given two positions (lat & lon in degrees), get the HORIZONTAL separation (in meters)
+double dclGetHorizontalSeparation(const Point3D& pos1, const Point3D& pos2);
-// Given two positions, get the HORIZONTAL separation
-double dclGetHorizontalSeparation(Point3D pos1, Point3D pos2);
+// Given a point and a line, get the HORIZONTAL shortest distance from the point to a point on the line.
+// Expects to be fed orthogonal co-ordinates, NOT lat & lon !
+double dclGetLinePointSeparation(double px, double py, double x1, double y1, double x2, double y2);
// Given a position (lat/lon/elev), heading, vertical angle, and distance, calculate the new position.
// Assumes that the ground is not hit!!! Expects heading and angle in degrees, distance in meters.
-Point3D dclUpdatePosition(Point3D pos, double heading, double angle, double distance);
+Point3D dclUpdatePosition(const Point3D& pos, double heading, double angle, double distance);
+
+// Get a heading from one lat/lon to another (in degrees)
+double GetHeadingFromTo(const Point3D& A, const Point3D& B);
+
+// Given a heading (in degrees), bound it from 0 -> 360
+void dclBoundHeading(double &hdg);
+
+// smallest difference between two angles in degrees
+// difference is negative if a1 > a2 and positive if a2 > a1
+double GetAngleDiff_deg( const double &a1, const double &a2);
+
+
+/*******************************
+*
+* Airport-related functions
+*
+********************************/
+
+// The next two functions are straight copies of their fg.... equivalents
+// in fg_init.cxx, and are just here temporarily until some rationalisation occurs.
+
+// find basic airport location info from airport database
+bool dclFindAirportID( const string& id, FGAirport *a );
+
+// get airport elevation IN METERS
+double dclGetAirportElev( const string& id );
+
+// get airport position (elev portion in FEET)
+Point3D dclGetAirportPos( const string& id );
+
+/****************
+*
+* Runways
+*
+****************/
+
+// Given a Point3D (lon/lat/elev) and an FGRunway struct, determine if the point lies on the runway
+bool OnRunway(const Point3D& pt, const FGRunway& rwy);
+
projects / flightgear.git / blobdiff