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 <algorithm> // for_each()
50 #include <vector> // STL vector
51 #include <deque> // STL double ended queue
54 #include <simgear/constants.h>
56 #include <Include/fg_typedefs.h>
57 #include <Aircraft/aircraft.hxx>
58 #include <FDM/flight.hxx>
59 #include <Controls/controls.hxx>
61 #include <Main/globals.hxx>
62 #include <Main/viewmgr.hxx>
64 #include "hud_opts.hxx"
68 SG_USING_NAMESPACE(std);
71 // some of Norman's crazy optimizations. :-)
79 int top, bottom, left, right;
83 // View mode definitions
85 enum VIEW_MODES{ HUD_VIEW, PANEL_VIEW, CHASE_VIEW, TOWER_VIEW };
87 // DAY, NIGHT and brightness levels need to be visible where dialogs and
88 // controls can be used to set intensity and appropriate color. This will
90 // Hud general constants
93 #define HUD_BRT_BLACK 3
94 #define HUD_BRT_DARK 4
95 #define HUD_BRT_MEDIUM 5
96 #define HUD_BRT_LIGHT 6
99 #define HUD_FONT_SMALL 1
100 #define HUD_FONT_LARGE 2
102 enum fgLabelJust{ LEFT_JUST, CENTER_JUST, RIGHT_JUST } ;
104 #define HUDS_AUTOTICKS 0x0001
105 #define HUDS_VERT 0x0002
106 #define HUDS_HORZ 0x0000
107 #define HUDS_TOP 0x0004
108 #define HUDS_BOTTOM 0x0008
109 #define HUDS_LEFT HUDS_TOP
110 #define HUDS_RIGHT HUDS_BOTTOM
111 #define HUDS_BOTH (HUDS_LEFT | HUDS_RIGHT)
112 #define HUDS_NOTICKS 0x0010
113 #define HUDS_ARITHTIC 0x0020
114 #define HUDS_DECITICS 0x0040
115 #define HUDS_NOTEXT 0x0080
118 // #define HUD_VERTICAL 1
119 // #define HUD_HORIZONTAL 2
120 // #define HUD_FREEFLOAT 3
122 // Ladder orientation modes
123 // #define HUD_LEFT 1
124 // #define HUD_RIGHT 2
126 // #define HUD_BOTTOM 2
127 // #define HUD_V_LEFT 1
128 // #define HUD_V_RIGHT 2
129 // #define HUD_H_TOP 1
130 // #define HUD_H_BOTTOM 2
135 // #define HUD_NOLIM 2
136 // #define HUD_CIRC 3
138 // #define HUD_INSTR_LADDER 1
139 // #define HUD_INSTR_CLADDER 2
140 // #define HUD_INSTR_HORIZON 3
141 // #define HUD_INSTR_LABEL 4
144 extern float get_throttleval ( void );
145 extern float get_aileronval ( void );
146 extern float get_elevatorval ( void );
147 extern float get_elev_trimval( void );
148 extern float get_rudderval ( void );
149 extern float get_speed ( void );
150 extern float get_aoa ( void );
151 extern float get_nlf ( void );
152 extern float get_roll ( void );
153 extern float get_pitch ( void );
154 extern float get_heading ( void );
155 extern float get_view_direction( void );
156 extern float get_altitude ( void );
157 extern float get_agl ( void );
158 extern float get_sideslip ( void );
159 extern float get_frame_rate ( void );
160 extern float get_latitude ( void );
161 extern float get_lat_min ( void );
162 extern float get_longitude ( void );
163 extern float get_long_min ( void );
164 extern float get_fov ( void );
165 extern float get_vfc_ratio ( void );
166 extern float get_vfc_tris_drawn ( void );
167 extern float get_vfc_tris_culled ( void );
168 extern float get_climb_rate ( void );
169 extern float get_mach( void );
170 extern char *coord_format_lat(float);
171 extern char *coord_format_lon(float);
172 //extern char *coord_format_latlon(float latitude, float longitude); // cockpit.cxx
174 // $$$ begin - added, VS Renganathan, 13 Oct 2K
175 // #define FIGHTER_HUD
176 extern float get_anzg (void);
177 extern float get_Vx (void);
178 extern float get_Vy (void);
179 extern float get_Vz (void);
180 extern float get_Ax (void);
181 extern float get_Ay (void);
182 extern float get_Az (void);
183 extern int get_iaux1 (void);
184 extern int get_iaux2 (void);
185 extern int get_iaux3 (void);
186 extern int get_iaux4 (void);
187 extern int get_iaux5 (void);
188 extern int get_iaux6 (void);
189 extern int get_iaux7 (void);
190 extern int get_iaux8 (void);
191 extern int get_iaux9 (void);
192 extern int get_iaux10 (void);
193 extern int get_iaux11 (void);
194 extern int get_iaux12 (void);
195 extern float get_aux1(void);
196 extern float get_aux2(void);
197 extern float get_aux3(void);
198 extern float get_aux4(void);
199 extern float get_aux5 (void);
200 extern float get_aux6 (void);
201 extern float get_aux7 (void);
202 extern float get_aux8(void);
203 extern float get_aux9(void);
204 extern float get_aux10(void);
205 extern float get_aux11(void);
206 extern float get_aux12(void);
207 extern float get_aux13(void);
208 extern float get_aux14(void);
209 extern float get_aux15(void);
210 extern float get_aux16(void);
211 extern float get_aux17(void);
212 extern float get_aux18(void);
213 // $$$ end - added, VS Renganathan, 13 Oct 2K
215 extern char *get_formated_gmt_time( void );
216 extern void fgHUDReshape(void);
218 enum hudinstype{ HUDno_instr,
230 typedef struct gltagRGBTRIPLE { // rgbt
238 GLfloat x0, y0, x1, y1;
241 fgLineSeg2D( GLfloat a = 0, GLfloat b =0, GLfloat c = 0, GLfloat d =0 )
242 : x0(a), y0(b), x1(c), y1(d) {}
244 fgLineSeg2D( const fgLineSeg2D & image )
245 : x0(image.x0), y0(image.y0), x1(image.x1), y1(image.y1) {}
247 fgLineSeg2D& operator= ( const fgLineSeg2D & image ) {
248 x0 = image.x0; y0 = image.y0; x1 = image.x1; y1 = image.y1; return *this;
260 class DrawLineSeg2D {
262 void operator() (fgLineSeg2D elem) const {
268 #define USE_HUD_TextList
269 extern float HUD_TextSize;
270 extern fntRenderer *HUDtext;
271 extern float HUD_matrix[16];
279 fgText(float x = 0, float y = 0, char *c = NULL,int digits=0): x(x), y(y) //suma
285 fgText( const fgText & image )
286 : x(image.x), y(image.y),digit(image.digit) {strcpy(msg,image.msg);} //suma
288 fgText& operator = ( const fgText & image ) {
289 strcpy(msg,image.msg); x = image.x; y = image.y;digit=image.digit; //suma
293 ~fgText() {msg[0]='\0';}
295 int getStringWidth ( char *str )
297 if ( HUDtext && str ) {
299 guiFntHandle->getBBox ( str, HUD_TextSize, 0, &l, &r, NULL, NULL ) ;
300 return FloatToInt( r - l );
305 int StringWidth (void )
307 if ( HUDtext && strlen( msg )) {
309 guiFntHandle->getBBox ( msg, HUD_TextSize, 0, &l, &r, NULL, NULL ) ;
310 return FloatToInt( r - l );
315 // this code is changed to display Numbers with big/small digits
316 // according to MIL Standards for example Altitude above 10000 ft
317 // is shown as 10ooo. begin suma
319 void Draw(fntRenderer *fnt,int digits) {
326 //if negative value then increase the c and p values
331 while(tmp[i]!='\0') {
332 if((tmp[i]>='0') && (tmp[i]<='9'))
337 fnt->setPointSize(8);
342 fnt->start2f(x+p2,y);
345 fnt->setPointSize(12);
347 strncpy(tmp2,msg,p1);
353 fnt->setPointSize(12);
354 fnt->start2f( x, y );
358 //if digits not equal to 1
359 fnt->setPointSize(8);
360 fnt->start2f( x, y );
368 guiFnt.drawString( msg, FloatToInt(x), FloatToInt(y) );
373 vector < fgLineSeg2D > List;
375 fgLineList( void ) {}
376 ~fgLineList( void ) {}
377 void add( fgLineSeg2D seg ) { List.push_back(seg); }
378 void erase( void ) { List.erase( List.begin(), List.end() ); }
381 for_each( List.begin(), List.end(), DrawLineSeg2D());
388 vector< fgText > List;
390 fgTextList ( void ) { Font = 0; }
391 ~fgTextList( void ) {}
393 void setFont( fntRenderer *Renderer ) { Font = Renderer; }
394 void add( fgText String ) { List.push_back(String); }
395 void erase( void ) { List.erase( List.begin(), List.end() ); }
400 vector < fgText > :: iterator curString = List.begin();
401 vector < fgText > :: iterator lastString = List.end();
403 glPushAttrib( GL_COLOR_BUFFER_BIT );
404 glEnable ( GL_ALPHA_TEST ) ;
405 glEnable ( GL_BLEND ) ;
406 glAlphaFunc ( GL_GREATER, 0.1 ) ;
407 glBlendFunc ( GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA ) ;
410 for( ; curString != lastString; curString++ ) {
411 curString->Draw(Font,curString->digit); //suma
415 glDisable ( GL_TEXTURE_2D ) ;
421 inline void Text( fgTextList &List, float x, float y, char *s)
423 List.add( fgText( x, y, s) );
426 inline void Text( fgTextList &List, fgText &me)
431 inline void Line( fgLineList &List, float x1, float y1, float x2, float y2)
433 List.add(fgLineSeg2D(x1,y1,x2,y2));
437 // Declare our externals
438 extern fgTextList HUD_TextList;
439 extern fgLineList HUD_LineList;
440 extern fgLineList HUD_StippleLineList;
443 class instr_item { // An Abstract Base Class (ABC)
445 static UINT instances; // More than 64K instruments? Nah!
446 static int brightness;
447 static glRGBTRIPLE color;
450 RECT scrn_pos; // Framing - affects scale dimensions
451 // and orientation. Vert vs Horz, etc.
452 FLTFNPTR load_value_fn;
453 float disp_factor; // Multiply by to get numbers shown on scale.
457 UINT scr_span; // Working values for draw;
466 FLTFNPTR data_source,
470 int digit = 0); //suma
472 instr_item( const instr_item & image );
474 instr_item & operator = ( const instr_item & rhs );
475 virtual ~instr_item ();
477 int get_brightness ( void ) { return brightness;}
478 RECT get_location ( void ) { return scrn_pos; }
479 bool is_broken ( void ) { return broken; }
480 bool enabled ( void ) { return is_enabled;}
481 bool data_available ( void ) { return !!load_value_fn; }
482 float get_value ( void ) { return load_value_fn(); }
483 float data_scaling ( void ) { return disp_factor; }
484 UINT get_span ( void ) { return scr_span; }
485 POINT get_centroid ( void ) { return mid_span; }
486 UINT get_options ( void ) { return opts; }
487 int get_digits ( void ) { return digits; } //suma
489 UINT huds_vert (UINT options) { return( options & HUDS_VERT ); }
490 UINT huds_left (UINT options) { return( options & HUDS_LEFT ); }
491 UINT huds_right (UINT options) { return( options & HUDS_RIGHT ); }
492 UINT huds_both (UINT options) {
493 return( (options & HUDS_BOTH) == HUDS_BOTH );
495 UINT huds_noticks (UINT options) { return( options & HUDS_NOTICKS ); }
496 UINT huds_notext (UINT options) { return( options & HUDS_NOTEXT ); }
497 UINT huds_top (UINT options) { return( options & HUDS_TOP ); }
498 UINT huds_bottom (UINT options) { return( options & HUDS_BOTTOM ); }
500 virtual void display_enable( bool working ) { is_enabled = !! working;}
502 virtual void update( void );
503 virtual void break_display ( bool bad );
504 virtual void SetBrightness( int illumination_level ); // fgHUDSetBright...
505 void SetPosition ( int x, int y, UINT width, UINT height );
506 UINT get_Handle( void );
507 virtual void draw( void ) = 0; // Required method in derived classes
509 void drawOneLine( float x1, float y1, float x2, float y2)
511 HUD_LineList.add(fgLineSeg2D(x1,y1,x2,y2));
513 void drawOneStippleLine( float x1, float y1, float x2, float y2)
515 HUD_StippleLineList.add(fgLineSeg2D(x1,y1,x2,y2));
517 void TextString( char *msg, float x, float y,int digit ) //suma
519 HUD_TextList.add(fgText(x, y, msg,digit)); //suma
521 int getStringWidth ( char *str )
523 if ( HUDtext && str ) {
525 guiFntHandle->getBBox ( str, HUD_TextSize, 0, &l, &r, NULL, NULL ) ;
526 return FloatToInt( r - l );
531 //code to draw ticks as small circles
532 void drawOneCircle(float x1, float y1, float r)
534 glBegin(GL_LINE_LOOP); // Use polygon to approximate a circle
535 for(int count=0; count<25; count++) {
536 float cosine = r * cos(count * 2 * SG_PI/10.0);
537 float sine = r * sin(count * 2 * SG_PI/10.0);
538 glVertex2f(cosine+x1, sine+y1);
545 typedef instr_item *HIptr;
549 void operator() (HIptr elem) const {
555 //typedef deque < instr_item * > hud_deque_type;
556 //typedef hud_deque_type::iterator hud_deque_iterator;
557 //typedef hud_deque_type::const_iterator hud_deque_const_iterator;
559 extern deque< instr_item *> HUD_deque;
560 extern int HUD_style;
561 //extern hud_deque_type HUD_deque;
563 // instr_item This class has no other purpose than to maintain
564 // a linked list of instrument and derived class
568 class instr_label : public instr_item {
572 const char *post_str;
576 char format_buffer[80];
586 FLTFNPTR data_source,
587 const char *label_format,
588 const char *pre_label_string,
589 const char *post_label_string,
592 fgLabelJust justification,
599 int digit ); //suma);
603 instr_label( const instr_label & image);
604 instr_label & operator = (const instr_label & rhs );
605 virtual void draw( void ); // Required method in base class
608 typedef instr_label * pInstlabel;
611 class lat_label : public instr_item {
615 const char *post_str;
619 char format_buffer[80];
626 FLTFNPTR data_source,
627 const char *label_format,
628 const char *pre_label_string,
629 const char *post_label_string,
632 fgLabelJust justification,
636 int digits =0 );//suma
640 lat_label( const lat_label & image);
641 lat_label & operator = (const lat_label & rhs );
642 virtual void draw( void ); // Required method in base class
645 typedef lat_label * pLatlabel;
647 class lon_label : public instr_item {
651 const char *post_str;
655 char format_buffer[80];
662 FLTFNPTR data_source,
663 const char *label_format,
664 const char *pre_label_string,
665 const char *post_label_string,
668 fgLabelJust justification,
677 lon_label( const lon_label & image);
678 lon_label & operator = (const lon_label & rhs );
679 virtual void draw( void ); // Required method in base class
682 typedef lon_label * pLonlabel;
685 // instr_scale This class is an abstract base class for both moving
686 // scale and moving needle (fixed scale) indicators. It
687 // does not draw itself, but is not instanciable.
690 class instr_scale : public instr_item {
692 float range_shown; // Width Units.
693 float Maximum_value; // ceiling.
694 float Minimum_value; // Representation floor.
695 float scale_factor; // factor => screen units/range values.
696 UINT Maj_div; // major division marker units
697 UINT Min_div; // minor division marker units
698 UINT Modulo; // Roll over point
699 int signif_digits; // digits to show to the right.
716 bool working = true);
718 virtual ~instr_scale();
719 instr_scale( const instr_scale & image);
720 instr_scale & operator = (const instr_scale & rhs);
722 virtual void draw ( void ) {}; // No-op here. Defined in derived classes.
723 UINT div_min ( void ) { return Min_div;}
724 UINT div_max ( void ) { return Maj_div;}
725 float min_val ( void ) { return Minimum_value;}
726 float max_val ( void ) { return Maximum_value;}
727 UINT modulo ( void ) { return Modulo; }
728 float factor ( void ) { return scale_factor;}
729 float range_to_show( void ) { return range_shown;}
732 // hud_card_ This class displays the indicated quantity on
733 // a scale that moves past the pointer. It may be
734 // horizontal or vertical, read above(left) or below(right) of the base
737 class hud_card : public instr_scale {
741 float half_width_units;
742 bool draw_tick_bottom;
744 bool draw_tick_right;
746 bool draw_cap_bottom;
756 float maxValue; //suma
757 float minValue; //suma
758 int divisions; //suma
780 bool draw_tick_bottom,
782 bool draw_tick_right,
784 bool draw_cap_bottom,
795 int divisions, //suma
801 hud_card( const hud_card & image);
802 hud_card & operator = (const hud_card & rhs );
803 // virtual void display_enable( bool setting );
804 virtual void draw( void ); // Required method in base class
805 void circles(float,float,float); // suma
806 void fixed(float,float,float,float,float,float); //suma
807 void zoomed_scale(int,int); //suma
810 typedef hud_card * pCardScale;
812 class gauge_instr : public instr_scale {
830 gauge_instr( const gauge_instr & image);
831 gauge_instr & operator = (const gauge_instr & rhs );
832 virtual void draw( void ); // Required method in base class
835 typedef gauge_instr * pGaugeInst;
837 // dual_instr_item This class was created to form the base class
838 // for both panel and HUD Turn Bank Indicators.
840 class dual_instr_item : public instr_item {
842 FLTFNPTR alt_data_source;
845 dual_instr_item ( int x,
849 FLTFNPTR chn1_source,
850 FLTFNPTR chn2_source,
854 virtual ~dual_instr_item() {};
855 dual_instr_item( const dual_instr_item & image);
856 dual_instr_item & operator = (const dual_instr_item & rhs );
858 float current_ch1( void ) { return (float)alt_data_source();}
859 float current_ch2( void ) { return (float)get_value();}
860 virtual void draw ( void ) { }
863 class fgTBI_instr : public dual_instr_item
877 FLTFNPTR chn1_source,
878 FLTFNPTR chn2_source,
886 fgTBI_instr( const fgTBI_instr & image);
887 fgTBI_instr & operator = (const fgTBI_instr & rhs );
891 UINT bank_limit( void ) { return BankLimit;}
892 UINT slew_limit( void ) { return SlewLimit;}
894 virtual void draw( void ); // Required method in base class
897 typedef fgTBI_instr * pTBI;
899 class HudLadder : public dual_instr_item {
909 string hudladder_type;
912 bool velocity_vector;
916 bool climb_dive_marker;
917 bool glide_slope_marker;
920 bool waypoint_marker;
926 // The Ladder has it's own temporary display lists
929 fgLineList StippleLineList;
932 HudLadder( string name,
938 FLTFNPTR ptch_source,
939 FLTFNPTR roll_source,
941 float division_units,
942 float minor_division,
947 bool velocity_vector,
951 bool climb_dive_marker,
952 bool glide_slope_marker,
955 bool waypoint_marker,
965 HudLadder( const HudLadder & image );
966 HudLadder & operator = ( const HudLadder & rhs );
967 virtual void draw( void );
968 void drawZenith(float,float,float); //suma
969 void drawNadir(float, float, float); //suma
971 void Text( float x, float y, char *s)
973 TextList.add( fgText( x, y, s) );
976 void Line( float x1, float y1, float x2, float y2)
978 LineList.add(fgLineSeg2D(x1,y1,x2,y2));
981 void StippleLine( float x1, float y1, float x2, float y2)
983 StippleLineList.add(fgLineSeg2D(x1,y1,x2,y2));
988 //using namespace std;
989 //deque <instr_item> * Hdeque_ptr;
991 extern void HUD_masterswitch( bool incr );
992 extern void HUD_brightkey( bool incr_bright );
993 extern int fgHUDInit( fgAIRCRAFT * /* current_aircraft */ );
994 extern int fgHUDInit2( fgAIRCRAFT * /* current_aircraft */ );
995 extern void fgUpdateHUD( void );
996 extern void fgUpdateHUD( GLfloat x_start, GLfloat y_start,
997 GLfloat x_end, GLfloat y_end );
1000 bool AddHUDInstrument( instr_item *pBlackBox );
1001 void DrawHUD ( void );
1002 bool DamageInstrument( INSTR_HANDLE unit );
1003 bool RepairInstrument( INSTR_HANDLE unit );
1006 void fgUpdateHUD ( Hptr hud );
1007 void fgUpdateHUD2( Hptr hud ); // Future use?
1008 void fgHUDSetTimeMode( Hptr hud, int time_of_day );