Cockpit/hud.hxx

   1 /**************************************************************************
   2  * hud.hxx -- hud defines and prototypes (initial draft)
   3  *
   4  * Written by Michele America, started September 1997.
   5  *
   6  * Copyright (C) 1997  Michele F. America  - nomimarketing@mail.telepac.pt
   7  *
   8  * This program is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU General Public License as
  10  * published by the Free Software Foundation; either version 2 of the
  11  * License, or (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful, but
  14  * WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  21  *
  22  * $Id$
  23  * (Log is kept at end of this file)
  24  **************************************************************************/
  25
  26
  27 #ifndef _HUD_HXX
  28 #define _HUD_HXX
  29
  30
  31 #ifndef __cplusplus
  32 # error This library requires C++
  33 #endif
  34
  35
  36 #include <config.h>
  37
  38
  39 #include <fg_typedefs.h>
  40 #include <fg_constants.h>
  41 #include <Aircraft/aircraft.h>
  42 #include <Flight/flight.h>
  43 #include <Controls/controls.h>
  44
  45 //using namespace std;
  46
  47 #include <deque.h>       // STL
  48
  49
  50 #ifndef WIN32
  51
  52   typedef struct {
  53       int x, y;
  54   } POINT;
  55
  56   typedef struct {
  57       int top, bottom, left, right;
  58   } RECT;
  59
  60 #endif
  61
  62
  63 // View mode definitions
  64
  65 enum VIEW_MODES{ HUD_VIEW, PANEL_VIEW, CHASE_VIEW, TOWER_VIEW };
  66
  67 // DAY, NIGHT and brightness levels need to be visible where dialogs and
  68 // controls can be used to set intensity and appropriate color. This will
  69 // be moved.
  70 // Hud general constants
  71 #define DAY                1
  72 #define NIGHT              2
  73 #define BRT_DARK           3
  74 #define BRT_MEDIUM         4
  75 #define BRT_LIGHT          5
  76 #define SIZE_SMALL         6
  77 #define SIZE_LARGE         7
  78
  79 // Label constants
  80 #define SMALL              1
  81 #define LARGE              2
  82
  83 #define BLINK              3
  84 #define NOBLINK            4
  85
  86 enum fgLabelJust{ LEFT_JUST, CENTER_JUST, RIGHT_JUST } ;
  87
  88 // Ladder constants
  89 #define NONE               1
  90 #define UPPER_LEFT         2
  91 #define UPPER_CENTER       3
  92 #define UPPER_RIGHT        4
  93 #define CENTER_RIGHT       5
  94 #define LOWER_RIGHT        6
  95 #define LOWER_CENTER       7
  96 #define LOWER_LEFT         8
  97 #define CENTER_LEFT        9
  98 #define SOLID_LINES       10
  99 #define DASHED_LINES      11
 100 #define DASHED_NEG_LINES  12
 101
 102
 103 #define HORIZON_FIXED   1
 104 #define HORIZON_MOVING  2
 105 #define LABEL_COUNTER   1
 106 #define LABEL_WARNING   2
 107
 108 // Ladder orientaion
 109 // #define HUD_VERTICAL        1
 110 // #define HUD_HORIZONTAL               2
 111 // #define HUD_FREEFLOAT                3
 112
 113 // Ladder orientation modes
 114 // #define HUD_LEFT             1
 115 // #define HUD_RIGHT            2
 116 // #define HUD_TOP              1
 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
 122
 123
 124 // Ladder sub-types
 125 // #define HUD_LIM                              1
 126 // #define HUD_NOLIM                    2
 127 // #define HUD_CIRC                     3
 128
 129 // #define HUD_INSTR_LADDER     1
 130 // #define HUD_INSTR_CLADDER    2
 131 // #define HUD_INSTR_HORIZON    3
 132 // #define HUD_INSTR_LABEL              4
 133
 134 extern double get_throttleval ( void );
 135 extern double get_aileronval  ( void );
 136 extern double get_elevatorval ( void );
 137 extern double get_elev_trimval( void );
 138 extern double get_rudderval   ( void );
 139 extern double get_speed       ( void );
 140 extern double get_aoa         ( void );
 141 extern double get_roll        ( void );
 142 extern double get_pitch       ( void );
 143 extern double get_heading     ( void );
 144 extern double get_altitude    ( void );
 145 extern double get_sideslip    ( void );
 146 extern double get_frame_rate  ( void );
 147 extern double get_latitude    ( void );
 148 extern double get_lat_min     ( void );
 149 extern double get_longitude   ( void );
 150 extern double get_long_min    ( void );
 151 extern double get_fov         ( void );
 152
 153 enum  hudinstype{ HUDno_instr,
 154               HUDscale,
 155               HUDlabel,
 156               HUDladder,
 157               HUDcirc_ladder,
 158               HUDhorizon,
 159               HUDguage,
 160               HUDdual_inst,
 161               HUDmoving_scale,
 162               HUDtbi
 163               };
 164
 165 enum ReadOriented{ ReadRIGHT, ReadLEFT, ReadTOP, ReadBOTTOM };
 166
 167 class instr_item {  // An Abstract Base Class (ABC)
 168   private:
 169     static UINT      instances;     // More than 64K instruments? Nah!
 170     UINT             handle;
 171     RECT             scrn_pos;      // Framing - affects scale dimensions
 172                                     // and orientation. Vert vs Horz, etc.
 173     DBLFNPTR         load_value_fn;
 174     ReadOriented     oriented;
 175     bool             is_enabled;
 176     bool             broken;
 177     int              brightness;
 178     UINT             scr_span;      // Working values for draw;
 179     POINT            mid_span;      //
 180
 181   public:
 182     instr_item( RECT           scrn_pos,
 183                 DBLFNPTR       data_source,
 184                 ReadOriented   orient,
 185                 bool           working      = true);
 186
 187     instr_item( const instr_item & image );
 188
 189     instr_item & operator = ( const instr_item & rhs );
 190     virtual ~instr_item ();
 191
 192     int          get_brightness  ( void ) { return brightness;}
 193     RECT         get_location    ( void ) { return scrn_pos;  }
 194     bool         is_broken       ( void ) { return broken;    }
 195     bool         enabled         ( void ) { return is_enabled;}
 196     double       get_value       ( void ) { return load_value_fn();}
 197     UINT         get_span        ( void ) { return scr_span;  }
 198     POINT        get_centroid    ( void ) { return mid_span;  }
 199     ReadOriented get_orientation ( void ) { return oriented;  }
 200
 201     virtual void display_enable( bool working ) { is_enabled = !! working;}
 202
 203
 204     virtual void update( void );
 205     virtual void break_display ( bool bad );
 206     virtual void SetBrightness( int illumination_level ); // fgHUDSetBright...
 207     UINT    get_Handle( void );
 208     virtual void draw( void ) = 0;   // Required method in derived classes
 209 };
 210
 211 typedef instr_item *HIptr;
 212
 213 extern deque< instr_item * > HUD_deque;
 214
 215 // instr_item           This class has no other purpose than to maintain
 216 //                      a linked list of instrument and derived class
 217 // object pointers.
 218
 219
 220 class instr_label : public instr_item {
 221   private:
 222     const char *pformat;
 223     const char *pre_str;
 224     const char *post_str;
 225     fgLabelJust justify;
 226     int         fontSize;
 227     int         blink;
 228
 229   public:
 230     instr_label( RECT         the_box,
 231                  DBLFNPTR     data_source,
 232                  const char  *label_format,
 233                  const char  *pre_label_string    = 0,
 234                  const char  *post_label_string   = 0,
 235                  ReadOriented orientation         = ReadTOP,
 236                  fgLabelJust  justification       = CENTER_JUST,
 237                  int          font_size           = SMALL,
 238                  int          blinking            = NOBLINK,
 239                  bool         working             = true);
 240
 241     ~instr_label();
 242
 243     instr_label( const instr_label & image);
 244     instr_label & operator = (const instr_label & rhs );
 245
 246     virtual void draw( void );       // Required method in base class
 247 };
 248
 249 typedef instr_label * pInstlabel;
 250
 251 //
 252 // instr_scale           This class is an abstract base class for both moving
 253 //                       scale and moving needle (fixed scale) indicators. It
 254 // does not draw itself, but is not instanciable.
 255 //
 256
 257 class instr_scale : public instr_item {
 258   private:
 259     int    range_shown;   // Width Units.
 260     int    Maximum_value; //                ceiling.
 261     int    Minimum_value; // Representation floor.
 262     UINT   Maj_div;       // major division marker units
 263     UINT   Min_div;       // minor division marker units
 264     UINT   Modulo;        // Roll over point
 265     double scale_factor;  // factor => screen units/range values.
 266
 267   public:
 268     instr_scale( RECT         the_box,
 269                  DBLFNPTR     load_fn,
 270                  ReadOriented orient,
 271                  int          show_range,
 272                  int          max_value,
 273                  int          min_value    =   0,
 274                  UINT         major_divs   =  10,
 275                  UINT         minor_divs   =   5,
 276                  UINT         rollover     =   0,
 277                  bool         working      = true);
 278
 279     virtual ~instr_scale();
 280     instr_scale( const instr_scale & image);
 281     instr_scale & operator = (const instr_scale & rhs);
 282
 283     virtual void draw   ( void ) {}; // No-op here. Defined in derived classes.
 284     UINT   div_min      ( void ) { return Min_div;}
 285     UINT   div_max      ( void ) { return Maj_div;}
 286     int    min_val      ( void ) { return Minimum_value;}
 287     int    max_val      ( void ) { return Maximum_value;}
 288     UINT   modulo       ( void ) { return Modulo; }
 289     double factor       ( void ) { return scale_factor;}
 290     double range_to_show( void ) { return range_shown;}
 291 };
 292
 293 // moving_scale_instr      This class displays the indicated quantity on
 294 //                         a scale that moves past the pointer. It may be
 295 // horizontal or vertical, read above(left) or below(right) of the base
 296 // line.
 297
 298 class moving_scale : public instr_scale {
 299   private:
 300     double val_span;
 301     double half_width_units;
 302
 303   public:
 304     moving_scale( RECT         box,
 305                   DBLFNPTR     load_fn,
 306                   ReadOriented readway,
 307                   int          maxValue,
 308                   int          minValue,
 309                   UINT         major_divs,
 310                   UINT         minor_divs,
 311                   UINT         modulator,
 312                   double       value_span,
 313                   bool         working = true);
 314
 315     ~moving_scale();
 316     moving_scale( const moving_scale & image);
 317     moving_scale & operator = (const moving_scale & rhs );
 318 //    virtual void display_enable( bool setting );
 319     virtual void draw( void );       // Required method in base class
 320 };
 321
 322 typedef moving_scale * pMoveScale;
 323
 324 class guage_instr : public instr_scale {
 325   private:
 326
 327   public:
 328     guage_instr( RECT         box,
 329                  DBLFNPTR     load_fn,
 330                  ReadOriented readway,
 331                  int          maxValue,
 332                  int          minValue,
 333                  UINT         major_divs,
 334                  UINT         minor_divs,
 335                  UINT         modulus,
 336                  bool         working = true);
 337
 338     ~guage_instr();
 339     guage_instr( const guage_instr & image);
 340     guage_instr & operator = (const guage_instr & rhs );
 341     virtual void draw( void );       // Required method in base class
 342 };
 343
 344 typedef guage_instr * pGuageInst;
 345 //
 346 // dual_instr_item         This class was created to form the base class
 347 //                         for both panel and HUD Turn Bank Indicators.
 348
 349 class dual_instr_item : public instr_item {
 350   private:
 351     DBLFNPTR alt_data_source;
 352
 353   public:
 354     dual_instr_item ( RECT         the_box,
 355                       DBLFNPTR     chn1_source,
 356                       DBLFNPTR     chn2_source,
 357                       bool         working     = true,
 358                       ReadOriented readway  = ReadTOP);
 359
 360     virtual ~dual_instr_item() {};
 361     dual_instr_item( const dual_instr_item & image);
 362     dual_instr_item & operator = (const dual_instr_item & rhs );
 363
 364     double current_ch1( void ) { return alt_data_source();}
 365     double current_ch2( void ) { return get_value();}
 366     virtual void draw ( void ) { }
 367 };
 368
 369 class fgTBI_instr : public dual_instr_item {
 370   private:
 371     UINT BankLimit;
 372     UINT SlewLimit;
 373     UINT scr_hole;
 374
 375   public:
 376     fgTBI_instr( RECT      the_box,
 377                  DBLFNPTR  chn1_source  = get_roll,
 378                  DBLFNPTR  chn2_source  = get_sideslip,
 379                  UINT      maxBankAngle = 45,
 380                  UINT      maxSlipAngle =  5,
 381                  UINT      gap_width    =  5,
 382                  bool      working      =  true);
 383
 384     fgTBI_instr( const fgTBI_instr & image);
 385     fgTBI_instr & operator = (const fgTBI_instr & rhs );
 386
 387     ~fgTBI_instr();
 388
 389     UINT bank_limit( void ) { return BankLimit;}
 390     UINT slew_limit( void ) { return SlewLimit;}
 391
 392     virtual void draw( void );       // Required method in base class
 393 };
 394
 395 typedef fgTBI_instr * pTBI;
 396
 397 class HudLadder : public dual_instr_item {
 398   private:
 399     UINT   width_units;
 400     int    div_units;
 401     UINT   minor_div;
 402     UINT   label_pos;
 403     UINT   scr_hole;
 404     int    vmax;
 405     int    vmin;
 406     double factor;
 407
 408   public:
 409     HudLadder( RECT      the_box,
 410                DBLFNPTR  ptch_source    = get_roll,
 411                DBLFNPTR  roll_source    = get_pitch,
 412                UINT      span_units     = 45,
 413                int       division_units = 10,
 414                UINT      minor_division = 0,
 415                UINT      screen_hole    = 70,
 416                UINT      lbl_pos        = 0,
 417                bool      working        = true );
 418
 419     ~HudLadder();
 420
 421     HudLadder( const HudLadder & image );
 422     HudLadder & operator = ( const HudLadder & rhs );
 423     virtual void draw( void );
 424 };
 425
 426
 427 //using namespace std;
 428 //deque <instr_item>  * Hdeque_ptr;
 429
 430 extern int  fgHUDInit( fgAIRCRAFT * /* current_aircraft */ );
 431 extern void fgUpdateHUD( void );
 432
 433 /*
 434 bool AddHUDInstrument( instr_item *pBlackBox );
 435 void DrawHUD ( void );
 436 bool DamageInstrument( INSTR_HANDLE unit );
 437 bool RepairInstrument( INSTR_HANDLE unit );
 438
 439
 440 void fgUpdateHUD ( Hptr hud );
 441 void fgUpdateHUD2( Hptr hud ); // Future use?
 442 void fgHUDSetTimeMode( Hptr hud, int time_of_day );
 443 */
 444
 445 #endif // _HUD_H
 446
 447 /* $Log$
 448 /* Revision 1.4  1998/05/16 13:04:15  curt
 449 /* New updates from Charlie Hotchkiss.
 450 /*
 451  * Revision 1.3  1998/05/13 18:27:55  curt
 452  * Added an fov to hud display.
 453  *
 454  * Revision 1.2  1998/05/11 18:13:12  curt
 455  * Complete C++ rewrite of all cockpit code by Charlie Hotchkiss.
 456  *
 457  * Revision 1.15  1998/02/23 19:07:57  curt
 458  * Incorporated Durk's Astro/ tweaks.  Includes unifying the sun position
 459  * calculation code between sun display, and other FG sections that use this
 460  * for things like lighting.
 461  *
 462  * Revision 1.14  1998/02/21 14:53:14  curt
 463  * Added Charlie's HUD changes.
 464  *
 465  * Revision 1.13  1998/02/20 00:16:22  curt
 466  * Thursday's tweaks.
 467  *
 468  * Revision 1.12  1998/02/19 13:05:52  curt
 469  * Incorporated some HUD tweaks from Michelle America.
 470  * Tweaked the sky's sunset/rise colors.
 471  * Other misc. tweaks.
 472  *
 473  * Revision 1.11  1998/02/16 13:38:42  curt
 474  * Integrated changes from Charlie Hotchkiss.
 475  *
 476  * Revision 1.11  1998/02/16 13:38:42  curt
 477  * Integrated changes from Charlie Hotchkiss.
 478  *
 479  * Revision 1.10  1998/02/12 21:59:42  curt
 480  * Incorporated code changes contributed by Charlie Hotchkiss
 481  * <chotchkiss@namg.us.anritsu.com>
 482  *
 483  * Revision 1.8  1998/02/07 15:29:35  curt
 484  * Incorporated HUD changes and struct/typedef changes from Charlie Hotchkiss
 485  * <chotchkiss@namg.us.anritsu.com>
 486  *
 487  * Revision 1.7  1998/02/03 23:20:15  curt
 488  * Lots of little tweaks to fix various consistency problems discovered by
 489  * Solaris' CC.  Fixed a bug in fg_debug.c with how the fgPrintf() wrapper
 490  * passed arguments along to the real printf().  Also incorporated HUD changes
 491  * by Michele America.
 492  *
 493  * Revision 1.6  1998/01/22 02:59:30  curt
 494  * Changed #ifdef FILE_H to #ifdef _FILE_H
 495  *
 496  * Revision 1.5  1998/01/19 19:27:01  curt
 497  * Merged in make system changes from Bob Kuehne <rpk@sgi.com>
 498  * This should simplify things tremendously.
 499  *
 500  * Revision 1.4  1998/01/19 18:40:21  curt
 501  * Tons of little changes to clean up the code and to remove fatal errors
 502  * when building with the c++ compiler.
 503  *
 504  * Revision 1.3  1997/12/30 16:36:41  curt
 505  * Merged in Durk's changes ...
 506  *
 507  * Revision 1.2  1997/12/10 22:37:40  curt
 508  * Prepended "fg" on the name of all global structures that didn't have it yet.
 509  * i.e. "struct WEATHER {}" became "struct fgWEATHER {}"
 510  *
 511  * Revision 1.1  1997/08/29 18:03:22  curt
 512  * Initial revision.
 513  *
 514  */