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