1 // hud.hxx -- hud defines and prototypes (initial draft)
3 // Written by Michele America, started September 1997.
5 // Copyright (C) 1997 Michele F. America - nomimarketing@mail.telepac.pt
7 // This program is free software; you can redistribute it and/or
8 // modify it under the terms of the GNU General Public License as
9 // published by the Free Software Foundation; either version 2 of the
10 // License, or (at your option) any later version.
12 // This program is distributed in the hope that it will be useful, but
13 // WITHOUT ANY WARRANTY; without even the implied warranty of
14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 // General Public License for more details.
17 // You should have received a copy of the GNU General Public License
18 // along with this program; if not, write to the Free Software
19 // Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
28 # error This library requires C++
31 #include <simgear/compiler.h>
45 //#ifdef HAVE_VALUES_H
46 //# include <values.h> // for MAXINT
49 #include <vector> // STL vector
50 #include <deque> // STL double ended queue
52 #include <simgear/constants.h>
54 #include <Include/fg_typedefs.h>
55 #include <Aircraft/aircraft.hxx>
56 #include <FDM/flight.hxx>
57 #include <Controls/controls.hxx>
60 #include "hud_opts.hxx"
64 FG_USING_NAMESPACE(std);
67 // some of Norman's crazy optimizations. :-)
75 int top, bottom, left, right;
79 // View mode definitions
81 enum VIEW_MODES{ HUD_VIEW, PANEL_VIEW, CHASE_VIEW, TOWER_VIEW };
83 // DAY, NIGHT and brightness levels need to be visible where dialogs and
84 // controls can be used to set intensity and appropriate color. This will
86 // Hud general constants
103 enum fgLabelJust{ LEFT_JUST, CENTER_JUST, RIGHT_JUST } ;
108 #define UPPER_CENTER 3
109 #define UPPER_RIGHT 4
110 #define CENTER_RIGHT 5
111 #define LOWER_RIGHT 6
112 #define LOWER_CENTER 7
114 #define CENTER_LEFT 9
115 #define SOLID_LINES 10
116 #define DASHED_LINES 11
117 #define DASHED_NEG_LINES 12
120 #define HORIZON_FIXED 1
121 #define HORIZON_MOVING 2
122 #define LABEL_COUNTER 1
123 #define LABEL_WARNING 2
125 #define HUDS_AUTOTICKS 0x0001
126 #define HUDS_VERT 0x0002
127 #define HUDS_HORZ 0x0000
128 #define HUDS_TOP 0x0004
129 #define HUDS_BOTTOM 0x0008
130 #define HUDS_LEFT HUDS_TOP
131 #define HUDS_RIGHT HUDS_BOTTOM
132 #define HUDS_BOTH (HUDS_LEFT | HUDS_RIGHT)
133 #define HUDS_NOTICKS 0x0010
134 #define HUDS_ARITHTIC 0x0020
135 #define HUDS_DECITICS 0x0040
136 #define HUDS_NOTEXT 0x0080
139 // #define HUD_VERTICAL 1
140 // #define HUD_HORIZONTAL 2
141 // #define HUD_FREEFLOAT 3
143 // Ladder orientation modes
144 // #define HUD_LEFT 1
145 // #define HUD_RIGHT 2
147 // #define HUD_BOTTOM 2
148 // #define HUD_V_LEFT 1
149 // #define HUD_V_RIGHT 2
150 // #define HUD_H_TOP 1
151 // #define HUD_H_BOTTOM 2
156 // #define HUD_NOLIM 2
157 // #define HUD_CIRC 3
159 // #define HUD_INSTR_LADDER 1
160 // #define HUD_INSTR_CLADDER 2
161 // #define HUD_INSTR_HORIZON 3
162 // #define HUD_INSTR_LABEL 4
165 extern float get_throttleval ( void );
166 extern float get_aileronval ( void );
167 extern float get_elevatorval ( void );
168 extern float get_elev_trimval( void );
169 extern float get_rudderval ( void );
170 extern float get_speed ( void );
171 extern float get_aoa ( void );
172 extern float get_roll ( void );
173 extern float get_pitch ( void );
174 extern float get_heading ( void );
175 extern float get_view_direction( void );
176 extern float get_altitude ( void );
177 extern float get_agl ( void );
178 extern float get_sideslip ( void );
179 extern float get_frame_rate ( void );
180 extern float get_latitude ( void );
181 extern float get_lat_min ( void );
182 extern float get_longitude ( void );
183 extern float get_long_min ( void );
184 extern float get_fov ( void );
185 extern float get_vfc_ratio ( void );
186 extern float get_vfc_tris_drawn ( void );
187 extern float get_vfc_tris_culled ( void );
188 extern float get_climb_rate ( void );
189 extern float get_mach( void );
190 extern char *coord_format_lat(float);
191 extern char *coord_format_lon(float);
192 //extern char *coord_format_latlon(float latitude, float longitude); // cockpit.cxx
194 // $$$ begin - added, VS Renganathan, 13 Oct 2K
195 // #define FIGHTER_HUD
196 extern float get_anzg (void);
197 extern float get_Vx (void);
198 extern float get_Vy (void);
199 extern float get_Vz (void);
200 extern float get_Ax (void);
201 extern float get_Ay (void);
202 extern float get_Az (void);
203 extern int get_iaux1 (void);
204 extern int get_iaux2 (void);
205 extern int get_iaux3 (void);
206 extern int get_iaux4 (void);
207 extern int get_iaux5 (void);
208 extern int get_iaux6 (void);
209 extern int get_iaux7 (void);
210 extern int get_iaux8 (void);
211 extern int get_iaux9 (void);
212 extern int get_iaux10 (void);
213 extern int get_iaux11 (void);
214 extern int get_iaux12 (void);
215 extern float get_aux1(void);
216 extern float get_aux2(void);
217 extern float get_aux3(void);
218 extern float get_aux4(void);
219 extern float get_aux5 (void);
220 extern float get_aux6 (void);
221 extern float get_aux8(void);
222 extern float get_aux9(void);
223 extern float get_aux10(void);
224 extern float get_aux11(void);
225 extern float get_aux12(void);
226 extern float get_aux13(void);
227 extern float get_aux14(void);
228 extern float get_aux15(void);
229 extern float get_aux16(void);
230 extern float get_aux17(void);
231 extern float get_aux18(void);
232 // $$$ end - added, VS Renganathan, 13 Oct 2K
234 extern char *get_formated_gmt_time( void );
235 extern void fgHUDReshape(void);
237 enum hudinstype{ HUDno_instr,
249 typedef struct gltagRGBTRIPLE { // rgbt
257 GLfloat x0, y0, x1, y1;
260 fgLineSeg2D( GLfloat a = 0, GLfloat b =0, GLfloat c = 0, GLfloat d =0 )
261 : x0(a), y0(b), x1(c), y1(d) {}
263 fgLineSeg2D( const fgLineSeg2D & image )
264 : x0(image.x0), y0(image.y0), x1(image.x1), y1(image.y1) {}
266 fgLineSeg2D& operator= ( const fgLineSeg2D & image ) {
267 x0 = image.x0; y0 = image.y0; x1 = image.x1; y1 = image.y1; return *this;
279 #define USE_HUD_TextList
280 extern float HUD_TextSize;
281 extern fntRenderer *HUDtext;
282 extern float HUD_matrix[16];
289 fgText( float x = 0, float y = 0, char *c = NULL )
290 : x(x), y(y) {strncpy(msg,c,64-1);}
292 fgText( const fgText & image )
293 : x(image.x), y(image.y) {strcpy(msg,image.msg);}
295 fgText& operator = ( const fgText & image ) {
296 strcpy(msg,image.msg); x = image.x; y = image.y;
300 ~fgText() {msg[0]='\0';}
302 int getStringWidth ( char *str )
304 if ( HUDtext && str )
307 guiFntHandle->getBBox ( str, HUD_TextSize, 0, &l, &r, NULL, NULL ) ;
308 return FloatToInt( r - l );
313 int StringWidth (void )
315 if ( HUDtext && strlen( msg ))
318 guiFntHandle->getBBox ( msg, HUD_TextSize, 0, &l, &r, NULL, NULL ) ;
319 return FloatToInt( r - l );
324 void Draw(fntRenderer *fnt)
326 fnt->start2f( x, y );
332 puDrawString ( guiFnt, msg, FloatToInt(x), FloatToInt(y) );
337 vector < fgLineSeg2D > List;
339 fgLineList( void ) {}
340 ~fgLineList( void ) {}
341 void add( fgLineSeg2D seg ) { List.push_back(seg); }
342 void erase( void ) { List.erase( List.begin(), List.end() ); }
344 vector < fgLineSeg2D > :: iterator curSeg;
345 vector < fgLineSeg2D > :: iterator lastSeg;
346 curSeg = List.begin();
347 lastSeg = List.end();
349 for ( ; curSeg != lastSeg; curSeg++ ) {
354 /* void draw( void ) {
355 vector < fgLineSeg2D > :: iterator curSeg;
356 vector < fgLineSeg2D > :: iterator lastSeg;
357 curSeg = List.begin();
358 lastSeg = List.end();
360 for ( ; curSeg != lastSeg; curSeg++ ) {
369 vector< fgText > List;
371 fgTextList ( void ) { Font = 0; }
372 ~fgTextList( void ) {}
374 void setFont( fntRenderer *Renderer ) { Font = Renderer; }
375 void add( fgText String ) { List.push_back(String); }
376 void erase( void ) { List.erase( List.begin(), List.end() ); }
379 vector < fgText > :: iterator curString;
380 vector < fgText > :: iterator lastString;
381 if( Font == 0 ) return;
382 curString = List.begin();
383 lastString = List.end();
384 glPushAttrib( GL_COLOR_BUFFER_BIT );
385 glEnable ( GL_ALPHA_TEST ) ;
386 glEnable ( GL_BLEND ) ;
387 glAlphaFunc ( GL_GREATER, 0.1 ) ;
388 glBlendFunc ( GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA ) ;
391 for( ; curString != lastString; curString++ ) {
392 curString->Draw(Font);
396 glDisable ( GL_TEXTURE_2D ) ;
402 inline void Text( fgTextList &List, float x, float y, char *s)
404 List.add( fgText( x, y, s) );
407 inline void Text( fgTextList &List, fgText &me)
412 inline void Line( fgLineList &List, float x1, float y1, float x2, float y2)
414 List.add(fgLineSeg2D(x1,y1,x2,y2));
418 // Declare our externals
419 extern fgTextList HUD_TextList;
420 extern fgLineList HUD_LineList;
421 extern fgLineList HUD_StippleLineList;
424 class instr_item { // An Abstract Base Class (ABC)
426 static UINT instances; // More than 64K instruments? Nah!
427 static int brightness;
428 static glRGBTRIPLE color;
431 RECT scrn_pos; // Framing - affects scale dimensions
432 // and orientation. Vert vs Horz, etc.
433 FLTFNPTR load_value_fn;
434 float disp_factor; // Multiply by to get numbers shown on scale.
438 UINT scr_span; // Working values for draw;
446 FLTFNPTR data_source,
449 bool working = true);
451 instr_item( const instr_item & image );
453 instr_item & operator = ( const instr_item & rhs );
454 virtual ~instr_item ();
456 int get_brightness ( void ) { return brightness;}
457 RECT get_location ( void ) { return scrn_pos; }
458 bool is_broken ( void ) { return broken; }
459 bool enabled ( void ) { return is_enabled;}
460 bool data_available ( void ) { return !!load_value_fn; }
461 float get_value ( void ) { return load_value_fn(); }
462 float data_scaling ( void ) { return disp_factor; }
463 UINT get_span ( void ) { return scr_span; }
464 POINT get_centroid ( void ) { return mid_span; }
465 UINT get_options ( void ) { return opts; }
467 UINT huds_vert (UINT options) { return( options & HUDS_VERT ); }
468 UINT huds_left (UINT options) { return( options & HUDS_LEFT ); }
469 UINT huds_right (UINT options) { return( options & HUDS_RIGHT ); }
470 UINT huds_both (UINT options) { return( (options & HUDS_BOTH) == HUDS_BOTH ); }
471 UINT huds_noticks (UINT options) { return( options & HUDS_NOTICKS ); }
472 UINT huds_notext (UINT options) { return( options & HUDS_NOTEXT ); }
473 UINT huds_top (UINT options) { return( options & HUDS_TOP ); }
474 UINT huds_bottom (UINT options) { return( options & HUDS_BOTTOM ); }
476 virtual void display_enable( bool working ) { is_enabled = !! working;}
478 virtual void update( void );
479 virtual void break_display ( bool bad );
480 virtual void SetBrightness( int illumination_level ); // fgHUDSetBright...
481 void SetPosition ( int x, int y, UINT width, UINT height );
482 UINT get_Handle( void );
483 virtual void draw( void ) = 0; // Required method in derived classes
485 void drawOneLine( float x1, float y1, float x2, float y2)
487 HUD_LineList.add(fgLineSeg2D(x1,y1,x2,y2));
489 void drawOneStippleLine( float x1, float y1, float x2, float y2)
491 HUD_StippleLineList.add(fgLineSeg2D(x1,y1,x2,y2));
493 void TextString( char *msg, float x, float y )
495 HUD_TextList.add(fgText(x, y, msg));
497 int getStringWidth ( char *str )
499 if ( HUDtext && str )
502 guiFntHandle->getBBox ( str, HUD_TextSize, 0, &l, &r, NULL, NULL ) ;
503 return FloatToInt( r - l );
510 typedef instr_item *HIptr;
511 //typedef deque < instr_item * > hud_deque_type;
512 //typedef hud_deque_type::iterator hud_deque_iterator;
513 //typedef hud_deque_type::const_iterator hud_deque_const_iterator;
515 extern deque< instr_item *> HUD_deque;
516 extern int HUD_style;
517 //extern hud_deque_type HUD_deque;
519 // instr_item This class has no other purpose than to maintain
520 // a linked list of instrument and derived class
524 class instr_label : public instr_item {
528 const char *post_str;
532 char format_buffer[80];
539 FLTFNPTR data_source,
540 const char *label_format,
541 const char *pre_label_string = 0,
542 const char *post_label_string = 0,
543 float scale_data = 1.0,
544 UINT options = HUDS_TOP,
545 fgLabelJust justification = CENTER_JUST,
546 int font_size = SMALL,
547 int blinking = NOBLINK,
548 bool working = true);
552 instr_label( const instr_label & image);
553 instr_label & operator = (const instr_label & rhs );
554 virtual void draw( void ); // Required method in base class
557 typedef instr_label * pInstlabel;
560 class lat_label : public instr_item {
564 const char *post_str;
568 char format_buffer[80];
575 FLTFNPTR data_source,
576 const char *label_format,
577 const char *pre_label_string = 0,
578 const char *post_label_string = 0,
579 float scale_data = 1.0,
580 UINT options = HUDS_TOP,
581 fgLabelJust justification = CENTER_JUST,
582 int font_size = SMALL,
583 int blinking = NOBLINK,
584 bool working = true);
588 lat_label( const lat_label & image);
589 lat_label & operator = (const lat_label & rhs );
590 virtual void draw( void ); // Required method in base class
593 typedef lat_label * pLatlabel;
595 class lon_label : public instr_item {
599 const char *post_str;
603 char format_buffer[80];
610 FLTFNPTR data_source,
611 const char *label_format,
612 const char *pre_label_string = 0,
613 const char *post_label_string = 0,
614 float scale_data = 1.0,
615 UINT options = HUDS_TOP,
616 fgLabelJust justification = CENTER_JUST,
617 int font_size = SMALL,
618 int blinking = NOBLINK,
619 bool working = true);
623 lon_label( const lon_label & image);
624 lon_label & operator = (const lon_label & rhs );
625 virtual void draw( void ); // Required method in base class
628 typedef lon_label * pLonlabel;
631 // instr_scale This class is an abstract base class for both moving
632 // scale and moving needle (fixed scale) indicators. It
633 // does not draw itself, but is not instanciable.
636 class instr_scale : public instr_item {
638 float range_shown; // Width Units.
639 float Maximum_value; // ceiling.
640 float Minimum_value; // Representation floor.
641 float scale_factor; // factor => screen units/range values.
642 UINT Maj_div; // major division marker units
643 UINT Min_div; // minor division marker units
644 UINT Modulo; // Roll over point
645 int signif_digits; // digits to show to the right.
655 float max_value = 100.0,
656 float min_value = 0.0,
657 float disp_scaling = 1.0,
658 UINT major_divs = 10,
662 bool working = true);
664 virtual ~instr_scale();
665 instr_scale( const instr_scale & image);
666 instr_scale & operator = (const instr_scale & rhs);
668 virtual void draw ( void ) {}; // No-op here. Defined in derived classes.
669 UINT div_min ( void ) { return Min_div;}
670 UINT div_max ( void ) { return Maj_div;}
671 float min_val ( void ) { return Minimum_value;}
672 float max_val ( void ) { return Maximum_value;}
673 UINT modulo ( void ) { return Modulo; }
674 float factor ( void ) { return scale_factor;}
675 float range_to_show( void ) { return range_shown;}
678 // hud_card_ This class displays the indicated quantity on
679 // a scale that moves past the pointer. It may be
680 // horizontal or vertical, read above(left) or below(right) of the base
683 class hud_card : public instr_scale {
686 float half_width_units;
695 float maxValue = 100.0,
696 float minValue = 0.0,
697 float disp_scaling = 1.0,
698 UINT major_divs = 10,
700 UINT modulator = 100,
702 float value_span = 100.0,
703 bool working = true);
706 hud_card( const hud_card & image);
707 hud_card & operator = (const hud_card & rhs );
708 // virtual void display_enable( bool setting );
709 virtual void draw( void ); // Required method in base class
712 typedef hud_card * pCardScale;
714 class guage_instr : public instr_scale {
722 float disp_scaling = 1.0,
723 float maxValue = 100,
725 UINT major_divs = 50,
729 bool working = true);
732 guage_instr( const guage_instr & image);
733 guage_instr & operator = (const guage_instr & rhs );
734 virtual void draw( void ); // Required method in base class
737 typedef guage_instr * pGuageInst;
739 // dual_instr_item This class was created to form the base class
740 // for both panel and HUD Turn Bank Indicators.
742 class dual_instr_item : public instr_item {
744 FLTFNPTR alt_data_source;
747 dual_instr_item ( int x,
751 FLTFNPTR chn1_source,
752 FLTFNPTR chn2_source,
754 UINT options = HUDS_TOP);
756 virtual ~dual_instr_item() {};
757 dual_instr_item( const dual_instr_item & image);
758 dual_instr_item & operator = (const dual_instr_item & rhs );
760 float current_ch1( void ) { return (float)alt_data_source();}
761 float current_ch2( void ) { return (float)get_value();}
762 virtual void draw ( void ) { }
765 class fgTBI_instr : public dual_instr_item {
776 FLTFNPTR chn1_source = get_roll,
777 FLTFNPTR chn2_source = get_sideslip,
778 float maxBankAngle = 45.0,
779 float maxSlipAngle = 5.0,
781 bool working = true);
783 fgTBI_instr( const fgTBI_instr & image);
784 fgTBI_instr & operator = (const fgTBI_instr & rhs );
788 UINT bank_limit( void ) { return BankLimit;}
789 UINT slew_limit( void ) { return SlewLimit;}
791 virtual void draw( void ); // Required method in base class
794 typedef fgTBI_instr * pTBI;
796 class HudLadder : public dual_instr_item {
810 fgLineList StippleLineList;
818 FLTFNPTR ptch_source = get_roll,
819 FLTFNPTR roll_source = get_pitch,
820 float span_units = 45.0,
821 float division_units = 10.0,
822 float minor_division = 0.0,
823 UINT screen_hole = 70,
825 bool working = true );
829 HudLadder( const HudLadder & image );
830 HudLadder & operator = ( const HudLadder & rhs );
831 virtual void draw( void );
833 void Text( float x, float y, char *s)
835 TextList.add( fgText( x, y, s) );
838 void Line( float x1, float y1, float x2, float y2)
840 LineList.add(fgLineSeg2D(x1,y1,x2,y2));
843 void StippleLine( float x1, float y1, float x2, float y2)
845 StippleLineList.add(fgLineSeg2D(x1,y1,x2,y2));
850 //using namespace std;
851 //deque <instr_item> * Hdeque_ptr;
853 extern void HUD_masterswitch( bool incr );
854 extern void HUD_brightkey( bool incr_bright );
855 extern int fgHUDInit( fgAIRCRAFT * /* current_aircraft */ );
856 extern int fgHUDInit2( fgAIRCRAFT * /* current_aircraft */ );
857 extern void fgUpdateHUD( void );
859 extern void drawOneLine ( UINT x1, UINT y1, UINT x2, UINT y2);
860 extern void drawOneLine ( RECT &rect);
861 extern void textString ( int x,
864 void *font = GLUT_BITMAP_8_BY_13);
865 extern void strokeString( int x,
868 void *font = GLUT_STROKE_ROMAN,
870 //extern void strokeString(float xx,
873 // void *font = GLUT_STROKE_ROMAN)
876 bool AddHUDInstrument( instr_item *pBlackBox );
877 void DrawHUD ( void );
878 bool DamageInstrument( INSTR_HANDLE unit );
879 bool RepairInstrument( INSTR_HANDLE unit );
882 void fgUpdateHUD ( Hptr hud );
883 void fgUpdateHUD2( Hptr hud ); // Future use?
884 void fgHUDSetTimeMode( Hptr hud, int time_of_day );