src/Cockpit/hud.hxx

   1 // hud.hxx -- hud defines and prototypes (initial draft)
   2 //
   3 // Written by Michele America, started September 1997.
   4 //
   5 // Copyright (C) 1997  Michele F. America  - nomimarketing@mail.telepac.pt
   6 //
   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.
  11 //
  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.
  16 //
  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.
  20 //
  21 // $Id$
  22
  23
  24 #ifndef _HUD_HXX
  25 #define _HUD_HXX
  26
  27 #ifndef __cplusplus
  28 # error This library requires C++
  29 #endif
  30
  31 #include <simgear/compiler.h>
  32
  33 #ifdef HAVE_CONFIG_H
  34 #  include <config.h>
  35 #endif
  36
  37 #ifdef HAVE_WINDOWS_H
  38 #  include <windows.h>
  39 #endif
  40
  41 #include <stdlib.h>
  42 #include <string.h>
  43
  44 //#ifdef HAVE_VALUES_H
  45 //#  include <values.h>  // for MAXINT
  46 //#endif
  47
  48 #include <algorithm>    // for_each()
  49 #include <vector>       // STL vector
  50 #include <deque>        // STL double ended queue
  51 #include STL_FSTREAM
  52
  53 #include <simgear/constants.h>
  54
  55 #include <Include/fg_typedefs.h>
  56 #include <Aircraft/aircraft.hxx>
  57 #include <Aircraft/controls.hxx>
  58 #include <FDM/flight.hxx>
  59 #include <GUI/gui.h>
  60 #include <Main/globals.hxx>
  61 #include <Main/viewmgr.hxx>
  62 #include <Airports/runways.hxx>
  63
  64 #include "hud_opts.hxx"
  65 #include <plib/sg.h>
  66
  67 SG_USING_STD(deque);
  68 SG_USING_STD(vector);
  69 SG_USING_NAMESPACE(std);
  70
  71
  72 // some of Norman's crazy optimizations. :-)
  73
  74 #ifndef WIN32
  75 typedef struct {
  76     int x, y;
  77 } POINT;
  78
  79 typedef struct {
  80     int top, bottom, left, right;
  81 } RECT;
  82 #endif
  83
  84 // View mode definitions
  85
  86 enum VIEW_MODES{ HUD_VIEW, PANEL_VIEW, CHASE_VIEW, TOWER_VIEW };
  87
  88 // Label constants
  89 #define HUD_FONT_SMALL     1
  90 #define HUD_FONT_LARGE     2
  91
  92 enum fgLabelJust{ LEFT_JUST, CENTER_JUST, RIGHT_JUST } ;
  93
  94 #define HUDS_AUTOTICKS           0x0001
  95 #define HUDS_VERT                0x0002
  96 #define HUDS_HORZ                0x0000
  97 #define HUDS_TOP                 0x0004
  98 #define HUDS_BOTTOM              0x0008
  99 #define HUDS_LEFT     HUDS_TOP
 100 #define HUDS_RIGHT    HUDS_BOTTOM
 101 #define HUDS_BOTH     (HUDS_LEFT | HUDS_RIGHT)
 102 #define HUDS_NOTICKS             0x0010
 103 #define HUDS_ARITHTIC            0x0020
 104 #define HUDS_DECITICS            0x0040
 105 #define HUDS_NOTEXT              0x0080
 106
 107 // Ladder orientaion
 108 // #define HUD_VERTICAL        1
 109 // #define HUD_HORIZONTAL       2
 110 // #define HUD_FREEFLOAT        3
 111
 112 // Ladder orientation modes
 113 // #define HUD_LEFT         1
 114 // #define HUD_RIGHT            2
 115 // #define HUD_TOP              1
 116 // #define HUD_BOTTOM           2
 117 // #define HUD_V_LEFT           1
 118 // #define HUD_V_RIGHT          2
 119 // #define HUD_H_TOP            1
 120 // #define HUD_H_BOTTOM         2
 121
 122
 123 // Ladder sub-types
 124 // #define HUD_LIM              1
 125 // #define HUD_NOLIM            2
 126 // #define HUD_CIRC         3
 127
 128 // #define HUD_INSTR_LADDER 1
 129 // #define HUD_INSTR_CLADDER    2
 130 // #define HUD_INSTR_HORIZON    3
 131 // #define HUD_INSTR_LABEL      4
 132
 133 // in cockpit.cxx
 134 extern float get_throttleval ( void );
 135 extern float get_aileronval  ( void );
 136 extern float get_elevatorval ( void );
 137 extern float get_elev_trimval( void );
 138 extern float get_rudderval   ( void );
 139 extern float get_speed       ( void );
 140 extern float get_aoa         ( void );
 141 extern float get_nlf         ( void );
 142 extern float get_roll        ( void );
 143 extern float get_pitch       ( void );
 144 extern float get_heading     ( void );
 145 extern float get_view_direction( void );
 146 extern float get_altitude    ( void );
 147 extern float get_agl         ( void );
 148 extern float get_sideslip    ( void );
 149 extern float get_frame_rate  ( void );
 150 extern float get_latitude    ( void );
 151 extern float get_lat_min     ( void );
 152 extern float get_longitude   ( void );
 153 extern float get_long_min    ( void );
 154 extern float get_fov         ( void );
 155 extern float get_vfc_ratio   ( void );
 156 extern float get_vfc_tris_drawn   ( void );
 157 extern float get_vfc_tris_culled   ( void );
 158 extern float get_climb_rate  ( void );
 159 extern float get_mach( void );
 160 extern char *coord_format_lat(float);
 161 extern char *coord_format_lon(float);
 162 //extern char *coord_format_latlon(float latitude, float longitude);  // cockpit.cxx
 163
 164 // $$$ begin - added, VS Renganathan, 13 Oct 2K
 165 // #define FIGHTER_HUD
 166 extern float get_anzg (void);
 167 extern float get_Vx (void);
 168 extern float get_Vy (void);
 169 extern float get_Vz (void);
 170 extern float get_Ax (void);
 171 extern float get_Ay (void);
 172 extern float get_Az (void);
 173 extern int get_iaux1 (void);
 174 extern int get_iaux2 (void);
 175 extern int get_iaux3 (void);
 176 extern int get_iaux4 (void);
 177 extern int get_iaux5 (void);
 178 extern int get_iaux6 (void);
 179 extern int get_iaux7 (void);
 180 extern int get_iaux8 (void);
 181 extern int get_iaux9 (void);
 182 extern int get_iaux10 (void);
 183 extern int get_iaux11 (void);
 184 extern int get_iaux12 (void);
 185 extern float get_aux1(void);
 186 extern float get_aux2(void);
 187 extern float get_aux3(void);
 188 extern float get_aux4(void);
 189 extern float get_aux5 (void);
 190 extern float get_aux6 (void);
 191 extern float get_aux7 (void);
 192 extern float get_aux8(void);
 193 extern float get_aux9(void);
 194 extern float get_aux10(void);
 195 extern float get_aux11(void);
 196 extern float get_aux12(void);
 197 extern float get_aux13(void);
 198 extern float get_aux14(void);
 199 extern float get_aux15(void);
 200 extern float get_aux16(void);
 201 extern float get_aux17(void);
 202 extern float get_aux18(void);
 203 // $$$ end - added, VS Renganathan, 13 Oct 2K
 204
 205 extern char *get_formated_gmt_time( void );
 206 extern void fgHUDReshape(void);
 207
 208 enum  hudinstype{ HUDno_instr,
 209                   HUDscale,
 210                   HUDlabel,
 211                   HUDladder,
 212                   HUDcirc_ladder,
 213                   HUDhorizon,
 214                   HUDgauge,
 215                   HUDdual_inst,
 216                   HUDmoving_scale,
 217                   HUDtbi
 218 };
 219
 220 typedef struct gltagRGBTRIPLE { // rgbt
 221     GLfloat Blue;
 222     GLfloat Green;
 223     GLfloat Red;
 224 } glRGBTRIPLE;
 225
 226 class fgLineSeg2D {
 227 private:
 228     GLfloat x0, y0, x1, y1;
 229
 230 public:
 231     fgLineSeg2D( GLfloat a = 0, GLfloat b =0, GLfloat c = 0, GLfloat d =0 )
 232         : x0(a), y0(b),  x1(c), y1(d) {}
 233
 234     fgLineSeg2D( const fgLineSeg2D & image )
 235         : x0(image.x0), y0(image.y0), x1(image.x1), y1(image.y1) {}
 236
 237     fgLineSeg2D& operator= ( const fgLineSeg2D & image ) {
 238         x0 = image.x0; y0 = image.y0; x1 = image.x1; y1 = image.y1; return *this;
 239     }
 240
 241     ~fgLineSeg2D() {}
 242
 243     void draw() const
 244     {
 245         glVertex2f(x0, y0);
 246         glVertex2f(x1, y1);
 247     }
 248 };
 249
 250 class DrawLineSeg2D {
 251     public:
 252         void operator() (const fgLineSeg2D& elem) const {
 253             elem.draw();
 254         }
 255 };
 256
 257
 258 #define USE_HUD_TextList
 259 extern fntTexFont        *HUD_Font;
 260 extern float              HUD_TextSize;
 261 extern fntRenderer       *HUDtext;
 262 extern float HUD_matrix[16];
 263
 264 class fgText {
 265 private:
 266     float x, y;
 267     char msg[64];
 268 public:
 269     int digit; //suma
 270     fgText(float x = 0, float y = 0, char *c = NULL,int digits=0): x(x), y(y) //suma
 271     {
 272         strcpy(msg,c);
 273         digit=digits; //suma
 274     }
 275
 276     fgText( const fgText & image )
 277         : x(image.x), y(image.y),digit(image.digit) { strcpy(msg,image.msg); } //suma
 278
 279     fgText& operator = ( const fgText & image ) {
 280         strcpy(msg,image.msg); x = image.x; y = image.y;digit=image.digit; //suma
 281         return *this;
 282     }
 283
 284     ~fgText() { msg[0]='\0'; }
 285
 286     int getStringWidth ( char *str )
 287     {
 288         if ( HUDtext && str ) {
 289             float r, l ;
 290             HUD_Font->getBBox ( str, HUD_TextSize, 0, &l, &r, NULL, NULL ) ;
 291             return FloatToInt( r - l );
 292         }
 293         return 0 ;
 294     }
 295
 296     int StringWidth (void )
 297     {
 298         if ( HUDtext && strlen( msg )) {
 299             float r, l ;
 300             HUD_Font->getBBox ( msg, HUD_TextSize, 0, &l, &r, NULL, NULL ) ;
 301             return FloatToInt( r - l );
 302         }
 303         return 0 ;
 304     }
 305
 306     // this code is changed to display Numbers with big/small digits
 307     // according to MIL Standards for example Altitude above 10000 ft
 308     // is shown as 10ooo.  begin suma
 309
 310     void Draw(fntRenderer *fnt,int digits) {
 311         if(digits==1) {
 312             int c=0,i=0;
 313             char *t=msg;
 314             int p=4;
 315
 316             if(t[0]=='-') {
 317                 //if negative value then increase the c and p values
 318                 //for '-' sign.  c++;
 319                 p++;
 320             }
 321             char *tmp=msg;
 322             while(tmp[i]!='\0') {
 323                 if((tmp[i]>='0') && (tmp[i]<='9'))
 324                     c++;
 325                 i++;
 326             }
 327             if(c>p) {
 328                 fnt->setPointSize(HUD_TextSize * 0.8);
 329                 int p1=c-3;
 330                 char *tmp1=msg+p1;
 331                 int p2=p1*8;
 332
 333                 fnt->start2f(x+p2,y);
 334                 fnt->puts(tmp1);
 335
 336                 fnt->setPointSize(HUD_TextSize * 1.2);
 337                 char tmp2[64];
 338                 strncpy(tmp2,msg,p1);
 339                 tmp2[p1]='\0';
 340
 341                 fnt->start2f(x,y);
 342                 fnt->puts(tmp2);
 343             } else {
 344                 fnt->setPointSize(HUD_TextSize * 1.2);
 345                 fnt->start2f( x, y );
 346                 fnt->puts(tmp);
 347             }
 348         } else {
 349             //if digits not equal to 1
 350             fnt->setPointSize(HUD_TextSize * 0.8);
 351             fnt->start2f( x, y );
 352             fnt->puts( msg ) ;
 353         }
 354     }
 355     //end suma
 356
 357     void Draw()
 358     {
 359         guiFnt.drawString( msg, FloatToInt(x), FloatToInt(y) );
 360     }
 361 };
 362
 363 class fgLineList {
 364     vector < fgLineSeg2D > List;
 365 public:
 366     fgLineList( void ) {}
 367     ~fgLineList( void ) {}
 368     void add( const fgLineSeg2D& seg ) { List.push_back(seg); }
 369     void erase( void ) { List.erase( List.begin(), List.end() ); }
 370     void draw( void ) {
 371         glBegin(GL_LINES);
 372         for_each( List.begin(), List.end(), DrawLineSeg2D());
 373         glEnd();
 374     }
 375 };
 376
 377 class fgTextList {
 378     fntRenderer *Font;
 379     vector< fgText > List;
 380 public:
 381     fgTextList ( void ) { Font = 0; }
 382     ~fgTextList( void ) {}
 383
 384     void setFont( fntRenderer *Renderer ) { Font = Renderer; }
 385     void add( const fgText& String ) { List.push_back(String); }
 386     void erase( void ) { List.erase( List.begin(), List.end() ); }
 387     void draw( void );
 388 };
 389
 390
 391 inline void Text( fgTextList &List, float x, float y, char *s)
 392 {
 393     List.add( fgText( x, y, s) );
 394 }
 395
 396 inline void Text( fgTextList &List, const fgText &me)
 397 {
 398     List.add(me);
 399 }
 400
 401 inline void Line( fgLineList &List, float x1, float y1, float x2, float y2)
 402 {
 403     List.add(fgLineSeg2D(x1,y1,x2,y2));
 404 }
 405
 406
 407 // Declare our externals
 408 extern fgTextList         HUD_TextList;
 409 extern fgLineList         HUD_LineList;
 410 extern fgLineList         HUD_StippleLineList;
 411
 412
 413 class instr_item {  // An Abstract Base Class (ABC)
 414 private:
 415     static UINT        instances;     // More than 64K instruments? Nah!
 416     static int         brightness;
 417     static glRGBTRIPLE color;
 418
 419     UINT               handle;
 420     RECT               scrn_pos;      // Framing - affects scale dimensions
 421                                       // and orientation. Vert vs Horz, etc.
 422     FLTFNPTR           load_value_fn;
 423     float              disp_factor;   // Multiply by to get numbers shown on scale.
 424     UINT               opts;
 425     bool               is_enabled;
 426     bool               broken;
 427     UINT               scr_span;      // Working values for draw;
 428     POINT              mid_span;      //
 429     int                digits;        //suma
 430
 431 public:
 432     instr_item( int            x,
 433                 int            y,
 434                 UINT           height,
 435                 UINT           width,
 436                 FLTFNPTR       data_source,
 437                 float          data_scaling,
 438                 UINT           options,
 439                 bool           working  = true,
 440                 int            digit = 0); //suma
 441
 442     instr_item( const instr_item & image );
 443
 444     virtual ~instr_item ();
 445
 446     int     get_brightness  ( void ) { return brightness;}
 447     RECT    get_location    ( void ) { return scrn_pos;  }
 448     bool    is_broken       ( void ) { return broken;    }
 449     bool    enabled         ( void ) { return is_enabled;}
 450     bool    data_available  ( void ) { return !!load_value_fn; }
 451     float   get_value       ( void ) { return load_value_fn(); }
 452     float   data_scaling    ( void ) { return disp_factor; }
 453     UINT    get_span        ( void ) { return scr_span;  }
 454     POINT   get_centroid    ( void ) { return mid_span;  }
 455     UINT    get_options     ( void ) { return opts;      }
 456     int     get_digits      ( void ) { return digits;         } //suma
 457
 458     UINT    huds_vert     (UINT options) { return( options  & HUDS_VERT ); }
 459     UINT    huds_left     (UINT options) { return( options  & HUDS_LEFT ); }
 460     UINT    huds_right    (UINT options) { return( options  & HUDS_RIGHT ); }
 461     UINT    huds_both     (UINT options) {
 462         return( (options & HUDS_BOTH) == HUDS_BOTH );
 463     }
 464     UINT    huds_noticks  (UINT options) { return( options  & HUDS_NOTICKS ); }
 465     UINT    huds_notext   (UINT options) { return( options  & HUDS_NOTEXT ); }
 466     UINT    huds_top      (UINT options) { return( options  & HUDS_TOP ); }
 467     UINT    huds_bottom   (UINT options) { return( options  & HUDS_BOTTOM ); }
 468
 469     virtual void display_enable( bool working ) { is_enabled = !! working;}
 470
 471     virtual void update( void );
 472     virtual void break_display ( bool bad );
 473     virtual void SetBrightness( int illumination_level ); // fgHUDSetBright...
 474     void         SetPosition  ( int x, int y, UINT width, UINT height );
 475     UINT         get_Handle( void );
 476     virtual void draw( void ) = 0;   // Required method in derived classes
 477
 478     void drawOneLine( float x1, float y1, float x2, float y2)
 479     {
 480         HUD_LineList.add(fgLineSeg2D(x1,y1,x2,y2));
 481     }
 482     void drawOneStippleLine( float x1, float y1, float x2, float y2)
 483     {
 484         HUD_StippleLineList.add(fgLineSeg2D(x1,y1,x2,y2));
 485     }
 486     void TextString( char *msg, float x, float y,int digit ) //suma
 487     {
 488         HUD_TextList.add(fgText(x, y, msg,digit)); //suma
 489     }
 490     int getStringWidth ( char *str )
 491     {
 492         if ( HUDtext && str ) {
 493             float r, l ;
 494             HUD_Font->getBBox ( str, HUD_TextSize, 0, &l, &r, NULL, NULL ) ;
 495             return FloatToInt( r - l );
 496         }
 497         return 0 ;
 498     }
 499
 500     //code to draw ticks as small circles
 501     void drawOneCircle(float x1, float y1, float r)
 502     {
 503         glBegin(GL_LINE_LOOP);  // Use polygon to approximate a circle
 504         for(int count=0; count<25; count++) {
 505             float cosine = r * cos(count * 2 * SG_PI/10.0);
 506             float sine =   r * sin(count * 2 * SG_PI/10.0);
 507             glVertex2f(cosine+x1, sine+y1);
 508         }
 509         glEnd();
 510     }
 511
 512 };
 513
 514 typedef instr_item *HIptr;
 515
 516 class HUDdraw {
 517     public:
 518         void operator() (HIptr elem) const {
 519             if( elem->enabled())
 520                 elem->draw();
 521         }
 522 };
 523
 524 //typedef deque <  instr_item * > hud_deque_type;
 525 //typedef hud_deque_type::iterator hud_deque_iterator;
 526 //typedef hud_deque_type::const_iterator hud_deque_const_iterator;
 527
 528 extern deque< instr_item *> HUD_deque;
 529 extern int HUD_style;
 530 //extern hud_deque_type HUD_deque;
 531
 532 // instr_item           This class has no other purpose than to maintain
 533 //                      a linked list of instrument and derived class
 534 // object pointers.
 535
 536
 537 class instr_label : public instr_item {
 538 private:
 539     const char *pformat;
 540     const char *pre_str;
 541     const char *post_str;
 542     fgLabelJust justify;
 543     int         fontSize;
 544     int         blink;
 545     char format_buffer[80];
 546     bool        lat;
 547     bool        lon;
 548     bool        lbox;
 549
 550 public:
 551     instr_label( int          x,
 552                  int          y,
 553                  UINT         width,
 554                  UINT         height,
 555                  FLTFNPTR     data_source,
 556                  const char  *label_format,
 557                  const char  *pre_label_string,
 558                  const char  *post_label_string,
 559                  float        scale_data,
 560                  UINT         options,
 561                  fgLabelJust  justification,
 562                  int          font_size,
 563                  int          blinking,
 564                  bool         latitude,
 565                  bool         longitude,
 566                  bool         label_box,
 567                  bool         working,
 568                  int          digit ); //suma);
 569
 570     ~instr_label();
 571
 572     instr_label( const instr_label & image);
 573     virtual void draw( void );       // Required method in base class
 574 };
 575
 576 typedef instr_label * pInstlabel;
 577
 578
 579 class lat_label : public instr_item {
 580 private:
 581     const char *pformat;
 582     const char *pre_str;
 583     const char *post_str;
 584     fgLabelJust justify;
 585     int         fontSize;
 586     int         blink;
 587     char format_buffer[80];
 588
 589 public:
 590     lat_label( int          x,
 591                int          y,
 592                UINT         width,
 593                UINT         height,
 594                FLTFNPTR     data_source,
 595                const char  *label_format,
 596                const char  *pre_label_string,
 597                const char  *post_label_string,
 598                float        scale_data,
 599                UINT         options,
 600                fgLabelJust  justification,
 601                int          font_size,
 602                int          blinking,
 603                bool         working,
 604                int          digits =0 );//suma
 605
 606     ~lat_label();
 607
 608     lat_label( const lat_label & image);
 609     virtual void draw( void );       // Required method in base class
 610 };
 611
 612 typedef lat_label * pLatlabel;
 613
 614 class lon_label : public instr_item {
 615 private:
 616     const char *pformat;
 617     const char *pre_str;
 618     const char *post_str;
 619     fgLabelJust justify;
 620     int         fontSize;
 621     int         blink;
 622     char format_buffer[80];
 623
 624 public:
 625     lon_label( int          x,
 626                int          y,
 627                UINT         width,
 628                UINT         height,
 629                FLTFNPTR     data_source,
 630                const char  *label_format,
 631                const char  *pre_label_string,
 632                const char  *post_label_string,
 633                float        scale_data,
 634                UINT         options,
 635                fgLabelJust  justification,
 636                int          font_size,
 637                int          blinking,
 638                bool         working,
 639                int          digit=0); //suma
 640
 641
 642     ~lon_label();
 643
 644     lon_label( const lon_label & image);
 645     virtual void draw( void );       // Required method in base class
 646 };
 647
 648 typedef lon_label * pLonlabel;
 649
 650 //
 651 // fgRunway_instr        This class is responsible for rendering the active runway
 652 //                        in the hud (if visible).
 653 class runway_instr : public instr_item
 654 {
 655 private:
 656         void boundPoint(const sgdVec3& v, sgdVec3& m);
 657         bool boundOutsidePoints(sgdVec3& v, sgdVec3& m);
 658         bool drawLine(const sgdVec3& a1, const sgdVec3& a2, const sgdVec3& p1, const sgdVec3& p2);
 659         void drawArrow();
 660         bool get_active_runway(FGRunway& rwy);
 661         void get_rwy_points(sgdVec3 *points);
 662         void setLineWidth(void);
 663
 664         sgdVec3 points3d[6],points2d[6];
 665         double mm[16],pm[16], arrowScale, arrowRad, lnScale, scaleDist, default_pitch, default_heading;
 666         GLint view[4];
 667         FGRunway runway;
 668         FGViewer* cockpit_view;
 669         unsigned short stippleOut,stippleCen;
 670         bool drawIA,drawIAAlways;
 671         RECT location;
 672         POINT center;
 673
 674 public:
 675     runway_instr( int    x,
 676                   int    y,
 677                   int    width,
 678                   int    height,
 679                   float  scale_data,
 680                   bool   working = true);
 681
 682     virtual void draw( void );       // Required method in base class
 683         void setArrowRotationRadius(double radius);
 684         void setArrowScale(double scale); // Scales the runway indication arrow
 685         void setDrawArrow(bool draw);         // Draws arrow when runway is not visible in HUD if draw=true
 686         void setDrawArrowAlways(bool draw); //Always draws arrow if draw=true;
 687         void setLineScale(double scale); //Sets the maximum line scale
 688         void setScaleDist(double dist_nm); //Sets the distance where to start scaling the lines
 689         void setStippleOutline(unsigned short stipple); //Sets the stipple pattern of the outline of the runway
 690         void setStippleCenterline(unsigned short stipple); //Sets the stipple patter of the center line of the runway
 691 };
 692
 693
 694 //
 695 // instr_scale           This class is an abstract base class for both moving
 696 //                       scale and moving needle (fixed scale) indicators. It
 697 // does not draw itself, but is not instanciable.
 698 //
 699
 700 class instr_scale : public instr_item {
 701 private:
 702     float range_shown;   // Width Units.
 703     float Maximum_value; //                ceiling.
 704     float Minimum_value; // Representation floor.
 705     float scale_factor;  // factor => screen units/range values.
 706     UINT   Maj_div;       // major division marker units
 707     UINT   Min_div;       // minor division marker units
 708     UINT   Modulo;        // Roll over point
 709     int    signif_digits; // digits to show to the right.
 710
 711 public:
 712     instr_scale( int          x,
 713                  int          y,
 714                  UINT         width,
 715                  UINT         height,
 716                  FLTFNPTR     load_fn,
 717                  UINT         options,
 718                  float        show_range,
 719                  float        max_value,
 720                  float        min_value,
 721                  float        disp_scaling,
 722                  UINT         major_divs,
 723                  UINT         minor_divs,
 724                  UINT         rollover,
 725                  int          dp_showing,
 726                  bool         working = true);
 727
 728     virtual ~instr_scale();
 729     instr_scale( const instr_scale & image);
 730
 731     virtual void draw   ( void ) {}; // No-op here. Defined in derived classes.
 732     UINT   div_min      ( void ) { return Min_div;}
 733     UINT   div_max      ( void ) { return Maj_div;}
 734     float min_val       ( void ) { return Minimum_value;}
 735     float max_val       ( void ) { return Maximum_value;}
 736     UINT   modulo       ( void ) { return Modulo; }
 737     float factor        ( void ) { return scale_factor;}
 738     float range_to_show ( void ) { return range_shown;}
 739 };
 740
 741 // hud_card_               This class displays the indicated quantity on
 742 //                         a scale that moves past the pointer. It may be
 743 // horizontal or vertical, read above(left) or below(right) of the base
 744 // line.
 745
 746 class hud_card : public instr_scale {
 747 private:
 748     float  val_span;
 749     string type;
 750     float  half_width_units;
 751     bool   draw_tick_bottom;
 752     bool   draw_tick_top;
 753     bool   draw_tick_right;
 754     bool   draw_tick_left;
 755     bool   draw_cap_bottom;
 756     bool   draw_cap_top;
 757     bool   draw_cap_right;
 758     bool   draw_cap_left;
 759     float  marker_offset;
 760     bool   pointer;
 761     string pointer_type;
 762     string tick_type;
 763     string tick_length;
 764     float  radius; //suma
 765     float  maxValue; //suma
 766     float  minValue; //suma
 767     int    divisions; //suma
 768     int    zoom; //suma
 769     UINT   Maj_div; //suma
 770     UINT   Min_div; //suma
 771
 772
 773 public:
 774     hud_card( int      x,
 775               int      y,
 776               UINT     width,
 777               UINT     height,
 778               FLTFNPTR load_fn,
 779               UINT     options,
 780               float    maxValue,
 781               float    minValue,
 782               float    disp_scaling,
 783               UINT     major_divs,
 784               UINT     minor_divs,
 785               UINT     modulator,
 786               int      dp_showing,
 787               float    value_span,
 788               string   type,
 789               bool     draw_tick_bottom,
 790               bool     draw_tick_top,
 791               bool     draw_tick_right,
 792               bool     draw_tick_left,
 793               bool     draw_cap_bottom,
 794               bool     draw_cap_top,
 795               bool     draw_cap_right,
 796               bool     draw_cap_left,
 797               float    marker_offset,
 798               bool     pointer,
 799               string   pointer_type,
 800               string  tick_type,
 801               string  tick_length,
 802               bool     working,
 803               float    radius, //suma
 804               int      divisions, //suma
 805               int      zoom //suma
 806             );
 807
 808
 809     ~hud_card();
 810     hud_card( const hud_card & image);
 811     //    virtual void display_enable( bool setting );
 812     virtual void draw( void );       // Required method in base class
 813     void circles(float,float,float); // suma
 814     void fixed(float,float,float,float,float,float); //suma
 815     void zoomed_scale(int,int); //suma
 816 };
 817
 818 typedef hud_card * pCardScale;
 819
 820 class gauge_instr : public instr_scale {
 821 public:
 822     gauge_instr( int       x,
 823                  int       y,
 824                  UINT      width,
 825                  UINT      height,
 826                  FLTFNPTR  load_fn,
 827                  UINT      options,
 828                  float     disp_scaling,
 829                  float     maxValue,
 830                  float     minValue,
 831                  UINT      major_divs,
 832                  UINT      minor_divs,
 833                  int       dp_showing,
 834                  UINT      modulus,
 835                  bool      working);
 836
 837     ~gauge_instr();
 838     gauge_instr( const gauge_instr & image);
 839     virtual void draw( void );       // Required method in base class
 840 };
 841
 842 typedef gauge_instr * pGaugeInst;
 843 //
 844 // dual_instr_item         This class was created to form the base class
 845 //                         for both panel and HUD Turn Bank Indicators.
 846
 847 class dual_instr_item : public instr_item {
 848 private:
 849     FLTFNPTR alt_data_source;
 850
 851 public:
 852     dual_instr_item ( int       x,
 853                       int       y,
 854                       UINT      width,
 855                       UINT      height,
 856                       FLTFNPTR  chn1_source,
 857                       FLTFNPTR  chn2_source,
 858                       bool      working,
 859                       UINT      options );
 860
 861     virtual ~dual_instr_item() {};
 862     dual_instr_item( const dual_instr_item & image);
 863
 864     float current_ch1( void ) { return (float)alt_data_source();}
 865     float current_ch2( void ) { return (float)get_value();}
 866     virtual void draw( void ) { }
 867 };
 868
 869 class fgTBI_instr : public dual_instr_item
 870 {
 871 private:
 872     UINT BankLimit;
 873     UINT SlewLimit;
 874     UINT scr_hole;
 875     bool tsi;  //suma
 876     float rad; //suma
 877
 878 public:
 879     fgTBI_instr( int       x,
 880                  int       y,
 881                  UINT      width,
 882                  UINT      height,
 883                  FLTFNPTR  chn1_source,
 884                  FLTFNPTR  chn2_source,
 885                  float     maxBankAngle,
 886                  float     maxSlipAngle,
 887                  UINT      gap_width,
 888                  bool      working,
 889                  bool      tsi, //suma
 890                  float     rad); //suma
 891
 892     fgTBI_instr( const fgTBI_instr & image);
 893
 894     ~fgTBI_instr();
 895
 896     UINT bank_limit( void ) { return BankLimit;}
 897     UINT slew_limit( void ) { return SlewLimit;}
 898
 899     virtual void draw( void );       // Required method in base class
 900 };
 901
 902 typedef fgTBI_instr * pTBI;
 903
 904 class HudLadder : public dual_instr_item {
 905 private:
 906     UINT   width_units;
 907     int    div_units;
 908     UINT   minor_div;
 909     UINT   label_pos;
 910     UINT   scr_hole;
 911     float  vmax;
 912     float  vmin;
 913     float  factor;
 914     string hudladder_type;
 915     bool   frl;
 916     bool   target_spot;
 917     bool   velocity_vector;
 918     bool   drift_marker;
 919     bool   alpha_bracket;
 920     bool   energy_marker;
 921     bool   climb_dive_marker;
 922     bool   glide_slope_marker;
 923     float  glide_slope;
 924     bool   energy_worm;
 925     bool   waypoint_marker;
 926     int    zenith; //suma
 927     int    nadir; //suma
 928     int    hat; //suma
 929
 930
 931     // The Ladder has it's own temporary display lists
 932     fgTextList         TextList;
 933     fgLineList         LineList;
 934     fgLineList         StippleLineList;
 935
 936 public:
 937     HudLadder( const string&    name,
 938                int       x,
 939                int       y,
 940                UINT      width,
 941                UINT      height,
 942                float     factor,
 943                FLTFNPTR  ptch_source,
 944                FLTFNPTR  roll_source,
 945                float     span_units,
 946                float     division_units,
 947                float     minor_division,
 948                UINT      screen_hole,
 949                UINT      lbl_pos,
 950                bool      frl,
 951                bool      target_spot,
 952                bool      velocity_vector,
 953                bool      drift_marker,
 954                bool      alpha_bracket,
 955                bool      energy_marker,
 956                bool      climb_dive_marker,
 957                bool      glide_slope_marker,
 958                float     glide_slope,
 959                bool      energy_worm,
 960                bool      waypoint_marker,
 961                bool      working,
 962                int       zenith, //suma
 963                int       nadir, //suma
 964                int       hat
 965              ); //suma
 966
 967
 968     ~HudLadder();
 969
 970     HudLadder( const HudLadder & image );
 971     virtual void draw( void );
 972     void drawZenith(float,float,float); //suma
 973     void drawNadir(float, float, float); //suma
 974
 975     void Text( float x, float y, char *s)
 976     {
 977         TextList.add( fgText( x, y, s) );
 978     }
 979
 980     void Line( float x1, float y1, float x2, float y2)
 981     {
 982         LineList.add(fgLineSeg2D(x1,y1,x2,y2));
 983     }
 984
 985     void StippleLine( float x1, float y1, float x2, float y2)
 986     {
 987         StippleLineList.add(fgLineSeg2D(x1,y1,x2,y2));
 988     }
 989 };
 990
 991
 992 //using namespace std;
 993 //deque <instr_item>  * Hdeque_ptr;
 994
 995 extern int  fgHUDInit( fgAIRCRAFT * /* current_aircraft */ );
 996 extern int  fgHUDInit2( fgAIRCRAFT * /* current_aircraft */ );
 997 extern void fgUpdateHUD( void );
 998 extern void fgUpdateHUD( GLfloat x_start, GLfloat y_start,
 999                          GLfloat x_end, GLfloat y_end );
