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>
43 #include <simgear/math/SGLimits.hxx>
44 #include <simgear/constants.h>
45 #include <simgear/structure/subsystem_mgr.hxx>
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>
59 ClipBox(const SGPropertyNode *, float xoffset = 0, float yoffset = 0);
66 SGConstPropertyNode_ptr _top_node;
67 SGConstPropertyNode_ptr _bot_node;
68 SGConstPropertyNode_ptr _left_node;
69 SGConstPropertyNode_ptr _right_node;
80 LineSegment(GLfloat x0, GLfloat y0, GLfloat x1, GLfloat y1)
81 : _x0(x0), _y0(y0), _x1(x1), _y1(y1) {}
89 GLfloat _x0, _y0, _x1, _y1;
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(); }
101 vector<LineSegment>::const_iterator it, end = _list.end();
102 for (it = _list.begin(); it != end; ++it)
108 vector<LineSegment> _list;
115 HUDText(fntRenderer *f, float x, float y, const char *s, int align = 0, int digits = 0);
122 static const int BUFSIZE = 64;
130 TextList() { _font = 0; }
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));
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;
143 vector<HUDText> _list;
151 class HUD : public SGSubsystem, public SGPropertyChangeListener {
158 // called from Main/renderer.cxx to draw 2D and 3D HUD
159 void draw(osg::State&);
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);
174 enum Units { FEET, METER };
175 Units getUnits() const { return _units; }
178 HORIZONTAL = 0x0000, // keep that at zero?
188 // for alignment (with LEFT, RIGHT, TOP, BOTTOM)
191 CENTER = (HCENTER|VCENTER),
196 int load(const char *, float x = 320.0f, float y = 240.0f,
197 int level = 0, const std::string& indent = "");
201 void draw2D(GLfloat, GLfloat, GLfloat, GLfloat);
210 class TurnBankIndicator;
215 deque<Item *> _items;
216 deque<Item *> _ladders;
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;
230 float _r, _g, _b, _a, _cl;
232 SGPropertyNode_ptr _scr_widthN, _scr_heightN;
233 int _scr_width, _scr_height;
234 SGPropertyNode_ptr _unitsN;
238 fntRenderer *_font_renderer;
239 FGFontCache *_font_cache;
247 LineList _stipple_line_list;
254 Input(const SGPropertyNode *n, float factor = 1.0, float offset = 0.0,
255 float min = -SGLimitsf::max(), float max = SGLimitsf::max()) :
258 _damped(SGLimitsf::max())
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);
269 const char *path = p->getStringValue();
270 if (path && path[0]) {
271 _property = fgGetNode(path, true);
277 bool getBoolValue() const {
279 return _property->getBoolValue();
282 const char *getStringValue() const {
284 return _property->getStringValue();
287 float getFloatValue() {
289 float f = _property->getFloatValue() * _factor + _offset;
290 if (_damped == SGLimitsf::max())
293 f = _damped = f * (1.0f - _coeff) + _damped * _coeff;
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; }
303 void set_min(float m, bool force = true) {
304 if (force || _min == -SGLimitsf::max())
307 void set_max(float m, bool force = true) {
308 if (force || _max == SGLimitsf::max())
314 SGConstPropertyNode_ptr _property;
327 Item(HUD *parent, const SGPropertyNode *, float x = 0.0f, float y = 0.0f);
329 virtual void draw() = 0;
330 virtual bool isEnabled();
343 Format check_format(const char *) const;
344 inline float get_span() const { return _scr_span; }
345 inline int get_digits() const { return _digits; }
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; }
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);
365 float _x, _y, _w, _h;
366 float _center_x, _center_y;
369 SGSharedPtr<SGCondition> _condition;
370 float _disp_factor; // Multiply by to get numbers shown on scale.
371 float _scr_span; // Working values for draw;
377 class HUD::Label : public Item {
379 Label(HUD *parent, const SGPropertyNode *, float x, float y);
388 int _halign; // HUDText alignment
392 float _pointer_width;
393 float _pointer_length;
395 SGSharedPtr<SGCondition> _blink_condition;
396 double _blink_interval;
397 double _blink_target; // time for next blink state change
403 // abstract base class for both moving scale and moving needle (fixed scale)
406 class HUD::Scale : public Item {
408 Scale(HUD *parent, const SGPropertyNode *, float x, float y);
409 virtual void draw ( void ) {} // No-op here. Defined in derived classes.
412 inline float factor() const { return _display_factor; }
413 inline float range_to_show() const { return _range_shown; }
416 float _major_divs; // major division marker units
417 float _minor_divs; // minor division marker units
418 unsigned int _modulo; // Roll over point
421 float _range_shown; // Width Units.
422 float _display_factor; // factor => screen units/range values.
426 class HUD::Gauge : public Scale {
428 Gauge(HUD *parent, const SGPropertyNode *, float x, float y);
434 // displays the indicated quantity on a scale that moves past the
435 // pointer. It may be horizontal or vertical.
437 class HUD::Tape : public Scale {
439 Tape(HUD *parent, const SGPropertyNode *, float x, float y);
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);
450 float _half_width_units;
451 bool _draw_tick_bottom;
453 bool _draw_tick_right;
454 bool _draw_tick_left;
455 bool _draw_cap_bottom;
457 bool _draw_cap_right;
459 float _marker_offset;
464 int _div_ratio; // _major_divs/_minor_divs
465 bool _odd_type; // whether to put numbers at 0/2/4 or 1/3/5
467 enum { BUFSIZE = 64 };
470 enum PointerType { FIXED, MOVING } _pointer_type;
471 enum TickType { LINE, CIRCLE } _tick_type;
472 enum TickLength { VARIABLE, CONSTANT } _tick_length;
477 class HUD::Dial : public Scale {
479 Dial(HUD *parent, const SGPropertyNode *, float x, float y);
489 class HUD::TurnBankIndicator : public Item {
491 TurnBankIndicator(HUD *parent, const SGPropertyNode *, float x, float y);
497 void draw_line(float, float, float, float);
498 void draw_tick(float angle, float r1, float r2, int side);
509 class HUD::Ladder : public Item {
511 Ladder(HUD *parent, const SGPropertyNode *, float x, float y);
516 void draw_zenith(float, float);
517 void draw_nadir(float, float);
519 void draw_text(float x, float y, const char *s, int align = 0) {
520 _locTextList.add(x, y, s, align, 0);
523 void draw_line(float x1, float y1, float x2, float y2, bool stipple = false) {
525 _locStippleLineList.add(LineSegment(x1, y1, x2, y2));
527 _locLineList.add(LineSegment(x1, y1, x2, y2));
530 enum Type { PITCH, CLIMB_DIVE } _type;
536 float _zero_bar_overlength;
537 bool _dive_bar_angle;
542 bool _dynamic_origin;
543 bool _frl; // fuselage reference line
545 bool _target_markers;
546 bool _velocity_vector;
550 bool _climb_dive_marker;
551 bool _glide_slope_marker;
554 bool _waypoint_marker;
560 // The Ladder has its own temporary display lists
561 TextList _locTextList;
562 LineList _locLineList;
563 LineList _locStippleLineList;
568 // responsible for rendering the active runway in the hud (if visible).
570 class HUD::Runway : public Item {
572 Runway(HUD *parent, const SGPropertyNode *, float x, float y);
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);
580 bool get_active_runway(FGRunway& rwy);
581 void get_rwy_points(sgdVec3 *points);
584 SGPropertyNode_ptr _agl;
585 sgdVec3 _points3d[6], _points2d[6];
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;
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;
605 class HUD::AimingReticle : public Item {
607 AimingReticle(HUD *parent, const SGPropertyNode *, float x, float y);
611 SGSharedPtr<SGCondition> _active_condition; // stadiametric (true) or standby (false)
612 Input _diameter; // inner/outer radius relation