1 // HUD.cxx -- 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.
22 #include <simgear/compiler.h>
23 #include <simgear/structure/exception.hxx>
32 #include <simgear/constants.h>
33 #include <simgear/misc/sg_path.hxx>
36 #include <Main/globals.hxx>
37 #include <Main/viewmgr.hxx>
42 static float clamp(float f)
44 return f < 0.0f ? 0.0f : f > 1.0f ? 1.0f : f;
49 _path(fgGetNode("/sim/hud/path[1]", "Huds/default.xml")),
50 _current(fgGetNode("/sim/hud/current-color", true)),
51 _visibility(fgGetNode("/sim/hud/visibility[1]", true)),
52 _3DenabledN(fgGetNode("/sim/hud/enable3d[1]", true)),
53 _antialiasing(fgGetNode("/sim/hud/color/antialiased", true)),
54 _transparency(fgGetNode("/sim/hud/color/transparent", true)),
55 _red(fgGetNode("/sim/hud/color/red", true)),
56 _green(fgGetNode("/sim/hud/color/green", true)),
57 _blue(fgGetNode("/sim/hud/color/blue", true)),
58 _alpha(fgGetNode("/sim/hud/color/alpha", true)),
59 _alpha_clamp(fgGetNode("/sim/hud/color/alpha-clamp", true)),
60 _brightness(fgGetNode("/sim/hud/color/brightness", true)),
64 _a(0.67), // FIXME better names
67 _scr_widthN(fgGetNode("/sim/startup/xsize", true)),
68 _scr_heightN(fgGetNode("/sim/startup/ysize", true)),
69 _unitsN(fgGetNode("/sim/startup/units", true)),
72 _font_renderer(new fntRenderer()),
76 _listener_active(false),
79 SG_LOG(SG_COCKPIT, SG_INFO, "Initializing HUD Instrument");
81 _path->addChangeListener(this);
82 _visibility->addChangeListener(this);
83 _3DenabledN->addChangeListener(this);
84 _antialiasing->addChangeListener(this);
85 _transparency->addChangeListener(this);
86 _red->addChangeListener(this);
87 _green->addChangeListener(this);
88 _blue->addChangeListener(this);
89 _alpha->addChangeListener(this);
90 _alpha_clamp->addChangeListener(this);
91 _brightness->addChangeListener(this);
92 _current->addChangeListener(this);
93 _scr_widthN->addChangeListener(this);
94 _scr_heightN->addChangeListener(this);
95 _unitsN->addChangeListener(this, true);
101 _path->removeChangeListener(this);
102 _visibility->removeChangeListener(this);
103 _3DenabledN->removeChangeListener(this);
104 _antialiasing->removeChangeListener(this);
105 _transparency->removeChangeListener(this);
106 _red->removeChangeListener(this);
107 _green->removeChangeListener(this);
108 _blue->removeChangeListener(this);
109 _alpha->removeChangeListener(this);
110 _alpha_clamp->removeChangeListener(this);
111 _brightness->removeChangeListener(this);
112 _current->removeChangeListener(this);
113 _scr_widthN->removeChangeListener(this);
114 _scr_heightN->removeChangeListener(this);
115 _unitsN->removeChangeListener(this);
116 delete _font_renderer;
119 deque<Item *>::const_iterator it, end = _items.end();
120 for (it = _items.begin(); it != end; ++it)
122 end = _ladders.end();
123 for (it = _ladders.begin(); it != end; ++it)
130 _font_cache = globals->get_fontcache();
132 _font = _font_cache->getTexFont(fgGetString("/sim/hud/font/name", "Helvetica.txf"));
134 throw sg_throwable(string("/sim/hud/font/name is not a texture font"));
136 _font_size = fgGetFloat("/sim/hud/font/size", 8);
137 _font_renderer->setFont(_font);
138 _font_renderer->setPointSize(_font_size);
139 _text_list.setFont(_font_renderer);
141 _path->fireValueChanged();
145 void HUD::update(double dt)
151 void HUD::draw(osg::State&)
156 if (!_items.size() && !_ladders.size())
164 const float normal_aspect = 640.0f / 480.0f;
165 // note: aspect_ratio is Y/X
166 float current_aspect = 1.0f / globals->get_current_view()->get_aspect_ratio();
167 if (current_aspect > normal_aspect) {
168 float aspect_adjust = current_aspect / normal_aspect;
169 float adjust = 320.0f * aspect_adjust - 320.0f;
170 draw2D(-adjust, 0.0f, 640.0f + adjust, 480.0f);
173 float aspect_adjust = normal_aspect / current_aspect;
174 float adjust = 240.0f * aspect_adjust - 240.0f;
175 draw2D(0.0f, -adjust, 640.0f, 480.0f + adjust);
178 glViewport(0, 0, _scr_width, _scr_height);
184 FGViewer* view = globals->get_current_view();
186 // Standard fgfs projection, with essentially meaningless clip
187 // planes (we'll map the whole HUD plane to z=-1)
188 glMatrixMode(GL_PROJECTION);
191 gluPerspective(view->get_v_fov(), 1.0 / view->get_aspect_ratio(), 0.1, 10);
193 glMatrixMode(GL_MODELVIEW);
197 // Standard fgfs view direction computation
199 lookat[0] = -sin(SG_DEGREES_TO_RADIANS * view->getHeadingOffset_deg());
200 lookat[1] = tan(SG_DEGREES_TO_RADIANS * view->getPitchOffset_deg());
201 lookat[2] = -cos(SG_DEGREES_TO_RADIANS * view->getHeadingOffset_deg());
202 if (fabs(lookat[1]) > 9999)
203 lookat[1] = 9999; // FPU sanity
204 gluLookAt(0, 0, 0, lookat[0], lookat[1], lookat[2], 0, 1, 0);
206 // Map the -1:1 square to a 55.0x41.25 degree wide patch at z=1.
207 // This is the default fgfs field of view, which the HUD files are
208 // written to assume.
209 float dx = 0.52056705; // tan(55/2)
210 float dy = dx * 0.75; // assumes 4:3 aspect ratio
212 m[0] = dx, m[4] = 0, m[ 8] = 0, m[12] = 0;
213 m[1] = 0, m[5] = dy, m[ 9] = 0, m[13] = 0;
214 m[2] = 0, m[6] = 0, m[10] = 1, m[14] = 0;
215 m[3] = 0, m[7] = 0, m[11] = 0, m[15] = 1;
218 // Convert the 640x480 "HUD standard" coordinate space to a square
219 // about the origin in the range [-1:1] at depth of -1
220 glScalef(1.0 / 320, 1.0 / 240, 1);
221 glTranslatef(-320, -240, -1);
225 glMatrixMode(GL_PROJECTION);
227 glMatrixMode(GL_MODELVIEW);
232 void HUD::draw2D(GLfloat x_start, GLfloat y_start, GLfloat x_end, GLfloat y_end)
234 glMatrixMode(GL_PROJECTION);
237 gluOrtho2D(x_start, x_end, y_start, y_end);
239 glMatrixMode(GL_MODELVIEW);
245 glMatrixMode(GL_PROJECTION);
247 glMatrixMode(GL_MODELVIEW);
252 void HUD::common_draw()
256 _stipple_line_list.erase();
258 glDisable(GL_DEPTH_TEST);
259 glDisable(GL_LIGHTING);
263 glBlendFunc(GL_SRC_ALPHA, GL_ONE);
265 glBlendFunc(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA);
267 if (isAntialiased()) {
268 glEnable(GL_LINE_SMOOTH);
269 glAlphaFunc(GL_GREATER, alphaClamp());
270 glHint(GL_LINE_SMOOTH_HINT, GL_DONT_CARE);
279 deque<Item *>::const_iterator it, end = _items.end();
280 for (it = _items.begin(); it != end; ++it)
281 if ((*it)->isEnabled())
287 if (_stipple_line_list.size()) {
288 glEnable(GL_LINE_STIPPLE);
289 glLineStipple(1, 0x00FF);
290 _stipple_line_list.draw();
291 glDisable(GL_LINE_STIPPLE);
294 // ladders last, as they can have their own clip planes
295 end = _ladders.end();
296 for (it = _ladders.begin(); it != end; ++it)
297 if ((*it)->isEnabled())
302 if (isAntialiased()) {
303 glDisable(GL_ALPHA_TEST);
304 glDisable(GL_LINE_SMOOTH);
309 glBlendFunc(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA);
311 glEnable(GL_DEPTH_TEST);
312 glEnable(GL_LIGHTING);
316 int HUD::load(const char *file, float x, float y, int level, const string& indent)
318 const sgDebugPriority TREE = SG_INFO;
319 const int MAXNEST = 10;
321 SGPath path(globals->get_fg_root());
325 SG_LOG(SG_INPUT, TREE, endl << "load " << file);
326 _items.erase(_items.begin(), _items.end());
327 _ladders.erase(_ladders.begin(), _ladders.end());
328 } else if (level > MAXNEST) {
329 SG_LOG(SG_INPUT, SG_ALERT, "HUD: files nested more than " << MAXNEST << " levels");
331 } else if (!file || !file[0]) {
332 SG_LOG(SG_INPUT, SG_ALERT, "HUD: invalid filename ");
337 ifstream input(path.c_str());
339 SG_LOG(SG_INPUT, SG_ALERT, "HUD: Cannot read configuration from " << path.str());
345 readProperties(input, &root);
346 } catch (const sg_exception &e) {
348 guiErrorMessage("HUD: Error ", e);
353 _clip_box = new ClipBox(fgGetNode("/sim/hud/clipping"), x, y);
355 for (int i = 0; i < root.nChildren(); i++) {
356 SGPropertyNode *n = root.getChild(i);
357 const char *d = n->getStringValue("name", 0);
360 desc = string(": \"") + d + '"';
362 const char *name = n->getName();
363 if (!strcmp(name, "name")) {
366 } else if (!strcmp(name, "enable3d")) {
367 // set in the tree so that valueChanged() picks it up
368 _3DenabledN->setBoolValue(n->getBoolValue());
371 } else if (!strcmp(name, "import")) {
372 const char *fn = n->getStringValue("path", "");
373 float xoffs = n->getFloatValue("x-offset", 0.0f);
374 float yoffs = n->getFloatValue("y-offset", 0.0f);
376 SG_LOG(SG_INPUT, TREE, indent << "|__import " << fn << desc);
378 string ind = indent + string(i + 1 < root.nChildren() ? "| " : " ");
379 ret |= load(fn, x + xoffs, y + yoffs, level + 1, ind);
383 SG_LOG(SG_INPUT, TREE, indent << "|__" << name << desc);
386 if (!strcmp(name, "label")) {
387 item = static_cast<Item *>(new Label(this, n, x, y));
388 } else if (!strcmp(name, "gauge")) {
389 item = static_cast<Item *>(new Gauge(this, n, x, y));
390 } else if (!strcmp(name, "tape")) {
391 item = static_cast<Item *>(new Tape(this, n, x, y));
392 } else if (!strcmp(name, "dial")) {
393 item = static_cast<Item *>(new Dial(this, n, x, y));
394 } else if (!strcmp(name, "turn-bank-indicator")) {
395 item = static_cast<Item *>(new TurnBankIndicator(this, n, x, y));
396 } else if (!strcmp(name, "ladder")) {
397 item = static_cast<Item *>(new Ladder(this, n, x, y));
398 _ladders.insert(_ladders.begin(), item);
400 } else if (!strcmp(name, "runway")) {
401 item = static_cast<Item *>(new Runway(this, n, x, y));
402 } else if (!strcmp(name, "aiming-reticle")) {
403 item = static_cast<Item *>(new AimingReticle(this, n, x, y));
405 SG_LOG(SG_INPUT, TREE, indent << " \\...unsupported!");
408 _items.insert(_items.begin(), item);
411 SG_LOG(SG_INPUT, TREE, indent);
416 void HUD::valueChanged(SGPropertyNode *node)
418 if (_listener_active)
420 _listener_active = true;
421 if (!strcmp(node->getName(), "path"))
422 load(fgGetString("/sim/hud/path[1]", "Huds/default.xml"));
424 if (!strcmp(node->getName(), "current-color")) {
425 int i = node->getIntValue();
428 SGPropertyNode *n = fgGetNode("/sim/hud/palette", true);
429 if ((n = n->getChild("color", i, false))) {
430 if (n->hasValue("red"))
431 _red->setFloatValue(n->getFloatValue("red", 1.0));
432 if (n->hasValue("green"))
433 _green->setFloatValue(n->getFloatValue("green", 1.0));
434 if (n->hasValue("blue"))
435 _blue->setFloatValue(n->getFloatValue("blue", 1.0));
436 if (n->hasValue("alpha"))
437 _alpha->setFloatValue(n->getFloatValue("alpha", 0.67));
438 if (n->hasValue("alpha-clamp"))
439 _alpha_clamp->setFloatValue(n->getFloatValue("alpha-clamp", 0.01));
440 if (n->hasValue("brightness"))
441 _brightness->setFloatValue(n->getFloatValue("brightness", 0.75));
442 if (n->hasValue("antialiased"))
443 _antialiasing->setBoolValue(n->getBoolValue("antialiased", false));
444 if (n->hasValue("transparent"))
445 _transparency->setBoolValue(n->getBoolValue("transparent", false));
448 _scr_width = _scr_widthN->getIntValue();
449 _scr_height = _scr_heightN->getIntValue();
451 _visible = _visibility->getBoolValue();
452 _3Denabled = _3DenabledN->getBoolValue();
453 _transparent = _transparency->getBoolValue();
454 _antialiased = _antialiasing->getBoolValue();
455 float brt = _brightness->getFloatValue();
456 _r = clamp(brt * _red->getFloatValue());
457 _g = clamp(brt * _green->getFloatValue());
458 _b = clamp(brt * _blue->getFloatValue());
459 _a = clamp(_alpha->getFloatValue());
460 _cl = clamp(_alpha_clamp->getFloatValue());
462 _units = strcmp(_unitsN->getStringValue(), "feet") ? METER : FEET;
463 _listener_active = false;
467 void HUD::setColor() const
470 glColor4f(_r, _g, _b, _a);
472 glColor3f(_r, _g, _b);
476 void HUD::textAlign(fntRenderer *rend, const char *s, int align,
477 float *x, float *y, float *l, float *r, float *b, float *t)
479 fntFont *font = rend->getFont();
480 float gap = font->getGap();
481 float left, right, bot, top;
482 font->getBBox(s, rend->getPointSize(), rend->getSlant(), &left, &right, &bot, &top);
484 if (align & HUD::HCENTER)
485 *x -= left - gap + (right - left - gap) / 2.0;
486 else if (align & HUD::RIGHT)
488 else if (align & HUD::LEFT)
491 if (align & HUD::VCENTER)
492 *y -= bot + (top - bot) / 2.0;
493 else if (align & HUD::TOP)
495 else if (align & HUD::BOTTOM)
507 // HUDText -- text container for TextList vector
510 HUDText::HUDText(fntRenderer *fnt, float x, float y, const char *s, int align, int d) :
516 strncpy(_msg, s, BUFSIZE);
520 HUD::textAlign(fnt, s, align, &_x, &_y, &ign, &ign, &ign, &ign);
526 if (!_digits) { // show all digits in same size
527 _fnt->start2f(_x, _y);
533 // this code is changed to display Numbers with big/small digits
534 // according to MIL Standards for example Altitude above 10000 ft
535 // is shown as 10ooo.
542 //if negative value then increase the c and p values
544 c++; // was moved to the comment. Unintentionally? TODO
548 while (tmp[i] != '\0') {
549 if ((tmp[i] >= '0') && (tmp[i] <= '9'))
554 float orig_size = _fnt->getPointSize();
556 _fnt->setPointSize(orig_size * 0.8);
558 char *tmp1 = _msg + p1;
561 _fnt->start2f(_x + p2, _y);
564 _fnt->setPointSize(orig_size * 1.2);
566 strncpy(tmp2, _msg, p1);
569 _fnt->start2f(_x, _y);
572 _fnt->setPointSize(orig_size * 1.2);
573 _fnt->start2f(_x, _y);
576 _fnt->setPointSize(orig_size);
580 void TextList::align(const char *s, int align, float *x, float *y,
581 float *l, float *r, float *b, float *t) const
583 HUD::textAlign(_font, s, align, x, y, l, r, b, t);
587 void TextList::draw()
592 glPushAttrib(GL_COLOR_BUFFER_BIT);
596 vector<HUDText>::iterator it, end = _list.end();
597 for (it = _list.begin(); it != end; ++it)
601 glDisable(GL_TEXTURE_2D);
606 ClipBox::ClipBox(const SGPropertyNode *n, float xoffset, float yoffset) :
614 // const_cast is necessary because ATM there's no matching getChild(const ...)
615 // prototype and getNode(const ..., <bool>) is wrongly interpreted as
616 // getNode(const ..., <int>)
617 _top_node = (const_cast<SGPropertyNode *>(n))->getChild("top", 0, true);
618 _bot_node = (const_cast<SGPropertyNode *>(n))->getChild("bottom", 0, true);
619 _left_node = (const_cast<SGPropertyNode *>(n))->getChild("left", 0, true);
620 _right_node = (const_cast<SGPropertyNode *>(n))->getChild("right", 0, true);
622 _left[0] = 1.0, _left[1] = _left[2] = 0.0;
623 _right[0] = -1.0, _right[1] = _right[2] = 0.0;
624 _top[0] = 0.0, _top[1] = -1.0, _top[2] = 0.0;
625 _bot[0] = 0.0, _bot[1] = 1.0, _bot[2] = 0.0;
635 _left[3] = -_left_node->getDoubleValue() - _xoffs;
636 _right[3] = _right_node->getDoubleValue() + _xoffs;
637 _bot[3] = -_bot_node->getDoubleValue() - _yoffs;
638 _top[3] = _top_node->getDoubleValue() + _yoffs;
640 glClipPlane(GL_CLIP_PLANE0, _top);
641 glEnable(GL_CLIP_PLANE0);
642 glClipPlane(GL_CLIP_PLANE1, _bot);
643 glEnable(GL_CLIP_PLANE1);
644 glClipPlane(GL_CLIP_PLANE2, _left);
645 glEnable(GL_CLIP_PLANE2);
646 glClipPlane(GL_CLIP_PLANE3, _right);
647 glEnable(GL_CLIP_PLANE3);
651 void ClipBox::unset()
654 glDisable(GL_CLIP_PLANE0);
655 glDisable(GL_CLIP_PLANE1);
656 glDisable(GL_CLIP_PLANE2);
657 glDisable(GL_CLIP_PLANE3);