1 // kln89_page.cxx - a class to manage the simulation of a KLN89
2 // GPS unit. Note that this is primarily the
3 // simulation of the user interface and display
4 // - the core GPS calculations such as position
5 // and waypoint sequencing are done (or should
6 // be done) by FG code.
8 // Written by David Luff, started 2005.
10 // Copyright (C) 2005 - David C Luff - david.luff@nottingham.ac.uk
12 // This program is free software; you can redistribute it and/or
13 // modify it under the terms of the GNU General Public License as
14 // published by the Free Software Foundation; either version 2 of the
15 // License, or (at your option) any later version.
17 // This program is distributed in the hope that it will be useful, but
18 // WITHOUT ANY WARRANTY; without even the implied warranty of
19 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 // General Public License for more details.
22 // You should have received a copy of the GNU General Public License
23 // along with this program; if not, write to the Free Software
24 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
29 #include "kln89_page.hxx"
30 #include "kln89_page_apt.hxx"
31 #include "kln89_page_vor.hxx"
32 #include "kln89_page_ndb.hxx"
33 #include "kln89_page_int.hxx"
34 #include "kln89_page_usr.hxx"
35 #include "kln89_page_act.hxx"
36 #include "kln89_page_nav.hxx"
37 #include "kln89_page_fpl.hxx"
38 #include "kln89_page_cal.hxx"
39 #include "kln89_page_set.hxx"
40 #include "kln89_page_oth.hxx"
41 #include "kln89_page_dir.hxx"
42 #include "kln89_page_nrst.hxx"
43 #include "kln89_symbols.hxx"
46 #include <ATCDCL/ATCProjection.hxx>
47 #include <Main/fg_props.hxx>
48 #include <simgear/math/SGMath.hxx>
49 #include "Airports/simple.hxx"
53 KLN89::KLN89(RenderArea2D* instrument)
54 : DCLGPS(instrument) {
55 _mode = KLN89_MODE_DISP;
62 // ..Field..[0] => no fields in action
80 GPSPage* apt_page = new KLN89AptPage(this);
81 _pages.push_back(apt_page);
82 GPSPage* vor_page = new KLN89VorPage(this);
83 _pages.push_back(vor_page);
84 GPSPage* ndb_page = new KLN89NDBPage(this);
85 _pages.push_back(ndb_page);
86 GPSPage* int_page = new KLN89IntPage(this);
87 _pages.push_back(int_page);
88 GPSPage* usr_page = new KLN89UsrPage(this);
89 _pages.push_back(usr_page);
90 GPSPage* act_page = new KLN89ActPage(this);
91 _pages.push_back(act_page);
92 GPSPage* nav_page = new KLN89NavPage(this);
93 _pages.push_back(nav_page);
94 GPSPage* fpl_page = new KLN89FplPage(this);
95 _pages.push_back(fpl_page);
96 GPSPage* cal_page = new KLN89CalPage(this);
97 _pages.push_back(cal_page);
98 GPSPage* set_page = new KLN89SetPage(this);
99 _pages.push_back(set_page);
100 GPSPage* oth_page = new KLN89OthPage(this);
101 _pages.push_back(oth_page);
102 _nPages = _pages.size();
106 _dir_page = new KLN89DirPage(this);
107 _nrst_page = new KLN89NrstPage(this);
109 _activePage = apt_page;
115 _maxFlightPlans = 26;
116 for(unsigned int i=0; i<_maxFlightPlans; ++i) {
117 GPSFlightPlan* fp = new GPSFlightPlan;
118 fp->waypoints.clear();
119 _flightPlans.push_back(fp);
121 _activeFP = _flightPlans[0];
125 _entRestoreCrsr = false;
132 _mapHeadingUpdateTimer = 0.0;
136 //_mapScaleIndex = 20;
137 _mapScaleIndex = 7; // I think that the above is more accurate for no-flightplan default, but this is more sane for initial testing!
138 _mapScaleAuto = true;
140 // Mega-hack - hardwire airport town and state names for the FG base area since we don't have any data for these at the moment
141 // TODO - do this better one day!
142 _airportTowns["KSFO"] = "San Francisco";
143 _airportTowns["KSQL"] = "San Carlos";
144 _airportTowns["KPAO"] = "Palo Alto";
145 _airportTowns["KNUQ"] = "Mountain View";
146 _airportTowns["KSJC"] = "San Jose";
147 _airportTowns["KRHV"] = "San Jose";
148 _airportTowns["E16"] = "San Martin";
149 _airportTowns["KWVI"] = "Watsonville";
150 _airportTowns["KOAK"] = "Oakland";
151 _airportTowns["KHWD"] = "Hayward";
152 _airportTowns["KLVK"] = "Livermore";
153 _airportTowns["KCCR"] = "Concord";
154 _airportTowns["KTCY"] = "Tracy";
155 _airportTowns["KSCK"] = "Stockton";
156 _airportTowns["KHAF"] = "Half Moon Bay";
158 _airportStates["KSFO"] = "CA";
159 _airportStates["KSQL"] = "CA";
160 _airportStates["KPAO"] = "CA";
161 _airportStates["KNUQ"] = "CA";
162 _airportStates["KSJC"] = "CA";
163 _airportStates["KRHV"] = "CA";
164 _airportStates["E16"] = "CA";
165 _airportStates["KWVI"] = "CA";
166 _airportStates["KOAK"] = "CA";
167 _airportStates["KHWD"] = "CA";
168 _airportStates["KLVK"] = "CA";
169 _airportStates["KCCR"] = "CA";
170 _airportStates["KTCY"] = "CA";
171 _airportStates["KSCK"] = "CA";
172 _airportStates["KHAF"] = "CA";
176 for(unsigned int i=0; i<_pages.size(); ++i) {
182 for(unsigned int i=0; i<_maxFlightPlans; ++i) {
184 delete _flightPlans[i];
189 fgTie("/instrumentation/gps/message-alert", this, &KLN89::GetMsgAlert);
193 void KLN89::unbind() {
194 fgUntie("/instrumentation/gps/message-alert");
198 void KLN89::update(double dt) {
199 // Run any positional calc's required first
215 _mapHeadingUpdateTimer += dt;
216 if(_mapHeadingUpdateTimer > 1.0) {
218 _mapHeadingUpdateTimer = 0.0;
221 _instrument->Flush();
222 _instrument->DrawBackground();
225 if(_messageStack.empty()) {
226 DrawText("No Message", 0, 5, 2);
228 // TODO - parse the message string for special strings that indicate degrees signs etc!
229 DrawText(*_messageStack.begin(), 0, 0, 3);
233 if(!_messageStack.empty()) {
238 if(_curPage == 6 && _activePage->GetSubPage() == 3) {
239 // Don't draw the bar on the nav-4 page
240 } else if(_activePage == _nrst_page) {
241 // Don't draw the bar on the nearest page
246 _activePage->Update(dt);
249 void KLN89::CreateDefaultFlightPlans() {
250 // TODO - read these in from preferences.xml or similar instead!!!!
251 // Create some hardwired default flightplans for testing.
253 vector<GPSWpType> wps;
257 ids.push_back("KLSN");
258 wps.push_back(GPS_WP_APT);
259 ids.push_back("VOLTA");
260 wps.push_back(GPS_WP_INT);
261 ids.push_back("C83");
262 wps.push_back(GPS_WP_APT);
263 CreateFlightPlan(_flightPlans[5], ids, wps);
267 ids.push_back("KCCR");
268 wps.push_back(GPS_WP_APT);
269 ids.push_back("SUZYE");
270 wps.push_back(GPS_WP_INT);
271 ids.push_back("ALTAM");
272 wps.push_back(GPS_WP_INT);
273 ids.push_back("C83");
274 wps.push_back(GPS_WP_APT);
275 CreateFlightPlan(_flightPlans[4], ids, wps);
279 ids.push_back("KLVK");
280 wps.push_back(GPS_WP_APT);
281 ids.push_back("OAK");
282 wps.push_back(GPS_WP_VOR);
283 ids.push_back("PORTE");
284 wps.push_back(GPS_WP_INT);
285 ids.push_back("KHAF");
286 wps.push_back(GPS_WP_APT);
287 CreateFlightPlan(_flightPlans[3], ids, wps);
291 ids.push_back("KDPA");
292 wps.push_back(GPS_WP_APT);
293 ids.push_back("OBK");
294 wps.push_back(GPS_WP_VOR);
295 ids.push_back("ENW");
296 wps.push_back(GPS_WP_VOR);
297 ids.push_back("KRAC");
298 wps.push_back(GPS_WP_APT);
299 CreateFlightPlan(_flightPlans[2], ids, wps);
300 //cout << "Size of FP2 WP list is " << _flightPlans[2]->waypoints.size() << '\n';
304 ids.push_back("KSFO");
305 ids.push_back("KOAK");
306 wps.push_back(GPS_WP_APT);
307 wps.push_back(GPS_WP_APT);
308 CreateFlightPlan(_flightPlans[1], ids, wps);
312 //ids.push_back("KOSH");
313 ids.push_back("KSFO");
314 ids.push_back("KHAF");
315 ids.push_back("OSI");
316 ids.push_back("KSQL");
317 //ids.push_back("KPAO");
318 //ids.push_back("KHWD");
319 wps.push_back(GPS_WP_APT);
320 wps.push_back(GPS_WP_APT);
321 wps.push_back(GPS_WP_VOR);
322 wps.push_back(GPS_WP_APT);
323 //wps.push_back(GPS_WP_APT);
324 //wps.push_back(GPS_WP_APT);
325 CreateFlightPlan(_flightPlans[0], ids, wps);
330 ids.push_back("KLVK");
331 ids.push_back("KHWD");
332 wps.push_back(GPS_WP_APT);
333 wps.push_back(GPS_WP_APT);
334 CreateFlightPlan(_flightPlans[0], ids, wps);
338 void KLN89::Knob1Right1() {
339 if(_mode == KLN89_MODE_DISP) {
340 _activePage->LooseFocus();
341 if(_cleanUpPage >= 0) {
342 _pages[(unsigned int)_cleanUpPage]->CleanUp();
346 if(_curPage >= _pages.size()) _curPage = 0;
347 _activePage = _pages[_curPage];
349 _activePage->Knob1Right1();
354 void KLN89::Knob1Left1() {
355 if(_mode == KLN89_MODE_DISP) {
356 _activePage->LooseFocus();
357 if(_cleanUpPage >= 0) {
358 _pages[(unsigned int)_cleanUpPage]->CleanUp();
362 _curPage = _pages.size() - 1;
366 _activePage = _pages[_curPage];
368 _activePage->Knob1Left1();
373 void KLN89::Knob2Left1() {
374 _activePage->Knob2Left1();
377 void KLN89::Knob2Right1() {
378 _activePage->Knob2Right1();
381 void KLN89::CrsrPressed() {
383 // CRSR cannot be switched off on nrst page.
384 if(_activePage == _nrst_page) { return; }
385 // CRSR is always off when inner-knob is out on nav4 page.
386 if(_curPage == 6 && _activePage->GetSubPage() == 3 && fgGetBool("/instrumentation/kln89/scan-pull")) { return; }
387 if(_cleanUpPage >= 0) {
388 _pages[(unsigned int)_cleanUpPage]->CleanUp();
391 _entRestoreCrsr = false;
393 ((KLN89Page*)_activePage)->SetEntInvert(false);
394 if(_mode == KLN89_MODE_DISP) {
395 _mode = KLN89_MODE_CRSR;
396 _activePage->CrsrPressed();
398 _mode = KLN89_MODE_DISP;
399 _activePage->CrsrPressed();
404 void KLN89::EntPressed() {
407 // one of the data pages. Signal ent pressed to it here, and ent pressed to the call back page a few lines further down.
408 // Ie. 2 ent pressed signals in this case is deliberate.
409 _activePage->EntPressed();
412 _activePage = _pages[(unsigned int)_entJump];
413 if(_entRestoreCrsr) _mode = KLN89_MODE_CRSR;
416 if(_activePage == _dir_page) {
417 _dir_page->EntPressed();
418 _mode = KLN89_MODE_DISP;
419 _activePage = _pages[_curPage];
421 _activePage->EntPressed();
425 void KLN89::ClrPressed() {
426 _activePage->ClrPressed();
429 void KLN89::DtoPressed() {
430 if(_activePage != _dir_page) {
431 // Figure out which waypoint the dir page should display
433 // Apt, Vor, Ndb, Int, Usr or Act
434 if(!_activePage->GetId().empty()) { // Guard against no user waypoints defined
435 _dir_page->SetId(_activePage->GetId());
437 _dir_page->SetId(_activeWaypoint.id);
439 } else if(_curPage == 6 && _activePage->GetSubPage() == 3 && fgGetBool("/instrumentation/kln89/scan-pull") && _activeFP->waypoints.size()) {
441 _dir_page->SetId(((KLN89NavPage*)_activePage)->GetNav4WpId());
442 } else if(_curPage == 7 && _activePage->GetSubPage() == 0 && _mode == KLN89_MODE_CRSR) {
443 //cout << "Checking the fpl page!\n";
445 if(!_activePage->GetId().empty()) {
446 //cout << "Not empty!!!\n";
447 _dir_page->SetId(_activePage->GetId());
449 //cout << "empty :-(\n";
450 _dir_page->SetId(_activeWaypoint.id);
453 _dir_page->SetId(_activeWaypoint.id);
455 // This need to come after the bit before otherwise the FPL or NAV4 page clears their current ID when it looses focus.
456 _activePage->LooseFocus();
457 _activePage = _dir_page;
458 _mode = KLN89_MODE_CRSR;
462 void KLN89::NrstPressed() {
463 if(_activePage != _nrst_page) {
464 _activePage->LooseFocus(); // TODO - check whether we should call loose focus here
465 _lastActivePage = _activePage;
466 _activePage = _nrst_page;
468 _mode = KLN89_MODE_CRSR;
470 _activePage = _lastActivePage;
475 void KLN89::AltPressed() {}
477 void KLN89::OBSPressed() {
478 DCLGPS::OBSPressed();
481 _mode = KLN89_MODE_CRSR;
482 _activePage->OBSPressed();
486 void KLN89::MsgPressed() {
487 // TODO - handle persistent messages such as SUA alerting.
488 // (The message annunciation flashes before first view, but afterwards remains continuously lit with the message available
489 // until the potential conflict no longer pertains).
490 if(_dispMsg && _messageStack.size()) {
491 _messageStack.pop_front();
493 _dispMsg = !_dispMsg;
496 void KLN89::DrawBar(int page) {
497 int px = 1 + (page * 15);
499 for(int i=0; i<7; ++i) {
500 // Ugh - this is crude and inefficient!
501 _instrument->DrawPixel(px+i, py);
502 _instrument->DrawPixel(px+i, py+1);
506 // Convert moving map to instrument co-ordinates
507 void KLN89::MapToInstrument(int &x, int &y) {
508 x += _xBorder + _xFieldBorder[2] + _xFieldStart[2];
511 // Draw a pixel specified in instrument co-ords, but clipped to the map region
512 //void KLN89::DrawInstrMapPixel(int x, int y) {
515 // Clip, translate and draw a map pixel
516 // If we didn't need per-pixel clipping, it would be cheaper to translate object rather than pixel positions.
517 void KLN89::DrawMapPixel(int x, int y, bool invert) {
518 if(x < 0 || x > 111 || y < 0 || y > 39) return;
519 x += _xBorder + _xFieldBorder[2] + _xFieldStart[2];
520 _instrument->DrawPixel(x, y, invert);
524 // HACK - use something FG provides
525 static double gps_min(const double &a, const double &b) {
526 return(a <= b ? a : b);
529 static double gps_max(const double &a, const double &b) {
530 return(a >= b ? a : b);
533 void KLN89::UpdateMapHeading() {
534 switch(_mapOrientation) {
539 _mapHeading = _dtkTrue;
542 _mapHeading = _track;
547 // The screen area allocated to the moving map is 111 x 40 pixels.
548 // In North up mode, the user position marker is at 57, 20. (Map co-ords).
549 void KLN89::DrawMap(bool draw_avs) {
550 // Set the clipping region to the moving map part of the display
551 int xstart = _xBorder + _xFieldBorder[2] + _xFieldStart[2];
552 _instrument->SetClipRegion(xstart, 0, xstart + 110, 39);
554 _mapScaleUnits = (int)_distUnits;
555 _mapScale = (double)(KLN89MapScales[_mapScaleUnits][_mapScaleIndex]);
557 //cout << "Map scale = " << _mapScale << '\n';
559 double mapScaleMeters = _mapScale * (_mapScaleUnits == 0 ? SG_NM_TO_METER : 1000);
561 // TODO - use an aligned projection when either DTK or TK up!
562 FGATCAlignedProjection mapProj(SGGeod::fromRad(_gpsLon, _gpsLat), _mapHeading);
564 double meter_per_pix = (_mapOrientation == 0 ? mapScaleMeters / 20.0f : mapScaleMeters / 29.0f);
566 SGGeod bottomLeft = mapProj.ConvertFromLocal(SGVec3d(gps_max(-57.0 * meter_per_pix, -50000), gps_max((_mapOrientation == 0 ? -20.0 * meter_per_pix : -11.0 * meter_per_pix), -25000), 0.0));
567 SGGeod topRight = mapProj.ConvertFromLocal(SGVec3d(gps_min(54.0 * meter_per_pix, 50000), gps_min((_mapOrientation == 0 ? 20.0 * meter_per_pix : 29.0 * meter_per_pix), 25000), 0.0));
569 // Draw Airport labels first (but not one's that are waypoints)
570 // Draw Airports first (but not one's that are waypoints)
571 // Ditto for VORs (not sure if SUA/VOR/Airport ordering is important or not).
575 // Then waypoint labels (not sure if this should be before or after waypoints)
577 // Annotation then gets drawn by Nav page, NOT this function.
579 if(_drawApt && draw_avs) {
581 bool have_apt = _overlays->FindArpByRegion(&apt, bottomLeft.lat(), bottomLeft.lon(), topRight.lat(), topRight.lon());
582 //cout << "Vors enclosed are: ";
583 // Draw all the labels first...
584 for(unsigned int i=0; i<apt.size(); ++i) {
585 //cout << nav[i]->id << ' ';
586 Point3D p = mapProj.ConvertToLocal(Point3D(apt[i]->lon * SG_RADIANS_TO_DEGREES, apt[i]->lat * SG_RADIANS_TO_DEGREES, 0.0));
587 //cout << p << " .... ";
588 int mx = int(p.x() / meter_per_pix) + 56;
589 int my = int(p.y() / meter_per_pix) + (_mapOrientation == 0 ? 19 : 10);
590 //cout << "mx = " << mx << ", my = " << my << '\n';
591 bool right_align = (p.x() < 0.0);
592 DrawLabel(apt[i]->id, mx + (right_align ? -2 : 3), my + (p.y() < 0.0 ? -7 : 3), right_align);
593 // I think that we probably should have -1 in the right_align case above to match the real life instrument.
595 // ...and then all the Apts.
596 for(unsigned int i=0; i<apt.size(); ++i) {
597 //cout << nav[i]->id << ' ';
598 Point3D p = mapProj.ConvertToLocal(Point3D(apt[i]->lon * SG_RADIANS_TO_DEGREES, apt[i]->lat * SG_RADIANS_TO_DEGREES, 0.0));
599 //cout << p << " .... ";
600 int mx = int(p.x() / meter_per_pix) + 56;
601 int my = int(p.y() / meter_per_pix) + (_mapOrientation == 0 ? 19 : 10);
602 //cout << "mx = " << mx << ", my = " << my << '\n';
609 if(_drawVOR && draw_avs) {
610 Overlays::nav_array_type nav;
611 bool have_vor = _overlays->FindVorByRegion(&nav, bottomLeft.lat(), bottomLeft.lon(), topRight.lat(), topRight.lon());
612 //cout << "Vors enclosed are: ";
613 // Draw all the labels first...
614 for(unsigned int i=0; i<nav.size(); ++i) {
615 //cout << nav[i]->id << ' ';
616 Point3D p = mapProj.ConvertToLocal(Point3D(nav[i]->lon * SG_RADIANS_TO_DEGREES, nav[i]->lat * SG_RADIANS_TO_DEGREES, 0.0));
617 //cout << p << " .... ";
618 int mx = int(p.x() / meter_per_pix) + 56;
619 int my = int(p.y() / meter_per_pix) + (_mapOrientation == 0 ? 19 : 10);
620 //cout << "mx = " << mx << ", my = " << my << '\n';
621 bool right_align = (p.x() < 0.0);
622 DrawLabel(nav[i]->id, mx + (right_align ? -2 : 3), my + (p.y() < 0.0 ? -7 : 3), right_align);
623 // I think that we probably should have -1 in the right_align case above to match the real life instrument.
625 // ...and then all the VORs.
626 for(unsigned int i=0; i<nav.size(); ++i) {
627 //cout << nav[i]->id << ' ';
628 Point3D p = mapProj.ConvertToLocal(Point3D(nav[i]->lon * SG_RADIANS_TO_DEGREES, nav[i]->lat * SG_RADIANS_TO_DEGREES, 0.0));
629 //cout << p << " .... ";
630 int mx = int(p.x() / meter_per_pix) + 56;
631 int my = int(p.y() / meter_per_pix) + (_mapOrientation == 0 ? 19 : 10);
632 //cout << "mx = " << mx << ", my = " << my << '\n';
640 if(_activeFP->waypoints.size() > 1) {
641 vector<int> xvec, yvec, qvec; // qvec stores the quadrant that each waypoint label should
642 // be drawn in (relative to the waypoint).
643 // 1 = NE, 2 = SE, 3 = SW, 4 = NW.
644 double save_h; // Each pass, save a heading from the previous one for label quadrant determination.
645 bool drawTrack = true;
646 for(unsigned int i=1; i<_activeFP->waypoints.size(); ++i) {
647 GPSWaypoint* wp0 = _activeFP->waypoints[i-1];
648 GPSWaypoint* wp1 = _activeFP->waypoints[i];
649 SGVec3d p0 = mapProj.ConvertToLocal(SGGeod::fromRad(wp0->lon, wp0->lat));
650 SGVec3d p1 = mapProj.ConvertToLocal(SGGeod::fromRad(wp1->lon, wp1->lat));
651 int mx0 = int(p0.x() / meter_per_pix) + 56;
652 int my0 = int(p0.y() / meter_per_pix) + (_mapOrientation == 0 ? 19 : 10);
653 int mx1 = int(p1.x() / meter_per_pix) + 56;
654 int my1 = int(p1.y() / meter_per_pix) + (_mapOrientation == 0 ? 19 : 10);
658 double h = GetGreatCircleCourse(wp0->lat, wp0->lon, wp1->lat, wp1->lon) * SG_RADIANS_TO_DEGREES;
659 // Adjust for map orientation
661 qvec.push_back(GetLabelQuadrant(h));
662 //cout << "i = " << i << ", h = " << h << ", qvec[0] = " << qvec[0] << '\n';
666 if(drawTrack) { DrawLine(mx0, my0, mx1, my1); }
668 double h = GetGreatCircleCourse(wp0->lat, wp0->lon, wp1->lat, wp1->lon) * SG_RADIANS_TO_DEGREES;
669 // Adjust for map orientation
671 qvec.push_back(GetLabelQuadrant(save_h, h));
673 save_h = GetGreatCircleCourse(wp1->lat, wp1->lon, wp0->lat, wp0->lon) * SG_RADIANS_TO_DEGREES;
674 // Adjust for map orientation
675 save_h -= _mapHeading;
676 if(i == _activeFP->waypoints.size() - 1) {
677 qvec.push_back(GetLabelQuadrant(save_h));
679 // Don't draw flight track beyond the missed approach point of an approach
680 if(_approachLoaded) {
681 //cout << "Waypoints are " << wp0->id << " and " << wp1->id << '\n';
682 //cout << "Types are " << wp0->appType << " and " << wp1->appType << '\n';
683 if(wp1->appType == GPS_MAP) {
688 // ASSERT(xvec.size() == yvec.size() == qvec.size() == _activeFP->waypoints.size());
689 for(unsigned int i=0; i<xvec.size(); ++i) {
690 DrawWaypoint(xvec[i], yvec[i]);
691 bool right_align = (qvec[i] > 2);
692 bool top = (qvec[i] == 1 || qvec[i] == 4);
693 // TODO - not sure if labels should be drawn in sequence with waypoints and flightpaths,
694 // or all before or all afterwards. Doesn't matter a huge deal though.
695 DrawLabel(_activeFP->waypoints[i]->id, xvec[i] + (right_align ? -2 : 3), yvec[i] + (top ? 3 : -7), right_align);
700 if(_mapOrientation == 0) {
703 } else if(_mapOrientation == 1) {
706 } else if(_mapOrientation == 2) {
711 // TODO - don't know what to do here!
714 // And finally, reset the clip region to stop the rest of the code going pear-shaped!
715 _instrument->ResetClipRegion();
718 // Get the quadrant to draw the label of the start or end waypoint (i.e. one with only one track from it).
719 // Heading specified FROM the waypoint.
723 int KLN89::GetLabelQuadrant(double h) {
724 while(h < 0.0) h += 360.0;
725 while(h > 360.0) h -= 360.0;
726 if(h < 90.0) return(3);
727 if(h < 180.0) return(4);
728 if(h < 270.0) return(1);
732 // Get the quadrant to draw the label of an en-route waypoint,
733 // with BOTH tracks specified as headings FROM the waypoint.
737 int KLN89::GetLabelQuadrant(double h1, double h2) {
738 while(h1 < 0.0) h1 += 360.0;
739 while(h1 > 360.0) h1 -= 360.0;
740 while(h2 < 0.0) h2 += 360.0;
741 while(h2 > 360.0) h2 -= 360.0;
742 double max_min_diff = 0.0;
744 for(int i=0; i<4; ++i) {
745 double h = 45 + (90 * i);
746 double diff1 = fabs(h - h1);
747 if(diff1 > 180) diff1 = 360 - diff1;
748 double diff2 = fabs(h - h2);
749 if(diff2 > 180) diff2 = 360 - diff2;
750 double min_diff = gps_min(diff1, diff2);
751 if(min_diff > max_min_diff) {
752 max_min_diff = min_diff;
756 //cout << "GetLabelQuadrant, h1 = " << h1 << ", h2 = " << h2 << ", quad = " << quad << '\n';
760 // Draw the diamond style of user pos
770 void KLN89::DrawUser1(int x, int y) {
771 MapToInstrument(x, y);
772 int min_j = 0, max_j = 0;
773 for(int i=-3; i<=3; ++i) {
774 for(int j=min_j; j<=max_j; ++j) {
775 _instrument->DrawPixel(x+j, y+i, (j == min_j || j == max_j ? true : false));
787 // Draw the airplane style of user pos
788 // Define the origin to be the midpoint of the *fuselage*
789 void KLN89::DrawUser2(int x, int y) {
790 MapToInstrument(x, y);
792 // Draw the background as three black quads first
793 _instrument->DrawQuad(x-2, y-3, x+2, y-1, true);
794 _instrument->DrawQuad(x-3, y, x+3, y+2, true);
795 _instrument->DrawQuad(x-1, y+3, x+1, y+3, true);
798 for(int j=y-2; j<=y+2; ++j) {
799 _instrument->DrawPixel(x, j);
801 for(int i=x-1; i<=x+1; ++i) {
802 _instrument->DrawPixel(i, y-2);
804 for(int i=x-2; i<=x+2; ++i) {
805 _instrument->DrawPixel(i, y+1);
808 _instrument->DrawQuad(x, y-2, x, y+2);
809 _instrument->DrawQuad(x-1, y-2, x+1, y-2);
810 _instrument->DrawQuad(x-2, y+1, x+2, y+1);
814 // Draw an airport symbol on the moving map
822 void KLN89::DrawApt(int x, int y) {
823 MapToInstrument(x, y);
827 for(i=x-1; i<=x+1; ++i) _instrument->DrawPixel(i, j, true);
829 for(i=x-2; i<=x+2; ++i) _instrument->DrawPixel(i, j, (i != x ? true : false));
831 for(i=x-2; i<=x+2; ++i) _instrument->DrawPixel(i, j, (abs(i - x) > 1 ? true : false));
833 for(i=x-2; i<=x+2; ++i) _instrument->DrawPixel(i, j, (i != x ? true : false));
835 for(i=x-1; i<=x+1; ++i) _instrument->DrawPixel(i, j, true);
838 // Draw a waypoint on the moving map
846 void KLN89::DrawWaypoint(int x, int y) {
847 MapToInstrument(x, y);
848 _instrument->SetDebugging(true);
850 // Draw black background
851 _instrument->DrawQuad(x-2, y-2, x+2, y+2, true);
853 // Draw the coloured square
855 for(int i=x-1; i<=x+1; ++i) {
856 for(int j=y-1; j<=y+1; ++j) {
857 _instrument->DrawPixel(i, j);
861 _instrument->DrawQuad(x-1, y-1, x+1, y+1);
863 _instrument->SetDebugging(false);
866 // Draw a VOR on the moving map
874 void KLN89::DrawVOR(int x, int y) {
875 // Cheat - draw a waypoint and then a black pixel in the middle.
876 // Need to call Waypoint draw *before* translating co-ords.
878 MapToInstrument(x, y);
879 _instrument->DrawPixel(x, y, true);
882 // Draw a line on the moving map
883 void KLN89::DrawLine(int x1, int y1, int x2, int y2) {
884 MapToInstrument(x1, y1);
885 MapToInstrument(x2, y2);
886 _instrument->DrawLine(x1, y1, x2, y2);
889 void KLN89::DrawMapUpArrow(int x, int y) {
890 MapToInstrument(x, y);
892 for(int j=0; j<7; ++j) {
893 _instrument->DrawPixel(x + 2, y + j);
896 _instrument->DrawQuad(x+2, y, x+2, y+6);
898 _instrument->DrawPixel(x, y+4);
899 _instrument->DrawPixel(x+1, y+5);
900 _instrument->DrawPixel(x+3, y+5);
901 _instrument->DrawPixel(x+4, y+4);
904 // Draw a quad on the moving map
905 void KLN89::DrawMapQuad(int x1, int y1, int x2, int y2, bool invert) {
906 MapToInstrument(x1, y1);
907 MapToInstrument(x2, y2);
908 _instrument->DrawQuad(x1, y1, x2, y2, invert);
911 // Draw an airport or waypoint label on the moving map
912 // Specify position by the map pixel co-ordinate of the left or right, bottom, of the *visible* portion of the label.
913 // The black background quad will automatically overlap this by 1 pixel.
914 void KLN89::DrawLabel(const string& s, int x1, int y1, bool right_align) {
915 MapToInstrument(x1, y1);
917 for(unsigned int i=0; i<s.size(); ++i) {
919 x1 += DrawSmallChar(c, x1, y1);
923 for(int i=(int)(s.size()-1); i>=0; --i) {
925 x1 -= DrawSmallChar(c, x1, y1, right_align);
931 void KLN89::DrawCDI() {
933 for(int i=0; i<5; ++i) {
934 DrawSpecialChar(2, 2, 3+i, 2);
935 DrawSpecialChar(1, 2, 9+i, 2);
939 int px = 8 * 7 + _xBorder + _xFieldBorder[field] + _xFieldStart[field] + 2;
940 int py = 2 * 9 + _yBorder + _yFieldBorder[field] + _yFieldStart[field];
943 // Every 7 pixels deflection left or right is one dot on the scale, and hence 1/5 FSD.
944 // Maximum deflection is 37 pixels left, or 38 pixels right !?!
945 double xtd = CalcCrossTrackDeviation();
947 if(_cdiScaleTransition) {
948 double dots = (xtd / _currentCdiScale) * 5.0;
949 deflect = (int)(dots * 7.0 * -1.0);
950 // TODO - for all these I think I should add 0.5 before casting to int, and *then* multiply by -1. Possibly!
952 if(0 == _currentCdiScaleIndex) { // 5.0nm FSD => 1 nm per dot => 7 pixels per nm.
953 deflect = (int)(xtd * 7.0 * -1.0); // The -1.0 is because we move the 'needle' indicating the course, not the plane.
954 } else if(1 == _currentCdiScaleIndex) {
955 deflect = (int)(xtd * 35.0 * -1.0);
956 } else { // 0.3 == _cdiScale
957 deflect = (int)(xtd * 116.6666666667 * -1.0);
960 if(deflect > 38) deflect = 38;
961 if(deflect < -37) deflect = -37;
963 for(int j=0; j<9; ++j) {
964 _instrument->DrawPixel(px + deflect, py+j);
965 _instrument->DrawPixel(px + deflect + 1, py+j);
968 _instrument->DrawQuad(px + deflect, py, px + deflect + 1, py + 8);
974 for(int j=4; j>=0; --j) {
976 for(int i=0; i<k; ++i) {
977 _instrument->DrawPixel(px+j+i, (_headingBugTo ? py+j : py+4-j));
978 // At the extremities, draw the outlining dark pixel
979 if(i == 0 || i == k-1) {
980 _instrument->DrawPixel(px+j+i, (_headingBugTo ? py+j+1 : py+3-j), true);
986 void KLN89::DrawLegTail(int py) {
987 int px = 0 * 7 + _xBorder + _xFieldBorder[2] + _xFieldStart[2];
988 py = py * 9 + _yBorder + _yFieldBorder[2] + _yFieldStart[2];
992 py++; // Hack - not sure if this represents a border issue.
994 for(int i=0; i<9; ++i) _instrument->DrawPixel(px, py+i);
995 for(int i2=0; i2<5; ++i2) _instrument->DrawPixel(px+i2, py+9);
998 void KLN89::DrawLongLegTail(int py) {
999 int px = 0 * 7 + _xBorder + _xFieldBorder[2] + _xFieldStart[2];
1000 py = py * 9 + _yBorder + _yFieldBorder[2] + _yFieldStart[2];
1004 py++; // Hack - not sure if this represents a border issue.
1006 for(int i=0; i<18; ++i) _instrument->DrawPixel(px, py+i);
1007 for(int i2=0; i2<5; ++i2) _instrument->DrawPixel(px+i2, py+18);
1010 void KLN89::DrawHalfLegTail(int py) {
1013 void KLN89::DrawDivider() {
1014 int px = _xFieldStart[2] - 1;
1016 for(int i=0; i<36; ++i) {
1017 _instrument->DrawPixel(px, py+i);
1021 void KLN89::DrawEnt(int field, int px, int py) {
1022 px = px * 7 + _xBorder + _xFieldBorder[field] + _xFieldStart[field];
1023 py = py * 9 + _yBorder + _yFieldBorder[field] + _yFieldStart[field] + 1;
1025 px++; // Not sure why we need px++, but it seems to work!
1029 for(int i=0; i<5; ++i) _instrument->DrawPixel(px, py+i);
1030 _instrument->DrawPixel(px+1, py);
1031 _instrument->DrawPixel(px+2, py);
1032 _instrument->DrawPixel(px+1, py+2);
1033 _instrument->DrawPixel(px+1, py+4);
1034 _instrument->DrawPixel(px+2, py+4);
1038 for(int i=0; i<4; ++i) _instrument->DrawPixel(px, py+i);
1039 _instrument->DrawPixel(px+1, py+2);
1040 _instrument->DrawPixel(px+2, py+1);
1041 for(int i=0; i<4; ++i) _instrument->DrawPixel(px+3, py+i);
1045 _instrument->DrawPixel(px, py+3);
1046 for(int i=0; i<4; ++i) _instrument->DrawPixel(px+1, py+i);
1047 _instrument->DrawPixel(px+2, py+3);
1050 void KLN89::DrawMessageAlert() {
1051 // TODO - draw the proper message indicator
1053 int px = _xBorder + _xFieldBorder[1] + _xFieldStart[1];
1054 int py = 1 * 9 + _yBorder + _yFieldBorder[1] + _yFieldStart[1] + 1;
1056 px++; // Not sure why we need px++, but it seems to work!
1059 DrawText(" ", 1, 0, 1, false, 99);
1060 _instrument->DrawQuad(px+1, py-1, px+2, py+5, true);
1061 _instrument->DrawQuad(px+3, py+3, px+3, py+5, true);
1062 _instrument->DrawQuad(px+4, py+2, px+4, py+4, true);
1063 _instrument->DrawQuad(px+5, py+1, px+6, py+3, true);
1064 _instrument->DrawQuad(px+7, py+2, px+7, py+4, true);
1065 _instrument->DrawQuad(px+8, py+3, px+8, py+5, true);
1066 _instrument->DrawQuad(px+9, py-1, px+10, py+5, true);
1070 void KLN89::Underline(int field, int px, int py, int len) {
1071 px = px * 7 + _xBorder + _xFieldBorder[field] + _xFieldStart[field];
1072 py = py * 9 + _yBorder + _yFieldBorder[field] + _yFieldStart[field];
1073 for(int i=0; i<(len*7); ++i) {
1074 _instrument->DrawPixel(px, py);
1079 void KLN89::DrawKPH(int field, int cx, int cy) {
1081 int px = cx * 7 + _xBorder + _xFieldBorder[field] + _xFieldStart[field];
1082 int py = cy * 9 + _yBorder + _yFieldBorder[field] + _yFieldStart[field];
1087 for(int j=0; j<=4; ++j) {
1088 _instrument->DrawPixel(px, py + 2 +j);
1089 _instrument->DrawPixel(px + 8, py + j);
1091 _instrument->DrawPixel(px + 11, py + j);
1092 _instrument->DrawPixel(px + 9 + j, py + 2);
1096 for(int i=0; i<=6; ++i) {
1098 _instrument->DrawPixel(px + 1 + i, py + 4 + i);
1099 _instrument->DrawPixel(px + 1 + i, py + (4 - i));
1101 _instrument->DrawPixel(px + 2 + i, py + i);
1105 void KLN89::DrawDTO(int field, int cx, int cy) {
1106 DrawSpecialChar(6, field, cx, cy);
1107 if(!(_waypointAlert && _blink)) {
1108 DrawSpecialChar(3, field, cx+1, cy);
1111 int px = cx * 7 + _xBorder + _xFieldBorder[field] + _xFieldStart[field];
1112 int py = cy * 9 + _yBorder + _yFieldBorder[field] + _yFieldStart[field];
1117 // Fill in the gap between the 'D' and the arrow.
1118 _instrument->DrawPixel(px+5, py+3);
1121 // Takes character position
1122 void KLN89::DrawChar(char c, int field, int px, int py, bool bold, bool invert) {
1123 // Ignore field for now
1125 px = px * 7 + _xBorder + _xFieldBorder[field] + _xFieldStart[field];
1126 py = py * 9 + _yBorder + _yFieldBorder[field] + _yFieldStart[field];
1128 // Draw an orange background for inverted characters
1130 for(int i=0; i<7; ++i) {
1131 for(int j=0; j<9; ++j) {
1132 _instrument->DrawPixel(px + i, py + j);
1137 if(c < 33) return; // space
1139 // Render normal decimal points in bold floats
1140 if(c == '.') bold = false;
1142 ++py; // Shift the char up by one pixel
1143 for(int j=7; j>=0; --j) {
1144 char c1 = (bold ? NumbersBold[c-48][j] : UpperAlpha[c-33][j]);
1145 // Don't do the last column for now (ie. j = 1, not 0)
1146 for(int i=5; i>=0; --i) {
1147 if(c1 & (01 << i)) {
1148 _instrument->DrawPixel(px, py, invert);
1157 // Takes pixel position
1158 void KLN89::DrawFreeChar(char c, int x, int y, bool draw_background) {
1160 if(draw_background) {
1161 _instrument->DrawQuad(x, y, x+6, y+8, true);
1164 if(c < 33) return; // space
1166 ++y; // Shift the char up by one pixel
1167 for(int j=7; j>=0; --j) {
1168 char c1 = UpperAlpha[c-33][j];
1169 // Don't do the last column for now (ie. j = 1, not 0)
1170 for(int i=5; i>=0; --i) {
1171 if(c1 & (01 << i)) {
1172 _instrument->DrawPixel(x, y);
1181 // Takes instrument pixel co-ordinates.
1182 // Position is specified by the bottom of the *visible* portion, by default the left position unless align_right is true.
1183 // The return value is the pixel width of the visible portion
1184 int KLN89::DrawSmallChar(char c, int x, int y, bool align_right) {
1185 // calculate the index into the SmallChar array
1187 if(c > 47 && c < 58) {
1190 } else if(c > 64 && c < 91) {
1197 char n = SmallChar[idx][0]; // Width of visible portion
1198 if(align_right) x -= n;
1201 _instrument->DrawQuad(x - 1, y - 1, x + n, y + 5, true);
1203 for(int j=7; j>=3; --j) {
1204 char c1 = SmallChar[idx][j];
1205 for(int i=n-1; i>=0; --i) {
1206 if(c1 & (01 << i)) {
1207 _instrument->DrawPixel(x, y);
1218 // Takes character position
1219 void KLN89::DrawSpecialChar(char c, int field, int cx, int cy, bool bold) {
1221 cout << "ERROR - requested special char outside array bounds!\n";
1222 return; // Increment this as SpecialChar grows
1225 // Convert character to pixel position.
1226 // Ignore field for now
1228 int px = cx * 7 + _xBorder + _xFieldBorder[field] + _xFieldStart[field];
1229 int py = cy * 9 + _yBorder + _yFieldBorder[field] + _yFieldStart[field];
1230 ++py; // Total hack - the special chars were coming out 1 pixel too low!
1231 for(int i=7; i>=0; --i) {
1232 char c1 = SpecialChar[(int)c][i];
1233 // Don't do the last column for now (ie. j = 1, not 0)
1234 for(int j=5; j>=0; --j) {
1235 if(c1 & (01 << j)) {
1236 _instrument->DrawPixel(px, py);
1245 void KLN89::DrawText(const string& s, int field, int px, int py, bool bold, int invert) {
1246 for(int i = 0; i < (int)s.size(); ++i) {
1247 DrawChar(s[(unsigned int)i], field, px+i, py, bold, (invert == i || invert == 99));
1251 void KLN89::DrawMapText(const string& s, int x, int y, bool draw_background) {
1252 MapToInstrument(x, y);
1253 if(draw_background) {
1254 //_instrument->DrawQuad(x, y, x + (7 * s.size()) - 1, y + 8, true);
1255 _instrument->DrawQuad(x - 1, y, x + (7 * s.size()) - 2, y + 8, true);
1256 // The minus 1 and minus 2 are an ugly hack to disguise the fact that I've lost track of exactly what's going on!
1259 for(int i = 0; i < (int)s.size(); ++i) {
1260 DrawFreeChar(s[(unsigned int)i], x+(i * 7)-1, y);
1264 void KLN89::DrawLatitude(double d, int field, int px, int py) {
1265 DrawChar((d >= 0 ? 'N' : 'S'), field, px, py);
1268 // TODO - sanity check input to ensure major lat field can only ever by 2 chars wide
1270 // Don't know whether to zero pad the below for single digits or not?
1271 //cout << d << ", " << (int)d << '\n';
1272 // 3 not 2 in size before for trailing \0
1273 int n = snprintf(buf, 3, "%i", (int)d);
1275 //cout << s << "... " << n << '\n';
1276 DrawText(s, field, px+(3-n), py);
1277 n = snprintf(buf, 7, "%05.2f'", ((double)(d - (int)d)) * 60.0f);
1280 DrawSpecialChar(0, field, px, py); // Degrees symbol
1282 DrawText(s, field, px, py);
1285 void KLN89::DrawLongitude(double d, int field, int px, int py) {
1286 DrawChar((d >= 0 ? 'E' : 'W'), field, px, py);
1289 // TODO - sanity check input to ensure major lat field can only ever be 2 chars wide
1291 // Don't know whether to zero pad the below for single digits or not?
1292 //cout << d << ", " << (int)d << '\n';
1293 // 4 not 3 in size before for trailing \0
1294 int n = snprintf(buf, 4, "%i", (int)d);
1296 //cout << s << "... " << n << '\n';
1297 DrawText(s, field, px+(3-n), py);
1298 n = snprintf(buf, 7, "%05.2f'", ((double)(d - (int)d)) * 60.0f);
1301 DrawSpecialChar(0, field, px, py); // Degrees symbol
1303 DrawText(s, field, px, py);
1306 void KLN89::DrawFreq(double d, int field, int px, int py) {
1307 if(d >= 1000) d /= 100.0f;
1309 snprintf(buf, 7, "%6.2f", d);
1311 DrawText(s, field, px, py);
1314 void KLN89::DrawTime(double time, int field, int px, int py) {
1315 int hrs = (int)(time / 3600);
1316 int mins = (int)(ceil((time - (hrs * 3600)) / 60.0));
1321 n = snprintf(buf, 9, "%i:%02i", hrs, mins);
1324 n = snprintf(buf, 4, ":%02i", (int)time);
1327 DrawText(s, field, px - n + 1, py);
1330 void KLN89::DrawHeading(int h, int field, int px, int py) {
1332 snprintf(buf, 4, "%i", h);
1334 DrawText(s, field, px - s.size(), py);
1335 DrawSpecialChar(0, field, px, py); // Degrees symbol
1338 void KLN89::DrawDist(double d, int field, int px, int py) {
1339 d *= (_distUnits == GPS_DIST_UNITS_NM ? 1.0 : SG_NM_TO_METER * 0.001);
1341 snprintf(buf, 9, "%i", (int)(d + 0.5));
1343 s += (_distUnits == GPS_DIST_UNITS_NM ? "nm" : "Km");
1344 DrawText(s, field, px - s.size() + 1, py);
1347 void KLN89::DrawSpeed(double v, int field, int px, int py, int decimal) {
1348 // TODO - implement variable decimal places
1349 v *= (_velUnits == GPS_VEL_UNITS_KT ? 1.0 : 0.51444444444 * 0.001 * 3600.0);
1351 snprintf(buf, 9, "%i", (int)(v + 0.5));
1353 if(_velUnits == GPS_VEL_UNITS_KT) {
1355 DrawText(s, field, px - s.size() + 1, py);
1357 DrawText(s, field, px - s.size() - 1, py);
1358 DrawKPH(field, px - 1, py);
1362 void KLN89::DrawDirDistField(double lat, double lon, int field, int px, int py, bool to_flag, bool cursel) {
1363 DrawChar('>', field, px, py);
1367 h = GetMagHeadingFromTo(_gpsLat, _gpsLon, lat, lon);
1369 h = GetMagHeadingFromTo(lat, lon, _gpsLat, _gpsLon);
1371 while(h < 0.0) h += 360.0;
1372 while(h > 360.0) h -= 360.0;
1373 snprintf(buf, 4, "%3i", (int)(h + 0.5));
1375 if(!(cursel && _blink)) {
1376 DrawText(s, field, px + 4 - s.size(), py);
1377 DrawSpecialChar(0, field, px+4, py);
1378 DrawText((to_flag ? "To" : "Fr"), field, px+5, py);
1379 if(cursel) Underline(field, px + 1, py, 6);
1381 //double d = GetHorizontalSeparation(_gpsLat, _gpsLon, lat, lon);
1382 //d *= (_distUnits == GPS_DIST_UNITS_NM ? SG_METER_TO_NM : 0.001);
1383 double d = GetGreatCircleDistance(_gpsLat, _gpsLon, lat, lon);
1384 d *= (_distUnits == GPS_DIST_UNITS_NM ? 1.0 : SG_NM_TO_METER * 0.001);
1386 snprintf(buf, 7, "%5i", (int)(d + 0.5));
1388 snprintf(buf, 7, "%4.1f", d);
1391 DrawText(s, field, px + 12 - s.size(), py);
1392 DrawText((_distUnits == GPS_DIST_UNITS_NM ? "nm" : "Km"), field, px + 12, py);
1395 char KLN89::IncChar(char c, bool gap, bool wrap) {
1396 if(c == '9') return(wrap ? (gap ? ' ' : 'A') : '9');
1397 if(c == 'Z') return('0');
1398 if(c == ' ') return('A');
1402 char KLN89::DecChar(char c, bool gap, bool wrap) {
1403 if(c == 'A') return(wrap ? (gap ? ' ' : '9') : 'A');
1404 if(c == '0') return('Z');
1405 if(c == ' ') return('9');