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 extern char *get_formated_gmt_time( void );
195 extern void fgHUDReshape(void);
197 enum hudinstype{ HUDno_instr,
209 typedef struct gltagRGBTRIPLE { // rgbt
217 GLfloat x0, y0, x1, y1;
220 fgLineSeg2D( GLfloat a = 0, GLfloat b =0, GLfloat c = 0, GLfloat d =0 )
221 : x0(a), y0(b), x1(c), y1(d) {}
223 fgLineSeg2D( const fgLineSeg2D & image )
224 : x0(image.x0), y0(image.y0), x1(image.x1), y1(image.y1) {}
226 fgLineSeg2D& operator= ( const fgLineSeg2D & image ) {
227 x0 = image.x0; y0 = image.y0; x1 = image.x1; y1 = image.y1; return *this;
239 #define USE_HUD_TextList
240 extern float HUD_TextSize;
241 extern fntRenderer *HUDtext;
242 extern float HUD_matrix[16];
249 fgText( float x = 0, float y = 0, char *c = NULL )
250 : x(x), y(y) {strncpy(msg,c,64-1);}
252 fgText( const fgText & image )
253 : x(image.x), y(image.y) {strcpy(msg,image.msg);}
255 fgText& operator = ( const fgText & image ) {
256 strcpy(msg,image.msg); x = image.x; y = image.y;
260 ~fgText() {msg[0]='\0';}
262 int getStringWidth ( char *str )
264 if ( HUDtext && str )
267 guiFntHandle->getBBox ( str, HUD_TextSize, 0, &l, &r, NULL, NULL ) ;
268 return FloatToInt( r - l );
273 int StringWidth (void )
275 if ( HUDtext && strlen( msg ))
278 guiFntHandle->getBBox ( msg, HUD_TextSize, 0, &l, &r, NULL, NULL ) ;
279 return FloatToInt( r - l );
284 void Draw(fntRenderer *fnt)
286 fnt->start2f( x, y );
292 puDrawString ( guiFnt, msg, FloatToInt(x), FloatToInt(y) );
297 vector < fgLineSeg2D > List;
299 fgLineList( void ) {}
300 ~fgLineList( void ) {}
301 void add( fgLineSeg2D seg ) { List.push_back(seg); }
302 void erase( void ) { List.erase( List.begin(), List.end() ); }
304 vector < fgLineSeg2D > :: iterator curSeg;
305 vector < fgLineSeg2D > :: iterator lastSeg;
306 curSeg = List.begin();
307 lastSeg = List.end();
309 for ( ; curSeg != lastSeg; curSeg++ ) {
314 /* void draw( void ) {
315 vector < fgLineSeg2D > :: iterator curSeg;
316 vector < fgLineSeg2D > :: iterator lastSeg;
317 curSeg = List.begin();
318 lastSeg = List.end();
320 for ( ; curSeg != lastSeg; curSeg++ ) {
329 vector< fgText > List;
331 fgTextList ( void ) { Font = 0; }
332 ~fgTextList( void ) {}
334 void setFont( fntRenderer *Renderer ) { Font = Renderer; }
335 void add( fgText String ) { List.push_back(String); }
336 void erase( void ) { List.erase( List.begin(), List.end() ); }
339 vector < fgText > :: iterator curString;
340 vector < fgText > :: iterator lastString;
341 if( Font == 0 ) return;
342 curString = List.begin();
343 lastString = List.end();
344 glPushAttrib( GL_COLOR_BUFFER_BIT );
345 glEnable ( GL_ALPHA_TEST ) ;
346 glEnable ( GL_BLEND ) ;
347 glAlphaFunc ( GL_GREATER, 0.1 ) ;
348 glBlendFunc ( GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA ) ;
351 for( ; curString != lastString; curString++ ) {
352 curString->Draw(Font);
356 glDisable ( GL_TEXTURE_2D ) ;
362 inline void Text( fgTextList &List, float x, float y, char *s)
364 List.add( fgText( x, y, s) );
367 inline void Text( fgTextList &List, fgText &me)
372 inline void Line( fgLineList &List, float x1, float y1, float x2, float y2)
374 List.add(fgLineSeg2D(x1,y1,x2,y2));
378 // Declare our externals
379 extern fgTextList HUD_TextList;
380 extern fgLineList HUD_LineList;
381 extern fgLineList HUD_StippleLineList;
384 class instr_item { // An Abstract Base Class (ABC)
386 static UINT instances; // More than 64K instruments? Nah!
387 static int brightness;
388 static glRGBTRIPLE color;
391 RECT scrn_pos; // Framing - affects scale dimensions
392 // and orientation. Vert vs Horz, etc.
393 FLTFNPTR load_value_fn;
394 float disp_factor; // Multiply by to get numbers shown on scale.
398 UINT scr_span; // Working values for draw;
406 FLTFNPTR data_source,
409 bool working = true);
411 instr_item( const instr_item & image );
413 instr_item & operator = ( const instr_item & rhs );
414 virtual ~instr_item ();
416 int get_brightness ( void ) { return brightness;}
417 RECT get_location ( void ) { return scrn_pos; }
418 bool is_broken ( void ) { return broken; }
419 bool enabled ( void ) { return is_enabled;}
420 bool data_available ( void ) { return !!load_value_fn; }
421 float get_value ( void ) { return load_value_fn(); }
422 float data_scaling ( void ) { return disp_factor; }
423 UINT get_span ( void ) { return scr_span; }
424 POINT get_centroid ( void ) { return mid_span; }
425 UINT get_options ( void ) { return opts; }
427 UINT huds_vert (UINT options) { return( options & HUDS_VERT ); }
428 UINT huds_left (UINT options) { return( options & HUDS_LEFT ); }
429 UINT huds_right (UINT options) { return( options & HUDS_RIGHT ); }
430 UINT huds_both (UINT options) { return( (options & HUDS_BOTH) == HUDS_BOTH ); }
431 UINT huds_noticks (UINT options) { return( options & HUDS_NOTICKS ); }
432 UINT huds_notext (UINT options) { return( options & HUDS_NOTEXT ); }
433 UINT huds_top (UINT options) { return( options & HUDS_TOP ); }
434 UINT huds_bottom (UINT options) { return( options & HUDS_BOTTOM ); }
436 virtual void display_enable( bool working ) { is_enabled = !! working;}
438 virtual void update( void );
439 virtual void break_display ( bool bad );
440 virtual void SetBrightness( int illumination_level ); // fgHUDSetBright...
441 void SetPosition ( int x, int y, UINT width, UINT height );
442 UINT get_Handle( void );
443 virtual void draw( void ) = 0; // Required method in derived classes
445 void drawOneLine( float x1, float y1, float x2, float y2)
447 HUD_LineList.add(fgLineSeg2D(x1,y1,x2,y2));
449 void drawOneStippleLine( float x1, float y1, float x2, float y2)
451 HUD_StippleLineList.add(fgLineSeg2D(x1,y1,x2,y2));
453 void TextString( char *msg, float x, float y )
455 HUD_TextList.add(fgText(x, y, msg));
457 int getStringWidth ( char *str )
459 if ( HUDtext && str )
462 guiFntHandle->getBBox ( str, HUD_TextSize, 0, &l, &r, NULL, NULL ) ;
463 return FloatToInt( r - l );
470 typedef instr_item *HIptr;
471 //typedef deque < instr_item * > hud_deque_type;
472 //typedef hud_deque_type::iterator hud_deque_iterator;
473 //typedef hud_deque_type::const_iterator hud_deque_const_iterator;
475 extern deque< instr_item *> HUD_deque;
476 extern int HUD_style;
477 //extern hud_deque_type HUD_deque;
479 // instr_item This class has no other purpose than to maintain
480 // a linked list of instrument and derived class
484 class instr_label : public instr_item {
488 const char *post_str;
492 char format_buffer[80];
499 FLTFNPTR data_source,
500 const char *label_format,
501 const char *pre_label_string = 0,
502 const char *post_label_string = 0,
503 float scale_data = 1.0,
504 UINT options = HUDS_TOP,
505 fgLabelJust justification = CENTER_JUST,
506 int font_size = SMALL,
507 int blinking = NOBLINK,
508 bool working = true);
512 instr_label( const instr_label & image);
513 instr_label & operator = (const instr_label & rhs );
514 virtual void draw( void ); // Required method in base class
517 typedef instr_label * pInstlabel;
520 class lat_label : public instr_item {
524 const char *post_str;
528 char format_buffer[80];
535 FLTFNPTR data_source,
536 const char *label_format,
537 const char *pre_label_string = 0,
538 const char *post_label_string = 0,
539 float scale_data = 1.0,
540 UINT options = HUDS_TOP,
541 fgLabelJust justification = CENTER_JUST,
542 int font_size = SMALL,
543 int blinking = NOBLINK,
544 bool working = true);
548 lat_label( const lat_label & image);
549 lat_label & operator = (const lat_label & rhs );
550 virtual void draw( void ); // Required method in base class
553 typedef lat_label * pLatlabel;
555 class lon_label : public instr_item {
559 const char *post_str;
563 char format_buffer[80];
570 FLTFNPTR data_source,
571 const char *label_format,
572 const char *pre_label_string = 0,
573 const char *post_label_string = 0,
574 float scale_data = 1.0,
575 UINT options = HUDS_TOP,
576 fgLabelJust justification = CENTER_JUST,
577 int font_size = SMALL,
578 int blinking = NOBLINK,
579 bool working = true);
583 lon_label( const lon_label & image);
584 lon_label & operator = (const lon_label & rhs );
585 virtual void draw( void ); // Required method in base class
588 typedef lon_label * pLonlabel;
591 // instr_scale This class is an abstract base class for both moving
592 // scale and moving needle (fixed scale) indicators. It
593 // does not draw itself, but is not instanciable.
596 class instr_scale : public instr_item {
598 float range_shown; // Width Units.
599 float Maximum_value; // ceiling.
600 float Minimum_value; // Representation floor.
601 float scale_factor; // factor => screen units/range values.
602 UINT Maj_div; // major division marker units
603 UINT Min_div; // minor division marker units
604 UINT Modulo; // Roll over point
605 int signif_digits; // digits to show to the right.
615 float max_value = 100.0,
616 float min_value = 0.0,
617 float disp_scaling = 1.0,
618 UINT major_divs = 10,
622 bool working = true);
624 virtual ~instr_scale();
625 instr_scale( const instr_scale & image);
626 instr_scale & operator = (const instr_scale & rhs);
628 virtual void draw ( void ) {}; // No-op here. Defined in derived classes.
629 UINT div_min ( void ) { return Min_div;}
630 UINT div_max ( void ) { return Maj_div;}
631 float min_val ( void ) { return Minimum_value;}
632 float max_val ( void ) { return Maximum_value;}
633 UINT modulo ( void ) { return Modulo; }
634 float factor ( void ) { return scale_factor;}
635 float range_to_show( void ) { return range_shown;}
638 // hud_card_ This class displays the indicated quantity on
639 // a scale that moves past the pointer. It may be
640 // horizontal or vertical, read above(left) or below(right) of the base
643 class hud_card : public instr_scale {
646 float half_width_units;
655 float maxValue = 100.0,
656 float minValue = 0.0,
657 float disp_scaling = 1.0,
658 UINT major_divs = 10,
660 UINT modulator = 100,
662 float value_span = 100.0,
663 bool working = true);
666 hud_card( const hud_card & image);
667 hud_card & operator = (const hud_card & rhs );
668 // virtual void display_enable( bool setting );
669 virtual void draw( void ); // Required method in base class
672 typedef hud_card * pCardScale;
674 class guage_instr : public instr_scale {
682 float disp_scaling = 1.0,
683 float maxValue = 100,
685 UINT major_divs = 50,
689 bool working = true);
692 guage_instr( const guage_instr & image);
693 guage_instr & operator = (const guage_instr & rhs );
694 virtual void draw( void ); // Required method in base class
697 typedef guage_instr * pGuageInst;
699 // dual_instr_item This class was created to form the base class
700 // for both panel and HUD Turn Bank Indicators.
702 class dual_instr_item : public instr_item {
704 FLTFNPTR alt_data_source;
707 dual_instr_item ( int x,
711 FLTFNPTR chn1_source,
712 FLTFNPTR chn2_source,
714 UINT options = HUDS_TOP);
716 virtual ~dual_instr_item() {};
717 dual_instr_item( const dual_instr_item & image);
718 dual_instr_item & operator = (const dual_instr_item & rhs );
720 float current_ch1( void ) { return (float)alt_data_source();}
721 float current_ch2( void ) { return (float)get_value();}
722 virtual void draw ( void ) { }
725 class fgTBI_instr : public dual_instr_item {
736 FLTFNPTR chn1_source = get_roll,
737 FLTFNPTR chn2_source = get_sideslip,
738 float maxBankAngle = 45.0,
739 float maxSlipAngle = 5.0,
741 bool working = true);
743 fgTBI_instr( const fgTBI_instr & image);
744 fgTBI_instr & operator = (const fgTBI_instr & rhs );
748 UINT bank_limit( void ) { return BankLimit;}
749 UINT slew_limit( void ) { return SlewLimit;}
751 virtual void draw( void ); // Required method in base class
754 typedef fgTBI_instr * pTBI;
756 class HudLadder : public dual_instr_item {
770 fgLineList StippleLineList;
778 FLTFNPTR ptch_source = get_roll,
779 FLTFNPTR roll_source = get_pitch,
780 float span_units = 45.0,
781 float division_units = 10.0,
782 float minor_division = 0.0,
783 UINT screen_hole = 70,
785 bool working = true );
789 HudLadder( const HudLadder & image );
790 HudLadder & operator = ( const HudLadder & rhs );
791 virtual void draw( void );
793 void Text( float x, float y, char *s)
795 TextList.add( fgText( x, y, s) );
798 void Line( float x1, float y1, float x2, float y2)
800 LineList.add(fgLineSeg2D(x1,y1,x2,y2));
803 void StippleLine( float x1, float y1, float x2, float y2)
805 StippleLineList.add(fgLineSeg2D(x1,y1,x2,y2));
810 //using namespace std;
811 //deque <instr_item> * Hdeque_ptr;
813 extern void HUD_masterswitch( bool incr );
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 );