1 // FGAILocalTraffic - AIEntity derived class with enough logic to
2 // fly and interact with the traffic pattern.
4 // Written by David Luff, started March 2002.
6 // Copyright (C) 2002 David C. Luff - david.luff@nottingham.ac.uk
8 // This program is free software; you can redistribute it and/or
9 // modify it under the terms of the GNU General Public License as
10 // published by the Free Software Foundation; either version 2 of the
11 // License, or (at your option) any later version.
13 // This program is distributed in the hope that it will be useful, but
14 // WITHOUT ANY WARRANTY; without even the implied warranty of
15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 // General Public License for more details.
18 // You should have received a copy of the GNU General Public License
19 // along with this program; if not, write to the Free Software
20 // Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
22 #ifndef _FG_AILocalTraffic_HXX
23 #define _FG_AILocalTraffic_HXX
27 #include <simgear/math/point3d.hxx>
28 #include <Main/fg_props.hxx>
31 #include "AIPlane.hxx"
32 #include "ATCProjection.hxx"
64 // perhaps we could use an FGRunway instead of this
65 struct RunwayDetails {
66 Point3D threshold_pos;
67 Point3D end1ortho; // ortho projection end1 (the threshold ATM)
68 Point3D end2ortho; // ortho projection end2 (the take off end in the current hardwired scheme)
71 double hdg; // true runway heading
72 double length; // In *METERS*
77 struct StartofDescent {
83 class FGAILocalTraffic : public FGAIPlane {
91 bool Init(string ICAO, OperatingState initialState = PARKED, PatternLeg initialLeg = DOWNWIND);
93 // Run the internal calculations
94 void Update(double dt);
96 // Go out and practice circuits
97 void FlyCircuits(int numCircuits, bool tag);
101 // Attempt to enter the traffic pattern in a reasonably intelligent manner
102 void EnterTrafficPattern(double dt);
104 // Do what is necessary to land and parkup at home airport
105 void ReturnToBase(double dt);
109 // This is purely for synactic convienience to avoid writing globals->get_ATC_mgr()-> all through the code!
112 OperatingState operatingState;
113 int circuitsToFly; //Number of circuits still to do in this session NOT INCLUDING THE CURRENT ONE
114 bool touchAndGo; //True if circuits should be flown touch and go, false for full stop
116 // Its possible that this might be moved out to the ground/airport class at some point.
117 FGATCAlignedProjection ortho; // Orthogonal mapping of the local area with the threshold at the origin
118 // and the runway aligned with the y axis.
120 // Airport/runway/pattern details
121 string airportID; // The ICAO code of the airport that we're operating around
122 double aptElev; // Airport elevation
123 FGGround* ground; // A pointer to the ground control.
124 FGTower* tower; // A pointer to the tower control.
126 double patternDirection; // 1 for right, -1 for left (This is double because we multiply/divide turn rates
127 // with it to get RH/LH turns - DON'T convert it to int under ANY circumstances!!
128 double glideAngle; // Assumed to be visual glidepath angle for FGAILocalTraffic - can be found at www.airnav.com
129 // Its conceivable that patternDirection and glidePath could be moved into the RunwayDetails structure.
131 // Performance characteristics of the plane in knots and ft/min - some of this might get moved out into FGAIPlane
133 double best_rate_of_climb_speed;
134 double best_rate_of_climb;
135 double nominal_climb_speed;
136 double nominal_climb_rate;
137 double nominal_circuit_speed;
138 double min_circuit_speed;
139 double max_circuit_speed;
140 double nominal_descent_rate;
141 double nominal_approach_speed;
142 double nominal_final_speed;
143 double stall_speed_landing_config;
144 double nominal_taxi_speed;
146 // Physical/rendering stuff
147 double wheelOffset; // Height above ground at which we need to render the plane whilst taxiing
148 bool elevInitGood; // We have had at least one good elev reading
149 bool inAir; // True when off the ground
151 // environment - some of this might get moved into FGAIPlane
152 SGPropertyNode* wind_from_hdg; //degrees
153 SGPropertyNode* wind_speed_knots; //knots
155 // Pattern details that (may) change
156 int numInPattern; // Number of planes in the pattern (this might get more complicated if high performance GA aircraft fly a higher pattern eventually)
157 int numAhead; // More importantly - how many of them are ahead of us?
158 double distToNext; // And even more importantly, how near are we getting to the one immediately ahead?
159 PatternLeg leg; // Out current position in the pattern
160 StartofDescent SoD; // Start of descent calculated wrt wind, pattern size & altitude, glideslope etc
163 // At the moment this assumes that all taxiing in is to gates (a loose term that includes
164 // any permitted parking spot) and that all taxiing out is to runways.
168 double desiredTaxiHeading;
169 double taxiTurnRadius;
170 double nominalTaxiSpeed;
172 ground_network_path_type path; // a path through the ground network for the plane to taxi
173 unsigned int taxiPathPos; // position of iterator in taxi path when applicable
174 node* nextTaxiNode; // next node in taxi path
175 //Runway out_dest; //FIXME - implement this
176 bool liningUp; // Set true when the turn onto the runway heading is commenced when taxiing out
178 void FlyTrafficPattern(double dt);
180 // TODO - need to add something to define what option we are flying - Touch and go / Stop and go / Landing properly / others?
182 void TransmitPatternPositionReport();
184 void CalculateStartofDescent();
186 void ExitRunway(Point3D orthopos);
190 void Taxi(double dt);
192 void GetNextTaxiNode();
196 void GetRwyDetails();
199 #endif // _FG_AILocalTraffic_HXX