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 #include <algorithm> // for_each()
45 #include <vector> // STL vector
46 #include <deque> // STL double ended queue
53 #include <simgear/math/SGMath.hxx>
54 #include <simgear/constants.h>
56 #include <Include/fg_typedefs.h>
57 #include <Aircraft/controls.hxx>
58 #include <FDM/flight.hxx>
60 #include <Main/fg_props.hxx>
61 #include <Main/globals.hxx>
62 #include <Main/viewmgr.hxx>
69 #define float_to_int(v) SGMiscf::roundToInt(v)
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 };
88 #define HUD_FONT_SMALL 1
89 #define HUD_FONT_LARGE 2
91 enum fgLabelJust{ LEFT_JUST, CENTER_JUST, RIGHT_JUST } ;
93 #define HUDS_AUTOTICKS 0x0001
94 #define HUDS_VERT 0x0002
95 #define HUDS_HORZ 0x0000
96 #define HUDS_TOP 0x0004
97 #define HUDS_BOTTOM 0x0008
98 #define HUDS_LEFT HUDS_TOP
99 #define HUDS_RIGHT HUDS_BOTTOM
100 #define HUDS_BOTH (HUDS_LEFT | HUDS_RIGHT)
101 #define HUDS_NOTICKS 0x0010
102 #define HUDS_ARITHTIC 0x0020
103 #define HUDS_DECITICS 0x0040
104 #define HUDS_NOTEXT 0x0080
107 extern float get_throttleval ( void );
108 extern float get_aileronval ( void );
109 extern float get_elevatorval ( void );
110 extern float get_elev_trimval( void );
111 extern float get_rudderval ( void );
112 extern float get_speed ( void );
113 extern float get_aoa ( void );
114 extern float get_nlf ( void );
115 extern float get_roll ( void );
116 extern float get_pitch ( void );
117 extern float get_heading ( void );
118 extern float get_view_direction( void );
119 extern float get_altitude ( void );
120 extern float get_agl ( void );
121 extern float get_sideslip ( void );
122 extern float get_frame_rate ( void );
123 extern float get_latitude ( void );
124 extern float get_lat_min ( void );
125 extern float get_longitude ( void );
126 extern float get_long_min ( void );
127 extern float get_fov ( void );
128 extern float get_vfc_ratio ( void );
129 extern float get_vfc_tris_drawn ( void );
130 extern float get_vfc_tris_culled ( void );
131 extern float get_climb_rate ( void );
132 extern float get_mach( void );
133 extern char *coord_format_lat(float);
134 extern char *coord_format_lon(float);
136 extern char *get_formated_gmt_time( void );
138 enum hudinstype{ HUDno_instr,
150 typedef struct gltagRGBTRIPLE { // rgbt
158 GLfloat x0, y0, x1, y1;
161 fgLineSeg2D( GLfloat a = 0, GLfloat b =0, GLfloat c = 0, GLfloat d =0 )
162 : x0(a), y0(b), x1(c), y1(d) {}
164 fgLineSeg2D( const fgLineSeg2D & image )
165 : x0(image.x0), y0(image.y0), x1(image.x1), y1(image.y1) {}
167 fgLineSeg2D& operator= ( const fgLineSeg2D & image ) { // seems unused
168 x0 = image.x0; y0 = image.y0; x1 = image.x1; y1 = image.y1; return *this;
178 class DrawLineSeg2D {
180 void operator() (const fgLineSeg2D& elem) const {
186 #define USE_HUD_TextList
187 extern fntTexFont *HUD_Font;
188 extern float HUD_TextSize;
189 extern fntRenderer *HUDtext;
190 extern float HUD_matrix[16];
200 fgText(float x, float y, const string& c, bool digits=false): x(x), y(y), msg( c), digit( digits) {};
202 fgText( const fgText & image )
203 : x(image.x), y(image.y), msg(image.msg), digit(image.digit) { }
205 fgText& operator = ( const fgText & image ) {
206 x = image.x; y = image.y; msg= image.msg; digit = image.digit;
210 static int getStringWidth ( const char *str )
212 if ( HUDtext && str ) {
214 HUD_Font->getBBox ( str, HUD_TextSize, 0, &l, &r, NULL, NULL ) ;
215 return float_to_int( r - l );
222 if ( HUDtext && msg != "") {
224 HUD_Font->getBBox ( msg.c_str(), HUD_TextSize, 0, &l, &r, NULL, NULL ) ;
225 return float_to_int( r - l );
230 // this code is changed to display Numbers with big/small digits
231 // according to MIL Standards for example Altitude above 10000 ft
232 // is shown as 10ooo.
234 void Draw(fntRenderer *fnt) {
241 //if negative value then increase the c and p values
246 for (string::size_type i = 0; i < msg.size(); i++) {
247 if ((msg[i]>='0') && (msg[i]<='9'))
250 float orig_size = fnt->getPointSize();
252 fnt->setPointSize(HUD_TextSize * 0.8);
253 int p2=(c-3)*8; //advance to the last 3 digits
255 fnt->start2f(x+p2,y);
256 fnt->puts(msg.c_str() + c - 3); // display last 3 digits
258 fnt->setPointSize(HUD_TextSize * 1.2);
261 fnt->puts(msg.substr(0,c-3).c_str());
263 fnt->setPointSize(HUD_TextSize * 1.2);
264 fnt->start2f( x, y );
265 fnt->puts(msg.c_str());
267 fnt->setPointSize(orig_size);
270 fnt->start2f( x, y );
271 fnt->puts( msg.c_str()) ;
277 guiFnt.drawString( msg.c_str(), float_to_int(x), float_to_int(y) );
282 vector < fgLineSeg2D > List;
284 fgLineList( void ) {}
285 void add( const fgLineSeg2D& seg ) { List.push_back(seg); }
286 void erase( void ) { List.clear();}
289 for_each( List.begin(), List.end(), DrawLineSeg2D());
296 vector< fgText > List;
298 fgTextList ( void ) { Font = 0; }
300 void setFont( fntRenderer *Renderer ) { Font = Renderer; }
301 void add( const fgText& String ) { List.push_back(String); }
302 void erase( void ) { List.clear(); }
307 inline void Text( fgTextList &List, float x, float y, char *s)
309 List.add( fgText( x, y, s) );
312 inline void Text( fgTextList &List, const fgText &me)
317 inline void Line( fgLineList &List, float x1, float y1, float x2, float y2)
319 List.add(fgLineSeg2D(x1,y1,x2,y2));
323 // Declare our externals
324 extern fgTextList HUD_TextList;
325 extern fgLineList HUD_LineList;
326 extern fgLineList HUD_StippleLineList;
329 class instr_item : public SGReferenced { // An Abstract Base Class (ABC)
331 static UINT instances; // More than 64K instruments? Nah!
332 static int brightness;
333 static glRGBTRIPLE color;
336 RECT scrn_pos; // Framing - affects scale dimensions
337 // and orientation. Vert vs Horz, etc.
338 FLTFNPTR load_value_fn;
339 float disp_factor; // Multiply by to get numbers shown on scale.
343 UINT scr_span; // Working values for draw;
352 FLTFNPTR data_source,
358 virtual ~instr_item ();
360 void set_data_source ( FLTFNPTR fn ) { load_value_fn = fn; }
361 int get_brightness ( void ) { return brightness;}
362 RECT get_location ( void ) { return scrn_pos; }
363 bool is_broken ( void ) { return broken; }
364 bool enabled ( void ) { return is_enabled;}
365 bool data_available ( void ) { return !!load_value_fn; }
366 float get_value ( void ) { return load_value_fn(); }
367 float data_scaling ( void ) { return disp_factor; }
368 UINT get_span ( void ) { return scr_span; }
369 POINT get_centroid ( void ) { return mid_span; }
370 UINT get_options ( void ) { return opts; }
371 int get_digits ( void ) { return digits; }
372 inline int get_x() const { return scrn_pos.left; }
373 inline int get_y() const { return scrn_pos.top; }
374 inline int get_width() const { return scrn_pos.right; }
375 inline int get_height() const { return scrn_pos.bottom; }
377 UINT huds_vert (UINT options) { return (options & HUDS_VERT); }
378 UINT huds_left (UINT options) { return (options & HUDS_LEFT); }
379 UINT huds_right (UINT options) { return (options & HUDS_RIGHT); }
380 UINT huds_both (UINT options) {
381 return ((options & HUDS_BOTH) == HUDS_BOTH);
383 UINT huds_noticks (UINT options) { return (options & HUDS_NOTICKS); }
384 UINT huds_notext (UINT options) { return (options & HUDS_NOTEXT); }
385 UINT huds_top (UINT options) { return (options & HUDS_TOP); }
386 UINT huds_bottom (UINT options) { return (options & HUDS_BOTTOM); }
388 virtual void display_enable( bool working ) { is_enabled = working;}
390 virtual void break_display ( bool bad );
391 virtual void SetBrightness( int illumination_level ); // fgHUDSetBright...
392 void SetPosition ( int x, int y, UINT width, UINT height );
393 UINT get_Handle( void );
394 virtual void draw( void ) = 0; // Required method in derived classes
396 void drawOneLine( float x1, float y1, float x2, float y2)
398 HUD_LineList.add(fgLineSeg2D(x1,y1,x2,y2));
400 void drawOneStippleLine( float x1, float y1, float x2, float y2)
402 HUD_StippleLineList.add(fgLineSeg2D(x1,y1,x2,y2));
404 void TextString( char *msg, float x, float y, bool digit )
406 HUD_TextList.add(fgText(x, y, msg,digit));
408 int getStringWidth ( char *str )
410 if ( HUDtext && str ) {
412 HUD_Font->getBBox ( str, HUD_TextSize, 0, &l, &r, NULL, NULL ) ;
413 return float_to_int( r - l );
422 typedef instr_item *HIptr;
426 void operator() (HIptr elem) const {
427 if ( elem->enabled())
433 extern int HUD_style;
435 // instr_item This class has no other purpose than to maintain
436 // a linked list of instrument and derived class
440 class instr_label : public instr_item {
447 string format_buffer;
451 SGPropertyNode_ptr lon_node;
452 SGPropertyNode_ptr lat_node;
455 instr_label(const SGPropertyNode *);
456 virtual void draw(void);
461 // fgRunway_instr This class is responsible for rendering the active runway
462 // in the hud (if visible).
463 class runway_instr : public instr_item {
465 void boundPoint(const sgdVec3& v, sgdVec3& m);
466 bool boundOutsidePoints(sgdVec3& v, sgdVec3& m);
467 bool drawLine(const sgdVec3& a1, const sgdVec3& a2,
468 const sgdVec3& p1, const sgdVec3& p2);
470 FGRunway* get_active_runway();
471 void get_rwy_points(sgdVec3 *points);
472 void setLineWidth(void);
474 sgdVec3 points3d[6], points2d[6];
475 double mm[16],pm[16], arrowScale, arrowRad, lnScale;
476 double scaleDist, default_pitch, default_heading;
479 FGViewer* cockpit_view;
480 unsigned short stippleOut, stippleCen;
481 bool drawIA, drawIAAlways;
486 runway_instr(const SGPropertyNode *);
488 virtual void draw( void );
489 void setArrowRotationRadius(double radius);
490 // Scales the runway indication arrow
491 void setArrowScale(double scale);
492 // Draws arrow when runway is not visible in HUD if draw=true
493 void setDrawArrow(bool draw);
494 // Always draws arrow if draw=true;
495 void setDrawArrowAlways(bool draw);
496 // Sets the maximum line scale
497 void setLineScale(double scale);
498 // Sets the distance where to start scaling the lines
499 void setScaleDist(double dist_nm);
500 // Sets the stipple pattern of the outline of the runway
501 void setStippleOutline(unsigned short stipple);
502 // Sets the stipple patter of the center line of the runway
503 void setStippleCenterline(unsigned short stipple);
508 // instr_scale This class is an abstract base class for both moving
509 // scale and moving needle (fixed scale) indicators. It
510 // does not draw itself, but is not instanciable.
513 class instr_scale : public instr_item {
515 float range_shown; // Width Units.
516 float Maximum_value; // ceiling.
517 float Minimum_value; // Representation floor.
518 float scale_factor; // factor => screen units/range values.
519 UINT Maj_div; // major division marker units
520 UINT Min_div; // minor division marker units
521 UINT Modulo; // Roll over point
522 int signif_digits; // digits to show to the right.
539 bool working = true);
541 virtual void draw ( void ) {}; // No-op here. Defined in derived classes.
542 UINT div_min ( void ) { return Min_div;}
543 UINT div_max ( void ) { return Maj_div;}
544 float min_val ( void ) { return Minimum_value;}
545 float max_val ( void ) { return Maximum_value;}
546 UINT modulo ( void ) { return Modulo; }
547 float factor ( void ) { return scale_factor;}
548 float range_to_show ( void ) { return range_shown;}
551 // hud_card This class displays the indicated quantity on
552 // a scale that moves past the pointer. It may be
553 // horizontal or vertical, read above(left) or below(right) of the base
556 class hud_card : public instr_scale {
560 float half_width_units;
561 bool draw_tick_bottom;
563 bool draw_tick_right;
565 bool draw_cap_bottom;
583 hud_card(const SGPropertyNode *);
584 // virtual void display_enable( bool setting ); // FIXME
585 virtual void draw(void);
586 void circles(float, float, float);
587 void fixed(float, float, float, float, float, float);
588 void zoomed_scale(int, int);
592 class gauge_instr : public instr_scale {
594 gauge_instr(const SGPropertyNode *);
595 virtual void draw( void ); // Required method in base class
600 // dual_instr_item This class was created to form the base class
601 // for both panel and HUD Turn Bank Indicators.
603 class dual_instr_item : public instr_item {
605 FLTFNPTR alt_data_source;
608 dual_instr_item ( int x,
612 FLTFNPTR chn1_source,
613 FLTFNPTR chn2_source,
617 float current_ch1( void ) { return (float)alt_data_source(); }
618 float current_ch2( void ) { return (float)get_value(); }
619 virtual void draw( void ) {}
623 class fgTBI_instr : public dual_instr_item {
632 fgTBI_instr(const SGPropertyNode *);
634 UINT bank_limit(void) { return BankLimit; }
635 UINT slew_limit(void) { return SlewLimit; }
637 virtual void draw(void);
641 class HudLadder : public dual_instr_item {
651 string hudladder_type;
654 bool velocity_vector;
658 bool climb_dive_marker;
659 bool glide_slope_marker;
662 bool waypoint_marker;
667 // The Ladder has it's own temporary display lists
670 fgLineList StippleLineList;
673 HudLadder(const SGPropertyNode *);
675 virtual void draw(void);
676 void drawZenith(float, float, float);
677 void drawNadir(float, float, float);
679 void Text(float x, float y, char *s)
681 TextList.add(fgText(x, y, s));
684 void Line(float x1, float y1, float x2, float y2)
686 LineList.add(fgLineSeg2D(x1, y1, x2, y2));
689 void StippleLine(float x1, float y1, float x2, float y2)
691 StippleLineList.add(fgLineSeg2D(x1, y1, x2, y2));
696 extern int fgHUDInit();
697 extern int fgHUDInit2();
698 extern void fgUpdateHUD( osg::State* );
699 extern void fgUpdateHUD( osg::State*, GLfloat x_start, GLfloat y_start,
700 GLfloat x_end, GLfloat y_end );
705 class HUD_Properties : public SGPropertyChangeListener {
708 void valueChanged(SGPropertyNode *n);
709 void setColor() const;
710 bool isVisible() const { return _visible; }
711 bool isAntialiased() const { return _antialiased; }
712 bool isTransparent() const { return _transparent; }
713 float alphaClamp() const { return _cl; }
716 float clamp(float f) { return f < 0.0f ? 0.0f : f > 1.0f ? 1.0f : f; }
717 SGPropertyNode_ptr _current;
718 SGPropertyNode_ptr _visibility;
719 SGPropertyNode_ptr _antialiasing;
720 SGPropertyNode_ptr _transparency;
721 SGPropertyNode_ptr _red, _green, _blue, _alpha;
722 SGPropertyNode_ptr _alpha_clamp;
723 SGPropertyNode_ptr _brightness;
727 float _r, _g, _b, _a, _cl;