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 tuned_station = ground;
204 ourGate = ground->GetGateNode();
205 if(ourGate == NULL) {
206 // Implies no available gates - what shall we do?
207 // For now just vanish the plane - possibly we can make this more elegant in the future
208 SG_LOG(SG_ATC, SG_ALERT, "No gate found by FGAILocalTraffic whilst attempting Init at " << airportID << '\n');
216 pos.setelev(aptElev);
217 hdg = ourGate->heading;
219 // Now we've set the position we can do the ground elev
220 elevInitGood = false;
227 tuned_station = ground;
228 // FIXME - implement this case properly
229 return(false); // remove this line when fixed!
232 // For now we'll always start the in_pattern case on the threshold ready to take-off
233 // since we've got the implementation for this case already.
234 // TODO - implement proper generic in_pattern startup.
236 tuned_station = tower;
238 // Get the active runway details (and copy them into rwy)
241 // Initial position on threshold for now
242 pos.setlat(rwy.threshold_pos.lat());
243 pos.setlon(rwy.threshold_pos.lon());
244 pos.setelev(rwy.threshold_pos.elev());
247 // Now we've set the position we can do the ground elev
248 // This might not always be necessary if we implement in-air start
249 elevInitGood = false;
259 circuitsToFly = 0; // ie just fly this circuit and then stop
261 // FIXME TODO - pattern direction is still hardwired
262 patternDirection = -1; // Left
263 // At the bare minimum we ought to make sure it goes the right way at dual parallel rwy airports!
264 if(rwy.rwyID.size() == 3) {
265 patternDirection = (rwy.rwyID.substr(2,1) == "R" ? 1 : -1);
268 operatingState = IN_PATTERN;
273 SG_LOG(SG_ATC, SG_ALERT, "Attempt to set unknown operating state in FGAILocalTraffic.Init(...)\n");
282 // Return what type of landing we're doing on this circuit
283 LandingType FGAILocalTraffic::GetLandingOption() {
285 return(touchAndGo ? TOUCH_AND_GO : STOP_AND_GO);
292 // Commands to do something from higher level logic
293 void FGAILocalTraffic::FlyCircuits(int numCircuits, bool tag) {
294 //cout << "FlyCircuits called" << endl;
296 switch(operatingState) {
298 circuitsToFly += numCircuits;
302 // TODO - For now we'll punt this and do nothing
305 circuitsToFly = numCircuits; // Note that one too many circuits gets flown because we only test and decrement circuitsToFly after landing
306 // thus flying one too many circuits. TODO - Need to sort this out better!
312 // Run the internal calculations
313 void FGAILocalTraffic::Update(double dt) {
314 //cout << "A" << flush;
315 //double responseTime = 10.0; // seconds - this should get more sophisticated at some point
316 responseCounter += dt;
317 if((contactTower) && (responseCounter >= 8.0)) {
318 // Acknowledge request before changing frequency so it gets rendered if the user is on the same freq
319 string trns = "Tower ";
320 double f = globals->get_ATC_mgr()->GetFrequency(airportID, TOWER) / 100.0;
322 sprintf(buf, "%.2f", f);
325 trns += plane.callsign;
326 pending_transmission = trns;
327 ConditionalTransmit(30.0);
328 responseCounter = 0.0;
329 contactTower = false;
331 changeFreqType = TOWER;
334 if((changeFreq) && (responseCounter > 8.0)) {
335 switch(changeFreqType) {
337 tuned_station = tower;
338 freq = (double)tower->get_freq() / 100.0;
340 // Contact the tower, even if only virtually
342 tower->ContactAtHoldShort(plane, this, CIRCUIT);
345 tuned_station = ground;
346 freq = (double)ground->get_freq() / 100.0;
348 // And to avoid compiler warnings...
349 case APPROACH: break;
352 case DEPARTURE: break;
357 //cout << "." << flush;
359 switch(operatingState) {
361 //cout << "In IN_PATTERN\n";
362 if(!inAir) DoGroundElev();
364 if(aip.getSGLocation()->get_cur_elev_m() > -9990.0) {
365 pos.setelev(aip.getSGLocation()->get_cur_elev_m() + wheelOffset);
366 //cout << "TAKEOFF_ROLL, POS = " << pos.lon() << ", " << pos.lat() << ", " << pos.elev() << '\n';
368 aip.setVisible(true);
369 //cout << "Making plane visible!\n";
373 FlyTrafficPattern(dt);
377 //cout << "In TAXIING\n";
378 //cout << "*" << flush;
381 if(aip.getSGLocation()->get_cur_elev_m() > -9990.0) {
382 pos.setelev(aip.getSGLocation()->get_cur_elev_m() + wheelOffset);
384 aip.setVisible(true);
386 //cout << "Making plane visible!\n";
391 //cout << "," << flush;
392 if(!((holdingShort) && (!clearedToLineUp))) {
393 //cout << "|" << flush;
396 //cout << ";" << flush;
397 if((clearedToTakeOff) && (responseCounter >= 8.0)) {
398 // possible assumption that we're at the hold short here - may not always hold
399 // TODO - sort out the case where we're cleared to line-up first and then cleared to take-off on the rwy.
400 taxiState = TD_LINING_UP;
401 path = ground->GetPath(holdShortNode, rwy.rwyID);
403 cout << "path returned was:" << endl;
404 for(unsigned int i=0; i<path.size(); ++i) {
405 switch(path[i]->struct_type) {
407 cout << "NODE " << ((node*)(path[i]))->nodeID << endl;
415 clearedToTakeOff = false; // We *are* still cleared - this simply stops the response recurring!!
416 holdingShort = false;
417 string trns = "Cleared for take-off ";
418 trns += plane.callsign;
419 pending_transmission = trns;
423 //cout << "^" << flush;
427 //cout << "In PARKED\n";
430 if(aip.getSGLocation()->get_cur_elev_m() > -9990.0) {
431 pos.setelev(aip.getSGLocation()->get_cur_elev_m() + wheelOffset);
433 aip.setVisible(true);
435 //cout << "Making plane visible!\n";
441 if((taxiRequestPending) && (taxiRequestCleared)) {
442 //cout << "&" << flush;
443 // Get the active runway details (and copy them into rwy)
446 // Get the takeoff node for the active runway, get a path to it and start taxiing
447 path = ground->GetPathToHoldShort(ourGate, rwy.rwyID);
448 if(path.size() < 2) {
449 // something has gone wrong
450 SG_LOG(SG_ATC, SG_ALERT, "Invalid path from gate to theshold in FGAILocalTraffic::FlyCircuits\n");
454 cout << "path returned was:\n";
455 for(unsigned int i=0; i<path.size(); ++i) {
456 switch(path[i]->struct_type) {
458 cout << "NODE " << ((node*)(path[i]))->nodeID << endl;
466 path.erase(path.begin()); // pop the gate - we're here already!
467 taxiState = TD_OUTBOUND;
468 taxiRequestPending = false;
469 holdShortNode = (node*)(*(path.begin() + path.size()));
471 } else if(!taxiRequestPending) {
472 //cout << "(" << flush;
473 // Do some communication
474 // airport name + tower + airplane callsign + location + request taxi for + operation type + ?
476 trns += tower->get_name();
478 trns += plane.callsign;
479 trns += " on apron parking request taxi for traffic pattern";
480 //cout << "trns = " << trns << endl;
481 pending_transmission = trns;
483 taxiRequestCleared = false;
484 taxiRequestPending = true;
488 //cout << "!" << flush;
490 // Maybe the below should be set when we get to the threshold and prepare for TO?
491 // FIXME TODO - pattern direction is still hardwired
492 patternDirection = -1; // Left
493 // At the bare minimum we ought to make sure it goes the right way at dual parallel rwy airports!
494 if(rwy.rwyID.size() == 3) {
495 patternDirection = (rwy.rwyID.substr(2,1) == "R" ? 1 : -1);
499 //cout << ")" << flush;
504 //cout << "I " << flush;
506 // Convienience output for AI debugging user the property logger
507 fgSetDouble("/AI/Local1/ortho-x", (ortho.ConvertToLocal(pos)).x());
508 fgSetDouble("/AI/Local1/ortho-y", (ortho.ConvertToLocal(pos)).y());
509 fgSetDouble("/AI/Local1/elev", pos.elev() * SG_METER_TO_FEET);
511 // And finally, call parent for transmission rendering
512 FGAIPlane::Update(dt);
515 void FGAILocalTraffic::RegisterTransmission(int code) {
517 case 1: // taxi request cleared
518 taxiRequestCleared = true;
519 SG_LOG(SG_ATC, SG_INFO, "AI local traffic " << plane.callsign << " cleared to taxi...");
521 case 2: // contact tower
524 SG_LOG(SG_ATC, SG_INFO, "AI local traffic " << plane.callsign << " told to contact tower...");
526 case 3: // Cleared to line up
528 clearedToLineUp = true;
529 SG_LOG(SG_ATC, SG_INFO, "AI local traffic " << plane.callsign << " cleared to line-up...");
531 case 4: // cleared to take-off
533 clearedToTakeOff = true;
534 SG_LOG(SG_ATC, SG_INFO, "AI local traffic " << plane.callsign << " cleared to take-off...");
541 // Fly a traffic pattern
542 // FIXME - far too much of the mechanics of turning, rolling, accellerating, descending etc is in here.
543 // Move it out to FGAIPlane and have FlyTrafficPattern just specify what to do, not the implementation.
544 void FGAILocalTraffic::FlyTrafficPattern(double dt) {
545 // Need to differentiate between in-air (IAS governed) and on-ground (vel governed)
546 // Take-off is an interesting case - we are on the ground but takeoff speed is IAS governed.
548 static bool transmitted = false; // FIXME - this is a hack
551 // Wind has two effects - a mechanical one in that IAS translates to a different vel, and the hdg != track,
552 // but also a piloting effect, in that the AI must be able to descend at a different rate in order to hit the threshold.
554 //cout << "dt = " << dt << '\n';
556 // ack - I can't remember how long a rate 1 turn is meant to take.
557 double turn_time = 60.0; // seconds - TODO - check this guess
558 double turn_circumference;
560 Point3D orthopos = ortho.ConvertToLocal(pos); // ortho position of the plane
561 //cout << "runway elev = " << rwy.threshold_pos.elev() << ' ' << rwy.threshold_pos.elev() * SG_METER_TO_FEET << '\n';
562 //cout << "elev = " << pos.elev() << ' ' << pos.elev() * SG_METER_TO_FEET << '\n';
564 // HACK FOR TESTING - REMOVE
565 //cout << "Calling ExitRunway..." << endl;
566 //ExitRunway(orthopos);
571 double wind_from = wind_from_hdg->getDoubleValue();
572 double wind_speed = wind_speed_knots->getDoubleValue();
584 if(aip.getSGLocation()->get_cur_elev_m() > -9990.0) {
585 pos.setelev(aip.getSGLocation()->get_cur_elev_m() + wheelOffset);
587 IAS = vel + (cos((hdg - wind_from) * DCL_DEGREES_TO_RADIANS) * wind_speed);
591 IAS = best_rate_of_climb_speed;
593 slope = 6.0; // Reduced it slightly since it's climbing a lot steeper than I can in the JSBSim C172.
599 // Turn to crosswind if above 600ft AND if other traffic allows
600 // (decided in FGTower and accessed through GetCrosswindConstraint(...)).
601 if((pos.elev() - rwy.threshold_pos.elev()) * SG_METER_TO_FEET > 600) {
603 if(tower->GetCrosswindConstraint(cc)) {
604 if(orthopos.y() > cc) {
605 cout << "Turning to crosswind, distance from threshold = " << orthopos.y() << '\n';
609 cout << "Turning to crosswind, distance from threshold = " << orthopos.y() << '\n';
613 // Need to check for levelling off in case we can't turn crosswind as soon
614 // as we would like due to other traffic.
615 if((pos.elev() - rwy.threshold_pos.elev()) * SG_METER_TO_FEET > 1000) {
618 IAS = 80.0; // FIXME - use smooth transistion to new speed and attitude.
622 track += (360.0 / turn_time) * dt * patternDirection;
623 Bank(25.0 * patternDirection);
624 if((track < (rwy.hdg - 89.0)) || (track > (rwy.hdg + 89.0))) {
630 track = rwy.hdg + (90.0 * patternDirection);
631 if((pos.elev() - rwy.threshold_pos.elev()) * SG_METER_TO_FEET > 1000) {
634 IAS = 80.0; // FIXME - use smooth transistion to new speed
636 // turn 1000m out for now, taking other traffic into accout
637 if(fabs(orthopos.x()) > 980) {
639 if(tower->GetDownwindConstraint(dd)) {
640 if(fabs(orthopos.x()) > fabs(dd)) {
641 cout << "Turning to downwind, distance from centerline = " << fabs(orthopos.x()) << '\n';
645 cout << "Turning to downwind, distance from centerline = " << fabs(orthopos.x()) << '\n';
651 track += (360.0 / turn_time) * dt * patternDirection;
652 Bank(25.0 * patternDirection);
653 // just in case we didn't make height on crosswind
654 if((pos.elev() - rwy.threshold_pos.elev()) * SG_METER_TO_FEET > 1000) {
657 IAS = 80.0; // FIXME - use smooth transistion to new speed
659 if((track < (rwy.hdg - 179.0)) || (track > (rwy.hdg + 179.0))) {
667 track = rwy.hdg - (180 * patternDirection); //should tend to bring track back into the 0->360 range
668 // just in case we didn't make height on crosswind
669 if((pos.elev() - rwy.threshold_pos.elev()) * SG_METER_TO_FEET > 1000) {
672 IAS = 90.0; // FIXME - use smooth transistion to new speed
674 if((orthopos.y() < 0) && (!transmitted)) {
675 TransmitPatternPositionReport();
678 if((orthopos.y() < -100) && (!descending)) {
679 // Maybe we should think about when to start descending.
680 // For now we're assuming that we aim to follow the same glidepath regardless of wind.
683 CalculateSoD((tower->GetBaseConstraint(d1) ? d1 : -1000.0), (tower->GetDownwindConstraint(d2) ? d2 : 1000.0 * patternDirection), (patternDirection ? true : false));
684 if(SoD.leg == DOWNWIND) {
685 descending = (orthopos.y() < SoD.y ? true : false);
690 slope = -5.5; // FIXME - calculate to descent at 500fpm and hit the desired point on the runway (taking wind into account as well!!)
695 // Try and arrange to turn nicely onto base
696 turn_circumference = IAS * 0.514444 * turn_time;
697 //Hmmm - this is an interesting one - ground vs airspeed in relation to turn radius
698 //We'll leave it as a hack with IAS for now but it needs revisiting.
699 turn_radius = turn_circumference / (2.0 * DCL_PI);
700 if(orthopos.y() < -1000.0 + turn_radius) {
701 //if(orthopos.y() < -980) {
703 if(tower->GetBaseConstraint(bb)) {
704 if(fabs(orthopos.y()) > fabs(bb)) {
705 cout << "Turning to base, distance from threshold = " << fabs(orthopos.y()) << '\n';
711 cout << "Turning to base, distance from threshold = " << fabs(orthopos.y()) << '\n';
719 track += (360.0 / turn_time) * dt * patternDirection;
720 Bank(25.0 * patternDirection);
721 if(fabs(rwy.hdg - track) < 91.0) {
728 TransmitPatternPositionReport();
734 // Make downwind leg position artifically large to avoid any chance of SoD being returned as
735 // on downwind when we are already on base.
736 CalculateSoD((tower->GetBaseConstraint(d1) ? d1 : -1000.0), (10000.0 * patternDirection), (patternDirection ? true : false));
737 if(SoD.leg == BASE) {
738 descending = (fabs(orthopos.y()) < fabs(SoD.y) ? true : false);
743 slope = -5.5; // FIXME - calculate to descent at 500fpm and hit the threshold (taking wind into account as well!!)
748 track = rwy.hdg - (90 * patternDirection);
750 // Try and arrange to turn nicely onto final
751 turn_circumference = IAS * 0.514444 * turn_time;
752 //Hmmm - this is an interesting one - ground vs airspeed in relation to turn radius
753 //We'll leave it as a hack with IAS for now but it needs revisiting.
754 turn_radius = turn_circumference / (2.0 * DCL_PI);
755 if(fabs(orthopos.x()) < (turn_radius + 50)) {
762 track += (360.0 / turn_time) * dt * patternDirection;
763 Bank(25.0 * patternDirection);
764 if(fabs(track - rwy.hdg) < 0.6) {
766 vel = nominal_final_speed;
772 TransmitPatternPositionReport();
776 // Make base leg position artifically large to avoid any chance of SoD being returned as
777 // on base or downwind when we are already on final.
778 CalculateSoD(-10000.0, (1000.0 * patternDirection), (patternDirection ? true : false));
779 if(SoD.leg == FINAL) {
780 descending = (fabs(orthopos.y()) < fabs(SoD.y) ? true : false);
785 slope = -5.5; // FIXME - calculate to descent at 500fpm and hit the threshold (taking wind into account as well!!)
789 // Try and track the extended centreline
790 track = rwy.hdg - (0.2 * orthopos.x());
791 //cout << "orthopos.x() = " << orthopos.x() << " hdg = " << hdg << '\n';
792 if(pos.elev() < (rwy.threshold_pos.elev()+20.0+wheelOffset)) {
793 DoGroundElev(); // Need to call it here expicitly on final since it's only called
794 // for us in update(...) when the inAir flag is false.
796 if(pos.elev() < (rwy.threshold_pos.elev()+10.0+wheelOffset)) {
797 if(aip.getSGLocation()->get_cur_elev_m() > -9990.0) {
798 if((aip.getSGLocation()->get_cur_elev_m() + wheelOffset) > pos.elev()) {
804 } // else need a fallback position based on arpt elev in case ground elev determination fails?
810 if(aip.getSGLocation()->get_cur_elev_m() > -9990.0) {
811 pos.setelev(aip.getSGLocation()->get_cur_elev_m() + wheelOffset);
816 // FIXME - differentiate between touch and go and full stops
818 //cout << "Vel <= 15.0, circuitsToFly = " << circuitsToFly << endl;
819 if(circuitsToFly <= 0) {
820 //cout << "Calling ExitRunway..." << endl;
821 ExitRunway(orthopos);
824 //cout << "Taking off again..." << endl;
835 // FIXME - at the moment this is a bit screwy
836 // The velocity correction is applied based on the relative headings.
837 // Then the heading is changed based on the velocity.
838 // Which comes first, the chicken or the egg?
839 // Does it really matter?
841 // Apply wind to ground-relative velocity if in the air
842 vel = IAS - (cos((hdg - wind_from) * DCL_DEGREES_TO_RADIANS) * wind_speed);
843 //crab = f(track, wind, vel);
844 // The vector we need to fly is our desired vector minus the wind vector
845 // TODO - we probably ought to use plib's built in vector types and operations for this
846 // ie. There's almost *certainly* a better way to do this!
847 double gxx = vel * sin(track * DCL_DEGREES_TO_RADIANS); // Plane desired velocity x component wrt ground
848 double gyy = vel * cos(track * DCL_DEGREES_TO_RADIANS); // Plane desired velocity y component wrt ground
849 double wxx = wind_speed * sin((wind_from + 180.0) * DCL_DEGREES_TO_RADIANS); // Wind velocity x component
850 double wyy = wind_speed * cos((wind_from + 180.0) * DCL_DEGREES_TO_RADIANS); // Wind velocity y component
851 double axx = gxx - wxx; // Plane in-air velocity x component
852 double ayy = gyy - wyy; // Plane in-air velocity y component
853 // Now we want the angle between gxx and axx (which is the crab)
854 double maga = sqrt(axx*axx + ayy*ayy);
855 double magg = sqrt(gxx*gxx + gyy*gyy);
856 crab = acos((axx*gxx + ayy*gyy) / (maga * magg));
857 // At this point this works except we're getting the modulus of the angle
858 //cout << "crab = " << crab << '\n';
860 // Make sure both headings are in the 0->360 circle in order to get sane differences
861 dclBoundHeading(wind_from);
862 dclBoundHeading(track);
863 if(track > wind_from) {
864 if((track - wind_from) <= 180) {
868 if((wind_from - track) >= 180) {
872 } else { // on the ground - crab dosen't apply
877 dist = vel * 0.514444 * dt;
878 pos = dclUpdatePosition(pos, track, slope, dist);
881 // Pattern direction is true for right, false for left
882 void FGAILocalTraffic::CalculateSoD(double base_leg_pos, double downwind_leg_pos, bool pattern_direction) {
883 // For now we'll ignore wind and hardwire the glide angle.
884 double ga = 5.5; //degrees
885 double pa = 1000.0 * SG_FEET_TO_METER; // pattern altitude in meters
886 // FIXME - get glideslope angle and pattern altitude agl from airport details if available
888 // For convienience, we'll have +ve versions of the input distances
889 double blp = fabs(base_leg_pos);
890 double dlp = fabs(downwind_leg_pos);
892 //double turn_allowance = 150.0; // Approximate distance in meters that a 90deg corner is shortened by turned in a light plane.
894 double stod = pa / tan(ga * DCL_DEGREES_TO_RADIANS); // distance in meters from touchdown point to start descent
895 //cout << "Descent to start = " << stod << " meters out\n";
896 if(stod < blp) { // Start descending on final
900 } else if(stod < (blp + dlp)) { // Start descending on base leg
903 SoD.x = (pattern_direction ? (stod - dlp) : (stod - dlp) * -1.0);
904 } else { // Start descending on downwind leg
906 SoD.x = (pattern_direction ? dlp : dlp * -1.0);
907 SoD.y = (blp - (stod - (blp + dlp))) * -1.0;
911 void FGAILocalTraffic::TransmitPatternPositionReport(void) {
912 // airport name + "traffic" + airplane callsign + pattern direction + pattern leg + rwy + ?
916 trns += tower->get_name();
918 trns += plane.callsign;
919 if(patternDirection == 1) {
925 // We could probably get rid of this whole switch statement and just pass a string containing the leg from the FlyPattern function.
926 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?
928 // Fall through to CROSSWIND
929 case CROSSWIND: // I don't think this case will be used here but it can't hurt to leave it in
930 trns += "crosswind ";
933 // Fall through to DOWNWIND
939 // Fall through to BASE
944 // Fall through to FINAL
945 case FINAL: // maybe this should include long/short final if appropriate?
948 default: // Hopefully this won't be used
952 // FIXME - I've hardwired the runway call as well!! (We could work this out from rwy heading and mag deviation)
953 trns += ConvertRwyNumToSpokenString(1);
955 // And add the airport name again
956 trns += tower->get_name();
958 pending_transmission = trns; // FIXME - make up pending_transmission natively
959 ConditionalTransmit(90.0, code); // Assume a report of this leg will be invalid if we can't transmit within a minute and a half.
963 void FGAILocalTraffic::ProcessCallback(int code) {
964 // 1 - Request Departure from ground
965 // 10 - report crosswind
966 // 11 - report downwind
970 ground->RequestDeparture(plane, this);
971 } else if(code == 11) {
972 tower->ReportDownwind(plane.callsign);
976 void FGAILocalTraffic::ExitRunway(Point3D orthopos) {
977 //cout << "In ExitRunway" << endl;
978 //cout << "Runway ID is " << rwy.ID << endl;
979 node_array_type exitNodes = ground->GetExits(rwy.rwyID); //I suppose we ought to have some fallback for rwy with no defined exits?
981 cout << "Node ID's of exits are ";
982 for(unsigned int i=0; i<exitNodes.size(); ++i) {
983 cout << exitNodes[i]->nodeID << ' ';
987 if(exitNodes.size()) {
988 //Find the next exit from orthopos.y
990 double dist = 100000; //ie. longer than any runway in existance
991 double backdist = 100000;
992 node_array_iterator nItr = exitNodes.begin();
993 node* rwyExit = *(exitNodes.begin());
994 //int gateID; //This might want to be more persistant at some point
995 while(nItr != exitNodes.end()) {
996 d = ortho.ConvertToLocal((*nItr)->pos).y() - ortho.ConvertToLocal(pos).y(); //FIXME - consider making orthopos a class variable
1003 if(fabs(d) < backdist) {
1005 //TODO - need some logic here that if we don't get a forward exit we turn round and store the backwards one
1010 ourGate = ground->GetGateNode();
1011 if(ourGate == NULL) {
1012 // Implies no available gates - what shall we do?
1013 // For now just vanish the plane - possibly we can make this more elegant in the future
1014 SG_LOG(SG_ATC, SG_ALERT, "No gate found by FGAILocalTraffic whilst landing at " << airportID << '\n');
1015 aip.setVisible(false);
1016 operatingState = PARKED;
1019 path = ground->GetPath(rwyExit, ourGate);
1021 cout << "path returned was:" << endl;
1022 for(unsigned int i=0; i<path.size(); ++i) {
1023 switch(path[i]->struct_type) {
1025 cout << "NODE " << ((node*)(path[i]))->nodeID << endl;
1033 taxiState = TD_INBOUND;
1036 // Something must have gone wrong with the ground network file - or there is only a rwy here and no exits defined
1037 SG_LOG(SG_ATC, SG_ALERT, "No exits found by FGAILocalTraffic from runway " << rwy.rwyID << " at " << airportID << '\n');
1038 // What shall we do - just remove the plane from sight?
1039 aip.setVisible(false);
1040 operatingState = PARKED;
1044 // Set the class variable nextTaxiNode to the next node in the path
1045 // and update taxiPathPos, the class variable path iterator position
1046 // TODO - maybe should return error codes to the calling function if we fail here
1047 void FGAILocalTraffic::GetNextTaxiNode() {
1048 //cout << "GetNextTaxiNode called " << endl;
1049 //cout << "taxiPathPos = " << taxiPathPos << endl;
1050 ground_network_path_iterator pathItr = path.begin() + taxiPathPos;
1051 if(pathItr == path.end()) {
1052 SG_LOG(SG_ATC, SG_ALERT, "ERROR IN AILocalTraffic::GetNextTaxiNode - no more nodes in path\n");
1054 if((*pathItr)->struct_type == NODE) {
1055 //cout << "ITS A NODE" << endl;
1056 //*pathItr = new node;
1057 nextTaxiNode = (node*)*pathItr;
1061 //cout << "ITS NOT A NODE" << endl;
1062 //The first item in found must have been an arc
1063 //Assume for now that it was straight
1066 if(pathItr == path.end()) {
1067 SG_LOG(SG_ATC, SG_ALERT, "ERROR IN AILocalTraffic::GetNextTaxiNode - path ended with an arc\n");
1068 } else if((*pathItr)->struct_type == NODE) {
1069 nextTaxiNode = (node*)*pathItr;
1072 //OOPS - two non-nodes in a row - that shouldn't happen ATM
1073 SG_LOG(SG_ATC, SG_ALERT, "ERROR IN AILocalTraffic::GetNextTaxiNode - two non-nodes in sequence\n");
1079 // StartTaxi - set up the taxiing state - call only at the start of taxiing
1080 void FGAILocalTraffic::StartTaxi() {
1081 //cout << "StartTaxi called" << endl;
1082 operatingState = TAXIING;
1085 //Set the desired heading
1086 //Assume we are aiming for first node on path
1087 //Eventually we may need to consider the fact that we might start on a curved arc and
1088 //not be able to head directly for the first node.
1089 GetNextTaxiNode(); // sets the class variable nextTaxiNode to the next taxi node!
1090 desiredTaxiHeading = GetHeadingFromTo(pos, nextTaxiNode->pos);
1091 //cout << "First taxi heading is " << desiredTaxiHeading << endl;
1094 // speed in knots, headings in degrees, radius in meters.
1095 static double TaxiTurnTowardsHeading(double current_hdg, double desired_hdg, double speed, double radius, double dt) {
1096 // wrap heading - this prevents a logic bug where the plane would just go round in circles!!
1097 while(current_hdg < 0.0) {
1098 current_hdg += 360.0;
1100 while(current_hdg > 360.0) {
1101 current_hdg -= 360.0;
1103 if(fabs(current_hdg - desired_hdg) > 0.1) {
1104 // Which is the quickest direction to turn onto heading?
1105 if(desired_hdg > current_hdg) {
1106 if((desired_hdg - current_hdg) <= 180) {
1108 current_hdg += ((speed * 0.514444 * dt) / (radius * DCL_PI)) * 180.0;
1109 // TODO - check that increments are less than the delta that we check for the right direction
1110 // Probably need to reduce convergence speed as convergence is reached
1112 current_hdg -= ((speed * 0.514444 * dt) / (radius * DCL_PI)) * 180.0;
1115 if((current_hdg - desired_hdg) <= 180) {
1117 current_hdg -= ((speed * 0.514444 * dt) / (radius * DCL_PI)) * 180.0;
1118 // TODO - check that increments are less than the delta that we check for the right direction
1119 // Probably need to reduce convergence speed as convergence is reached
1121 current_hdg += ((speed * 0.514444 * dt) / (radius * DCL_PI)) * 180.0;
1125 return(current_hdg);
1128 void FGAILocalTraffic::Taxi(double dt) {
1129 //cout << "Taxi called" << endl;
1130 // Logic - if we are further away from next point than turn radius then head for it
1131 // If we have reached turning point then get next point and turn onto that heading
1132 // Look out for the finish!!
1134 //Point3D orthopos = ortho.ConvertToLocal(pos); // ortho position of the plane
1135 desiredTaxiHeading = GetHeadingFromTo(pos, nextTaxiNode->pos);
1137 bool lastNode = (taxiPathPos == path.size() ? true : false);
1139 //cout << "LAST NODE\n";
1142 // HACK ALERT! - for now we will taxi at constant speed for straights and turns
1144 // Remember that hdg is always equal to track when taxiing so we don't have to consider them both
1145 double dist_to_go = dclGetHorizontalSeparation(pos, nextTaxiNode->pos); // we may be able to do this more cheaply using orthopos
1146 //cout << "dist_to_go = " << dist_to_go << endl;
1147 if((nextTaxiNode->type == GATE) && (dist_to_go <= 0.1)) {
1148 // This might be more robust to outward paths starting with a gate if we check for either
1149 // last node or TD_INBOUND ?
1151 operatingState = PARKED;
1152 } else if(((dist_to_go > taxiTurnRadius) || (nextTaxiNode->type == GATE)) && (!liningUp)){
1153 // if the turn radius is r, and speed is s, then in a time dt we turn through
1154 // ((s.dt)/(PI.r)) x 180 degrees
1155 // or alternatively (s.dt)/r radians
1156 //cout << "hdg = " << hdg << " desired taxi heading = " << desiredTaxiHeading << '\n';
1157 hdg = TaxiTurnTowardsHeading(hdg, desiredTaxiHeading, nominalTaxiSpeed, taxiTurnRadius, dt);
1158 double vel = nominalTaxiSpeed;
1159 //cout << "vel = " << vel << endl;
1160 double dist = vel * 0.514444 * dt;
1161 //cout << "dist = " << dist << endl;
1163 //cout << "track = " << track << endl;
1165 pos = dclUpdatePosition(pos, track, slope, dist);
1166 //cout << "Updated position...\n";
1167 if(aip.getSGLocation()->get_cur_elev_m() > -9990) {
1168 pos.setelev(aip.getSGLocation()->get_cur_elev_m() + wheelOffset);
1169 } // else don't change the elev until we get a valid ground elev again!
1170 } else if(lastNode) {
1171 if(taxiState == TD_LINING_UP) {
1172 if((!liningUp) && (dist_to_go <= taxiTurnRadius)) {
1176 hdg = TaxiTurnTowardsHeading(hdg, rwy.hdg, nominalTaxiSpeed, taxiTurnRadius, dt);
1177 double vel = nominalTaxiSpeed;
1178 //cout << "vel = " << vel << endl;
1179 double dist = vel * 0.514444 * dt;
1180 //cout << "dist = " << dist << endl;
1182 //cout << "track = " << track << endl;
1184 pos = dclUpdatePosition(pos, track, slope, dist);
1185 //cout << "Updated position...\n";
1186 if(aip.getSGLocation()->get_cur_elev_m() > -9990) {
1187 pos.setelev(aip.getSGLocation()->get_cur_elev_m() + wheelOffset);
1188 } // else don't change the elev until we get a valid ground elev again!
1189 if(fabs(hdg - rwy.hdg) <= 1.0) {
1190 operatingState = IN_PATTERN;
1196 } else if(taxiState == TD_OUTBOUND) {
1197 // Pause awaiting further instructions
1198 // and for now assume we've reached the hold-short node
1199 holdingShort = true;
1200 } // else at the moment assume TD_INBOUND always ends in a gate in which case we can ignore it
1202 // Time to turn (we've already checked it's not the end we're heading for).
1203 // set the target node to be the next node which will prompt automatically turning onto
1204 // the right heading in the stuff above, with the usual provisos applied.
1206 // For now why not just recursively call this function?
1212 // Warning - ground elev determination is CPU intensive
1213 // Either this function or the logic of how often it is called
1214 // will almost certainly change.
1215 void FGAILocalTraffic::DoGroundElev() {
1217 // It would be nice if we could set the correct tile center here in order to get a correct
1218 // answer with one call to the function, but what I tried in the two commented-out lines
1219 // below only intermittently worked, and I haven't quite groked why yet.
1220 //SGBucket buck(pos.lon(), pos.lat());
1221 //aip.getSGLocation()->set_tile_center(Point3D(buck.get_center_lon(), buck.get_center_lat(), 0.0));
1223 double visibility_meters = fgGetDouble("/environment/visibility-m");
1224 //globals->get_tile_mgr()->prep_ssg_nodes( acmodel_location,
1225 globals->get_tile_mgr()->prep_ssg_nodes( aip.getSGLocation(), visibility_meters );
1226 Point3D scenery_center = globals->get_scenery()->get_center();
1227 globals->get_tile_mgr()->update( aip.getSGLocation(), visibility_meters, (aip.getSGLocation())->get_absolute_view_pos( scenery_center ) );
1228 // save results of update in SGLocation for fdm...
1230 //if ( globals->get_scenery()->get_cur_elev() > -9990 ) {
1231 // acmodel_location->
1232 // set_cur_elev_m( globals->get_scenery()->get_cur_elev() );
1235 // The need for this here means that at least 2 consecutive passes are needed :-(
1236 aip.getSGLocation()->set_tile_center( globals->get_scenery()->get_next_center() );
1238 //cout << "Transform Elev is " << globals->get_scenery()->get_cur_elev() << '\n';
1239 aip.getSGLocation()->set_cur_elev_m(globals->get_scenery()->get_cur_elev());
1240 //return(globals->get_scenery()->get_cur_elev());