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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
28 # error This library requires C++
31 #include <simgear/compiler.h>
44 //#ifdef HAVE_VALUES_H
45 //# include <values.h> // for MAXINT
48 #include <algorithm> // for_each()
49 #include <vector> // STL vector
50 #include <deque> // STL double ended queue
53 #include <simgear/math/fastmath.hxx> // float_to_int()
54 #include <simgear/constants.h>
56 #include <Include/fg_typedefs.h>
57 #include <Aircraft/aircraft.hxx>
58 #include <Aircraft/controls.hxx>
59 #include <FDM/flight.hxx>
61 #include <Main/fg_props.hxx>
62 #include <Main/globals.hxx>
63 #include <Main/viewmgr.hxx>
64 #include <Airports/runways.hxx>
70 SG_USING_NAMESPACE(std);
73 // some of Norman's crazy optimizations. :-)
81 int top, bottom, left, right;
85 // View mode definitions
87 enum VIEW_MODES{ HUD_VIEW, PANEL_VIEW, CHASE_VIEW, TOWER_VIEW };
90 #define HUD_FONT_SMALL 1
91 #define HUD_FONT_LARGE 2
93 enum fgLabelJust{ LEFT_JUST, CENTER_JUST, RIGHT_JUST } ;
95 #define HUDS_AUTOTICKS 0x0001
96 #define HUDS_VERT 0x0002
97 #define HUDS_HORZ 0x0000
98 #define HUDS_TOP 0x0004
99 #define HUDS_BOTTOM 0x0008
100 #define HUDS_LEFT HUDS_TOP
101 #define HUDS_RIGHT HUDS_BOTTOM
102 #define HUDS_BOTH (HUDS_LEFT | HUDS_RIGHT)
103 #define HUDS_NOTICKS 0x0010
104 #define HUDS_ARITHTIC 0x0020
105 #define HUDS_DECITICS 0x0040
106 #define HUDS_NOTEXT 0x0080
109 // #define HUD_VERTICAL 1
110 // #define HUD_HORIZONTAL 2
111 // #define HUD_FREEFLOAT 3
113 // Ladder orientation modes
114 // #define HUD_LEFT 1
115 // #define HUD_RIGHT 2
117 // #define HUD_BOTTOM 2
118 // #define HUD_V_LEFT 1
119 // #define HUD_V_RIGHT 2
120 // #define HUD_H_TOP 1
121 // #define HUD_H_BOTTOM 2
126 // #define HUD_NOLIM 2
127 // #define HUD_CIRC 3
129 // #define HUD_INSTR_LADDER 1
130 // #define HUD_INSTR_CLADDER 2
131 // #define HUD_INSTR_HORIZON 3
132 // #define HUD_INSTR_LABEL 4
135 extern float get_throttleval ( void );
136 extern float get_aileronval ( void );
137 extern float get_elevatorval ( void );
138 extern float get_elev_trimval( void );
139 extern float get_rudderval ( void );
140 extern float get_speed ( void );
141 extern float get_aoa ( void );
142 extern float get_nlf ( void );
143 extern float get_roll ( void );
144 extern float get_pitch ( void );
145 extern float get_heading ( void );
146 extern float get_view_direction( void );
147 extern float get_altitude ( void );
148 extern float get_agl ( void );
149 extern float get_sideslip ( void );
150 extern float get_frame_rate ( void );
151 extern float get_latitude ( void );
152 extern float get_lat_min ( void );
153 extern float get_longitude ( void );
154 extern float get_long_min ( void );
155 extern float get_fov ( void );
156 extern float get_vfc_ratio ( void );
157 extern float get_vfc_tris_drawn ( void );
158 extern float get_vfc_tris_culled ( void );
159 extern float get_climb_rate ( void );
160 extern float get_mach( void );
161 extern char *coord_format_lat(float);
162 extern char *coord_format_lon(float);
163 //extern char *coord_format_latlon(float latitude, float longitude); // cockpit.cxx
165 // $$$ begin - added, VS Renganathan, 13 Oct 2K
166 // #define FIGHTER_HUD
167 extern float get_anzg (void);
168 extern float get_Vx (void);
169 extern float get_Vy (void);
170 extern float get_Vz (void);
171 extern float get_Ax (void);
172 extern float get_Ay (void);
173 extern float get_Az (void);
174 extern int get_iaux1 (void);
175 extern int get_iaux2 (void);
176 extern int get_iaux3 (void);
177 extern int get_iaux4 (void);
178 extern int get_iaux5 (void);
179 extern int get_iaux6 (void);
180 extern int get_iaux7 (void);
181 extern int get_iaux8 (void);
182 extern int get_iaux9 (void);
183 extern int get_iaux10 (void);
184 extern int get_iaux11 (void);
185 extern int get_iaux12 (void);
186 extern float get_aux1(void);
187 extern float get_aux2(void);
188 extern float get_aux3(void);
189 extern float get_aux4(void);
190 extern float get_aux5 (void);
191 extern float get_aux6 (void);
192 extern float get_aux7 (void);
193 extern float get_aux8(void);
194 extern float get_aux9(void);
195 extern float get_aux10(void);
196 extern float get_aux11(void);
197 extern float get_aux12(void);
198 extern float get_aux13(void);
199 extern float get_aux14(void);
200 extern float get_aux15(void);
201 extern float get_aux16(void);
202 extern float get_aux17(void);
203 extern float get_aux18(void);
204 // $$$ end - added, VS Renganathan, 13 Oct 2K
206 extern char *get_formated_gmt_time( void );
207 extern void fgHUDReshape(void);
209 enum hudinstype{ HUDno_instr,
221 typedef struct gltagRGBTRIPLE { // rgbt
229 GLfloat x0, y0, x1, y1;
232 fgLineSeg2D( GLfloat a = 0, GLfloat b =0, GLfloat c = 0, GLfloat d =0 )
233 : x0(a), y0(b), x1(c), y1(d) {}
235 fgLineSeg2D( const fgLineSeg2D & image )
236 : x0(image.x0), y0(image.y0), x1(image.x1), y1(image.y1) {}
238 fgLineSeg2D& operator= ( const fgLineSeg2D & image ) { // seems unused
239 x0 = image.x0; y0 = image.y0; x1 = image.x1; y1 = image.y1; return *this;
249 class DrawLineSeg2D {
251 void operator() (const fgLineSeg2D& elem) const {
257 #define USE_HUD_TextList
258 extern fntTexFont *HUD_Font;
259 extern float HUD_TextSize;
260 extern fntRenderer *HUDtext;
261 extern float HUD_matrix[16];
269 fgText(float x = 0, float y = 0, char *c = NULL,int digits=0): x(x), y(y)
275 fgText( const fgText & image )
276 : x(image.x), y(image.y),digit(image.digit) { strcpy(msg,image.msg); }
278 fgText& operator = ( const fgText & image ) { // seems unused
279 strcpy(msg,image.msg); x = image.x; y = image.y;digit=image.digit;
283 ~fgText() { msg[0]='\0'; } // used but useless
285 int getStringWidth ( char *str )
287 if ( HUDtext && str ) {
289 HUD_Font->getBBox ( str, HUD_TextSize, 0, &l, &r, NULL, NULL ) ;
290 return float_to_int( r - l );
295 int StringWidth (void )
297 if ( HUDtext && strlen( msg )) {
299 HUD_Font->getBBox ( msg, HUD_TextSize, 0, &l, &r, NULL, NULL ) ;
300 return float_to_int( r - l );
305 // this code is changed to display Numbers with big/small digits
306 // according to MIL Standards for example Altitude above 10000 ft
307 // is shown as 10ooo.
309 void Draw(fntRenderer *fnt,int digits) {
316 //if negative value then increase the c and p values
321 while (tmp[i]!='\0') {
322 if ((tmp[i]>='0') && (tmp[i]<='9'))
327 fnt->setPointSize(HUD_TextSize * 0.8);
332 fnt->start2f(x+p2,y);
335 fnt->setPointSize(HUD_TextSize * 1.2);
337 strncpy(tmp2,msg,p1);
343 fnt->setPointSize(HUD_TextSize * 1.2);
344 fnt->start2f( x, y );
348 //if digits not equal to 1
349 fnt->setPointSize(HUD_TextSize * 0.8);
350 fnt->start2f( x, y );
357 guiFnt.drawString( msg, float_to_int(x), float_to_int(y) );
362 vector < fgLineSeg2D > List;
364 fgLineList( void ) {}
365 void add( const fgLineSeg2D& seg ) { List.push_back(seg); }
366 void erase( void ) { List.erase( List.begin(), List.end() ); }
369 for_each( List.begin(), List.end(), DrawLineSeg2D());
376 vector< fgText > List;
378 fgTextList ( void ) { Font = 0; }
380 void setFont( fntRenderer *Renderer ) { Font = Renderer; }
381 void add( const fgText& String ) { List.push_back(String); }
382 void erase( void ) { List.erase( List.begin(), List.end() ); }
387 inline void Text( fgTextList &List, float x, float y, char *s)
389 List.add( fgText( x, y, s) );
392 inline void Text( fgTextList &List, const fgText &me)
397 inline void Line( fgLineList &List, float x1, float y1, float x2, float y2)
399 List.add(fgLineSeg2D(x1,y1,x2,y2));
403 // Declare our externals
404 extern fgTextList HUD_TextList;
405 extern fgLineList HUD_LineList;
406 extern fgLineList HUD_StippleLineList;
409 class instr_item { // An Abstract Base Class (ABC)
411 static UINT instances; // More than 64K instruments? Nah!
412 static int brightness;
413 static glRGBTRIPLE color;
416 RECT scrn_pos; // Framing - affects scale dimensions
417 // and orientation. Vert vs Horz, etc.
418 FLTFNPTR load_value_fn;
419 float disp_factor; // Multiply by to get numbers shown on scale.
423 UINT scr_span; // Working values for draw;
432 FLTFNPTR data_source,
438 virtual ~instr_item ();
440 void set_data_source ( FLTFNPTR fn ) { load_value_fn = fn; }
441 int get_brightness ( void ) { return brightness;}
442 RECT get_location ( void ) { return scrn_pos; }
443 bool is_broken ( void ) { return broken; }
444 bool enabled ( void ) { return is_enabled;}
445 bool data_available ( void ) { return !!load_value_fn; }
446 float get_value ( void ) { return load_value_fn(); }
447 float data_scaling ( void ) { return disp_factor; }
448 UINT get_span ( void ) { return scr_span; }
449 POINT get_centroid ( void ) { return mid_span; }
450 UINT get_options ( void ) { return opts; }
451 int get_digits ( void ) { return digits; }
452 inline int get_x() const { return scrn_pos.left; }
453 inline int get_y() const { return scrn_pos.top; }
454 inline int get_width() const { return scrn_pos.right; }
455 inline int get_height() const { return scrn_pos.bottom; }
457 UINT huds_vert (UINT options) { return (options & HUDS_VERT); }
458 UINT huds_left (UINT options) { return (options & HUDS_LEFT); }
459 UINT huds_right (UINT options) { return (options & HUDS_RIGHT); }
460 UINT huds_both (UINT options) {
461 return ((options & HUDS_BOTH) == HUDS_BOTH);
463 UINT huds_noticks (UINT options) { return (options & HUDS_NOTICKS); }
464 UINT huds_notext (UINT options) { return (options & HUDS_NOTEXT); }
465 UINT huds_top (UINT options) { return (options & HUDS_TOP); }
466 UINT huds_bottom (UINT options) { return (options & HUDS_BOTTOM); }
468 virtual void display_enable( bool working ) { is_enabled = working;}
470 virtual void break_display ( bool bad );
471 virtual void SetBrightness( int illumination_level ); // fgHUDSetBright...
472 void SetPosition ( int x, int y, UINT width, UINT height );
473 UINT get_Handle( void );
474 virtual void draw( void ) = 0; // Required method in derived classes
476 void drawOneLine( float x1, float y1, float x2, float y2)
478 HUD_LineList.add(fgLineSeg2D(x1,y1,x2,y2));
480 void drawOneStippleLine( float x1, float y1, float x2, float y2)
482 HUD_StippleLineList.add(fgLineSeg2D(x1,y1,x2,y2));
484 void TextString( char *msg, float x, float y,int digit )
486 HUD_TextList.add(fgText(x, y, msg,digit));
488 int getStringWidth ( char *str )
490 if ( HUDtext && str ) {
492 HUD_Font->getBBox ( str, HUD_TextSize, 0, &l, &r, NULL, NULL ) ;
493 return float_to_int( r - l );
498 //code to draw ticks as small circles
499 void drawOneCircle(float x1, float y1, float r)
501 glBegin(GL_LINE_LOOP); // Use polygon to approximate a circle
502 for (int count=0; count<25; count++) {
503 float cosine = r * cos(count * 2 * SG_PI/10.0);
504 float sine = r * sin(count * 2 * SG_PI/10.0);
505 glVertex2f(cosine+x1, sine+y1);
512 typedef instr_item *HIptr;
516 void operator() (HIptr elem) const {
517 if ( elem->enabled())
523 extern deque< instr_item *> HUD_deque;
524 extern int HUD_style;
525 //extern hud_deque_type HUD_deque;
527 // instr_item This class has no other purpose than to maintain
528 // a linked list of instrument and derived class
532 class instr_label : public instr_item {
536 const char *post_str;
540 char format_buffer[80];
544 SGPropertyNode_ptr lon_node;
545 SGPropertyNode_ptr lat_node;
548 instr_label(const SGPropertyNode *);
549 virtual void draw(void);
554 // fgRunway_instr This class is responsible for rendering the active runway
555 // in the hud (if visible).
556 class runway_instr : public instr_item {
558 void boundPoint(const sgdVec3& v, sgdVec3& m);
559 bool boundOutsidePoints(sgdVec3& v, sgdVec3& m);
560 bool drawLine(const sgdVec3& a1, const sgdVec3& a2,
561 const sgdVec3& p1, const sgdVec3& p2);
563 bool get_active_runway(FGRunway& rwy);
564 void get_rwy_points(sgdVec3 *points);
565 void setLineWidth(void);
567 sgdVec3 points3d[6], points2d[6];
568 double mm[16],pm[16], arrowScale, arrowRad, lnScale;
569 double scaleDist, default_pitch, default_heading;
572 FGViewer* cockpit_view;
573 unsigned short stippleOut, stippleCen;
574 bool drawIA, drawIAAlways;
579 runway_instr(const SGPropertyNode *);
581 virtual void draw( void );
582 void setArrowRotationRadius(double radius);
583 // Scales the runway indication arrow
584 void setArrowScale(double scale);
585 // Draws arrow when runway is not visible in HUD if draw=true
586 void setDrawArrow(bool draw);
587 // Always draws arrow if draw=true;
588 void setDrawArrowAlways(bool draw);
589 // Sets the maximum line scale
590 void setLineScale(double scale);
591 // Sets the distance where to start scaling the lines
592 void setScaleDist(double dist_nm);
593 // Sets the stipple pattern of the outline of the runway
594 void setStippleOutline(unsigned short stipple);
595 // Sets the stipple patter of the center line of the runway
596 void setStippleCenterline(unsigned short stipple);
601 // instr_scale This class is an abstract base class for both moving
602 // scale and moving needle (fixed scale) indicators. It
603 // does not draw itself, but is not instanciable.
606 class instr_scale : public instr_item {
608 float range_shown; // Width Units.
609 float Maximum_value; // ceiling.
610 float Minimum_value; // Representation floor.
611 float scale_factor; // factor => screen units/range values.
612 UINT Maj_div; // major division marker units
613 UINT Min_div; // minor division marker units
614 UINT Modulo; // Roll over point
615 int signif_digits; // digits to show to the right.
632 bool working = true);
634 virtual void draw ( void ) {}; // No-op here. Defined in derived classes.
635 UINT div_min ( void ) { return Min_div;}
636 UINT div_max ( void ) { return Maj_div;}
637 float min_val ( void ) { return Minimum_value;}
638 float max_val ( void ) { return Maximum_value;}
639 UINT modulo ( void ) { return Modulo; }
640 float factor ( void ) { return scale_factor;}
641 float range_to_show ( void ) { return range_shown;}
644 // hud_card This class displays the indicated quantity on
645 // a scale that moves past the pointer. It may be
646 // horizontal or vertical, read above(left) or below(right) of the base
649 class hud_card : public instr_scale {
653 float half_width_units;
654 bool draw_tick_bottom;
656 bool draw_tick_right;
658 bool draw_cap_bottom;
676 hud_card(const SGPropertyNode *);
677 // virtual void display_enable( bool setting ); // FIXME
678 virtual void draw(void);
679 void circles(float, float, float);
680 void fixed(float, float, float, float, float, float);
681 void zoomed_scale(int, int);
685 class gauge_instr : public instr_scale {
687 gauge_instr(const SGPropertyNode *);
688 virtual void draw( void ); // Required method in base class
693 // dual_instr_item This class was created to form the base class
694 // for both panel and HUD Turn Bank Indicators.
696 class dual_instr_item : public instr_item {
698 FLTFNPTR alt_data_source;
701 dual_instr_item ( int x,
705 FLTFNPTR chn1_source,
706 FLTFNPTR chn2_source,
710 float current_ch1( void ) { return (float)alt_data_source(); }
711 float current_ch2( void ) { return (float)get_value(); }
712 virtual void draw( void ) {}
716 class fgTBI_instr : public dual_instr_item {
725 fgTBI_instr(const SGPropertyNode *);
727 UINT bank_limit(void) { return BankLimit; }
728 UINT slew_limit(void) { return SlewLimit; }
730 virtual void draw(void);
734 class HudLadder : public dual_instr_item {
744 string hudladder_type;
747 bool velocity_vector;
751 bool climb_dive_marker;
752 bool glide_slope_marker;
755 bool waypoint_marker;
760 // The Ladder has it's own temporary display lists
763 fgLineList StippleLineList;
766 HudLadder(const SGPropertyNode *);
768 virtual void draw(void);
769 void drawZenith(float, float, float);
770 void drawNadir(float, float, float);
772 void Text(float x, float y, char *s)
774 TextList.add(fgText(x, y, s));
777 void Line(float x1, float y1, float x2, float y2)
779 LineList.add(fgLineSeg2D(x1, y1, x2, y2));
782 void StippleLine(float x1, float y1, float x2, float y2)
784 StippleLineList.add(fgLineSeg2D(x1, y1, x2, y2));
789 //using namespace std;
790 //deque <instr_item> * Hdeque_ptr;
792 extern int fgHUDInit( fgAIRCRAFT * /* current_aircraft */ );
793 extern int fgHUDInit2( fgAIRCRAFT * /* current_aircraft */ );
794 extern void fgUpdateHUD( void );
795 extern void fgUpdateHUD( GLfloat x_start, GLfloat y_start,
796 GLfloat x_end, GLfloat y_end );
799 bool AddHUDInstrument( instr_item *pBlackBox );
800 void DrawHUD ( void );
801 bool DamageInstrument( INSTR_HANDLE unit );
802 bool RepairInstrument( INSTR_HANDLE unit );
805 void fgUpdateHUD ( Hptr hud );
806 void fgUpdateHUD2( Hptr hud ); // Future use?
807 void fgHUDSetTimeMode( Hptr hud, int time_of_day );
813 class HUD_Properties : public SGPropertyChangeListener {
816 void valueChanged(SGPropertyNode *n);
817 void setColor() const;
818 bool isVisible() const { return _visible; }
819 bool isAntialiased() const { return _antialiased; }
820 bool isTransparent() const { return _transparent; }
821 float alphaClamp() const { return _cl; }
824 float clamp(float f) { return f < 0.0f ? 0.0f : f > 1.0f ? 1.0f : f; }
825 SGPropertyNode_ptr _current;
826 SGPropertyNode_ptr _visibility;
827 SGPropertyNode_ptr _antialiasing;
828 SGPropertyNode_ptr _transparency;
829 SGPropertyNode_ptr _red, _green, _blue, _alpha;
830 SGPropertyNode_ptr _alpha_clamp;
831 SGPropertyNode_ptr _brightness;
835 float _r, _g, _b, _a, _cl;