src/Instrumentation/HUD/HUD.hxx

   1 // HUD.hxx -- Head Up Display
   2 //
   3 // Written by Michele America, started September 1997.
   4 //
   5 // Copyright (C) 1997  Michele F. America  [micheleamerica#geocities:com]
   6 // Copyright (C) 2006  Melchior FRANZ  [mfranz#aon:at]
   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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  21
  22 #ifndef _HUD_HXX
  23 #define _HUD_HXX
  24
  25 #include <simgear/compiler.h>
  26 #include <simgear/props/condition.hxx>
  27
  28 #ifdef HAVE_CONFIG_H
  29 #  include <config.h>
  30 #endif
  31
  32 #include <vector>
  33 #include <deque>
  34 #include <fstream>
  35
  36 using std::deque;
  37 using std::vector;
  38
  39 #include <osg/State>
  40
  41 #include <plib/sg.h>
  42
  43 #include <simgear/math/SGLimits.hxx>
  44 #include <simgear/constants.h>
  45 #include <simgear/structure/subsystem_mgr.hxx>
  46
  47 #include <Airports/runways.hxx>     // FGRunway
  48 #include <GUI/gui.h>                // fntRenderer ?   guiErrorMessage()
  49 #include <GUI/new_gui.hxx>          // FGFontCache, FGColor
  50 #include <Include/fg_typedefs.h>
  51 #include <Main/fg_props.hxx>
  52
  53
  54 class FGViewer;
  55
  56
  57 class ClipBox {
  58 public:
  59     ClipBox(const SGPropertyNode *, float xoffset = 0, float yoffset = 0);
  60     void set();
  61     void unset();
  62
  63 private:
  64     bool _active;
  65     float _xoffs, _yoffs;
  66     SGConstPropertyNode_ptr _top_node;
  67     SGConstPropertyNode_ptr _bot_node;
  68     SGConstPropertyNode_ptr _left_node;
  69     SGConstPropertyNode_ptr _right_node;
  70     GLdouble _top[4];
  71     GLdouble _bot[4];
  72     GLdouble _left[4];
  73     GLdouble _right[4];
  74 };
  75
  76
  77
  78 class LineSegment {
  79 public:
  80     LineSegment(GLfloat x0, GLfloat y0, GLfloat x1, GLfloat y1)
  81         : _x0(x0), _y0(y0), _x1(x1), _y1(y1) {}
  82
  83     void draw() const {
  84         glVertex2f(_x0, _y0);
  85         glVertex2f(_x1, _y1);
  86     }
  87
  88 private:
  89     GLfloat _x0, _y0, _x1, _y1;
  90 };
  91
  92
  93
  94 class LineList {
  95 public:
  96     void add(const LineSegment& seg) { _list.push_back(seg); }
  97     void erase() { _list.erase(_list.begin(), _list.end()); }
  98     inline unsigned int size() const { return _list.size(); }
  99     void draw() {
 100         glBegin(GL_LINES);
 101         vector<LineSegment>::const_iterator it, end = _list.end();
 102         for (it = _list.begin(); it != end; ++it)
 103             it->draw();
 104         glEnd();
 105     }
 106
 107 private:
 108     vector<LineSegment> _list;
 109 };
 110
 111
 112
 113 class HUDText {
 114 public:
 115     HUDText(fntRenderer *f, float x, float y, const char *s, int align = 0, int digits = 0);
 116     void draw();
 117
 118 private:
 119     fntRenderer *_fnt;
 120     float _x, _y;
 121     int _digits;
 122     static const int BUFSIZE = 64;
 123     char _msg[BUFSIZE];
 124 };
 125
 126
 127
 128 class TextList {
 129 public:
 130     TextList() { _font = 0; }
 131
 132     void setFont(fntRenderer *Renderer) { _font = Renderer; }
 133     void add(float x, float y, const char *s, int align = 0, int digit = 0) {
 134         _list.push_back(HUDText(_font, x, y, s, align, digit));
 135     }
 136     void erase() { _list.erase(_list.begin(), _list.end()); }
 137     void align(const char *s, int align, float *x, float *y,
 138             float *l, float *r, float *b, float *t) const;
 139     void draw();
 140
 141 private:
 142     fntRenderer *_font;
 143     vector<HUDText> _list;
 144 };
 145
 146
 147
 148
 149
 150
 151 class HUD : public SGSubsystem, public SGPropertyChangeListener {
 152 public:
 153     HUD();
 154     ~HUD();
 155     void init();
 156     void update(double);
 157
 158     // called from Main/renderer.cxx to draw 2D and 3D HUD
 159     void draw(osg::State&);
 160
 161     // listener callback to read various HUD related properties
 162     void valueChanged(SGPropertyNode *);
 163     // set current glColor
 164     void setColor() const;
 165     inline bool isVisible() const { return _visible; }
 166     inline bool isAntialiased() const { return _antialiased; }
 167     inline bool isTransparent() const { return _transparent; }
 168     inline bool is3D() const { return _3Denabled; }
 169     inline float alphaClamp() const { return _cl; }
 170     inline double timer() const { return _timer; }
 171     static void textAlign(fntRenderer *rend, const char *s, int align, float *x, float *y,
 172             float *l, float *r, float *b, float *t);
 173
 174     enum Units { FEET, METER };
 175     Units getUnits() const { return _units; }
 176
 177     enum {
 178         HORIZONTAL = 0x0000,  // keep that at zero?
 179         VERTICAL   = 0x0001,
 180         TOP        = 0x0002,
 181         BOTTOM     = 0x0004,
 182         LEFT       = 0x0008,
 183         RIGHT      = 0x0010,
 184         NOTICKS    = 0x0020,
 185         NOTEXT     = 0x0040,
 186         BOTH       = (LEFT|RIGHT),
 187
 188         // for alignment (with LEFT, RIGHT, TOP, BOTTOM)
 189         HCENTER    = 0x0080,
 190         VCENTER    = 0x0100,
 191         CENTER     = (HCENTER|VCENTER),
 192     };
 193
 194 protected:
 195     void common_draw();
 196     int load(const char *, float x = 320.0f, float y = 240.0f,
 197             int level = 0, const std::string& indent = "");
 198
 199 private:
 200     void draw3D();
 201     void draw2D(GLfloat, GLfloat, GLfloat, GLfloat);
 202
 203     class Input;
 204     class Item;
 205     class Label;
 206     class Scale;
 207     class Gauge;
 208     class Tape;
 209     class Dial;
 210     class TurnBankIndicator;
 211     class Ladder;
 212     class Runway;
 213     class AimingReticle;
 214
 215     deque<Item *> _items;
 216     deque<Item *> _ladders;
 217
 218     SGPropertyNode_ptr _current;
 219     SGPropertyNode_ptr _visibility;
 220     SGPropertyNode_ptr _3DenabledN;
 221     SGPropertyNode_ptr _antialiasing;
 222     SGPropertyNode_ptr _transparency;
 223     SGPropertyNode_ptr _red, _green, _blue, _alpha;
 224     SGPropertyNode_ptr _alpha_clamp;
 225     SGPropertyNode_ptr _brightness;
 226     bool _visible;
 227     bool _3Denabled;
 228     bool _antialiased;
 229     bool _transparent;
 230     float _r, _g, _b, _a, _cl;
 231
 232     SGPropertyNode_ptr _scr_widthN, _scr_heightN;
 233     int _scr_width, _scr_height;
 234     SGPropertyNode_ptr _unitsN;
 235     Units _units;
 236     double _timer;
 237
 238     fntRenderer *_font_renderer;
 239     FGFontCache *_font_cache;
 240     fntTexFont *_font;
 241     float _font_size;
 242     int _style;
 243
 244     ClipBox *_clip_box;
 245     TextList _text_list;
 246     LineList _line_list;
 247     LineList _stipple_line_list;
 248 };
 249
 250
 251
 252 class HUD::Input {
 253 public:
 254     Input(const SGPropertyNode *n, float factor = 1.0, float offset = 0.0,
 255             float min = -SGLimitsf::max(), float max = SGLimitsf::max()) :
 256         _valid(false),
 257         _property(0),
 258         _damped(SGLimitsf::max())
 259     {
 260         if (!n)
 261             return;
 262         _factor = n->getFloatValue("factor", factor);
 263         _offset = n->getFloatValue("offset", offset);
 264         _min = n->getFloatValue("min", min);
 265         _max = n->getFloatValue("max", max);
 266         _coeff = 1.0 - 1.0 / powf(10, fabsf(n->getFloatValue("damp", 0.0)));
 267         SGPropertyNode *p = ((SGPropertyNode *)n)->getNode("property", false);
 268         if (p) {
 269             const char *path = p->getStringValue();
 270             if (path && path[0]) {
 271                 _property = fgGetNode(path, true);
 272                 _valid = true;
 273             }
 274         }
 275     }
 276
 277     bool getBoolValue() const {
 278         assert(_property);
 279         return _property->getBoolValue();
 280     }
 281
 282     const char *getStringValue() const {
 283         assert(_property);
 284         return _property->getStringValue();
 285     }
 286
 287     float getFloatValue() {
 288         assert(_property);
 289         float f = _property->getFloatValue() * _factor + _offset;
 290         if (_damped == SGLimitsf::max())
 291             _damped = f;
 292         if (_coeff > 0.0f)
 293             f = _damped = f * (1.0f - _coeff) + _damped * _coeff;
 294         return clamp(f);
 295     }
 296
 297     inline float isValid() const { return _valid; }
 298     inline float min() const { return _min; }
 299     inline float max() const { return _max; }
 300     inline float factor() const { return _factor; }
 301     float clamp(float v) const { return v < _min ? _min : v > _max ? _max : v; }
 302
 303     void set_min(float m, bool force = true) {
 304         if (force || _min == -SGLimitsf::max())
 305             _min = m;
 306     }
 307     void set_max(float m, bool force = true) {
 308         if (force || _max == SGLimitsf::max())
 309             _max = m;
 310     }
 311
 312 private:
 313     bool _valid;
 314     SGConstPropertyNode_ptr _property;
 315     float _factor;
 316     float _offset;
 317     float _min;
 318     float _max;
 319     float _coeff;
 320     float _damped;
 321 };
 322
 323
 324
 325 class HUD::Item {
 326 public:
 327     Item(HUD *parent, const SGPropertyNode *, float x = 0.0f, float y = 0.0f);
 328     virtual ~Item () {}
 329     virtual void draw() = 0;
 330     virtual bool isEnabled();
 331
 332 protected:
 333     enum Format {
 334         INVALID,
 335         NONE,
 336         INT,
 337         LONG,
 338         FLOAT,
 339         DOUBLE,
 340         STRING,
 341     };
 342
 343     Format  check_format(const char *) const;
 344     inline float get_span()       const { return _scr_span; }
 345     inline int   get_digits()     const { return _digits; }
 346
 347     inline bool option_vert()    const { return (_options & VERTICAL) == VERTICAL; }
 348     inline bool option_left()    const { return (_options & LEFT) == LEFT; }
 349     inline bool option_right()   const { return (_options & RIGHT) == RIGHT; }
 350     inline bool option_both()    const { return (_options & BOTH) == BOTH; }
 351     inline bool option_noticks() const { return (_options & NOTICKS) == NOTICKS; }
 352     inline bool option_notext()  const { return (_options & NOTEXT) == NOTEXT; }
 353     inline bool option_top()     const { return (_options & TOP) == TOP; }
 354     inline bool option_bottom()  const { return (_options & BOTTOM) == BOTTOM; }
 355
 356     void draw_line(float x1, float y1, float x2, float y2);
 357     void draw_stipple_line(float x1, float y1, float x2, float y2);
 358     void draw_text(float x, float y, const char *msg, int align = 0, int digit = 0);
 359     void draw_circle(float x1, float y1, float r) const;
 360     void draw_bullet(float, float, float);
 361
 362     HUD         *_hud;
 363     std::string      _name;
 364     int         _options;
 365     float       _x, _y, _w, _h;
 366     float       _center_x, _center_y;
 367
 368 private:
 369     SGSharedPtr<SGCondition> _condition;
 370     float       _disp_factor;   // Multiply by to get numbers shown on scale.
 371     float       _scr_span;      // Working values for draw;
 372     int         _digits;
 373 };
 374
 375
 376
 377 class HUD::Label : public Item {
 378 public:
 379     Label(HUD *parent, const SGPropertyNode *, float x, float y);
 380     virtual void draw();
 381
 382 private:
 383     bool    blink();
 384
 385     Input   _input;
 386     Format  _mode;
 387     std::string  _format;
 388     int     _halign;    // HUDText alignment
 389     int     _blink;
 390     bool    _box;
 391     float   _text_y;
 392     float   _pointer_width;
 393     float   _pointer_length;
 394
 395     SGSharedPtr<SGCondition> _blink_condition;
 396     double  _blink_interval;
 397     double  _blink_target;  // time for next blink state change
 398     bool    _blink_state;
 399 };
 400
 401
 402
 403 // abstract base class for both moving scale and moving needle (fixed scale)
 404 // indicators.
 405 //
 406 class HUD::Scale : public Item {
 407 public:
 408     Scale(HUD *parent, const SGPropertyNode *, float x, float y);
 409     virtual void draw    ( void ) {}  // No-op here. Defined in derived classes.
 410
 411 protected:
 412     inline float factor() const { return _display_factor; }
 413     inline float range_to_show() const { return _range_shown; }
 414
 415     Input _input;
 416     float _major_divs;      // major division marker units
 417     float _minor_divs;      // minor division marker units
 418     unsigned int _modulo;   // Roll over point
 419
 420 private:
 421     float _range_shown;     // Width Units.
 422     float _display_factor;  // factor => screen units/range values.
 423 };
 424
 425
 426 class HUD::Gauge : public Scale {
 427 public:
 428     Gauge(HUD *parent, const SGPropertyNode *, float x, float y);
 429     virtual void draw();
 430 };
 431
 432
 433
 434 // displays the indicated quantity on a scale that moves past the
 435 // pointer. It may be horizontal or vertical.
 436 //
 437 class HUD::Tape : public Scale {
 438 public:
 439     Tape(HUD *parent, const SGPropertyNode *, float x, float y);
 440     virtual void draw();
 441
 442 protected:
 443     void draw_vertical(float);
 444     void draw_horizontal(float);
 445     void draw_fixed_pointer(float, float, float, float, float, float);
 446     char *format_value(float);
 447
 448 private:
 449     float  _val_span;
 450     float  _half_width_units;
 451     bool   _draw_tick_bottom;
 452     bool   _draw_tick_top;
 453     bool   _draw_tick_right;
 454     bool   _draw_tick_left;
 455     bool   _draw_cap_bottom;
 456     bool   _draw_cap_top;
 457     bool   _draw_cap_right;
 458     bool   _draw_cap_left;
 459     float  _marker_offset;
 460     float  _label_gap;
 461     bool   _pointer;
 462     Format _label_fmt;
 463     std::string _format;
 464     int    _div_ratio;          // _major_divs/_minor_divs
 465     bool   _odd_type;           // whether to put numbers at 0/2/4 or 1/3/5
 466
 467     enum { BUFSIZE = 64 };
 468     char   _buf[BUFSIZE];
 469
 470     enum PointerType { FIXED, MOVING } _pointer_type;
 471     enum TickType { LINE, CIRCLE } _tick_type;
 472     enum TickLength { VARIABLE, CONSTANT } _tick_length;
 473 };
 474
 475
 476
 477 class HUD::Dial : public Scale {
 478 public:
 479     Dial(HUD *parent, const SGPropertyNode *, float x, float y);
 480     virtual void draw();
 481
 482 private:
 483     float  _radius;
 484     int    _divisions;
 485 };
 486
 487
 488
 489 class HUD::TurnBankIndicator : public Item {
 490 public:
 491     TurnBankIndicator(HUD *parent, const SGPropertyNode *, float x, float y);
 492     virtual void draw();
 493
 494 private:
 495     void draw_scale();
 496     void draw_tee();
 497     void draw_line(float, float, float, float);
 498     void draw_tick(float angle, float r1, float r2, int side);
 499
 500     Input _bank;
 501     Input _sideslip;
 502
 503     float _gap_width;
 504     bool  _bank_scale;
 505 };
 506
 507
 508
 509 class HUD::Ladder : public Item {
 510 public:
 511     Ladder(HUD *parent, const SGPropertyNode *, float x, float y);
 512     ~Ladder();
 513     virtual void draw();
 514
 515 private:
 516     void draw_zenith(float, float);
 517     void draw_nadir(float, float);
 518
 519     void draw_text(float x, float y, const char *s, int align = 0) {
 520         _locTextList.add(x, y, s, align, 0);
 521     }
 522
 523     void draw_line(float x1, float y1, float x2, float y2, bool stipple = false) {
 524         if (stipple)
 525             _locStippleLineList.add(LineSegment(x1, y1, x2, y2));
 526         else
 527             _locLineList.add(LineSegment(x1, y1, x2, y2));
 528     }
 529
 530     enum   Type { PITCH, CLIMB_DIVE } _type;
 531     Input  _pitch;
 532     Input  _roll;
 533     float  _width_units;
 534     int    _div_units;
 535     float  _scr_hole;
 536     float  _zero_bar_overlength;
 537     bool   _dive_bar_angle;
 538     float  _tick_length;
 539     float  _vmax;
 540     float  _vmin;
 541     float  _compression;
 542     bool   _dynamic_origin;
 543     bool   _frl;               // fuselage reference line
 544     bool   _target_spot;
 545     bool   _target_markers;
 546     bool   _velocity_vector;
 547     bool   _drift_marker;
 548     bool   _alpha_bracket;
 549     bool   _energy_marker;
 550     bool   _climb_dive_marker;
 551     bool   _glide_slope_marker;
 552     float  _glide_slope;
 553     bool   _energy_worm;
 554     bool   _waypoint_marker;
 555     bool   _zenith;
 556     bool   _nadir;
 557     bool   _hat;
 558
 559     ClipBox *_clip_box;
 560     // The Ladder has its own temporary display lists
 561     TextList _locTextList;
 562     LineList _locLineList;
 563     LineList _locStippleLineList;
 564 };
 565
 566
 567
 568 // responsible for rendering the active runway in the hud (if visible).
 569 //
 570 class HUD::Runway : public Item {
 571 public:
 572     Runway(HUD *parent, const SGPropertyNode *, float x, float y);
 573     virtual void draw();
 574
 575 private:
 576     void boundPoint(const sgdVec3& v, sgdVec3& m);
 577     bool boundOutsidePoints(sgdVec3& v, sgdVec3& m);
 578     bool drawLine(const sgdVec3& a1, const sgdVec3& a2, const sgdVec3& p1, const sgdVec3& p2);
 579     void drawArrow();
 580     FGRunway* get_active_runway();
 581     void get_rwy_points(sgdVec3 *points);
 582     void setLineWidth();
 583
 584     SGPropertyNode_ptr _agl;
 585     sgdVec3 _points3d[6], _points2d[6];
 586     double _mm[16];
 587     double _pm[16];
 588     double _arrow_scale;  // scales of runway indication arrow
 589     double _arrow_radius;
 590     double _line_scale;   // maximum line scale
 591     double _scale_dist;   // distance where to start scaling the lines
 592     double _default_pitch;
 593     double _default_heading;
 594     GLint  _view[4];
 595     FGRunway* _runway;
 596     FGViewer* _cockpit_view;
 597     unsigned short _stipple_out;    // stipple pattern of the outline of the runway
 598     unsigned short _stipple_center; // stipple pattern of the center line of the runway
 599     bool   _draw_arrow;             // draw arrow when runway is not visible in HUD
 600     bool   _draw_arrow_always;      // always draws arrow
 601     float  _left, _right, _top, _bottom;
 602 };
 603
 604
 605 class HUD::AimingReticle : public Item {
 606 public:
 607     AimingReticle(HUD *parent, const SGPropertyNode *, float x, float y);
 608     virtual void draw();
 609
 610 private:
 611     SGSharedPtr<SGCondition> _active_condition;  // stadiametric (true) or standby (false)
 612     Input   _diameter;               // inner/outer radius relation
 613     float   _bullet_size;
 614     float   _inner_radius;
 615 };
 616
 617
 618 #endif // _HUD_HXX