1 /**************************************************************************
2 * hud.hxx -- hud defines and prototypes (initial draft)
4 * Written by Michele America, started September 1997.
6 * Copyright (C) 1997 Michele F. America - nomimarketing@mail.telepac.pt
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.
23 * (Log is kept at end of this file)
24 **************************************************************************/
31 # error This library requires C++
47 # include <values.h> // for MAXINT
50 #include <fg_typedefs.h>
51 #include <fg_constants.h>
52 #include <Aircraft/aircraft.h>
53 #include <Flight/flight.h>
54 #include <Controls/controls.h>
56 #include <deque> // STL double ended queue
58 #ifdef NEEDNAMESPACESTD
68 int top, bottom, left, right;
72 // View mode definitions
74 enum VIEW_MODES{ HUD_VIEW, PANEL_VIEW, CHASE_VIEW, TOWER_VIEW };
76 // DAY, NIGHT and brightness levels need to be visible where dialogs and
77 // controls can be used to set intensity and appropriate color. This will
79 // Hud general constants
96 enum fgLabelJust{ LEFT_JUST, CENTER_JUST, RIGHT_JUST } ;
101 #define UPPER_CENTER 3
102 #define UPPER_RIGHT 4
103 #define CENTER_RIGHT 5
104 #define LOWER_RIGHT 6
105 #define LOWER_CENTER 7
107 #define CENTER_LEFT 9
108 #define SOLID_LINES 10
109 #define DASHED_LINES 11
110 #define DASHED_NEG_LINES 12
113 #define HORIZON_FIXED 1
114 #define HORIZON_MOVING 2
115 #define LABEL_COUNTER 1
116 #define LABEL_WARNING 2
118 #define HUDS_AUTOTICKS 0x0001
119 #define HUDS_VERT 0x0002
120 #define HUDS_HORZ 0x0000
121 #define HUDS_TOP 0x0004
122 #define HUDS_BOTTOM 0x0008
123 #define HUDS_LEFT HUDS_TOP
124 #define HUDS_RIGHT HUDS_BOTTOM
125 #define HUDS_BOTH (HUDS_LEFT | HUDS_RIGHT)
126 #define HUDS_NOTICKS 0x0010
127 #define HUDS_ARITHTIC 0x0020
128 #define HUDS_DECITICS 0x0040
129 #define HUDS_NOTEXT 0x0080
132 // #define HUD_VERTICAL 1
133 // #define HUD_HORIZONTAL 2
134 // #define HUD_FREEFLOAT 3
136 // Ladder orientation modes
137 // #define HUD_LEFT 1
138 // #define HUD_RIGHT 2
140 // #define HUD_BOTTOM 2
141 // #define HUD_V_LEFT 1
142 // #define HUD_V_RIGHT 2
143 // #define HUD_H_TOP 1
144 // #define HUD_H_BOTTOM 2
149 // #define HUD_NOLIM 2
150 // #define HUD_CIRC 3
152 // #define HUD_INSTR_LADDER 1
153 // #define HUD_INSTR_CLADDER 2
154 // #define HUD_INSTR_HORIZON 3
155 // #define HUD_INSTR_LABEL 4
157 extern double get_throttleval ( void );
158 extern double get_aileronval ( void );
159 extern double get_elevatorval ( void );
160 extern double get_elev_trimval( void );
161 extern double get_rudderval ( void );
162 extern double get_speed ( void );
163 extern double get_aoa ( void );
164 extern double get_roll ( void );
165 extern double get_pitch ( void );
166 extern double get_heading ( void );
167 extern double get_altitude ( void );
168 extern double get_agl ( void );
169 extern double get_sideslip ( void );
170 extern double get_frame_rate ( void );
171 extern double get_latitude ( void );
172 extern double get_lat_min ( void );
173 extern double get_longitude ( void );
174 extern double get_long_min ( void );
175 extern double get_fov ( void );
176 extern double get_vfc_ratio ( void );
177 extern double get_vfc_tris_drawn ( void );
179 enum hudinstype{ HUDno_instr,
191 typedef struct gltagRGBTRIPLE { // rgbt
197 class instr_item { // An Abstract Base Class (ABC)
199 static UINT instances; // More than 64K instruments? Nah!
200 static int brightness;
201 static glRGBTRIPLE color;
204 RECT scrn_pos; // Framing - affects scale dimensions
205 // and orientation. Vert vs Horz, etc.
206 DBLFNPTR load_value_fn;
207 double disp_factor; // Multiply by to get numbers shown on scale.
211 UINT scr_span; // Working values for draw;
219 DBLFNPTR data_source,
222 bool working = true);
224 instr_item( const instr_item & image );
226 instr_item & operator = ( const instr_item & rhs );
227 virtual ~instr_item ();
229 int get_brightness ( void ) { return brightness;}
230 RECT get_location ( void ) { return scrn_pos; }
231 bool is_broken ( void ) { return broken; }
232 bool enabled ( void ) { return is_enabled;}
233 bool data_available ( void ) { return !!load_value_fn; }
234 double get_value ( void ) { return load_value_fn(); }
235 double data_scaling ( void ) { return disp_factor; }
236 UINT get_span ( void ) { return scr_span; }
237 POINT get_centroid ( void ) { return mid_span; }
238 UINT get_options ( void ) { return opts; }
240 virtual void display_enable( bool working ) { is_enabled = !! working;}
243 virtual void update( void );
244 virtual void break_display ( bool bad );
245 virtual void SetBrightness( int illumination_level ); // fgHUDSetBright...
246 void SetPosition ( int x, int y, UINT width, UINT height );
247 UINT get_Handle( void );
248 virtual void draw( void ) = 0; // Required method in derived classes
251 typedef instr_item *HIptr;
252 extern deque< instr_item *> HUD_deque;
254 // instr_item This class has no other purpose than to maintain
255 // a linked list of instrument and derived class
259 class instr_label : public instr_item {
263 const char *post_str;
273 DBLFNPTR data_source,
274 const char *label_format,
275 const char *pre_label_string = 0,
276 const char *post_label_string = 0,
277 double scale_data = 1.0,
278 UINT options = HUDS_TOP,
279 fgLabelJust justification = CENTER_JUST,
280 int font_size = SMALL,
281 int blinking = NOBLINK,
282 bool working = true);
286 instr_label( const instr_label & image);
287 instr_label & operator = (const instr_label & rhs );
288 virtual void draw( void ); // Required method in base class
291 typedef instr_label * pInstlabel;
294 // instr_scale This class is an abstract base class for both moving
295 // scale and moving needle (fixed scale) indicators. It
296 // does not draw itself, but is not instanciable.
299 class instr_scale : public instr_item {
301 double range_shown; // Width Units.
302 double Maximum_value; // ceiling.
303 double Minimum_value; // Representation floor.
304 double scale_factor; // factor => screen units/range values.
305 UINT Maj_div; // major division marker units
306 UINT Min_div; // minor division marker units
307 UINT Modulo; // Roll over point
308 int signif_digits; // digits to show to the right.
318 double max_value = 100.0,
319 double min_value = 0.0,
320 double disp_scaling = 1.0,
321 UINT major_divs = 10,
325 bool working = true);
327 virtual ~instr_scale();
328 instr_scale( const instr_scale & image);
329 instr_scale & operator = (const instr_scale & rhs);
331 virtual void draw ( void ) {}; // No-op here. Defined in derived classes.
332 UINT div_min ( void ) { return Min_div;}
333 UINT div_max ( void ) { return Maj_div;}
334 double min_val ( void ) { return Minimum_value;}
335 double max_val ( void ) { return Maximum_value;}
336 UINT modulo ( void ) { return Modulo; }
337 double factor ( void ) { return scale_factor;}
338 double range_to_show( void ) { return range_shown;}
341 // hud_card_ This class displays the indicated quantity on
342 // a scale that moves past the pointer. It may be
343 // horizontal or vertical, read above(left) or below(right) of the base
346 class hud_card : public instr_scale {
349 double half_width_units;
358 double maxValue = 100.0,
359 double minValue = 0.0,
360 double disp_scaling = 1.0,
361 UINT major_divs = 10,
363 UINT modulator = 100,
365 double value_span = 100.0,
366 bool working = true);
369 hud_card( const hud_card & image);
370 hud_card & operator = (const hud_card & rhs );
371 // virtual void display_enable( bool setting );
372 virtual void draw( void ); // Required method in base class
375 typedef hud_card * pCardScale;
377 class guage_instr : public instr_scale {
387 double disp_scaling = 1.0,
388 double maxValue = 100,
390 UINT major_divs = 50,
394 bool working = true);
397 guage_instr( const guage_instr & image);
398 guage_instr & operator = (const guage_instr & rhs );
399 virtual void draw( void ); // Required method in base class
402 typedef guage_instr * pGuageInst;
404 // dual_instr_item This class was created to form the base class
405 // for both panel and HUD Turn Bank Indicators.
407 class dual_instr_item : public instr_item {
409 DBLFNPTR alt_data_source;
412 dual_instr_item ( int x,
416 DBLFNPTR chn1_source,
417 DBLFNPTR chn2_source,
419 UINT options = HUDS_TOP);
421 virtual ~dual_instr_item() {};
422 dual_instr_item( const dual_instr_item & image);
423 dual_instr_item & operator = (const dual_instr_item & rhs );
425 double current_ch1( void ) { return alt_data_source();}
426 double current_ch2( void ) { return get_value();}
427 virtual void draw ( void ) { }
430 class fgTBI_instr : public dual_instr_item {
441 DBLFNPTR chn1_source = get_roll,
442 DBLFNPTR chn2_source = get_sideslip,
443 double maxBankAngle = 45.0,
444 double maxSlipAngle = 5.0,
445 UINT gap_width = 5.0,
446 bool working = true);
448 fgTBI_instr( const fgTBI_instr & image);
449 fgTBI_instr & operator = (const fgTBI_instr & rhs );
453 UINT bank_limit( void ) { return BankLimit;}
454 UINT slew_limit( void ) { return SlewLimit;}
456 virtual void draw( void ); // Required method in base class
459 typedef fgTBI_instr * pTBI;
461 class HudLadder : public dual_instr_item {
477 DBLFNPTR ptch_source = get_roll,
478 DBLFNPTR roll_source = get_pitch,
479 double span_units = 45.0,
480 double division_units = 10.0,
481 double minor_division = 0.0,
482 UINT screen_hole = 70,
484 bool working = true );
488 HudLadder( const HudLadder & image );
489 HudLadder & operator = ( const HudLadder & rhs );
490 virtual void draw( void );
494 //using namespace std;
495 //deque <instr_item> * Hdeque_ptr;
497 extern void HUD_brightkey( bool incr_bright );
498 extern int fgHUDInit( fgAIRCRAFT * /* current_aircraft */ );
499 extern int fgHUDInit2( fgAIRCRAFT * /* current_aircraft */ );
500 extern void fgUpdateHUD( void );
502 extern void drawOneLine ( UINT x1, UINT y1, UINT x2, UINT y2);
503 extern void drawOneLine ( RECT &rect);
504 extern void textString ( int x,
507 void *font = GLUT_BITMAP_8_BY_13);
508 extern void strokeString( int x,
511 void *font = GLUT_STROKE_ROMAN,
514 bool AddHUDInstrument( instr_item *pBlackBox );
515 void DrawHUD ( void );
516 bool DamageInstrument( INSTR_HANDLE unit );
517 bool RepairInstrument( INSTR_HANDLE unit );
520 void fgUpdateHUD ( Hptr hud );
521 void fgUpdateHUD2( Hptr hud ); // Future use?
522 void fgHUDSetTimeMode( Hptr hud, int time_of_day );
528 /* Revision 1.12 1998/08/24 20:05:17 curt
529 /* Added a second minimalistic HUD.
530 /* Added code to display the number of triangles rendered.
532 * Revision 1.11 1998/07/24 21:36:55 curt
533 * Ran dos2unix to get rid of extraneous ^M's. Tweaked parameter in
534 * ImageGetRawData() to match usage.
536 * Revision 1.10 1998/07/13 21:28:02 curt
537 * Converted the aoa scale to a radio altimeter.
539 * Revision 1.9 1998/07/13 21:00:48 curt
540 * Integrated Charlies latest HUD updates.
541 * Wrote access functions for current fgOPTIONS.
543 * Revision 1.8 1998/07/03 13:16:29 curt
544 * Added Charlie Hotchkiss's HUD updates and improvementes.
546 * Revision 1.6 1998/06/03 00:43:28 curt
547 * No .h when including stl stuff.
549 * Revision 1.5 1998/05/17 16:58:13 curt
550 * Added a View Frustum Culling ratio display to the hud.
552 * Revision 1.4 1998/05/16 13:04:15 curt
553 * New updates from Charlie Hotchkiss.
555 * Revision 1.3 1998/05/13 18:27:55 curt
556 * Added an fov to hud display.
558 * Revision 1.2 1998/05/11 18:13:12 curt
559 * Complete C++ rewrite of all cockpit code by Charlie Hotchkiss.
561 * Revision 1.15 1998/02/23 19:07:57 curt
562 * Incorporated Durk's Astro/ tweaks. Includes unifying the sun position
563 * calculation code between sun display, and other FG sections that use this
564 * for things like lighting.
566 * Revision 1.14 1998/02/21 14:53:14 curt
567 * Added Charlie's HUD changes.
569 * Revision 1.13 1998/02/20 00:16:22 curt
572 * Revision 1.12 1998/02/19 13:05:52 curt
573 * Incorporated some HUD tweaks from Michelle America.
574 * Tweaked the sky's sunset/rise colors.
575 * Other misc. tweaks.
577 * Revision 1.11 1998/02/16 13:38:42 curt
578 * Integrated changes from Charlie Hotchkiss.
580 * Revision 1.11 1998/02/16 13:38:42 curt
581 * Integrated changes from Charlie Hotchkiss.
583 * Revision 1.10 1998/02/12 21:59:42 curt
584 * Incorporated code changes contributed by Charlie Hotchkiss
585 * <chotchkiss@namg.us.anritsu.com>
587 * Revision 1.8 1998/02/07 15:29:35 curt
588 * Incorporated HUD changes and struct/typedef changes from Charlie Hotchkiss
589 * <chotchkiss@namg.us.anritsu.com>
591 * Revision 1.7 1998/02/03 23:20:15 curt
592 * Lots of little tweaks to fix various consistency problems discovered by
593 * Solaris' CC. Fixed a bug in fg_debug.c with how the fgPrintf() wrapper
594 * passed arguments along to the real printf(). Also incorporated HUD changes
595 * by Michele America.
597 * Revision 1.6 1998/01/22 02:59:30 curt
598 * Changed #ifdef FILE_H to #ifdef _FILE_H
600 * Revision 1.5 1998/01/19 19:27:01 curt
601 * Merged in make system changes from Bob Kuehne <rpk@sgi.com>
602 * This should simplify things tremendously.
604 * Revision 1.4 1998/01/19 18:40:21 curt
605 * Tons of little changes to clean up the code and to remove fatal errors
606 * when building with the c++ compiler.
608 * Revision 1.3 1997/12/30 16:36:41 curt
609 * Merged in Durk's changes ...
611 * Revision 1.2 1997/12/10 22:37:40 curt
612 * Prepended "fg" on the name of all global structures that didn't have it yet.
613 * i.e. "struct WEATHER {}" became "struct fgWEATHER {}"
615 * Revision 1.1 1997/08/29 18:03:22 curt