1 // HUD.hxx -- Head Up Display
3 // Written by Michele America, started September 1997.
5 // Copyright (C) 1997 Michele F. America [micheleamerica#geocities:com]
6 // Copyright (C) 2006 Melchior FRANZ [mfranz#aon:at]
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.
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.
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.
25 #include <simgear/compiler.h>
26 #include <simgear/props/condition.hxx>
38 SG_USING_NAMESPACE(std);
44 #include <simgear/math/SGLimits.hxx>
45 #include <simgear/constants.h>
46 #include <simgear/structure/subsystem_mgr.hxx>
48 #include <Airports/runways.hxx> // FGRunway
49 #include <GUI/gui.h> // fntRenderer ? guiErrorMessage()
50 #include <GUI/new_gui.hxx> // FGFontCache, FGColor
51 #include <Include/fg_typedefs.h>
52 #include <Main/fg_props.hxx>
60 LineSegment(GLfloat x0, GLfloat y0, GLfloat x1, GLfloat y1)
61 : _x0(x0), _y0(y0), _x1(x1), _y1(y1) {}
69 GLfloat _x0, _y0, _x1, _y1;
76 void add(const LineSegment& seg) { _list.push_back(seg); }
77 void erase() { _list.erase(_list.begin(), _list.end()); }
78 inline unsigned int size() const { return _list.size(); }
81 vector<LineSegment>::const_iterator it, end = _list.end();
82 for (it = _list.begin(); it != end; ++it)
88 vector<LineSegment> _list;
95 HUDText(fntRenderer *f, float x, float y, const char *s, int align = 0, int digits = 0);
102 static const int BUFSIZE = 64;
110 TextList() { _font = 0; }
112 void setFont(fntRenderer *Renderer) { _font = Renderer; }
113 void add(float x, float y, const char *s, int align = 0, int digit = 0) {
114 _list.push_back(HUDText(_font, x, y, s, align, digit));
116 void erase() { _list.erase(_list.begin(), _list.end()); }
117 void align(const char *s, int align, float *x, float *y,
118 float *l, float *r, float *b, float *t) const;
123 vector<HUDText> _list;
131 class HUD : public SGSubsystem, public SGPropertyChangeListener {
138 // called from Main/renderer.cxx to draw 2D and 3D HUD
139 void draw(osg::State&);
141 // listener callback to read various HUD related properties
142 void valueChanged(SGPropertyNode *);
143 // set current glColor
144 void setColor() const;
145 inline bool isVisible() const { return _visible; }
146 inline bool isAntialiased() const { return _antialiased; }
147 inline bool isTransparent() const { return _transparent; }
148 inline bool is3D() const { return _3Denabled; }
149 inline float alphaClamp() const { return _cl; }
150 inline double timer() const { return _timer; }
151 static void textAlign(fntRenderer *rend, const char *s, int align, float *x, float *y,
152 float *l, float *r, float *b, float *t);
154 enum Units { FEET, METER };
155 Units getUnits() const { return _units; }
158 HORIZONTAL = 0x0000, // keep that at zero?
168 // for alignment (with LEFT, RIGHT, TOP, BOTTOM)
171 CENTER = (HCENTER|VCENTER),
176 int load(const char *, float x = 320.0f, float y = 240.0f,
177 int level = 0, const string& indent = "");
181 void draw2D(GLfloat, GLfloat, GLfloat, GLfloat);
190 class TurnBankIndicator;
195 deque<Item *> _items;
197 SGPropertyNode_ptr _current;
198 SGPropertyNode_ptr _visibility;
199 SGPropertyNode_ptr _3DenabledN;
200 SGPropertyNode_ptr _antialiasing;
201 SGPropertyNode_ptr _transparency;
202 SGPropertyNode_ptr _red, _green, _blue, _alpha;
203 SGPropertyNode_ptr _alpha_clamp;
204 SGPropertyNode_ptr _brightness;
209 float _r, _g, _b, _a, _cl;
211 SGPropertyNode_ptr _scr_widthN, _scr_heightN;
212 int _scr_width, _scr_height;
213 SGPropertyNode_ptr _unitsN;
217 fntRenderer *_font_renderer;
218 FGFontCache *_font_cache;
225 LineList _stipple_line_list;
232 Input(const SGPropertyNode *n, float factor = 1.0, float offset = 0.0,
233 float min = -SGLimitsf::max(), float max = SGLimitsf::max()) :
236 _damped(SGLimitsf::max())
240 _factor = n->getFloatValue("factor", factor);
241 _offset = n->getFloatValue("offset", offset);
242 _min = n->getFloatValue("min", min);
243 _max = n->getFloatValue("max", max);
244 _coeff = 1.0 - 1.0 / powf(10, fabsf(n->getFloatValue("damp", 0.0)));
245 SGPropertyNode *p = ((SGPropertyNode *)n)->getNode("property", false);
247 const char *path = p->getStringValue();
248 if (path && path[0]) {
249 _property = fgGetNode(path, true);
255 bool getBoolValue() const {
257 return _property->getBoolValue();
260 const char *getStringValue() const {
262 return _property->getStringValue();
265 float getFloatValue() {
267 float f = _property->getFloatValue() * _factor + _offset;
268 if (_damped == SGLimitsf::max())
271 f = _damped = f * (1.0f - _coeff) + _damped * _coeff;
275 inline float isValid() const { return _valid; }
276 inline float min() const { return _min; }
277 inline float max() const { return _max; }
278 inline float factor() const { return _factor; }
279 float clamp(float v) const { return v < _min ? _min : v > _max ? _max : v; }
281 void set_min(float m, bool force = true) {
282 if (force || _min == -SGLimitsf::max())
285 void set_max(float m, bool force = true) {
286 if (force || _max == SGLimitsf::max())
292 SGConstPropertyNode_ptr _property;
305 Item(HUD *parent, const SGPropertyNode *, float x = 0.0f, float y = 0.0f);
307 virtual void draw() = 0;
308 virtual bool isEnabled();
321 Format check_format(const char *) const;
322 inline float get_span() const { return _scr_span; }
323 inline int get_digits() const { return _digits; }
325 inline bool option_vert() const { return (_options & VERTICAL) == VERTICAL; }
326 inline bool option_left() const { return (_options & LEFT) == LEFT; }
327 inline bool option_right() const { return (_options & RIGHT) == RIGHT; }
328 inline bool option_both() const { return (_options & BOTH) == BOTH; }
329 inline bool option_noticks() const { return (_options & NOTICKS) == NOTICKS; }
330 inline bool option_notext() const { return (_options & NOTEXT) == NOTEXT; }
331 inline bool option_top() const { return (_options & TOP) == TOP; }
332 inline bool option_bottom() const { return (_options & BOTTOM) == BOTTOM; }
334 void draw_line(float x1, float y1, float x2, float y2);
335 void draw_stipple_line(float x1, float y1, float x2, float y2);
336 void draw_text(float x, float y, char *msg, int align = 0, int digit = 0);
337 void draw_circle(float x1, float y1, float r) const;
338 void draw_bullet(float, float, float);
343 float _x, _y, _w, _h;
344 float _center_x, _center_y;
347 SGSharedPtr<SGCondition> _condition;
348 float _disp_factor; // Multiply by to get numbers shown on scale.
349 float _scr_span; // Working values for draw;
355 class HUD::Label : public Item {
357 Label(HUD *parent, const SGPropertyNode *, float x, float y);
366 int _halign; // HUDText alignment
370 float _pointer_width;
371 float _pointer_length;
373 SGSharedPtr<SGCondition> _blink_condition;
374 double _blink_interval;
375 double _blink_target; // time for next blink state change
381 // abstract base class for both moving scale and moving needle (fixed scale)
384 class HUD::Scale : public Item {
386 Scale(HUD *parent, const SGPropertyNode *, float x, float y);
387 virtual void draw ( void ) {} // No-op here. Defined in derived classes.
390 inline float factor() const { return _display_factor; }
391 inline float range_to_show() const { return _range_shown; }
394 float _major_divs; // major division marker units
395 float _minor_divs; // minor division marker units
396 unsigned int _modulo; // Roll over point
399 float _range_shown; // Width Units.
400 float _display_factor; // factor => screen units/range values.
404 class HUD::Gauge : public Scale {
406 Gauge(HUD *parent, const SGPropertyNode *, float x, float y);
412 // displays the indicated quantity on a scale that moves past the
413 // pointer. It may be horizontal or vertical.
415 class HUD::Tape : public Scale {
417 Tape(HUD *parent, const SGPropertyNode *, float x, float y);
421 void draw_vertical(float);
422 void draw_horizontal(float);
423 void draw_fixed_pointer(float, float, float, float, float, float);
424 char *format_value(float);
428 float _half_width_units;
429 bool _draw_tick_bottom;
431 bool _draw_tick_right;
432 bool _draw_tick_left;
433 bool _draw_cap_bottom;
435 bool _draw_cap_right;
437 float _marker_offset;
442 int _div_ratio; // _major_divs/_minor_divs
443 bool _odd_type; // whether to put numbers at 0/2/4 or 1/3/5
445 enum { BUFSIZE = 64 };
448 enum PointerType { FIXED, MOVING } _pointer_type;
449 enum TickType { LINE, CIRCLE } _tick_type;
450 enum TickLength { VARIABLE, CONSTANT } _tick_length;
455 class HUD::Dial : public Scale {
457 Dial(HUD *parent, const SGPropertyNode *, float x, float y);
467 class HUD::TurnBankIndicator : public Item {
469 TurnBankIndicator(HUD *parent, const SGPropertyNode *, float x, float y);
475 void draw_line(float, float, float, float);
476 void draw_tick(float angle, float r1, float r2, int side);
487 class HUD::Ladder : public Item {
489 Ladder(HUD *parent, const SGPropertyNode *, float x, float y);
493 void draw_zenith(float, float);
494 void draw_nadir(float, float);
496 void draw_text(float x, float y, char *s, int align = 0) {
497 _locTextList.add(x, y, s, align, 0);
500 void draw_line(float x1, float y1, float x2, float y2) {
501 _locLineList.add(LineSegment(x1, y1, x2, y2));
504 void draw_stipple_line(float x1, float y1, float x2, float y2) {
505 _locStippleLineList.add(LineSegment(x1, y1, x2, y2));
508 enum Type { PITCH, CLIMB_DIVE } _type;
513 unsigned int _scr_hole;
517 bool _dynamic_origin;
519 bool _frl; // fuselage reference line
521 bool _target_markers;
522 bool _velocity_vector;
526 bool _climb_dive_marker;
527 bool _glide_slope_marker;
530 bool _waypoint_marker;
535 // The Ladder has its own temporary display lists
536 TextList _locTextList;
537 LineList _locLineList;
538 LineList _locStippleLineList;
543 // responsible for rendering the active runway in the hud (if visible).
545 class HUD::Runway : public Item {
547 Runway(HUD *parent, const SGPropertyNode *, float x, float y);
551 void boundPoint(const sgdVec3& v, sgdVec3& m);
552 bool boundOutsidePoints(sgdVec3& v, sgdVec3& m);
553 bool drawLine(const sgdVec3& a1, const sgdVec3& a2, const sgdVec3& p1, const sgdVec3& p2);
555 bool get_active_runway(FGRunway& rwy);
556 void get_rwy_points(sgdVec3 *points);
559 SGPropertyNode_ptr _agl;
560 sgdVec3 _points3d[6], _points2d[6];
563 double _arrow_scale; // scales of runway indication arrow
564 double _arrow_radius;
565 double _line_scale; // maximum line scale
566 double _scale_dist; // distance where to start scaling the lines
567 double _default_pitch;
568 double _default_heading;
571 FGViewer* _cockpit_view;
572 unsigned short _stipple_out; // stipple pattern of the outline of the runway
573 unsigned short _stipple_center; // stipple pattern of the center line of the runway
574 bool _draw_arrow; // draw arrow when runway is not visible in HUD
575 bool _draw_arrow_always; // always draws arrow
576 float _left, _right, _top, _bottom;
580 class HUD::AimingReticle : public Item {
582 AimingReticle(HUD *parent, const SGPropertyNode *, float x, float y);
586 SGSharedPtr<SGCondition> _active_condition; // stadiametric (true) or standby (false)
587 Input _diameter; // inner/outer radius relation