1000
1001 /*
1002 bool AddHUDInstrument( instr_item *pBlackBox );
1003 void DrawHUD ( void );
1004 bool DamageInstrument( INSTR_HANDLE unit );
1005 bool RepairInstrument( INSTR_HANDLE unit );
1006
1007
1008 void fgUpdateHUD ( Hptr hud );
1009 void fgUpdateHUD2( Hptr hud ); // Future use?
1010 void fgHUDSetTimeMode( Hptr hud, int time_of_day );
1011 */
1012
1013
1014
1015
1016 class HUD_Properties : public SGPropertyChangeListener {
1017 public:
1018     HUD_Properties();
1019     void valueChanged(SGPropertyNode *n);
1020     void setColor() const;
1021     bool isVisible() const { return _visible; }
1022     bool isAntialiased() const { return _antialiased; }
1023     bool isTransparent() const { return _transparent; }
1024     float alphaClamp() const { return _cl; }
1025
1026 private:
1027     float clamp(float f) { return f < 0.0f ? 0.0f : f > 1.0f ? 1.0f : f; }
1028     SGPropertyNode_ptr _current;
1029     SGPropertyNode_ptr _visibility;
1030     SGPropertyNode_ptr _antialiasing;
1031     SGPropertyNode_ptr _transparency;
1032     SGPropertyNode_ptr _red, _green, _blue, _alpha;
1033     SGPropertyNode_ptr _alpha_clamp;
1034     SGPropertyNode_ptr _brightness;
1035     bool _visible;
1036     bool _antialiased;
1037     bool _transparent;
1038     float _r, _g, _b, _a, _cl;
1039 };
1040
1041 #endif // _HUD_H