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
53 #include <simgear/constants.h>
55 #include <Include/fg_typedefs.h>
56 #include <Aircraft/aircraft.hxx>
57 #include <FDM/flight.hxx>
58 #include <Controls/controls.hxx>
60 #include <Main/globals.hxx>
61 #include <Main/viewmgr.hxx>
63 #include "hud_opts.hxx"
67 SG_USING_NAMESPACE(std);
70 // some of Norman's crazy optimizations. :-)
78 int top, bottom, left, right;
82 // View mode definitions
84 enum VIEW_MODES{ HUD_VIEW, PANEL_VIEW, CHASE_VIEW, TOWER_VIEW };
86 // DAY, NIGHT and brightness levels need to be visible where dialogs and
87 // controls can be used to set intensity and appropriate color. This will
89 // Hud general constants
106 enum fgLabelJust{ LEFT_JUST, CENTER_JUST, RIGHT_JUST } ;
111 #define UPPER_CENTER 3
112 #define UPPER_RIGHT 4
113 #define CENTER_RIGHT 5
114 #define LOWER_RIGHT 6
115 #define LOWER_CENTER 7
117 #define CENTER_LEFT 9
118 #define SOLID_LINES 10
119 #define DASHED_LINES 11
120 #define DASHED_NEG_LINES 12
123 #define HORIZON_FIXED 1
124 #define HORIZON_MOVING 2
125 #define LABEL_COUNTER 1
126 #define LABEL_WARNING 2
128 #define HUDS_AUTOTICKS 0x0001
129 #define HUDS_VERT 0x0002
130 #define HUDS_HORZ 0x0000
131 #define HUDS_TOP 0x0004
132 #define HUDS_BOTTOM 0x0008
133 #define HUDS_LEFT HUDS_TOP
134 #define HUDS_RIGHT HUDS_BOTTOM
135 #define HUDS_BOTH (HUDS_LEFT | HUDS_RIGHT)
136 #define HUDS_NOTICKS 0x0010
137 #define HUDS_ARITHTIC 0x0020
138 #define HUDS_DECITICS 0x0040
139 #define HUDS_NOTEXT 0x0080
142 // #define HUD_VERTICAL 1
143 // #define HUD_HORIZONTAL 2
144 // #define HUD_FREEFLOAT 3
146 // Ladder orientation modes
147 // #define HUD_LEFT 1
148 // #define HUD_RIGHT 2
150 // #define HUD_BOTTOM 2
151 // #define HUD_V_LEFT 1
152 // #define HUD_V_RIGHT 2
153 // #define HUD_H_TOP 1
154 // #define HUD_H_BOTTOM 2
159 // #define HUD_NOLIM 2
160 // #define HUD_CIRC 3
162 // #define HUD_INSTR_LADDER 1
163 // #define HUD_INSTR_CLADDER 2
164 // #define HUD_INSTR_HORIZON 3
165 // #define HUD_INSTR_LABEL 4
168 extern float get_throttleval ( void );
169 extern float get_aileronval ( void );
170 extern float get_elevatorval ( void );
171 extern float get_elev_trimval( void );
172 extern float get_rudderval ( void );
173 extern float get_speed ( void );
174 extern float get_aoa ( void );
175 extern float get_nlf ( void );
176 extern float get_roll ( void );
177 extern float get_pitch ( void );
178 extern float get_heading ( void );
179 extern float get_view_direction( void );
180 extern float get_altitude ( void );
181 extern float get_agl ( void );
182 extern float get_sideslip ( void );
183 extern float get_frame_rate ( void );
184 extern float get_latitude ( void );
185 extern float get_lat_min ( void );
186 extern float get_longitude ( void );
187 extern float get_long_min ( void );
188 extern float get_fov ( void );
189 extern float get_vfc_ratio ( void );
190 extern float get_vfc_tris_drawn ( void );
191 extern float get_vfc_tris_culled ( void );
192 extern float get_climb_rate ( void );
193 extern float get_mach( void );
194 extern char *coord_format_lat(float);
195 extern char *coord_format_lon(float);
196 //extern char *coord_format_latlon(float latitude, float longitude); // cockpit.cxx
198 // $$$ begin - added, VS Renganathan, 13 Oct 2K
199 // #define FIGHTER_HUD
200 extern float get_anzg (void);
201 extern float get_Vx (void);
202 extern float get_Vy (void);
203 extern float get_Vz (void);
204 extern float get_Ax (void);
205 extern float get_Ay (void);
206 extern float get_Az (void);
207 extern int get_iaux1 (void);
208 extern int get_iaux2 (void);
209 extern int get_iaux3 (void);
210 extern int get_iaux4 (void);
211 extern int get_iaux5 (void);
212 extern int get_iaux6 (void);
213 extern int get_iaux7 (void);
214 extern int get_iaux8 (void);
215 extern int get_iaux9 (void);
216 extern int get_iaux10 (void);
217 extern int get_iaux11 (void);
218 extern int get_iaux12 (void);
219 extern float get_aux1(void);
220 extern float get_aux2(void);
221 extern float get_aux3(void);
222 extern float get_aux4(void);
223 extern float get_aux5 (void);
224 extern float get_aux6 (void);
225 extern float get_aux7 (void);
226 extern float get_aux8(void);
227 extern float get_aux9(void);
228 extern float get_aux10(void);
229 extern float get_aux11(void);
230 extern float get_aux12(void);
231 extern float get_aux13(void);
232 extern float get_aux14(void);
233 extern float get_aux15(void);
234 extern float get_aux16(void);
235 extern float get_aux17(void);
236 extern float get_aux18(void);
237 // $$$ end - added, VS Renganathan, 13 Oct 2K
239 extern char *get_formated_gmt_time( void );
240 extern void fgHUDReshape(void);
242 enum hudinstype{ HUDno_instr,
254 typedef struct gltagRGBTRIPLE { // rgbt
262 GLfloat x0, y0, x1, y1;
265 fgLineSeg2D( GLfloat a = 0, GLfloat b =0, GLfloat c = 0, GLfloat d =0 )
266 : x0(a), y0(b), x1(c), y1(d) {}
268 fgLineSeg2D( const fgLineSeg2D & image )
269 : x0(image.x0), y0(image.y0), x1(image.x1), y1(image.y1) {}
271 fgLineSeg2D& operator= ( const fgLineSeg2D & image ) {
272 x0 = image.x0; y0 = image.y0; x1 = image.x1; y1 = image.y1; return *this;
284 #define USE_HUD_TextList
285 extern float HUD_TextSize;
286 extern fntRenderer *HUDtext;
287 extern float HUD_matrix[16];
295 fgText(float x = 0, float y = 0, char *c = NULL,int digits=0): x(x), y(y) //suma
301 fgText( const fgText & image )
302 : x(image.x), y(image.y),digit(image.digit) {strcpy(msg,image.msg);} //suma
304 fgText& operator = ( const fgText & image ) {
305 strcpy(msg,image.msg); x = image.x; y = image.y;digit=image.digit; //suma
309 ~fgText() {msg[0]='\0';}
311 int getStringWidth ( char *str )
313 if ( HUDtext && str ) {
315 guiFntHandle->getBBox ( str, HUD_TextSize, 0, &l, &r, NULL, NULL ) ;
316 return FloatToInt( r - l );
321 int StringWidth (void )
323 if ( HUDtext && strlen( msg )) {
325 guiFntHandle->getBBox ( msg, HUD_TextSize, 0, &l, &r, NULL, NULL ) ;
326 return FloatToInt( r - l );
331 // this code is changed to display Numbers with big/small digits
332 // according to MIL Standards for example Altitude above 10000 ft
333 // is shown as 10ooo. begin suma
335 void Draw(fntRenderer *fnt,int digits) {
342 //if negative value then increase the c and p values
347 while(tmp[i]!='\0') {
348 if((tmp[i]>='0') && (tmp[i]<='9'))
353 fnt->setPointSize(8);
358 fnt->start2f(x+p2,y);
361 fnt->setPointSize(12);
363 strncpy(tmp2,msg,p1);
369 fnt->setPointSize(12);
370 fnt->start2f( x, y );
374 //if digits not equal to 1
375 fnt->setPointSize(8);
376 fnt->start2f( x, y );
384 guiFnt.drawString( msg, FloatToInt(x), FloatToInt(y) );
389 vector < fgLineSeg2D > List;
391 fgLineList( void ) {}
392 ~fgLineList( void ) {}
393 void add( fgLineSeg2D seg ) { List.push_back(seg); }
394 void erase( void ) { List.erase( List.begin(), List.end() ); }
396 vector < fgLineSeg2D > :: iterator curSeg;
397 vector < fgLineSeg2D > :: iterator lastSeg;
398 curSeg = List.begin();
399 lastSeg = List.end();
401 for ( ; curSeg != lastSeg; curSeg++ ) {
406 /* void draw( void ) {
407 vector < fgLineSeg2D > :: iterator curSeg;
408 vector < fgLineSeg2D > :: iterator lastSeg;
409 curSeg = List.begin();
410 lastSeg = List.end();
412 for ( ; curSeg != lastSeg; curSeg++ ) {
421 vector< fgText > List;
423 fgTextList ( void ) { Font = 0; }
424 ~fgTextList( void ) {}
426 void setFont( fntRenderer *Renderer ) { Font = Renderer; }
427 void add( fgText String ) { List.push_back(String); }
428 void erase( void ) { List.erase( List.begin(), List.end() ); }
431 vector < fgText > :: iterator curString;
432 vector < fgText > :: iterator lastString;
433 if( Font == 0 ) return;
434 curString = List.begin();
435 lastString = List.end();
436 glPushAttrib( GL_COLOR_BUFFER_BIT );
437 glEnable ( GL_ALPHA_TEST ) ;
438 glEnable ( GL_BLEND ) ;
439 glAlphaFunc ( GL_GREATER, 0.1 ) ;
440 glBlendFunc ( GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA ) ;
443 for( ; curString != lastString; curString++ ) {
444 curString->Draw(Font,curString->digit); //suma
448 glDisable ( GL_TEXTURE_2D ) ;
454 inline void Text( fgTextList &List, float x, float y, char *s)
456 List.add( fgText( x, y, s) );
459 inline void Text( fgTextList &List, fgText &me)
464 inline void Line( fgLineList &List, float x1, float y1, float x2, float y2)
466 List.add(fgLineSeg2D(x1,y1,x2,y2));
470 // Declare our externals
471 extern fgTextList HUD_TextList;
472 extern fgLineList HUD_LineList;
473 extern fgLineList HUD_StippleLineList;
476 class instr_item { // An Abstract Base Class (ABC)
478 static UINT instances; // More than 64K instruments? Nah!
479 static int brightness;
480 static glRGBTRIPLE color;
483 RECT scrn_pos; // Framing - affects scale dimensions
484 // and orientation. Vert vs Horz, etc.
485 FLTFNPTR load_value_fn;
486 float disp_factor; // Multiply by to get numbers shown on scale.
490 UINT scr_span; // Working values for draw;
499 FLTFNPTR data_source,
503 int digit = 0); //suma
506 instr_item( const instr_item & image );
508 instr_item & operator = ( const instr_item & rhs );
509 virtual ~instr_item ();
511 int get_brightness ( void ) { return brightness;}
512 RECT get_location ( void ) { return scrn_pos; }
513 bool is_broken ( void ) { return broken; }
514 bool enabled ( void ) { return is_enabled;}
515 bool data_available ( void ) { return !!load_value_fn; }
516 float get_value ( void ) { return load_value_fn(); }
517 float data_scaling ( void ) { return disp_factor; }
518 UINT get_span ( void ) { return scr_span; }
519 POINT get_centroid ( void ) { return mid_span; }
520 UINT get_options ( void ) { return opts; }
521 int get_digits ( void ) { return digits; } //suma
523 UINT huds_vert (UINT options) { return( options & HUDS_VERT ); }
524 UINT huds_left (UINT options) { return( options & HUDS_LEFT ); }
525 UINT huds_right (UINT options) { return( options & HUDS_RIGHT ); }
526 UINT huds_both (UINT options) {
527 return( (options & HUDS_BOTH) == HUDS_BOTH );
529 UINT huds_noticks (UINT options) { return( options & HUDS_NOTICKS ); }
530 UINT huds_notext (UINT options) { return( options & HUDS_NOTEXT ); }
531 UINT huds_top (UINT options) { return( options & HUDS_TOP ); }
532 UINT huds_bottom (UINT options) { return( options & HUDS_BOTTOM ); }
534 virtual void display_enable( bool working ) { is_enabled = !! working;}
536 virtual void update( void );
537 virtual void break_display ( bool bad );
538 virtual void SetBrightness( int illumination_level ); // fgHUDSetBright...
539 void SetPosition ( int x, int y, UINT width, UINT height );
540 UINT get_Handle( void );
541 virtual void draw( void ) = 0; // Required method in derived classes
543 void drawOneLine( float x1, float y1, float x2, float y2)
545 HUD_LineList.add(fgLineSeg2D(x1,y1,x2,y2));
547 void drawOneStippleLine( float x1, float y1, float x2, float y2)
549 HUD_StippleLineList.add(fgLineSeg2D(x1,y1,x2,y2));
551 void TextString( char *msg, float x, float y,int digit ) //suma
553 HUD_TextList.add(fgText(x, y, msg,digit)); //suma
555 int getStringWidth ( char *str )
557 if ( HUDtext && str ) {
559 guiFntHandle->getBBox ( str, HUD_TextSize, 0, &l, &r, NULL, NULL ) ;
560 return FloatToInt( r - l );
565 //code to draw ticks as small circles
566 void drawOneCircle(float x1, float y1, float r)
568 glBegin(GL_LINE_LOOP); // Use polygon to approximate a circle
569 for(int count=0; count<25; count++) {
570 float cosine = r * cos(count * 2 * SG_PI/10.0);
571 float sine = r * sin(count * 2 * SG_PI/10.0);
572 glVertex2f(cosine+x1, sine+y1);
579 typedef instr_item *HIptr;
580 //typedef deque < instr_item * > hud_deque_type;
581 //typedef hud_deque_type::iterator hud_deque_iterator;
582 //typedef hud_deque_type::const_iterator hud_deque_const_iterator;
584 extern deque< instr_item *> HUD_deque;
585 extern int HUD_style;
586 //extern hud_deque_type HUD_deque;
588 // instr_item This class has no other purpose than to maintain
589 // a linked list of instrument and derived class
593 class instr_label : public instr_item {
597 const char *post_str;
601 char format_buffer[80];
611 FLTFNPTR data_source,
612 const char *label_format,
613 const char *pre_label_string,
614 const char *post_label_string,
617 fgLabelJust justification,
624 int digit ); //suma);
628 instr_label( const instr_label & image);
629 instr_label & operator = (const instr_label & rhs );
630 virtual void draw( void ); // Required method in base class
633 typedef instr_label * pInstlabel;
636 class lat_label : public instr_item {
640 const char *post_str;
644 char format_buffer[80];
651 FLTFNPTR data_source,
652 const char *label_format,
653 const char *pre_label_string,
654 const char *post_label_string,
657 fgLabelJust justification,
661 int digits =0 );//suma
665 lat_label( const lat_label & image);
666 lat_label & operator = (const lat_label & rhs );
667 virtual void draw( void ); // Required method in base class
670 typedef lat_label * pLatlabel;
672 class lon_label : public instr_item {
676 const char *post_str;
680 char format_buffer[80];
687 FLTFNPTR data_source,
688 const char *label_format,
689 const char *pre_label_string,
690 const char *post_label_string,
693 fgLabelJust justification,
702 lon_label( const lon_label & image);
703 lon_label & operator = (const lon_label & rhs );
704 virtual void draw( void ); // Required method in base class
707 typedef lon_label * pLonlabel;
710 // instr_scale This class is an abstract base class for both moving
711 // scale and moving needle (fixed scale) indicators. It
712 // does not draw itself, but is not instanciable.
715 class instr_scale : public instr_item {
717 float range_shown; // Width Units.
718 float Maximum_value; // ceiling.
719 float Minimum_value; // Representation floor.
720 float scale_factor; // factor => screen units/range values.
721 UINT Maj_div; // major division marker units
722 UINT Min_div; // minor division marker units
723 UINT Modulo; // Roll over point
724 int signif_digits; // digits to show to the right.
741 bool working = true);
743 virtual ~instr_scale();
744 instr_scale( const instr_scale & image);
745 instr_scale & operator = (const instr_scale & rhs);
747 virtual void draw ( void ) {}; // No-op here. Defined in derived classes.
748 UINT div_min ( void ) { return Min_div;}
749 UINT div_max ( void ) { return Maj_div;}
750 float min_val ( void ) { return Minimum_value;}
751 float max_val ( void ) { return Maximum_value;}
752 UINT modulo ( void ) { return Modulo; }
753 float factor ( void ) { return scale_factor;}
754 float range_to_show( void ) { return range_shown;}
757 // hud_card_ This class displays the indicated quantity on
758 // a scale that moves past the pointer. It may be
759 // horizontal or vertical, read above(left) or below(right) of the base
762 class hud_card : public instr_scale {
766 float half_width_units;
767 bool draw_tick_bottom;
769 bool draw_tick_right;
771 bool draw_cap_bottom;
781 float maxValue; //suma
782 float minValue; //suma
783 int divisions; //suma
805 bool draw_tick_bottom,
807 bool draw_tick_right,
809 bool draw_cap_bottom,
820 int divisions, //suma
825 hud_card( const hud_card & image);
826 hud_card & operator = (const hud_card & rhs );
827 // virtual void display_enable( bool setting );
828 virtual void draw( void ); // Required method in base class
829 void circles(float,float,float); // suma
830 void fixed(float,float,float,float,float,float); //suma
831 void zoomed_scale(int,int); //suma
834 typedef hud_card * pCardScale;
836 class gauge_instr : public instr_scale {
854 gauge_instr( const gauge_instr & image);
855 gauge_instr & operator = (const gauge_instr & rhs );
856 virtual void draw( void ); // Required method in base class
859 typedef gauge_instr * pGaugeInst;
861 // dual_instr_item This class was created to form the base class
862 // for both panel and HUD Turn Bank Indicators.
864 class dual_instr_item : public instr_item {
866 FLTFNPTR alt_data_source;
869 dual_instr_item ( int x,
873 FLTFNPTR chn1_source,
874 FLTFNPTR chn2_source,
878 virtual ~dual_instr_item() {};
879 dual_instr_item( const dual_instr_item & image);
880 dual_instr_item & operator = (const dual_instr_item & rhs );
882 float current_ch1( void ) { return (float)alt_data_source();}
883 float current_ch2( void ) { return (float)get_value();}
884 virtual void draw ( void ) { }
887 class fgTBI_instr : public dual_instr_item
901 FLTFNPTR chn1_source,
902 FLTFNPTR chn2_source,
910 fgTBI_instr( const fgTBI_instr & image);
911 fgTBI_instr & operator = (const fgTBI_instr & rhs );
915 UINT bank_limit( void ) { return BankLimit;}
916 UINT slew_limit( void ) { return SlewLimit;}
918 virtual void draw( void ); // Required method in base class
921 typedef fgTBI_instr * pTBI;
923 class HudLadder : public dual_instr_item {
933 string hudladder_type;
936 bool velocity_vector;
940 bool climb_dive_marker;
941 bool glide_slope_marker;
944 bool waypoint_marker;
952 fgLineList StippleLineList;
955 HudLadder( string name,
961 FLTFNPTR ptch_source,
962 FLTFNPTR roll_source,
964 float division_units,
965 float minor_division,
970 bool velocity_vector,
974 bool climb_dive_marker,
975 bool glide_slope_marker,
978 bool waypoint_marker,
987 HudLadder( const HudLadder & image );
988 HudLadder & operator = ( const HudLadder & rhs );
989 virtual void draw( void );
990 void drawZenith(float,float,float); //suma
991 void drawNadir(float, float, float); //suma
993 void Text( float x, float y, char *s)
995 TextList.add( fgText( x, y, s) );
998 void Line( float x1, float y1, float x2, float y2)
1000 LineList.add(fgLineSeg2D(x1,y1,x2,y2));
1003 void StippleLine( float x1, float y1, float x2, float y2)
1005 StippleLineList.add(fgLineSeg2D(x1,y1,x2,y2));
1010 //using namespace std;
1011 //deque <instr_item> * Hdeque_ptr;
1013 extern void HUD_masterswitch( bool incr );
1014 extern void HUD_brightkey( bool incr_bright );
1015 extern int fgHUDInit( fgAIRCRAFT * /* current_aircraft */ );
1016 extern int fgHUDInit2( fgAIRCRAFT * /* current_aircraft */ );
1017 extern void fgUpdateHUD( void );
1018 extern void fgUpdateHUD( GLfloat x_start, GLfloat y_start,
1019 GLfloat x_end, GLfloat y_end );
1021 extern void drawOneLine ( UINT x1, UINT y1, UINT x2, UINT y2);
1022 extern void drawOneLine ( RECT &rect);
1023 extern void textString ( int x,
1026 void *font = GLUT_BITMAP_9_BY_15,int digit=0); //suma
1027 extern void strokeString( int x,
1030 void *font = GLUT_STROKE_ROMAN,
1033 //extern void strokeString(float xx,
1036 // void *font = GLUT_STROKE_ROMAN)
1039 bool AddHUDInstrument( instr_item *pBlackBox );
1040 void DrawHUD ( void );
1041 bool DamageInstrument( INSTR_HANDLE unit );
1042 bool RepairInstrument( INSTR_HANDLE unit );
1045 void fgUpdateHUD ( Hptr hud );
1046 void fgUpdateHUD2( Hptr hud ); // Future use?
1047 void fgHUDSetTimeMode( Hptr hud, int time_of_day );