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>
35 #include <Main/globals.hxx>
36 #include <Main/viewmgr.hxx>
43 static float clamp(float f)
45 return f < 0.0f ? 0.0f : f > 1.0f ? 1.0f : f;
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()),
77 SG_LOG(SG_COCKPIT, SG_INFO, "Initializing HUD Instrument");
79 _visibility->addChangeListener(this);
80 _3DenabledN->addChangeListener(this);
81 _antialiasing->addChangeListener(this);
82 _transparency->addChangeListener(this);
83 _red->addChangeListener(this);
84 _green->addChangeListener(this);
85 _blue->addChangeListener(this);
86 _alpha->addChangeListener(this);
87 _alpha_clamp->addChangeListener(this);
88 _brightness->addChangeListener(this);
89 _current->addChangeListener(this);
90 _scr_widthN->addChangeListener(this);
91 _scr_heightN->addChangeListener(this);
92 _unitsN->addChangeListener(this, true);
98 _visibility->removeChangeListener(this);
99 _3DenabledN->removeChangeListener(this);
100 _antialiasing->removeChangeListener(this);
101 _transparency->removeChangeListener(this);
102 _red->removeChangeListener(this);
103 _green->removeChangeListener(this);
104 _blue->removeChangeListener(this);
105 _alpha->removeChangeListener(this);
106 _alpha_clamp->removeChangeListener(this);
107 _brightness->removeChangeListener(this);
108 _current->removeChangeListener(this);
109 _scr_widthN->removeChangeListener(this);
110 _scr_heightN->removeChangeListener(this);
111 _unitsN->removeChangeListener(this);
112 delete _font_renderer;
114 deque<Item *>::const_iterator it, end = _items.end();
115 for (it = _items.begin(); it != end; ++it)
122 _font_cache = globals->get_fontcache();
124 _font = _font_cache->getTexFont(fgGetString("/sim/hud/font/name", "Helvetica.txf"));
126 throw sg_throwable(string("/sim/hud/font/name is not a texture font"));
128 _font_size = fgGetFloat("/sim/hud/font/size", 8);
129 _font_renderer->setFont(_font);
130 _font_renderer->setPointSize(_font_size);
131 _text_list.setFont(_font_renderer);
133 load(fgGetString("/sim/hud/path[1]", "Huds/default.xml"));
137 void HUD::update(double dt)
143 void HUD::draw(osg::State&)
156 const float normal_aspect = 640.0f / 480.0f;
157 // note: aspect_ratio is Y/X
158 float current_aspect = 1.0f / globals->get_current_view()->get_aspect_ratio();
159 if (current_aspect > normal_aspect) {
160 float aspect_adjust = current_aspect / normal_aspect;
161 float adjust = 320.0f * aspect_adjust - 320.0f;
162 draw2D(-adjust, 0.0f, 640.0f + adjust, 480.0f);
165 float aspect_adjust = normal_aspect / current_aspect;
166 float adjust = 240.0f * aspect_adjust - 240.0f;
167 draw2D(0.0f, -adjust, 640.0f, 480.0f + adjust);
170 glViewport(0, 0, _scr_width, _scr_height);
176 FGViewer* view = globals->get_current_view();
178 // Standard fgfs projection, with essentially meaningless clip
179 // planes (we'll map the whole HUD plane to z=-1)
180 glMatrixMode(GL_PROJECTION);
183 gluPerspective(view->get_v_fov(), 1.0 / view->get_aspect_ratio(), 0.1, 10);
185 glMatrixMode(GL_MODELVIEW);
189 // Standard fgfs view direction computation
191 lookat[0] = -sin(SG_DEGREES_TO_RADIANS * view->getHeadingOffset_deg());
192 lookat[1] = tan(SG_DEGREES_TO_RADIANS * view->getPitchOffset_deg());
193 lookat[2] = -cos(SG_DEGREES_TO_RADIANS * view->getHeadingOffset_deg());
194 if (fabs(lookat[1]) > 9999)
195 lookat[1] = 9999; // FPU sanity
196 gluLookAt(0, 0, 0, lookat[0], lookat[1], lookat[2], 0, 1, 0);
198 // Map the -1:1 square to a 55.0x41.25 degree wide patch at z=1.
199 // This is the default fgfs field of view, which the HUD files are
200 // written to assume.
201 float dx = 0.52056705; // tan(55/2)
202 float dy = dx * 0.75; // assumes 4:3 aspect ratio
204 m[0] = dx, m[4] = 0, m[ 8] = 0, m[12] = 0;
205 m[1] = 0, m[5] = dy, m[ 9] = 0, m[13] = 0;
206 m[2] = 0, m[6] = 0, m[10] = 1, m[14] = 0;
207 m[3] = 0, m[7] = 0, m[11] = 0, m[15] = 1;
210 // Convert the 640x480 "HUD standard" coordinate space to a square
211 // about the origin in the range [-1:1] at depth of -1
212 glScalef(1.0 / 320, 1.0 / 240, 1);
213 glTranslatef(-320, -240, -1);
217 glMatrixMode(GL_PROJECTION);
219 glMatrixMode(GL_MODELVIEW);
224 void HUD::draw2D(GLfloat x_start, GLfloat y_start, GLfloat x_end, GLfloat y_end)
226 glMatrixMode(GL_PROJECTION);
229 gluOrtho2D(x_start, x_end, y_start, y_end);
231 glMatrixMode(GL_MODELVIEW);
237 glMatrixMode(GL_PROJECTION);
239 glMatrixMode(GL_MODELVIEW);
244 void HUD::common_draw()
248 _stipple_line_list.erase();
250 glDisable(GL_DEPTH_TEST);
251 glDisable(GL_LIGHTING);
255 glBlendFunc(GL_SRC_ALPHA, GL_ONE);
257 glBlendFunc(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA);
259 if (isAntialiased()) {
260 glEnable(GL_LINE_SMOOTH);
261 glAlphaFunc(GL_GREATER, alphaClamp());
262 glHint(GL_LINE_SMOOTH_HINT, GL_DONT_CARE);
269 deque<Item *>::const_iterator it, end = _items.end();
270 for (it = _items.begin(); it != end; ++it)
271 if ((*it)->isEnabled())
277 if (_stipple_line_list.size()) {
278 glEnable(GL_LINE_STIPPLE);
279 glLineStipple(1, 0x00FF);
280 _stipple_line_list.draw();
281 glDisable(GL_LINE_STIPPLE);
284 if (isAntialiased()) {
285 glDisable(GL_ALPHA_TEST);
286 glDisable(GL_LINE_SMOOTH);
291 glBlendFunc(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA);
293 glEnable(GL_DEPTH_TEST);
294 glEnable(GL_LIGHTING);
298 int HUD::load(const char *file, float x, float y, int level, const string& indent)
300 const sgDebugPriority TREE = SG_INFO;
301 const int MAXNEST = 10;
303 SGPath path(globals->get_fg_root());
307 SG_LOG(SG_INPUT, TREE, endl << "load " << file);
308 _items.erase(_items.begin(), _items.end());
309 } else if (level > MAXNEST) {
310 SG_LOG(SG_INPUT, SG_ALERT, "HUD: files nested more than " << MAXNEST << " levels");
312 } else if (!file || !file[0]) {
313 SG_LOG(SG_INPUT, SG_ALERT, "HUD: invalid filename ");
318 ifstream input(path.c_str());
320 SG_LOG(SG_INPUT, SG_ALERT, "HUD: Cannot read configuration from " << path.str());
326 readProperties(input, &root);
327 } catch (const sg_exception &e) {
329 guiErrorMessage("HUD: Error ", e);
333 for (int i = 0; i < root.nChildren(); i++) {
334 SGPropertyNode *n = root.getChild(i);
335 const char *d = n->getStringValue("name", 0);
338 desc = string(": \"") + d + '"';
340 const char *name = n->getName();
341 if (!strcmp(name, "name")) {
344 } else if (!strcmp(name, "enable3d")) {
345 // set in the tree so that valueChanged() picks it up
346 _3DenabledN->setBoolValue(n->getBoolValue());
349 } else if (!strcmp(name, "import")) {
350 const char *fn = n->getStringValue("path", "");
351 float xoffs = n->getFloatValue("x-offset", 0.0f);
352 float yoffs = n->getFloatValue("y-offset", 0.0f);
354 SG_LOG(SG_INPUT, TREE, indent << "|__import " << fn << desc);
356 string ind = indent + string(i + 1 < root.nChildren() ? "| " : " ");
357 ret |= load(fn, x + xoffs, y + yoffs, level + 1, ind);
361 SG_LOG(SG_INPUT, TREE, indent << "|__" << name << desc);
364 if (!strcmp(name, "label")) {
365 item = static_cast<Item *>(new Label(this, n, x, y));
366 } else if (!strcmp(name, "gauge")) {
367 item = static_cast<Item *>(new Gauge(this, n, x, y));
368 } else if (!strcmp(name, "tape")) {
369 item = static_cast<Item *>(new Tape(this, n, x, y));
370 } else if (!strcmp(name, "dial")) {
371 item = static_cast<Item *>(new Dial(this, n, x, y));
372 } else if (!strcmp(name, "turn-bank-indicator")) {
373 item = static_cast<Item *>(new TurnBankIndicator(this, n, x, y));
374 } else if (!strcmp(name, "ladder")) {
375 item = static_cast<Item *>(new Ladder(this, n, x, y));
376 } else if (!strcmp(name, "runway")) {
377 item = static_cast<Item *>(new Runway(this, n, x, y));
378 } else if (!strcmp(name, "aiming-reticle")) {
379 item = static_cast<Item *>(new AimingReticle(this, n, x, y));
381 SG_LOG(SG_INPUT, TREE, indent << " \\...unsupported!");
384 _items.insert(_items.begin(), item);
387 SG_LOG(SG_INPUT, TREE, indent);
392 void HUD::valueChanged(SGPropertyNode *node)
394 if (!strcmp(node->getName(), "current-color")) {
395 int i = node->getIntValue();
398 SGPropertyNode *n = fgGetNode("/sim/hud/palette", true);
399 if ((n = n->getChild("color", i, false))) {
400 if (n->hasValue("red"))
401 _red->setFloatValue(n->getFloatValue("red", 1.0));
402 if (n->hasValue("green"))
403 _green->setFloatValue(n->getFloatValue("green", 1.0));
404 if (n->hasValue("blue"))
405 _blue->setFloatValue(n->getFloatValue("blue", 1.0));
406 if (n->hasValue("alpha"))
407 _alpha->setFloatValue(n->getFloatValue("alpha", 0.67));
408 if (n->hasValue("alpha-clamp"))
409 _alpha_clamp->setFloatValue(n->getFloatValue("alpha-clamp", 0.01));
410 if (n->hasValue("brightness"))
411 _brightness->setFloatValue(n->getFloatValue("brightness", 0.75));
412 if (n->hasValue("antialiased"))
413 _antialiasing->setBoolValue(n->getBoolValue("antialiased", false));
414 if (n->hasValue("transparent"))
415 _transparency->setBoolValue(n->getBoolValue("transparent", false));
418 _scr_width = _scr_widthN->getIntValue();
419 _scr_height = _scr_heightN->getIntValue();
421 _visible = _visibility->getBoolValue();
422 _3Denabled = _3DenabledN->getBoolValue();
423 _transparent = _transparency->getBoolValue();
424 _antialiased = _antialiasing->getBoolValue();
425 float brt = _brightness->getFloatValue();
426 _r = clamp(brt * _red->getFloatValue());
427 _g = clamp(brt * _green->getFloatValue());
428 _b = clamp(brt * _blue->getFloatValue());
429 _a = clamp(_alpha->getFloatValue());
430 _cl = clamp(_alpha_clamp->getFloatValue());
432 _units = strcmp(_unitsN->getStringValue(), "feet") ? METER : FEET;
436 void HUD::setColor() const
439 glColor4f(_r, _g, _b, _a);
441 glColor3f(_r, _g, _b);
447 void HUD::textAlign(fntRenderer *rend, const char *s, int align,
448 float *x, float *y, float *l, float *r, float *t, float *b)
450 fntFont *font = rend->getFont();
451 float gap = font->getGap();
452 float left, right, bot, top;
453 font->getBBox(s, rend->getPointSize(), rend->getSlant(), &left, &right, &bot, &top);
455 if (align & HUD::HCENTER)
456 *x -= left - gap + (right - left - gap) / 2.0;
457 else if (align & HUD::RIGHT)
459 else if (align & HUD::LEFT)
462 if (align & HUD::VCENTER)
463 *y -= bot + (top - bot) / 2.0;
464 else if (align & HUD::TOP)
466 else if (align & HUD::BOTTOM)
478 // HUDText -- text container for TextList vector
481 HUDText::HUDText(fntRenderer *fnt, float x, float y, const char *s, int align, int d) :
487 strncpy(_msg, s, BUFSIZE);
491 HUD::textAlign(fnt, s, align, &_x, &_y, &ign, &ign, &ign, &ign);
497 if (!_digits) { // show all digits in same size
498 _fnt->start2f(_x, _y);
504 // this code is changed to display Numbers with big/small digits
505 // according to MIL Standards for example Altitude above 10000 ft
506 // is shown as 10ooo.
513 //if negative value then increase the c and p values
515 c++; // was moved to the comment. Unintentionally? TODO
519 while (tmp[i] != '\0') {
520 if ((tmp[i] >= '0') && (tmp[i] <= '9'))
525 float orig_size = _fnt->getPointSize();
527 _fnt->setPointSize(orig_size * 0.8);
529 char *tmp1 = _msg + p1;
532 _fnt->start2f(_x + p2, _y);
535 _fnt->setPointSize(orig_size * 1.2);
537 strncpy(tmp2, _msg, p1);
540 _fnt->start2f(_x, _y);
543 _fnt->setPointSize(orig_size * 1.2);
544 _fnt->start2f(_x, _y);
547 _fnt->setPointSize(orig_size);
551 void TextList::align(const char *s, int align, float *x, float *y,
552 float *l, float *r, float *b, float *t) const
554 HUD::textAlign(_font, s, align, x, y, l, r, b, t);
558 void TextList::draw()
563 glPushAttrib(GL_COLOR_BUFFER_BIT);
567 vector<HUDText>::iterator it, end = _list.end();
568 for (it = _list.begin(); it != end; ++it)
572 glDisable(GL_TEXTURE_2D);