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}};
45 const char* KLN89TimeCodes[20] = { "UTC", "GST", "GDT", "ATS", "ATD", "EST", "EDT", "CST", "CDT", "MST",
46 "MDT", "PST", "PDT", "AKS", "AKD", "HAS", "HAD", "SST", "SDT", "LCL" };
49 // Used for storing airport town and county mapped by ID, since currently FG does not store this
50 typedef map<string, string> airport_id_str_map_type;
51 typedef airport_id_str_map_type::iterator airport_id_str_map_iterator;
53 typedef vector<KLN89Page*> kln89_page_list_type;
54 typedef kln89_page_list_type::iterator kln89_page_list_itr;
56 class KLN89 : public DCLGPS {
58 friend class KLN89Page;
59 friend class KLN89AptPage;
60 friend class KLN89VorPage;
61 friend class KLN89NDBPage;
62 friend class KLN89IntPage;
63 friend class KLN89UsrPage;
64 friend class KLN89ActPage;
65 friend class KLN89NavPage;
66 friend class KLN89FplPage;
67 friend class KLN89CalPage;
68 friend class KLN89SetPage;
69 friend class KLN89OthPage;
70 friend class KLN89AltPage;
71 friend class KLN89DirPage;
72 friend class KLN89NrstPage;
75 KLN89(RenderArea2D* instrument);
81 void update(double dt);
83 inline void SetTurnAnticipation(bool b) { _turnAnticipationEnabled = b; }
84 inline bool GetTurnAnticipation() { return(_turnAnticipationEnabled); }
86 inline void SetSuaAlertEnabled(bool b) { _suaAlertEnabled = b; }
87 inline bool GetSuaAlertEnabled() { return(_suaAlertEnabled); }
89 inline void SetAltAlertEnabled(bool b) { _altAlertEnabled = b; }
90 inline bool GetAltAlertEnabled() { return(_altAlertEnabled); }
92 void SetMinDisplayBrightness(int n); // Set minDisplayBrightness (between 1 and 9)
93 void DecrementMinDisplayBrightness(); // Decrease by 1
94 void IncrementMinDisplayBrightness(); // Increase by 1
95 inline int GetMinDisplayBrightness() { return(_minDisplayBrightness); }
97 inline bool GetMsgAlert() const { return(!_messageStack.empty()); }
112 void CreateDefaultFlightPlans();
115 void ToggleOBSMode();
117 // Initiate Direct To operation to the supplied ID.
118 void DtoInitiate(const string& id);
120 //----------------------- Drawing functions which take CHARACTER units -------------------------
121 // Render string s in display field field at position x, y
122 // WHERE POSITION IS IN CHARACTER UNITS!
124 // invert: -1 => no inversion, 0 -> n => 1 char - s[invert] gets inverted, 99 => entire string gets inverted
125 void DrawText(const string& s, int field, int px, int py, bool bold = false, int invert = -1);
127 void DrawLatitude(double d, int field, int px, int py);
128 void DrawLongitude(double d, int field, int px, int py);
130 // Draw a frequency as xxx.xx
131 void DrawFreq(double d, int field, int px, int py);
133 // Draw a time in seconds as hh:mm
134 // NOTE: px is RIGHT JUSTIFIED!
135 void DrawTime(double time, int field, int px, int py);
137 // Draw an integer heading, where px specifies the position of the degrees sign at the RIGHT of the value.
138 void DrawHeading(int h, int field, int px, int py);
140 // Draw a distance spec'd as nm as an integer (TODO - may need 1 decimal place if < 100) where px specifies RHS of units.
141 // Some uses definately don't want decimal place though (as at present), so would have to be arg.
142 void DrawDist(double d, int field, int px, int py);
144 // Draw a speed specifed in knots. px is RHS of the units. Can draw up to 2 decimal places.
145 void DrawSpeed(double v, int field, int px, int py, int decimals = 0);
147 void Underline(int field, int px, int py, int len);
149 // Render a char at a given position as above (position in CHARACTER units)
150 void DrawChar(char c, int field, int px, int py, bool bold = false, bool invert = false);
151 void DrawSpecialChar(char c, int field, int cx, int cy, bool bold = false);
153 // Draws the dir/dist field at the bottom of the main field
154 void DrawDirDistField(double lat, double lon, int field, int px, int py, bool to_flag = true, bool cursel = false);
156 //--------------------------------- end char units -----------------------------------------------
158 //----------------------- Drawing functions which take PIXEL units ------------------------------
160 // Takes instrument *pixel* co-ordinates NOT character units
161 // Position is specified by the bottom of the *visible* portion, by default the left position unless align_right is true.
162 // The return value is the pixel width of the visible portion
163 int DrawSmallChar(char c, int x, int y, bool align_right = false);
165 void DrawFreeChar(char c, int x, int y, bool draw_background = false);
167 //----------------------------------- end pixel unit functions -----------------------------------
171 void DrawEnt(int field = 1, int px = 0, int py = 1);
173 void DrawMessageAlert();
175 void DrawKPH(int field, int cx, int cy);
177 void DrawDTO(int field, int cx, int cy);
179 // Draw the bar that indicates which page we're on (zero-based)
180 void DrawBar(int page);
184 void DrawLegTail(int py);
185 void DrawLongLegTail(int py);
186 void DrawHalfLegTail(int py);
188 void UpdateMapHeading();
190 // Draw the moving map
191 // Apt, VOR and SUA drawing can be suspended by setting draw_avs to false, without affecting the stored drawing preference state.
192 void DrawMap(bool draw_avs = true);
194 // Set whether the display should be draw pixelated (more primatives, but might be closer to real-life)
195 // or not (in which case it is assumed that pixels are square and can be merged into quads).
198 // Flashing output should be hidden when blink is true
203 // In Crsr mode, CRSR pressed events are passed to the active page, in disp mode they change which page is active
205 // And the facility to save a mode
208 // Increment/Decrement a character in the KLN89 A-Z,0-9 scheme.
209 // Set gap to true to get a space between A and 9 when wrapping, set wrap to false to disable wrap.
210 char IncChar(char c, bool gap = false, bool wrap = true);
211 char DecChar(char c, bool gap = false, bool wrap = true);
213 // ==================== Page organisation stuff =============
214 // The list of cyclical pages that the user can cycle through
215 kln89_page_list_type _pages;
217 // The currently active page
218 KLN89Page* _activePage;
219 // And a facility to save the immediately preceeding active page
220 KLN89Page* _lastActivePage;
222 // Ugly hack. Housekeeping to allow us to temporarily display one page, while remembering which
223 // other page to "jump" back to. Used when the waypoint pages are used to review waypoint entry
224 // from the flightplan page.
225 int _entJump; // The page to jump back to if ENT is pressed. -1 indicates no jump.
226 int _clrJump; // The page to jump back to if CLR is pressed. -1 indicates no jump.
227 bool _jumpRestoreCrsr; // Indicates that jump back at this point should restore cursor mode.
229 // Misc pages that aren't in the cyclic list.
231 KLN89Page* _alt_page;
233 KLN89Page* _dir_page;
235 KLN89Page* _nrst_page;
236 // ====================== end of page stuff ===================
238 // Moving-map display stuff
239 int _mapOrientation; // 0 => North (true) up, 1 => DTK up, 2 => TK up, 3 => heading up (only when connected to external heading source).
240 double _mapHeading; // Degrees. The actual map heading gets updated at a lower frequency than DrawMap() is called at, hence we need to store it.
241 double _mapHeadingUpdateTimer; // Timer to determine when to update the above.
242 bool _mapScaleAuto; // Indicates that map should autoscale when true.
243 int _mapScaleIndex; // Index into array of available map scales.
244 int _mapScaleUnits; // 0 => nm, 1 => km.
245 double _mapScale; // nm or km from aircraft position to top of map.
246 // Note that aircraft position differs depending on orientation, but 'scale' retains the same meaning,
247 // so the scale per pixel alters to suit the defined scale when the rendered aircraft position changes.
248 bool _drawSUA; // special user airspace
252 // Convert map to instrument coordinates
253 void MapToInstrument(int &x, int &y);
255 // The following map drawing functions all take MAP co-ordinates, NOT instrument co-ordinates!
257 // Draw the diamond style of user pos
258 void DrawUser1(int x, int y);
260 // Draw the airplane style of user pos
261 void DrawUser2(int x, int y);
263 // Draw an airport symbol on the moving map
264 void DrawApt(int x, int y);
266 // Draw a waypoint on the moving map
267 void DrawWaypoint(int x, int y);
269 // Draw a VOR on the moving map
270 void DrawVOR(int x, int y);
272 // Draw an airport or waypoint label on the moving map
273 // Specify position by the map pixel co-ordinate of the left or right, bottom, of the *visible* portion of the label.
274 // The black background quad will automatically overlap this by 1 pixel.
275 void DrawLabel(const string& s, int x1, int y1, bool right_align = false);
277 int GetLabelQuadrant(double h);
278 int GetLabelQuadrant(double h1, double h2);
280 // Draw a line on the moving map
281 void DrawLine(int x1, int y1, int x2, int y2);
283 // Draw normal sized text on the moving map
284 void DrawMapText(const string& s, int x, int y, bool draw_background = false);
286 void DrawMapUpArrow(int x, int y);
288 // Draw a Quad on the moving map
289 void DrawMapQuad(int x1, int y1, int x2, int y2, bool invert = false);
291 // Airport town and state mapped by ID, since currently FG does not store this
292 airport_id_str_map_type _airportTowns;
293 airport_id_str_map_type _airportStates;
295 // NOTE - It is a deliberate decision not to have a proper message page class,
296 // since button events get directed to the page that was active before the
297 // message was displayed, not the message page itself.
298 bool _dispMsg; // Set true while the message page is being displayed
300 // Sometimes the datapages can be used to review a waypoint whilst the user makes a decision,
301 // and we need to remember why.
302 bool _dtoReview; // Set true when we a reviewing a waypoint for DTO operation.
304 // Configuration settings that the user can set via. the KLN89 SET pages.
305 bool _suaAlertEnabled; // Alert user to potential SUA entry
306 bool _altAlertEnabled; // Alert user to min safe alt violation
307 int _minDisplayBrightness; // Minimum display brightness in low light.
308 char _defaultFirstChar; // Default first waypoint character.
310 // The user-settable barometric pressure.
311 // This can be set in the range 22.00 -> 32.99", or 745 -> 1117mB/hPa.
312 // For user input, we maintain a single integer value that is either between 2200 and 3299 (")
313 // or between 745 and 1117 (mB/hPa). It gets converted from one to the other only when the
314 // units are changed.
315 // For internal VNAV calculations (which we don't currently do) this will be converted to a floating
316 // point value before use.
317 int _userBaroSetting;