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.
26 #include <simgear/scene/model/location.hxx>
28 #include <Airports/runways.hxx>
29 #include <Main/globals.hxx>
30 #include <Scenery/scenery.hxx>
31 #include <Scenery/tilemgr.hxx>
32 #include <simgear/math/point3d.hxx>
33 #include <simgear/math/sg_geodesy.hxx>
34 #include <simgear/misc/sg_path.hxx>
41 #include "AILocalTraffic.hxx"
42 #include "ATCutils.hxx"
44 FGAILocalTraffic::FGAILocalTraffic() {
45 ATC = globals->get_ATC_mgr();
47 // TODO - unhardwire this - possibly let the AI manager set the callsign
48 plane.callsign = "Trainer-two-five-charlie";
49 plane.type = GA_SINGLE;
55 //Hardwire initialisation for now - a lot of this should be read in from config eventually
57 best_rate_of_climb_speed = 70.0;
59 //nominal_climb_speed;
61 //nominal_circuit_speed;
64 nominal_descent_rate = 500.0;
65 nominal_final_speed = 65.0;
66 //nominal_approach_speed;
67 //stall_speed_landing_config;
68 nominalTaxiSpeed = 7.5;
70 wheelOffset = 1.45; // Warning - hardwired to the C172 - we need to read this in from file.
72 // Init the property nodes
73 wind_from_hdg = fgGetNode("/environment/wind-from-heading-deg", true);
74 wind_speed_knots = fgGetNode("/environment/wind-speed-kt", true);
77 taxiRequestPending = false;
78 taxiRequestCleared = false;
80 clearedToLineUp = false;
81 clearedToTakeOff = false;
82 reportReadyForDeparture = false;
84 contactGround = false;
87 targetDescentRate = 0.0;
90 FGAILocalTraffic::~FGAILocalTraffic() {
94 // Get details of the active runway
95 // It is assumed that by the time this is called the tower control and airport code will have been set up.
96 void FGAILocalTraffic::GetRwyDetails() {
97 //cout << "GetRwyDetails called" << endl;
99 rwy.rwyID = tower->GetActiveRunway();
101 // Now we need to get the threshold position and rwy heading
104 bool rwyGood = globals->get_runways()->search(airportID, rwy.rwyID,
107 // Get the threshold position
108 hdg = runway.heading; // TODO - check - is this our heading we are setting here, and if so should we be?
109 //cout << "hdg reset to " << hdg << '\n';
110 double other_way = hdg - 180.0;
111 while(other_way <= 0.0) {
115 // move to the +l end/center of the runway
116 //cout << "Runway center is at " << runway.lon << ", " << runway.lat << '\n';
117 Point3D origin = Point3D(runway.lon, runway.lat, aptElev);
118 Point3D ref = origin;
119 double tshlon, tshlat, tshr;
120 double tolon, tolat, tor;
121 rwy.length = runway.length * SG_FEET_TO_METER;
122 geo_direct_wgs_84 ( aptElev, ref.lat(), ref.lon(), other_way,
123 rwy.length / 2.0 - 25.0, &tshlat, &tshlon, &tshr );
124 geo_direct_wgs_84 ( aptElev, ref.lat(), ref.lon(), hdg,
125 rwy.length / 2.0 - 25.0, &tolat, &tolon, &tor );
126 // Note - 25 meters in from the runway end is a bit of a hack to put the plane ahead of the user.
127 // now copy what we need out of runway into rwy
128 rwy.threshold_pos = Point3D(tshlon, tshlat, aptElev);
129 Point3D takeoff_end = Point3D(tolon, tolat, aptElev);
130 //cout << "Threshold position = " << tshlon << ", " << tshlat << ", " << aptElev << '\n';
131 //cout << "Takeoff position = " << tolon << ", " << tolat << ", " << aptElev << '\n';
133 // Set the projection for the local area
134 ortho.Init(rwy.threshold_pos, rwy.hdg);
135 rwy.end1ortho = ortho.ConvertToLocal(rwy.threshold_pos); // should come out as zero
136 rwy.end2ortho = ortho.ConvertToLocal(takeoff_end);
138 SG_LOG(SG_ATC, SG_ALERT, "Help - can't get good runway in FGAILocalTraffic!!\n");
144 There are two possible scenarios during initialisation:
145 The first is that the user is flying towards the airport, and hence the traffic
146 could be initialised anywhere, as long as the AI planes are consistent with
148 The second is that the user has started the sim at or close to the airport, and
149 hence the traffic must be initialised with respect to the user as well as each other.
150 To a certain extent it's FGAIMgr that has to worry about this, but we need to provide
151 sufficient initialisation functionality within the plane classes to allow the manager
152 to initialy position them where and how required.
154 bool FGAILocalTraffic::Init(string ICAO, OperatingState initialState, PatternLeg initialLeg) {
155 //cout << "FGAILocalTraffic.Init(...) called" << endl;
156 // Hack alert - Hardwired path!!
157 string planepath = "Aircraft/c172/Models/c172-dpm.ac";
158 ssgBranch *model = sgLoad3DModel( globals->get_fg_root(),
160 globals->get_props(),
161 globals->get_sim_time_sec() );
163 aip.setVisible(false); // This will be set to true once a valid ground elevation has been determined
164 globals->get_scenery()->get_scene_graph()->addKid(aip.getSceneGraph());
166 // Find the tower frequency - this is dependent on the ATC system being initialised before the AI system
169 if(ATC->GetAirportATCDetails(airportID, &a)) {
170 if(a.tower_freq) { // Has a tower
171 tower = (FGTower*)ATC->GetATCPointer((string)airportID, TOWER); // Maybe need some error checking here
173 // Something has gone wrong - abort or carry on with un-towered operation?
176 freq = (double)tower->get_freq() / 100.0;
177 ground = tower->GetGroundPtr();
179 // Something has gone wrong :-(
180 SG_LOG(SG_ATC, SG_ALERT, "ERROR - can't get a ground pointer from tower control in FGAILocalTraffic::Init() :-(");
182 } else if((initialState == PARKED) || (initialState == TAXIING)) {
183 freq = (double)ground->get_freq() / 100.0;
185 //cout << "AILocalTraffic freq is " << freq << '\n';
187 // TODO - Check CTAF, unicom etc
190 //cout << "Unable to find airport details in FGAILocalTraffic::Init()\n";
193 // Get the airport elevation
194 aptElev = dclGetAirportElev(airportID.c_str()) * SG_FEET_TO_METER;
195 //cout << "Airport elev in AILocalTraffic = " << aptElev << '\n';
196 // WARNING - we use this elev for the whole airport - some assumptions in the code
197 // might fall down with very slopey airports.
199 //cout << "In Init(), initialState = " << initialState << endl;
200 operatingState = initialState;
201 switch(operatingState) {
203 ourGate = ground->GetGateNode();
204 if(ourGate == NULL) {
205 // Implies no available gates - what shall we do?
206 // For now just vanish the plane - possibly we can make this more elegant in the future
207 SG_LOG(SG_ATC, SG_ALERT, "No gate found by FGAILocalTraffic whilst attempting Init at " << airportID << '\n');
215 pos.setelev(aptElev);
216 hdg = ourGate->heading;
218 // Now we've set the position we can do the ground elev
219 elevInitGood = false;
226 // FIXME - implement this case properly
227 return(false); // remove this line when fixed!
230 // For now we'll always start the in_pattern case on the threshold ready to take-off
231 // since we've got the implementation for this case already.
232 // TODO - implement proper generic in_pattern startup.
234 // Get the active runway details (and copy them into rwy)
237 // Initial position on threshold for now
238 pos.setlat(rwy.threshold_pos.lat());
239 pos.setlon(rwy.threshold_pos.lon());
240 pos.setelev(rwy.threshold_pos.elev());
243 // Now we've set the position we can do the ground elev
244 // This might not always be necessary if we implement in-air start
245 elevInitGood = false;
255 circuitsToFly = 0; // ie just fly this circuit and then stop
257 // FIXME TODO - pattern direction is still hardwired
258 patternDirection = -1; // Left
259 // At the bare minimum we ought to make sure it goes the right way at dual parallel rwy airports!
260 if(rwy.rwyID.size() == 3) {
261 patternDirection = (rwy.rwyID.substr(2,1) == "R" ? 1 : -1);
264 operatingState = IN_PATTERN;
269 SG_LOG(SG_ATC, SG_ALERT, "Attempt to set unknown operating state in FGAILocalTraffic.Init(...)\n");
278 // Return what type of landing we're doing on this circuit
279 LandingType FGAILocalTraffic::GetLandingOption() {
281 return(touchAndGo ? TOUCH_AND_GO : STOP_AND_GO);
288 // Commands to do something from higher level logic
289 void FGAILocalTraffic::FlyCircuits(int numCircuits, bool tag) {
290 //cout << "FlyCircuits called" << endl;
292 switch(operatingState) {
294 circuitsToFly += numCircuits;
298 // For now we'll punt this and do nothing
301 circuitsToFly = numCircuits; // Note that one too many circuits gets flown because we only test and decrement circuitsToFly after landing
302 // thus flying one too many circuits. TODO - Need to sort this out better!
305 // Get the active runway details (and copy them into rwy)
308 // Get the takeoff node for the active runway, get a path to it and start taxiing
309 path = ground->GetPath(ourGate, rwy.rwyID);
310 if(path.size() < 2) {
311 // something has gone wrong
312 SG_LOG(SG_ATC, SG_ALERT, "Invalid path from gate to theshold in FGAILocalTraffic::FlyCircuits\n");
316 cout << "path returned was:" << endl;
317 for(unsigned int i=0; i<path.size(); ++i) {
318 switch(path[i]->struct_type) {
320 cout << "NODE " << ((node*)(path[i]))->nodeID << endl;
328 // pop the gate - we're here already!
329 path.erase(path.begin());
330 //path.erase(path.begin());
332 cout << "path after popping front is:" << endl;
333 for(unsigned int i=0; i<path.size(); ++i) {
334 switch(path[i]->struct_type) {
336 cout << "NODE " << ((node*)(path[i]))->nodeID << endl;
345 taxiState = TD_OUTBOUND;
348 // Maybe the below should be set when we get to the threshold and prepare for TO?
349 // FIXME TODO - pattern direction is still hardwired
350 patternDirection = -1; // Left
351 // At the bare minimum we ought to make sure it goes the right way at dual parallel rwy airports!
352 if(rwy.rwyID.size() == 3) {
353 patternDirection = (rwy.rwyID.substr(2,1) == "R" ? 1 : -1);
362 // Run the internal calculations
363 void FGAILocalTraffic::Update(double dt) {
364 //cout << "A" << flush;
365 //double responseTime = 10.0; // seconds - this should get more sophisticated at some point
366 responseCounter += dt;
367 if((contactTower) && (responseCounter >= 8.0)) {
368 // Acknowledge request before changing frequency so it gets rendered if the user is on the same freq
369 string trns = "Tower ";
370 double f = globals->get_ATC_mgr()->GetFrequency(airportID, TOWER) / 100.0;
372 sprintf(buf, "%f", f);
375 trns += plane.callsign;
377 responseCounter = 0.0;
378 contactTower = false;
380 changeFreqType = TOWER;
383 if((changeFreq) && (responseCounter > 8.0)) {
384 switch(changeFreqType) {
386 freq = (double)tower->get_freq() / 100.0;
388 // Contact the tower, even if only virtually
390 tower->ContactAtHoldShort(plane, this, CIRCUIT);
393 freq = (double)ground->get_freq() / 100.0;
395 // And to avoid compiler warnings...
409 //cout << "." << flush;
411 switch(operatingState) {
413 //cout << "In IN_PATTERN\n";
414 if(!inAir) DoGroundElev();
416 if(aip.getSGLocation()->get_cur_elev_m() > -9990.0) {
417 pos.setelev(aip.getSGLocation()->get_cur_elev_m() + wheelOffset);
418 //cout << "TAKEOFF_ROLL, POS = " << pos.lon() << ", " << pos.lat() << ", " << pos.elev() << '\n';
420 aip.setVisible(true);
421 //cout << "Making plane visible!\n";
425 FlyTrafficPattern(dt);
429 //cout << "In TAXIING\n";
430 //cout << "*" << flush;
433 if(aip.getSGLocation()->get_cur_elev_m() > -9990.0) {
434 pos.setelev(aip.getSGLocation()->get_cur_elev_m() + wheelOffset);
436 aip.setVisible(true);
438 //cout << "Making plane visible!\n";
443 //cout << "," << flush;
444 if(!((holdingShort) && (!clearedToLineUp))) {
445 //cout << "|" << flush;
448 //cout << ";" << flush;
449 if((clearedToTakeOff) && (responseCounter >= 8.0)) {
450 // possible assumption that we're at the hold short here - may not always hold
451 // TODO - sort out the case where we're cleared to line-up first and then cleared to take-off on the rwy.
452 taxiState = TD_LINING_UP;
453 path = ground->GetPath(holdShortNode, rwy.rwyID);
455 cout << "path returned was:" << endl;
456 for(unsigned int i=0; i<path.size(); ++i) {
457 switch(path[i]->struct_type) {
459 cout << "NODE " << ((node*)(path[i]))->nodeID << endl;
467 clearedToTakeOff = false; // We *are* still cleared - this simply stops the response recurring!!
468 holdingShort = false;
469 string trns = "Cleared for take-off ";
470 trns += plane.callsign;
474 //cout << "^" << flush;
478 //cout << "In PARKED\n";
481 if(aip.getSGLocation()->get_cur_elev_m() > -9990.0) {
482 pos.setelev(aip.getSGLocation()->get_cur_elev_m() + wheelOffset);
484 aip.setVisible(true);
486 //cout << "Making plane visible!\n";
492 if((taxiRequestPending) && (taxiRequestCleared)) {
493 //cout << "&" << flush;
494 // Get the active runway details (and copy them into rwy)
497 // Get the takeoff node for the active runway, get a path to it and start taxiing
498 path = ground->GetPathToHoldShort(ourGate, rwy.rwyID);
499 if(path.size() < 2) {
500 // something has gone wrong
501 SG_LOG(SG_ATC, SG_ALERT, "Invalid path from gate to theshold in FGAILocalTraffic::FlyCircuits\n");
505 cout << "path returned was:\n";
506 for(unsigned int i=0; i<path.size(); ++i) {
507 switch(path[i]->struct_type) {
509 cout << "NODE " << ((node*)(path[i]))->nodeID << endl;
517 path.erase(path.begin()); // pop the gate - we're here already!
518 taxiState = TD_OUTBOUND;
519 taxiRequestPending = false;
520 holdShortNode = (node*)(*(path.begin() + path.size()));
522 } else if(!taxiRequestPending) {
523 //cout << "(" << flush;
524 ground->RequestDeparture(plane, this);
525 // Do some communication
526 // airport name + tower + airplane callsign + location + request taxi for + operation type + ?
528 trns += tower->get_name();
530 trns += plane.callsign;
531 trns += " on apron parking request taxi for traffic pattern";
532 //cout << "trns = " << trns << endl;
534 taxiRequestCleared = false;
535 taxiRequestPending = true;
539 //cout << "!" << flush;
541 // Maybe the below should be set when we get to the threshold and prepare for TO?
542 // FIXME TODO - pattern direction is still hardwired
543 patternDirection = -1; // Left
544 // At the bare minimum we ought to make sure it goes the right way at dual parallel rwy airports!
545 if(rwy.rwyID.size() == 3) {
546 patternDirection = (rwy.rwyID.substr(2,1) == "R" ? 1 : -1);
550 //cout << ")" << flush;
555 //cout << "I " << flush;
557 // Convienience output for AI debugging user the property logger
558 fgSetDouble("/AI/Local1/ortho-x", (ortho.ConvertToLocal(pos)).x());
559 fgSetDouble("/AI/Local1/ortho-y", (ortho.ConvertToLocal(pos)).y());
560 fgSetDouble("/AI/Local1/elev", pos.elev() * SG_METER_TO_FEET);
563 void FGAILocalTraffic::RegisterTransmission(int code) {
565 case 1: // taxi request cleared
566 taxiRequestCleared = true;
567 SG_LOG(SG_ATC, SG_INFO, "AI local traffic " << plane.callsign << " cleared to taxi...");
569 case 2: // contact tower
572 SG_LOG(SG_ATC, SG_INFO, "AI local traffic " << plane.callsign << " told to contact tower...");
574 case 3: // Cleared to line up
576 clearedToLineUp = true;
577 SG_LOG(SG_ATC, SG_INFO, "AI local traffic " << plane.callsign << " cleared to line-up...");
579 case 4: // cleared to take-off
581 clearedToTakeOff = true;
582 SG_LOG(SG_ATC, SG_INFO, "AI local traffic " << plane.callsign << " cleared to take-off...");
589 // Fly a traffic pattern
590 // FIXME - far too much of the mechanics of turning, rolling, accellerating, descending etc is in here.
591 // Move it out to FGAIPlane and have FlyTrafficPattern just specify what to do, not the implementation.
592 void FGAILocalTraffic::FlyTrafficPattern(double dt) {
593 // Need to differentiate between in-air (IAS governed) and on-ground (vel governed)
594 // Take-off is an interesting case - we are on the ground but takeoff speed is IAS governed.
596 static bool transmitted = false; // FIXME - this is a hack
599 // Wind has two effects - a mechanical one in that IAS translates to a different vel, and the hdg != track,
600 // but also a piloting effect, in that the AI must be able to descend at a different rate in order to hit the threshold.
602 //cout << "dt = " << dt << '\n';
604 // ack - I can't remember how long a rate 1 turn is meant to take.
605 double turn_time = 60.0; // seconds - TODO - check this guess
606 double turn_circumference;
608 Point3D orthopos = ortho.ConvertToLocal(pos); // ortho position of the plane
609 //cout << "runway elev = " << rwy.threshold_pos.elev() << ' ' << rwy.threshold_pos.elev() * SG_METER_TO_FEET << '\n';
610 //cout << "elev = " << pos.elev() << ' ' << pos.elev() * SG_METER_TO_FEET << '\n';
612 // HACK FOR TESTING - REMOVE
613 //cout << "Calling ExitRunway..." << endl;
614 //ExitRunway(orthopos);
619 double wind_from = wind_from_hdg->getDoubleValue();
620 double wind_speed = wind_speed_knots->getDoubleValue();
632 if(aip.getSGLocation()->get_cur_elev_m() > -9990.0) {
633 pos.setelev(aip.getSGLocation()->get_cur_elev_m() + wheelOffset);
635 IAS = vel + (cos((hdg - wind_from) * DCL_DEGREES_TO_RADIANS) * wind_speed);
639 IAS = best_rate_of_climb_speed;
641 slope = 6.0; // Reduced it slightly since it's climbing a lot steeper than I can in the JSBSim C172.
647 // Turn to crosswind if above 600ft AND if other traffic allows
648 // (decided in FGTower and accessed through GetCrosswindConstraint(...)).
649 if((pos.elev() - rwy.threshold_pos.elev()) * SG_METER_TO_FEET > 600) {
651 if(tower->GetCrosswindConstraint(cc)) {
652 if(orthopos.y() > cc) {
653 cout << "Turning to crosswind, distance from threshold = " << orthopos.y() << '\n';
657 cout << "Turning to crosswind, distance from threshold = " << orthopos.y() << '\n';
661 // Need to check for levelling off in case we can't turn crosswind as soon
662 // as we would like due to other traffic.
663 if((pos.elev() - rwy.threshold_pos.elev()) * SG_METER_TO_FEET > 1000) {
666 IAS = 80.0; // FIXME - use smooth transistion to new speed and attitude.
670 track += (360.0 / turn_time) * dt * patternDirection;
671 Bank(25.0 * patternDirection);
672 if((track < (rwy.hdg - 89.0)) || (track > (rwy.hdg + 89.0))) {
678 track = rwy.hdg + (90.0 * patternDirection);
679 if((pos.elev() - rwy.threshold_pos.elev()) * SG_METER_TO_FEET > 1000) {
682 IAS = 80.0; // FIXME - use smooth transistion to new speed
684 // turn 1000m out for now, taking other traffic into accout
685 if(fabs(orthopos.x()) > 980) {
687 if(tower->GetDownwindConstraint(dd)) {
688 if(fabs(orthopos.x()) > fabs(dd)) {
689 cout << "Turning to downwind, distance from centerline = " << fabs(orthopos.x()) << '\n';
693 cout << "Turning to downwind, distance from centerline = " << fabs(orthopos.x()) << '\n';
699 track += (360.0 / turn_time) * dt * patternDirection;
700 Bank(25.0 * patternDirection);
701 // just in case we didn't make height on crosswind
702 if((pos.elev() - rwy.threshold_pos.elev()) * SG_METER_TO_FEET > 1000) {
705 IAS = 80.0; // FIXME - use smooth transistion to new speed
707 if((track < (rwy.hdg - 179.0)) || (track > (rwy.hdg + 179.0))) {
715 track = rwy.hdg - (180 * patternDirection); //should tend to bring track back into the 0->360 range
716 // just in case we didn't make height on crosswind
717 if((pos.elev() - rwy.threshold_pos.elev()) * SG_METER_TO_FEET > 1000) {
720 IAS = 90.0; // FIXME - use smooth transistion to new speed
722 if((orthopos.y() < 0) && (!transmitted)) {
723 TransmitPatternPositionReport();
726 if((orthopos.y() < -100) && (!descending)) {
727 // Maybe we should think about when to start descending.
728 // For now we're assuming that we aim to follow the same glidepath regardless of wind.
731 CalculateSoD((tower->GetBaseConstraint(d1) ? d1 : -1000.0), (tower->GetDownwindConstraint(d2) ? d2 : 1000.0 * patternDirection), (patternDirection ? true : false));
732 if(SoD.leg == DOWNWIND) {
733 descending = (orthopos.y() < SoD.y ? true : false);
738 slope = -5.5; // FIXME - calculate to descent at 500fpm and hit the desired point on the runway (taking wind into account as well!!)
743 // Try and arrange to turn nicely onto base
744 turn_circumference = IAS * 0.514444 * turn_time;
745 //Hmmm - this is an interesting one - ground vs airspeed in relation to turn radius
746 //We'll leave it as a hack with IAS for now but it needs revisiting.
747 turn_radius = turn_circumference / (2.0 * DCL_PI);
748 if(orthopos.y() < -1000.0 + turn_radius) {
749 //if(orthopos.y() < -980) {
751 if(tower->GetBaseConstraint(bb)) {
752 if(fabs(orthopos.y()) > fabs(bb)) {
753 cout << "Turning to base, distance from threshold = " << fabs(orthopos.y()) << '\n';
759 cout << "Turning to base, distance from threshold = " << fabs(orthopos.y()) << '\n';
767 track += (360.0 / turn_time) * dt * patternDirection;
768 Bank(25.0 * patternDirection);
769 if(fabs(rwy.hdg - track) < 91.0) {
776 TransmitPatternPositionReport();
782 // Make downwind leg position artifically large to avoid any chance of SoD being returned as
783 // on downwind when we are already on base.
784 CalculateSoD((tower->GetBaseConstraint(d1) ? d1 : -1000.0), (10000.0 * patternDirection), (patternDirection ? true : false));
785 if(SoD.leg == BASE) {
786 descending = (fabs(orthopos.y()) < fabs(SoD.y) ? true : false);
791 slope = -5.5; // FIXME - calculate to descent at 500fpm and hit the threshold (taking wind into account as well!!)
796 track = rwy.hdg - (90 * patternDirection);
798 // Try and arrange to turn nicely onto final
799 turn_circumference = IAS * 0.514444 * turn_time;
800 //Hmmm - this is an interesting one - ground vs airspeed in relation to turn radius
801 //We'll leave it as a hack with IAS for now but it needs revisiting.
802 turn_radius = turn_circumference / (2.0 * DCL_PI);
803 if(fabs(orthopos.x()) < (turn_radius + 50)) {
810 track += (360.0 / turn_time) * dt * patternDirection;
811 Bank(25.0 * patternDirection);
812 if(fabs(track - rwy.hdg) < 0.6) {
814 vel = nominal_final_speed;
820 TransmitPatternPositionReport();
824 // Make base leg position artifically large to avoid any chance of SoD being returned as
825 // on base or downwind when we are already on final.
826 CalculateSoD(-10000.0, (1000.0 * patternDirection), (patternDirection ? true : false));
827 if(SoD.leg == FINAL) {
828 descending = (fabs(orthopos.y()) < fabs(SoD.y) ? true : false);
833 slope = -5.5; // FIXME - calculate to descent at 500fpm and hit the threshold (taking wind into account as well!!)
837 // Try and track the extended centreline
838 track = rwy.hdg - (0.2 * orthopos.x());
839 //cout << "orthopos.x() = " << orthopos.x() << " hdg = " << hdg << '\n';
840 if(pos.elev() < (rwy.threshold_pos.elev()+20.0+wheelOffset)) {
841 DoGroundElev(); // Need to call it here expicitly on final since it's only called
842 // for us in update(...) when the inAir flag is false.
844 if(pos.elev() < (rwy.threshold_pos.elev()+10.0+wheelOffset)) {
845 if(aip.getSGLocation()->get_cur_elev_m() > -9990.0) {
846 if((aip.getSGLocation()->get_cur_elev_m() + wheelOffset) > pos.elev()) {
852 } // else need a fallback position based on arpt elev in case ground elev determination fails?
857 if(aip.getSGLocation()->get_cur_elev_m() > -9990.0) {
858 pos.setelev(aip.getSGLocation()->get_cur_elev_m() + wheelOffset);
863 // FIXME - differentiate between touch and go and full stops
865 //cout << "Vel <= 15.0, circuitsToFly = " << circuitsToFly << endl;
866 if(circuitsToFly <= 0) {
867 //cout << "Calling ExitRunway..." << endl;
868 ExitRunway(orthopos);
871 //cout << "Taking off again..." << endl;
882 // FIXME - at the moment this is a bit screwy
883 // The velocity correction is applied based on the relative headings.
884 // Then the heading is changed based on the velocity.
885 // Which comes first, the chicken or the egg?
886 // Does it really matter?
888 // Apply wind to ground-relative velocity if in the air
889 vel = IAS - (cos((hdg - wind_from) * DCL_DEGREES_TO_RADIANS) * wind_speed);
890 //crab = f(track, wind, vel);
891 // The vector we need to fly is our desired vector minus the wind vector
892 // TODO - we probably ought to use plib's built in vector types and operations for this
893 // ie. There's almost *certainly* a better way to do this!
894 double gxx = vel * sin(track * DCL_DEGREES_TO_RADIANS); // Plane desired velocity x component wrt ground
895 double gyy = vel * cos(track * DCL_DEGREES_TO_RADIANS); // Plane desired velocity y component wrt ground
896 double wxx = wind_speed * sin((wind_from + 180.0) * DCL_DEGREES_TO_RADIANS); // Wind velocity x component
897 double wyy = wind_speed * cos((wind_from + 180.0) * DCL_DEGREES_TO_RADIANS); // Wind velocity y component
898 double axx = gxx - wxx; // Plane in-air velocity x component
899 double ayy = gyy - wyy; // Plane in-air velocity y component
900 // Now we want the angle between gxx and axx (which is the crab)
901 double maga = sqrt(axx*axx + ayy*ayy);
902 double magg = sqrt(gxx*gxx + gyy*gyy);
903 crab = acos((axx*gxx + ayy*gyy) / (maga * magg));
904 // At this point this works except we're getting the modulus of the angle
905 //cout << "crab = " << crab << '\n';
907 // Make sure both headings are in the 0->360 circle in order to get sane differences
908 dclBoundHeading(wind_from);
909 dclBoundHeading(track);
910 if(track > wind_from) {
911 if((track - wind_from) <= 180) {
915 if((wind_from - track) >= 180) {
919 } else { // on the ground - crab dosen't apply
924 dist = vel * 0.514444 * dt;
925 pos = dclUpdatePosition(pos, track, slope, dist);
928 // Pattern direction is true for right, false for left
929 void FGAILocalTraffic::CalculateSoD(double base_leg_pos, double downwind_leg_pos, bool pattern_direction) {
930 // For now we'll ignore wind and hardwire the glide angle.
931 double ga = 5.5; //degrees
932 double pa = 1000.0 * SG_FEET_TO_METER; // pattern altitude in meters
933 // FIXME - get glideslope angle and pattern altitude agl from airport details if available
935 // For convienience, we'll have +ve versions of the input distances
936 double blp = fabs(base_leg_pos);
937 double dlp = fabs(downwind_leg_pos);
939 //double turn_allowance = 150.0; // Approximate distance in meters that a 90deg corner is shortened by turned in a light plane.
941 double stod = pa / tan(ga * DCL_DEGREES_TO_RADIANS); // distance in meters from touchdown point to start descent
942 cout << "Descent to start = " << stod << " meters out\n";
943 if(stod < blp) { // Start descending on final
947 } else if(stod < (blp + dlp)) { // Start descending on base leg
950 SoD.x = (pattern_direction ? (stod - dlp) : (stod - dlp) * -1.0);
951 } else { // Start descending on downwind leg
953 SoD.x = (pattern_direction ? dlp : dlp * -1.0);
954 SoD.y = (blp - (stod - (blp + dlp))) * -1.0;
958 void FGAILocalTraffic::TransmitPatternPositionReport(void) {
959 // airport name + "traffic" + airplane callsign + pattern direction + pattern leg + rwy + ?
962 trns += tower->get_name();
964 trns += plane.callsign;
965 if(patternDirection == 1) {
971 // We could probably get rid of this whole switch statement and just pass a string containing the leg from the FlyPattern function.
972 switch(leg) { // We'll assume that transmissions in turns are intended for next leg - do pilots ever call out that they are in the turn?
974 // Fall through to CROSSWIND
975 case CROSSWIND: // I don't think this case will be used here but it can't hurt to leave it in
976 trns += "crosswind ";
979 // Fall through to DOWNWIND
984 // Fall through to BASE
989 // Fall through to FINAL
990 case FINAL: // maybe this should include long/short final if appropriate?
993 default: // Hopefully this won't be used
997 // FIXME - I've hardwired the runway call as well!! (We could work this out from rwy heading and mag deviation)
998 trns += ConvertRwyNumToSpokenString(1);
1000 // And add the airport name again
1001 trns += tower->get_name();
1006 void FGAILocalTraffic::ExitRunway(Point3D orthopos) {
1007 //cout << "In ExitRunway" << endl;
1008 //cout << "Runway ID is " << rwy.ID << endl;
1009 node_array_type exitNodes = ground->GetExits(rwy.rwyID); //I suppose we ought to have some fallback for rwy with no defined exits?
1011 cout << "Node ID's of exits are ";
1012 for(unsigned int i=0; i<exitNodes.size(); ++i) {
1013 cout << exitNodes[i]->nodeID << ' ';
1017 if(exitNodes.size()) {
1018 //Find the next exit from orthopos.y
1020 double dist = 100000; //ie. longer than any runway in existance
1021 double backdist = 100000;
1022 node_array_iterator nItr = exitNodes.begin();
1023 node* rwyExit = *(exitNodes.begin());
1024 //int gateID; //This might want to be more persistant at some point
1025 while(nItr != exitNodes.end()) {
1026 d = ortho.ConvertToLocal((*nItr)->pos).y() - ortho.ConvertToLocal(pos).y(); //FIXME - consider making orthopos a class variable
1033 if(fabs(d) < backdist) {
1035 //TODO - need some logic here that if we don't get a forward exit we turn round and store the backwards one
1040 ourGate = ground->GetGateNode();
1041 if(ourGate == NULL) {
1042 // Implies no available gates - what shall we do?
1043 // For now just vanish the plane - possibly we can make this more elegant in the future
1044 SG_LOG(SG_ATC, SG_ALERT, "No gate found by FGAILocalTraffic whilst landing at " << airportID << '\n');
1045 aip.setVisible(false);
1046 operatingState = PARKED;
1049 path = ground->GetPath(rwyExit, ourGate);
1051 cout << "path returned was:" << endl;
1052 for(unsigned int i=0; i<path.size(); ++i) {
1053 switch(path[i]->struct_type) {
1055 cout << "NODE " << ((node*)(path[i]))->nodeID << endl;
1063 taxiState = TD_INBOUND;
1066 // Something must have gone wrong with the ground network file - or there is only a rwy here and no exits defined
1067 SG_LOG(SG_ATC, SG_ALERT, "No exits found by FGAILocalTraffic from runway " << rwy.rwyID << " at " << airportID << '\n');
1068 // What shall we do - just remove the plane from sight?
1069 aip.setVisible(false);
1070 operatingState = PARKED;
1074 // Set the class variable nextTaxiNode to the next node in the path
1075 // and update taxiPathPos, the class variable path iterator position
1076 // TODO - maybe should return error codes to the calling function if we fail here
1077 void FGAILocalTraffic::GetNextTaxiNode() {
1078 //cout << "GetNextTaxiNode called " << endl;
1079 //cout << "taxiPathPos = " << taxiPathPos << endl;
1080 ground_network_path_iterator pathItr = path.begin() + taxiPathPos;
1081 if(pathItr == path.end()) {
1082 SG_LOG(SG_ATC, SG_ALERT, "ERROR IN AILocalTraffic::GetNextTaxiNode - no more nodes in path\n");
1084 if((*pathItr)->struct_type == NODE) {
1085 //cout << "ITS A NODE" << endl;
1086 //*pathItr = new node;
1087 nextTaxiNode = (node*)*pathItr;
1091 //cout << "ITS NOT A NODE" << endl;
1092 //The first item in found must have been an arc
1093 //Assume for now that it was straight
1096 if(pathItr == path.end()) {
1097 SG_LOG(SG_ATC, SG_ALERT, "ERROR IN AILocalTraffic::GetNextTaxiNode - path ended with an arc\n");
1098 } else if((*pathItr)->struct_type == NODE) {
1099 nextTaxiNode = (node*)*pathItr;
1102 //OOPS - two non-nodes in a row - that shouldn't happen ATM
1103 SG_LOG(SG_ATC, SG_ALERT, "ERROR IN AILocalTraffic::GetNextTaxiNode - two non-nodes in sequence\n");
1109 // StartTaxi - set up the taxiing state - call only at the start of taxiing
1110 void FGAILocalTraffic::StartTaxi() {
1111 //cout << "StartTaxi called" << endl;
1112 operatingState = TAXIING;
1115 //Set the desired heading
1116 //Assume we are aiming for first node on path
1117 //Eventually we may need to consider the fact that we might start on a curved arc and
1118 //not be able to head directly for the first node.
1119 GetNextTaxiNode(); // sets the class variable nextTaxiNode to the next taxi node!
1120 desiredTaxiHeading = GetHeadingFromTo(pos, nextTaxiNode->pos);
1121 //cout << "First taxi heading is " << desiredTaxiHeading << endl;
1124 // speed in knots, headings in degrees, radius in meters.
1125 static double TaxiTurnTowardsHeading(double current_hdg, double desired_hdg, double speed, double radius, double dt) {
1126 // wrap heading - this prevents a logic bug where the plane would just go round in circles!!
1127 while(current_hdg < 0.0) {
1128 current_hdg += 360.0;
1130 while(current_hdg > 360.0) {
1131 current_hdg -= 360.0;
1133 if(fabs(current_hdg - desired_hdg) > 0.1) {
1134 // Which is the quickest direction to turn onto heading?
1135 if(desired_hdg > current_hdg) {
1136 if((desired_hdg - current_hdg) <= 180) {
1138 current_hdg += ((speed * 0.514444 * dt) / (radius * DCL_PI)) * 180.0;
1139 // TODO - check that increments are less than the delta that we check for the right direction
1140 // Probably need to reduce convergence speed as convergence is reached
1142 current_hdg -= ((speed * 0.514444 * dt) / (radius * DCL_PI)) * 180.0;
1145 if((current_hdg - desired_hdg) <= 180) {
1147 current_hdg -= ((speed * 0.514444 * dt) / (radius * DCL_PI)) * 180.0;
1148 // TODO - check that increments are less than the delta that we check for the right direction
1149 // Probably need to reduce convergence speed as convergence is reached
1151 current_hdg += ((speed * 0.514444 * dt) / (radius * DCL_PI)) * 180.0;
1155 return(current_hdg);
1158 void FGAILocalTraffic::Taxi(double dt) {
1159 //cout << "Taxi called" << endl;
1160 // Logic - if we are further away from next point than turn radius then head for it
1161 // If we have reached turning point then get next point and turn onto that heading
1162 // Look out for the finish!!
1164 //Point3D orthopos = ortho.ConvertToLocal(pos); // ortho position of the plane
1165 desiredTaxiHeading = GetHeadingFromTo(pos, nextTaxiNode->pos);
1167 bool lastNode = (taxiPathPos == path.size() ? true : false);
1169 //cout << "LAST NODE\n";
1172 // HACK ALERT! - for now we will taxi at constant speed for straights and turns
1174 // Remember that hdg is always equal to track when taxiing so we don't have to consider them both
1175 double dist_to_go = dclGetHorizontalSeparation(pos, nextTaxiNode->pos); // we may be able to do this more cheaply using orthopos
1176 //cout << "dist_to_go = " << dist_to_go << endl;
1177 if((nextTaxiNode->type == GATE) && (dist_to_go <= 0.1)) {
1178 // This might be more robust to outward paths starting with a gate if we check for either
1179 // last node or TD_INBOUND ?
1181 operatingState = PARKED;
1182 } else if(((dist_to_go > taxiTurnRadius) || (nextTaxiNode->type == GATE)) && (!liningUp)){
1183 // if the turn radius is r, and speed is s, then in a time dt we turn through
1184 // ((s.dt)/(PI.r)) x 180 degrees
1185 // or alternatively (s.dt)/r radians
1186 //cout << "hdg = " << hdg << " desired taxi heading = " << desiredTaxiHeading << '\n';
1187 hdg = TaxiTurnTowardsHeading(hdg, desiredTaxiHeading, nominalTaxiSpeed, taxiTurnRadius, dt);
1188 double vel = nominalTaxiSpeed;
1189 //cout << "vel = " << vel << endl;
1190 double dist = vel * 0.514444 * dt;
1191 //cout << "dist = " << dist << endl;
1193 //cout << "track = " << track << endl;
1195 pos = dclUpdatePosition(pos, track, slope, dist);
1196 //cout << "Updated position...\n";
1197 if(aip.getSGLocation()->get_cur_elev_m() > -9990) {
1198 pos.setelev(aip.getSGLocation()->get_cur_elev_m() + wheelOffset);
1199 } // else don't change the elev until we get a valid ground elev again!
1200 } else if(lastNode) {
1201 if(taxiState == TD_LINING_UP) {
1202 if((!liningUp) && (dist_to_go <= taxiTurnRadius)) {
1206 hdg = TaxiTurnTowardsHeading(hdg, rwy.hdg, nominalTaxiSpeed, taxiTurnRadius, dt);
1207 double vel = nominalTaxiSpeed;
1208 //cout << "vel = " << vel << endl;
1209 double dist = vel * 0.514444 * dt;
1210 //cout << "dist = " << dist << endl;
1212 //cout << "track = " << track << endl;
1214 pos = dclUpdatePosition(pos, track, slope, dist);
1215 //cout << "Updated position...\n";
1216 if(aip.getSGLocation()->get_cur_elev_m() > -9990) {
1217 pos.setelev(aip.getSGLocation()->get_cur_elev_m() + wheelOffset);
1218 } // else don't change the elev until we get a valid ground elev again!
1219 if(fabs(hdg - rwy.hdg) <= 1.0) {
1220 operatingState = IN_PATTERN;
1226 } else if(taxiState == TD_OUTBOUND) {
1227 // Pause awaiting further instructions
1228 // and for now assume we've reached the hold-short node
1229 holdingShort = true;
1230 } // else at the moment assume TD_INBOUND always ends in a gate in which case we can ignore it
1232 // Time to turn (we've already checked it's not the end we're heading for).
1233 // set the target node to be the next node which will prompt automatically turning onto
1234 // the right heading in the stuff above, with the usual provisos applied.
1236 // For now why not just recursively call this function?
1242 // Warning - ground elev determination is CPU intensive
1243 // Either this function or the logic of how often it is called
1244 // will almost certainly change.
1245 void FGAILocalTraffic::DoGroundElev() {
1247 // It would be nice if we could set the correct tile center here in order to get a correct
1248 // answer with one call to the function, but what I tried in the two commented-out lines
1249 // below only intermittently worked, and I haven't quite groked why yet.
1250 //SGBucket buck(pos.lon(), pos.lat());
1251 //aip.getSGLocation()->set_tile_center(Point3D(buck.get_center_lon(), buck.get_center_lat(), 0.0));
1253 double visibility_meters = fgGetDouble("/environment/visibility-m");
1254 //globals->get_tile_mgr()->prep_ssg_nodes( acmodel_location,
1255 globals->get_tile_mgr()->prep_ssg_nodes( aip.getSGLocation(), visibility_meters );
1256 Point3D scenery_center = globals->get_scenery()->get_center();
1257 globals->get_tile_mgr()->update( aip.getSGLocation(), visibility_meters, (aip.getSGLocation())->get_absolute_view_pos( scenery_center ) );
1258 // save results of update in SGLocation for fdm...
1260 //if ( globals->get_scenery()->get_cur_elev() > -9990 ) {
1261 // acmodel_location->
1262 // set_cur_elev_m( globals->get_scenery()->get_cur_elev() );
1265 // The need for this here means that at least 2 consecutive passes are needed :-(
1266 aip.getSGLocation()->set_tile_center( globals->get_scenery()->get_next_center() );
1268 //cout << "Transform Elev is " << globals->get_scenery()->get_cur_elev() << '\n';
1269 aip.getSGLocation()->set_cur_elev_m(globals->get_scenery()->get_cur_elev());
1270 //return(globals->get_scenery()->get_cur_elev());