1 // kln89_page.hxx - 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 - daveluff AT ntlworld.com
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.
31 #include <Instrumentation/dclgps.hxx>
32 #include "kln89_page.hxx"
36 const int KLN89MapScales[2][21] = {{1, 2, 3, 5, 7, 10, 12, 15, 17, 20, 25, 30, 40, 60, 80, 100, 120, 160, 240, 320, 500},
37 {2, 4, 6, 9, 13, 18, 22, 28, 32, 37, 46, 55, 75, 110, 150, 185, 220, 300, 440, 600, 925}};
44 enum KLN89DistanceUnits {
45 GPS_DIST_UNITS_NM = 0,
49 enum KLN89SpeedUnits {
54 enum KLN89AltitudeUnits {
59 enum KLN89PressureUnits {
60 GPS_PRES_UNITS_IN = 1,
66 const char* KLN89TimeCodes[20] = { "UTC", "GST", "GDT", "ATS", "ATD", "EST", "EDT", "CST", "CDT", "MST",
67 "MDT", "PST", "PDT", "AKS", "AKD", "HAS", "HAD", "SST", "SDT", "LCL" };
70 // Used for storing airport town and county mapped by ID, since currently FG does not store this
71 typedef std::map<std::string, std::string> airport_id_str_map_type;
72 typedef airport_id_str_map_type::iterator airport_id_str_map_iterator;
74 typedef std::vector<KLN89Page*> kln89_page_list_type;
75 typedef kln89_page_list_type::iterator kln89_page_list_itr;
77 class KLN89 : public DCLGPS {
79 friend class KLN89Page;
80 friend class KLN89AptPage;
81 friend class KLN89VorPage;
82 friend class KLN89NDBPage;
83 friend class KLN89IntPage;
84 friend class KLN89UsrPage;
85 friend class KLN89ActPage;
86 friend class KLN89NavPage;
87 friend class KLN89FplPage;
88 friend class KLN89CalPage;
89 friend class KLN89SetPage;
90 friend class KLN89OthPage;
91 friend class KLN89AltPage;
92 friend class KLN89DirPage;
93 friend class KLN89NrstPage;
96 KLN89(RenderArea2D* instrument);
102 void update(double dt);
105 // m if true, ft if false
106 inline void SetAltUnitsSI(bool b) { _altUnits = (b ? GPS_ALT_UNITS_M : GPS_ALT_UNITS_FT); }
107 // Returns true if alt units are SI (m), false if ft
108 inline bool GetAltUnitsSI() { return(_altUnits == GPS_ALT_UNITS_M ? true : false); }
109 // km and k/h if true, nm and kt if false
110 inline void SetDistVelUnitsSI(bool b) { _distUnits = (b ? GPS_DIST_UNITS_KM : GPS_DIST_UNITS_NM); _velUnits = (b ? GPS_VEL_UNITS_KPH : GPS_VEL_UNITS_KT); }
111 // Returns true if dist/vel units are SI
112 inline bool GetDistVelUnitsSI() { return(_distUnits == GPS_DIST_UNITS_KM && _velUnits == GPS_VEL_UNITS_KPH ? true : false); }
113 // Set baro units - 1 = in, 2 = mB, 3 = hP Wrapping if for the convienience of the GPS setter.
114 void SetBaroUnits(int n, bool wrap = false);
115 // Get baro units: 1 = in, 2 = mB, 3 = hP
116 inline int GetBaroUnits() { return((int)_baroUnits); }
118 inline void SetTurnAnticipation(bool b) { _turnAnticipationEnabled = b; }
119 inline bool GetTurnAnticipation() { return(_turnAnticipationEnabled); }
121 inline void SetSuaAlertEnabled(bool b) { _suaAlertEnabled = b; }
122 inline bool GetSuaAlertEnabled() { return(_suaAlertEnabled); }
124 inline void SetAltAlertEnabled(bool b) { _altAlertEnabled = b; }
125 inline bool GetAltAlertEnabled() { return(_altAlertEnabled); }
127 void SetMinDisplayBrightness(int n); // Set minDisplayBrightness (between 1 and 9)
128 void DecrementMinDisplayBrightness(); // Decrease by 1
129 void IncrementMinDisplayBrightness(); // Increase by 1
130 inline int GetMinDisplayBrightness() { return(_minDisplayBrightness); }
132 inline bool GetMsgAlert() const { return(!_messageStack.empty()); }
147 void CreateDefaultFlightPlans();
150 void ToggleOBSMode();
152 // Initiate Direct To operation to the supplied ID.
153 void DtoInitiate(const std::string& id);
155 //----------------------- Drawing functions which take CHARACTER units -------------------------
156 // Render string s in display field field at position x, y
157 // WHERE POSITION IS IN CHARACTER UNITS!
159 // invert: -1 => no inversion, 0 -> n => 1 char - s[invert] gets inverted, 99 => entire string gets inverted
160 void DrawText(const std::string& s, int field, int px, int py, bool bold = false, int invert = -1);
162 void DrawLatitude(double d, int field, int px, int py);
163 void DrawLongitude(double d, int field, int px, int py);
165 // Draw a frequency as xxx.xx
166 void DrawFreq(double d, int field, int px, int py);
168 // Draw a time in seconds as hh:mm
169 // NOTE: px is RIGHT JUSTIFIED!
170 void DrawTime(double time, int field, int px, int py);
172 // Draw an integer heading, where px specifies the position of the degrees sign at the RIGHT of the value.
173 void DrawHeading(int h, int field, int px, int py);
175 // Draw a distance spec'd as nm as an integer (TODO - may need 1 decimal place if < 100) where px specifies RHS of units.
176 // Some uses definately don't want decimal place though (as at present), so would have to be arg.
177 void DrawDist(double d, int field, int px, int py);
179 // Draw a speed specifed in knots. px is RHS of the units. Can draw up to 2 decimal places.
180 void DrawSpeed(double v, int field, int px, int py, int decimals = 0);
182 void Underline(int field, int px, int py, int len);
184 // Render a char at a given position as above (position in CHARACTER units)
185 void DrawChar(char c, int field, int px, int py, bool bold = false, bool invert = false);
186 void DrawSpecialChar(char c, int field, int cx, int cy, bool bold = false);
188 // Draws the dir/dist field at the bottom of the main field
189 void DrawDirDistField(double lat, double lon, int field, int px, int py, bool to_flag = true, bool cursel = false);
191 //--------------------------------- end char units -----------------------------------------------
193 //----------------------- Drawing functions which take PIXEL units ------------------------------
195 // Takes instrument *pixel* co-ordinates NOT character units
196 // Position is specified by the bottom of the *visible* portion, by default the left position unless align_right is true.
197 // The return value is the pixel width of the visible portion
198 int DrawSmallChar(char c, int x, int y, bool align_right = false);
200 void DrawFreeChar(char c, int x, int y, bool draw_background = false);
202 //----------------------------------- end pixel unit functions -----------------------------------
206 void DrawEnt(int field = 1, int px = 0, int py = 1);
208 void DrawMessageAlert();
210 void DrawKPH(int field, int cx, int cy);
212 void DrawDTO(int field, int cx, int cy);
214 // Draw the bar that indicates which page we're on (zero-based)
215 void DrawBar(int page);
219 void DrawLegTail(int py);
220 void DrawLongLegTail(int py);
221 void DrawHalfLegTail(int py);
223 void UpdateMapHeading();
225 // Draw the moving map
226 // Apt, VOR and SUA drawing can be suspended by setting draw_avs to false, without affecting the stored drawing preference state.
227 void DrawMap(bool draw_avs = true);
229 // Set whether the display should be draw pixelated (more primatives, but might be closer to real-life)
230 // or not (in which case it is assumed that pixels are square and can be merged into quads).
233 // Flashing output should be hidden when blink is true
238 // In Crsr mode, CRSR pressed events are passed to the active page, in disp mode they change which page is active
240 // And the facility to save a mode
243 // Increment/Decrement a character in the KLN89 A-Z,0-9 scheme.
244 // Set gap to true to get a space between A and 9 when wrapping, set wrap to false to disable wrap.
245 char IncChar(char c, bool gap = false, bool wrap = true);
246 char DecChar(char c, bool gap = false, bool wrap = true);
248 // ==================== Page organisation stuff =============
249 // The list of cyclical pages that the user can cycle through
250 kln89_page_list_type _pages;
252 // The currently active page
253 KLN89Page* _activePage;
254 // And a facility to save the immediately preceeding active page
255 KLN89Page* _lastActivePage;
257 // Ugly hack. Housekeeping to allow us to temporarily display one page, while remembering which
258 // other page to "jump" back to. Used when the waypoint pages are used to review waypoint entry
259 // from the flightplan page.
260 int _entJump; // The page to jump back to if ENT is pressed. -1 indicates no jump.
261 int _clrJump; // The page to jump back to if CLR is pressed. -1 indicates no jump.
262 bool _jumpRestoreCrsr; // Indicates that jump back at this point should restore cursor mode.
264 // Misc pages that aren't in the cyclic list.
266 KLN89Page* _alt_page;
268 KLN89Page* _dir_page;
270 KLN89Page* _nrst_page;
271 // ====================== end of page stuff ===================
273 // Moving-map display stuff
274 int _mapOrientation; // 0 => North (true) up, 1 => DTK up, 2 => TK up, 3 => heading up (only when connected to external heading source).
275 double _mapHeading; // Degrees. The actual map heading gets updated at a lower frequency than DrawMap() is called at, hence we need to store it.
276 double _mapHeadingUpdateTimer; // Timer to determine when to update the above.
277 bool _mapScaleAuto; // Indicates that map should autoscale when true.
278 int _mapScaleIndex; // Index into array of available map scales.
279 int _mapScaleUnits; // 0 => nm, 1 => km.
280 double _mapScale; // nm or km from aircraft position to top of map.
281 // Note that aircraft position differs depending on orientation, but 'scale' retains the same meaning,
282 // so the scale per pixel alters to suit the defined scale when the rendered aircraft position changes.
283 bool _drawSUA; // special user airspace
287 // Convert map to instrument coordinates
288 void MapToInstrument(int &x, int &y);
290 // The following map drawing functions all take MAP co-ordinates, NOT instrument co-ordinates!
292 // Draw the diamond style of user pos
293 void DrawUser1(int x, int y);
295 // Draw the airplane style of user pos
296 void DrawUser2(int x, int y);
298 // Draw an airport symbol on the moving map
299 void DrawApt(int x, int y);
301 // Draw a waypoint on the moving map
302 void DrawWaypoint(int x, int y);
304 // Draw a VOR on the moving map
305 void DrawVOR(int x, int y);
307 // Draw an airport or waypoint label on the moving map
308 // Specify position by the map pixel co-ordinate of the left or right, bottom, of the *visible* portion of the label.
309 // The black background quad will automatically overlap this by 1 pixel.
310 void DrawLabel(const std::string& s, int x1, int y1, bool right_align = false);
312 int GetLabelQuadrant(double h);
313 int GetLabelQuadrant(double h1, double h2);
315 // Draw a line on the moving map
316 void DrawLine(int x1, int y1, int x2, int y2);
318 // Draw normal sized text on the moving map
319 void DrawMapText(const std::string& s, int x, int y, bool draw_background = false);
321 void DrawMapUpArrow(int x, int y);
323 // Draw a Quad on the moving map
324 void DrawMapQuad(int x1, int y1, int x2, int y2, bool invert = false);
326 // Airport town and state mapped by ID, since currently FG does not store this
327 airport_id_str_map_type _airportTowns;
328 airport_id_str_map_type _airportStates;
330 // NOTE - It is a deliberate decision not to have a proper message page class,
331 // since button events get directed to the page that was active before the
332 // message was displayed, not the message page itself.
333 bool _dispMsg; // Set true while the message page is being displayed
335 // Sometimes the datapages can be used to review a waypoint whilst the user makes a decision,
336 // and we need to remember why.
337 bool _dtoReview; // Set true when we a reviewing a waypoint for DTO operation.
339 // Configuration settings that the user can set via. the KLN89 SET pages.
340 KLN89SpeedUnits _velUnits;
341 KLN89DistanceUnits _distUnits;
342 KLN89PressureUnits _baroUnits;
343 KLN89AltitudeUnits _altUnits;
344 bool _suaAlertEnabled; // Alert user to potential SUA entry
345 bool _altAlertEnabled; // Alert user to min safe alt violation
346 int _minDisplayBrightness; // Minimum display brightness in low light.
347 char _defaultFirstChar; // Default first waypoint character.
349 // The user-settable barometric pressure.
350 // This can be set in the range 22.00 -> 32.99", or 745 -> 1117mB/hPa.
351 // For user input, we maintain a single integer value that is either between 2200 and 3299 (")
352 // or between 745 and 1117 (mB/hPa). It gets converted from one to the other only when the
353 // units are changed.
354 // For internal VNAV calculations (which we don't currently do) this will be converted to a floating
355 // point value before use.
356 int _userBaroSetting;