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++
44 # include <values.h> // for MAXINT
47 #include <vector> // STL vector
48 #include <deque> // STL double ended queue
50 #include <simgear/constants.h>
52 #include <fg_typedefs.h>
53 #include <Aircraft/aircraft.hxx>
54 #include <FDM/flight.hxx>
55 #include <Controls/controls.hxx>
58 #include "hud_opts.hxx"
62 FG_USING_NAMESPACE(std);
65 // some of Norman's crazy optimizations. :-)
73 int top, bottom, left, right;
77 // View mode definitions
79 enum VIEW_MODES{ HUD_VIEW, PANEL_VIEW, CHASE_VIEW, TOWER_VIEW };
81 // DAY, NIGHT and brightness levels need to be visible where dialogs and
82 // controls can be used to set intensity and appropriate color. This will
84 // Hud general constants
101 enum fgLabelJust{ LEFT_JUST, CENTER_JUST, RIGHT_JUST } ;
106 #define UPPER_CENTER 3
107 #define UPPER_RIGHT 4
108 #define CENTER_RIGHT 5
109 #define LOWER_RIGHT 6
110 #define LOWER_CENTER 7
112 #define CENTER_LEFT 9
113 #define SOLID_LINES 10
114 #define DASHED_LINES 11
115 #define DASHED_NEG_LINES 12
118 #define HORIZON_FIXED 1
119 #define HORIZON_MOVING 2
120 #define LABEL_COUNTER 1
121 #define LABEL_WARNING 2
123 #define HUDS_AUTOTICKS 0x0001
124 #define HUDS_VERT 0x0002
125 #define HUDS_HORZ 0x0000
126 #define HUDS_TOP 0x0004
127 #define HUDS_BOTTOM 0x0008
128 #define HUDS_LEFT HUDS_TOP
129 #define HUDS_RIGHT HUDS_BOTTOM
130 #define HUDS_BOTH (HUDS_LEFT | HUDS_RIGHT)
131 #define HUDS_NOTICKS 0x0010
132 #define HUDS_ARITHTIC 0x0020
133 #define HUDS_DECITICS 0x0040
134 #define HUDS_NOTEXT 0x0080
137 // #define HUD_VERTICAL 1
138 // #define HUD_HORIZONTAL 2
139 // #define HUD_FREEFLOAT 3
141 // Ladder orientation modes
142 // #define HUD_LEFT 1
143 // #define HUD_RIGHT 2
145 // #define HUD_BOTTOM 2
146 // #define HUD_V_LEFT 1
147 // #define HUD_V_RIGHT 2
148 // #define HUD_H_TOP 1
149 // #define HUD_H_BOTTOM 2
154 // #define HUD_NOLIM 2
155 // #define HUD_CIRC 3
157 // #define HUD_INSTR_LADDER 1
158 // #define HUD_INSTR_CLADDER 2
159 // #define HUD_INSTR_HORIZON 3
160 // #define HUD_INSTR_LABEL 4
163 extern float get_throttleval ( void );
164 extern float get_aileronval ( void );
165 extern float get_elevatorval ( void );
166 extern float get_elev_trimval( void );
167 extern float get_rudderval ( void );
168 extern float get_speed ( void );
169 extern float get_aoa ( void );
170 extern float get_roll ( void );
171 extern float get_pitch ( void );
172 extern float get_heading ( void );
173 extern float get_view_direction( void );
174 extern float get_altitude ( void );
175 extern float get_agl ( void );
176 extern float get_sideslip ( void );
177 extern float get_frame_rate ( void );
178 extern float get_latitude ( void );
179 extern float get_lat_min ( void );
180 extern float get_longitude ( void );
181 extern float get_long_min ( void );
182 extern float get_fov ( void );
183 extern float get_vfc_ratio ( void );
184 extern float get_vfc_tris_drawn ( void );
185 extern float get_vfc_tris_culled ( void );
186 extern float get_climb_rate ( void );
187 extern float get_mach( void );
188 extern char *coord_format_lat(float);
189 extern char *coord_format_lon(float);
190 //extern char *coord_format_latlon(float latitude, float longitude); // cockpit.cxx
192 extern char *get_formated_gmt_time( void );
194 enum hudinstype{ HUDno_instr,
206 typedef struct gltagRGBTRIPLE { // rgbt
214 GLfloat x0, y0, x1, y1;
217 fgLineSeg2D( GLfloat a = 0, GLfloat b =0, GLfloat c = 0, GLfloat d =0 )
218 : x0(a), y0(b), x1(c), y1(d) {}
220 fgLineSeg2D( const fgLineSeg2D & image )
221 : x0(image.x0), y0(image.y0), x1(image.x1), y1(image.y1) {}
223 fgLineSeg2D& operator= ( const fgLineSeg2D & image ) {
224 x0 = image.x0; y0 = image.y0; x1 = image.x1; y1 = image.y1; return *this;
236 #define USE_HUD_TextList
237 extern float HUD_TextSize;
238 extern fntRenderer *HUDtext;
239 extern float HUD_matrix[16];
246 fgText( float x = 0, float y = 0, char *c = NULL )
247 : x(x), y(y) {strncpy(msg,c,64-1);}
249 fgText( const fgText & image )
250 : x(image.x), y(image.y) {strcpy(msg,image.msg);}
252 fgText& operator = ( const fgText & image ) {
253 strcpy(msg,image.msg); x = image.x; y = image.y;
257 ~fgText() {msg[0]='\0';}
259 int getStringWidth ( char *str )
261 if ( HUDtext && str )
264 guiFntHandle->getBBox ( str, HUD_TextSize, 0, &l, &r, NULL, NULL ) ;
265 return FloatToInt( r - l );
270 int StringWidth (void )
272 if ( HUDtext && strlen( msg ))
275 guiFntHandle->getBBox ( msg, HUD_TextSize, 0, &l, &r, NULL, NULL ) ;
276 return FloatToInt( r - l );
281 void Draw(fntRenderer *fnt)
283 fnt->start2f( x, y );
289 puDrawString ( guiFnt, msg, FloatToInt(x), FloatToInt(y) );
294 vector < fgLineSeg2D > List;
296 fgLineList( void ) {}
297 ~fgLineList( void ) {}
298 void add( fgLineSeg2D seg ) { List.push_back(seg); }
299 void erase( void ) { List.erase( List.begin(), List.end() ); }
301 vector < fgLineSeg2D > :: iterator curSeg;
302 vector < fgLineSeg2D > :: iterator lastSeg;
303 curSeg = List.begin();
304 lastSeg = List.end();
306 for ( ; curSeg != lastSeg; curSeg++ ) {
314 vector < fgLineSeg2D > :: iterator curSeg;
315 vector < fgLineSeg2D > :: iterator lastSeg;
316 curSeg = List.begin();
317 lastSeg = List.end();
319 for ( ; curSeg != lastSeg; curSeg++ ) {
330 vector< fgText > List;
332 fgTextList ( void ) { Font = 0; }
333 ~fgTextList( void ) {}
335 void setFont( fntRenderer *Renderer ) { Font = Renderer; }
336 void add( fgText String ) { List.push_back(String); }
337 void erase( void ) { List.erase( List.begin(), List.end() ); }
340 vector < fgText > :: iterator curString;
341 vector < fgText > :: iterator lastString;
342 if( Font == 0 ) return;
343 curString = List.begin();
344 lastString = List.end();
345 glPushAttrib( GL_COLOR_BUFFER_BIT );
346 glEnable ( GL_ALPHA_TEST ) ;
347 glEnable ( GL_BLEND ) ;
348 glAlphaFunc ( GL_GREATER, 0.1 ) ;
349 glBlendFunc ( GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA ) ;
352 for( ; curString != lastString; curString++ ) {
353 curString->Draw(Font);
357 glDisable ( GL_TEXTURE_2D ) ;
363 inline void Text( fgTextList &List, float x, float y, char *s)
365 List.add( fgText( x, y, s) );
368 inline void Text( fgTextList &List, fgText &me)
373 inline void Line( fgLineList &List, float x1, float y1, float x2, float y2)
375 List.add(fgLineSeg2D(x1,y1,x2,y2));
379 // Declare our externals
380 extern fgTextList HUD_TextList;
381 extern fgLineList HUD_LineList;
382 extern fgLineList HUD_StippleLineList;
385 class instr_item { // An Abstract Base Class (ABC)
387 static UINT instances; // More than 64K instruments? Nah!
388 static int brightness;
389 static glRGBTRIPLE color;
392 RECT scrn_pos; // Framing - affects scale dimensions
393 // and orientation. Vert vs Horz, etc.
394 FLTFNPTR load_value_fn;
395 float disp_factor; // Multiply by to get numbers shown on scale.
399 UINT scr_span; // Working values for draw;
407 FLTFNPTR data_source,
410 bool working = true);
412 instr_item( const instr_item & image );
414 instr_item & operator = ( const instr_item & rhs );
415 virtual ~instr_item ();
417 int get_brightness ( void ) { return brightness;}
418 RECT get_location ( void ) { return scrn_pos; }
419 bool is_broken ( void ) { return broken; }
420 bool enabled ( void ) { return is_enabled;}
421 bool data_available ( void ) { return !!load_value_fn; }
422 float get_value ( void ) { return load_value_fn(); }
423 float data_scaling ( void ) { return disp_factor; }
424 UINT get_span ( void ) { return scr_span; }
425 POINT get_centroid ( void ) { return mid_span; }
426 UINT get_options ( void ) { return opts; }
428 UINT huds_vert (UINT options) { return( options & HUDS_VERT ); }
429 UINT huds_left (UINT options) { return( options & HUDS_LEFT ); }
430 UINT huds_right (UINT options) { return( options & HUDS_RIGHT ); }
431 UINT huds_both (UINT options) { return( (options & HUDS_BOTH) == HUDS_BOTH ); }
432 UINT huds_noticks (UINT options) { return( options & HUDS_NOTICKS ); }
433 UINT huds_notext (UINT options) { return( options & HUDS_NOTEXT ); }
434 UINT huds_top (UINT options) { return( options & HUDS_TOP ); }
435 UINT huds_bottom (UINT options) { return( options & HUDS_BOTTOM ); }
437 virtual void display_enable( bool working ) { is_enabled = !! working;}
439 virtual void update( void );
440 virtual void break_display ( bool bad );
441 virtual void SetBrightness( int illumination_level ); // fgHUDSetBright...
442 void SetPosition ( int x, int y, UINT width, UINT height );
443 UINT get_Handle( void );
444 virtual void draw( void ) = 0; // Required method in derived classes
446 void drawOneLine( float x1, float y1, float x2, float y2)
448 HUD_LineList.add(fgLineSeg2D(x1,y1,x2,y2));
450 void drawOneStippleLine( float x1, float y1, float x2, float y2)
452 HUD_StippleLineList.add(fgLineSeg2D(x1,y1,x2,y2));
454 void TextString( char *msg, float x, float y )
456 HUD_TextList.add(fgText(x, y, msg));
458 int getStringWidth ( char *str )
460 if ( HUDtext && str )
463 guiFntHandle->getBBox ( str, HUD_TextSize, 0, &l, &r, NULL, NULL ) ;
464 return FloatToInt( r - l );
471 typedef instr_item *HIptr;
472 //typedef deque < instr_item * > hud_deque_type;
473 //typedef hud_deque_type::iterator hud_deque_iterator;
474 //typedef hud_deque_type::const_iterator hud_deque_const_iterator;
476 extern deque< instr_item *> HUD_deque;
477 extern int HUD_style;
478 //extern hud_deque_type HUD_deque;
480 // instr_item This class has no other purpose than to maintain
481 // a linked list of instrument and derived class
485 class instr_label : public instr_item {
489 const char *post_str;
493 char format_buffer[80];
500 FLTFNPTR data_source,
501 const char *label_format,
502 const char *pre_label_string = 0,
503 const char *post_label_string = 0,
504 float scale_data = 1.0,
505 UINT options = HUDS_TOP,
506 fgLabelJust justification = CENTER_JUST,
507 int font_size = SMALL,
508 int blinking = NOBLINK,
509 bool working = true);
513 instr_label( const instr_label & image);
514 instr_label & operator = (const instr_label & rhs );
515 virtual void draw( void ); // Required method in base class
518 typedef instr_label * pInstlabel;
521 class lat_label : public instr_item {
525 const char *post_str;
529 char format_buffer[80];
536 FLTFNPTR data_source,
537 const char *label_format,
538 const char *pre_label_string = 0,
539 const char *post_label_string = 0,
540 float scale_data = 1.0,
541 UINT options = HUDS_TOP,
542 fgLabelJust justification = CENTER_JUST,
543 int font_size = SMALL,
544 int blinking = NOBLINK,
545 bool working = true);
549 lat_label( const lat_label & image);
550 lat_label & operator = (const lat_label & rhs );
551 virtual void draw( void ); // Required method in base class
554 typedef lat_label * pLatlabel;
556 class lon_label : public instr_item {
560 const char *post_str;
564 char format_buffer[80];
571 FLTFNPTR data_source,
572 const char *label_format,
573 const char *pre_label_string = 0,
574 const char *post_label_string = 0,
575 float scale_data = 1.0,
576 UINT options = HUDS_TOP,
577 fgLabelJust justification = CENTER_JUST,
578 int font_size = SMALL,
579 int blinking = NOBLINK,
580 bool working = true);
584 lon_label( const lon_label & image);
585 lon_label & operator = (const lon_label & rhs );
586 virtual void draw( void ); // Required method in base class
589 typedef lon_label * pLonlabel;
592 // instr_scale This class is an abstract base class for both moving
593 // scale and moving needle (fixed scale) indicators. It
594 // does not draw itself, but is not instanciable.
597 class instr_scale : public instr_item {
599 float range_shown; // Width Units.
600 float Maximum_value; // ceiling.
601 float Minimum_value; // Representation floor.
602 float scale_factor; // factor => screen units/range values.
603 UINT Maj_div; // major division marker units
604 UINT Min_div; // minor division marker units
605 UINT Modulo; // Roll over point
606 int signif_digits; // digits to show to the right.
616 float max_value = 100.0,
617 float min_value = 0.0,
618 float disp_scaling = 1.0,
619 UINT major_divs = 10,
623 bool working = true);
625 virtual ~instr_scale();
626 instr_scale( const instr_scale & image);
627 instr_scale & operator = (const instr_scale & rhs);
629 virtual void draw ( void ) {}; // No-op here. Defined in derived classes.
630 UINT div_min ( void ) { return Min_div;}
631 UINT div_max ( void ) { return Maj_div;}
632 float min_val ( void ) { return Minimum_value;}
633 float max_val ( void ) { return Maximum_value;}
634 UINT modulo ( void ) { return Modulo; }
635 float factor ( void ) { return scale_factor;}
636 float range_to_show( void ) { return range_shown;}
639 // hud_card_ This class displays the indicated quantity on
640 // a scale that moves past the pointer. It may be
641 // horizontal or vertical, read above(left) or below(right) of the base
644 class hud_card : public instr_scale {
647 float half_width_units;
656 float maxValue = 100.0,
657 float minValue = 0.0,
658 float disp_scaling = 1.0,
659 UINT major_divs = 10,
661 UINT modulator = 100,
663 float value_span = 100.0,
664 bool working = true);
667 hud_card( const hud_card & image);
668 hud_card & operator = (const hud_card & rhs );
669 // virtual void display_enable( bool setting );
670 virtual void draw( void ); // Required method in base class
673 typedef hud_card * pCardScale;
675 class guage_instr : public instr_scale {
683 float disp_scaling = 1.0,
684 float maxValue = 100,
686 UINT major_divs = 50,
690 bool working = true);
693 guage_instr( const guage_instr & image);
694 guage_instr & operator = (const guage_instr & rhs );
695 virtual void draw( void ); // Required method in base class
698 typedef guage_instr * pGuageInst;
700 // dual_instr_item This class was created to form the base class
701 // for both panel and HUD Turn Bank Indicators.
703 class dual_instr_item : public instr_item {
705 FLTFNPTR alt_data_source;
708 dual_instr_item ( int x,
712 FLTFNPTR chn1_source,
713 FLTFNPTR chn2_source,
715 UINT options = HUDS_TOP);
717 virtual ~dual_instr_item() {};
718 dual_instr_item( const dual_instr_item & image);
719 dual_instr_item & operator = (const dual_instr_item & rhs );
721 float current_ch1( void ) { return (float)alt_data_source();}
722 float current_ch2( void ) { return (float)get_value();}
723 virtual void draw ( void ) { }
726 class fgTBI_instr : public dual_instr_item {
737 FLTFNPTR chn1_source = get_roll,
738 FLTFNPTR chn2_source = get_sideslip,
739 float maxBankAngle = 45.0,
740 float maxSlipAngle = 5.0,
742 bool working = true);
744 fgTBI_instr( const fgTBI_instr & image);
745 fgTBI_instr & operator = (const fgTBI_instr & rhs );
749 UINT bank_limit( void ) { return BankLimit;}
750 UINT slew_limit( void ) { return SlewLimit;}
752 virtual void draw( void ); // Required method in base class
755 typedef fgTBI_instr * pTBI;
757 class HudLadder : public dual_instr_item {
771 fgLineList StippleLineList;
779 FLTFNPTR ptch_source = get_roll,
780 FLTFNPTR roll_source = get_pitch,
781 float span_units = 45.0,
782 float division_units = 10.0,
783 float minor_division = 0.0,
784 UINT screen_hole = 70,
786 bool working = true );
790 HudLadder( const HudLadder & image );
791 HudLadder & operator = ( const HudLadder & rhs );
792 virtual void draw( void );
794 void Text( float x, float y, char *s)
796 TextList.add( fgText( x, y, s) );
799 void Line( float x1, float y1, float x2, float y2)
801 LineList.add(fgLineSeg2D(x1,y1,x2,y2));
804 void StippleLine( float x1, float y1, float x2, float y2)
806 StippleLineList.add(fgLineSeg2D(x1,y1,x2,y2));
811 //using namespace std;
812 //deque <instr_item> * Hdeque_ptr;
814 extern void HUD_brightkey( bool incr_bright );
815 extern int fgHUDInit( fgAIRCRAFT * /* current_aircraft */ );
816 extern int fgHUDInit2( fgAIRCRAFT * /* current_aircraft */ );
817 extern void fgUpdateHUD( void );
819 extern void drawOneLine ( UINT x1, UINT y1, UINT x2, UINT y2);
820 extern void drawOneLine ( RECT &rect);
821 extern void textString ( int x,
824 void *font = GLUT_BITMAP_8_BY_13);
825 extern void strokeString( int x,
828 void *font = GLUT_STROKE_ROMAN,
830 //extern void strokeString(float xx,
833 // void *font = GLUT_STROKE_ROMAN)
836 bool AddHUDInstrument( instr_item *pBlackBox );
837 void DrawHUD ( void );
838 bool DamageInstrument( INSTR_HANDLE unit );
839 bool RepairInstrument( INSTR_HANDLE unit );
842 void fgUpdateHUD ( Hptr hud );
843 void fgUpdateHUD2( Hptr hud ); // Future use?
844 void fgHUDSetTimeMode( Hptr hud, int time_of_day );