1 // hud.cxx -- hud defines and prototypes
3 // Written by Michele America, started September 1997.
5 // Copyright (C) 1997 Michele F. America - micheleamerica@geocities.com
7 // This program is free software; you can redistribute it and/or
8 // modify it under the terms of the GNU General Public License as
9 // published by the Free Software Foundation; either version 2 of the
10 // License, or (at your option) any later version.
12 // This program is distributed in the hope that it will be useful, but
13 // WITHOUT ANY WARRANTY; without even the implied warranty of
14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 // General Public License for more details.
17 // You should have received a copy of the GNU General Public License
18 // along with this program; if not, write to the Free Software
19 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
23 #include <simgear/compiler.h>
24 #include <simgear/structure/exception.hxx>
35 #include <stdio.h> // char related functions
36 #include <string.h> // strcmp()
38 #include <simgear/constants.h>
39 #include <simgear/debug/logstream.hxx>
40 #include <simgear/misc/sg_path.hxx>
41 #include <simgear/props/props_io.hxx>
45 #include <GUI/new_gui.hxx> // FGFontCache
46 #include <Main/globals.hxx>
47 #include <Scenery/scenery.hxx>
48 #include <Airports/runways.hxx>
49 #include <Main/viewer.hxx>
54 static HUD_Properties *HUDprop = 0;
58 deque<SGSharedPtr<instr_item> > HUD_deque;
60 fgTextList HUD_TextList;
61 fgLineList HUD_LineList;
62 fgLineList HUD_StippleLineList;
64 fntRenderer *HUDtext = 0;
65 fntTexFont *HUD_Font = 0;
66 float HUD_TextSize = 0;
71 int readHud( istream &input );
72 int readInstrument ( const SGPropertyNode * node);
74 static void drawHUD(osg::State*);
75 static void fgUpdateHUDVirtual(osg::State*);
82 locRECT( UINT left, UINT top, UINT right, UINT bottom);
83 RECT get_rect(void) { return rect; }
86 locRECT :: locRECT( UINT left, UINT top, UINT right, UINT bottom)
99 int readInstrument(const SGPropertyNode * node)
101 static const SGPropertyNode *startup_units_node
102 = fgGetNode("/sim/startup/units");
106 if ( !strcmp(startup_units_node->getStringValue(), "feet") ) {
107 strcpy(units, " ft");
112 const SGPropertyNode * ladder_group = node->getNode("ladders");
114 if (ladder_group != 0) {
115 int nLadders = ladder_group->nChildren();
116 for (int j = 0; j < nLadders; j++) {
117 HIptr = static_cast<instr_item *>(new HudLadder(ladder_group->getChild(j)));
118 HUD_deque.insert(HUD_deque.begin(), HIptr);
122 const SGPropertyNode * card_group = node->getNode("cards");
123 if (card_group != 0) {
124 int nCards = card_group->nChildren();
125 for (int j = 0; j < nCards; j++) {
126 const char *type = card_group->getChild(j)->getStringValue("type", "gauge");
128 if (!strcmp(type, "gauge"))
129 HIptr = static_cast<instr_item *>(new gauge_instr(card_group->getChild(j)));
130 else if (!strcmp(type, "dial") || !strcmp(type, "tape"))
131 HIptr = static_cast<instr_item *>(new hud_card(card_group->getChild(j)));
133 SG_LOG(SG_INPUT, SG_WARN, "HUD: unknown 'card' type: " << type);
136 HUD_deque.insert(HUD_deque.begin(), HIptr);
140 const SGPropertyNode * label_group = node->getNode("labels");
141 if (label_group != 0) {
142 int nLabels = label_group->nChildren();
143 for (int j = 0; j < nLabels; j++) {
144 HIptr = static_cast<instr_item *>(new instr_label(label_group->getChild(j)));
145 HUD_deque.insert(HUD_deque.begin(), HIptr);
149 const SGPropertyNode * tbi_group = node->getNode("tbis");
150 if (tbi_group != 0) {
151 int nTbis = tbi_group->nChildren();
152 for (int j = 0; j < nTbis; j++) {
153 HIptr = static_cast<instr_item *>(new fgTBI_instr(tbi_group->getChild(j)));
154 HUD_deque.insert(HUD_deque.begin(), HIptr);
158 const SGPropertyNode * rwy_group = node->getNode("runways");
159 if (rwy_group != 0) {
160 int nRwy = rwy_group->nChildren();
161 for (int j = 0; j < nRwy; j++) {
162 HIptr = static_cast<instr_item *>(new runway_instr(rwy_group->getChild(j)));
163 HUD_deque.insert(HUD_deque.begin(), HIptr);
167 } //end readinstrument
170 int readHud( istream &input )
176 readProperties(input, &root);
177 } catch (const sg_exception &e) {
178 guiErrorMessage("Error reading HUD: ", e);
183 SG_LOG(SG_INPUT, SG_DEBUG, "Read properties for " <<
184 root.getStringValue("name"));
186 if (!root.getNode("depreciated"))
187 SG_LOG(SG_INPUT, SG_ALERT, "WARNING: use of depreciated old HUD");
189 HUD_deque.erase( HUD_deque.begin(), HUD_deque.end());
192 SG_LOG(SG_INPUT, SG_DEBUG, "Reading Hud instruments");
194 const SGPropertyNode * instrument_group = root.getChild("instruments");
195 int nInstruments = instrument_group->nChildren();
197 for (int i = 0; i < nInstruments; i++) {
199 const SGPropertyNode * node = instrument_group->getChild(i);
201 SGPath path( globals->get_fg_root() );
202 path.append(node->getStringValue("path"));
204 SG_LOG(SG_INPUT, SG_DEBUG, "Reading Instrument "
209 SGPropertyNode root2;
211 readProperties(path.str(), &root2);
212 } catch (const sg_exception &e) {
213 guiErrorMessage("Error reading HUD instrument: ", e);
216 readInstrument(&root2);
225 // Constructs a HUD object and then adds in instruments. At the present
226 // the instruments are hard coded into the routine. Ultimately these need
227 // to be defined by the aircraft's instrumentation records so that the
228 // display for a Piper Cub doesn't show the speed range of a North American
229 // mustange and the engine readouts of a B36!
236 SG_LOG( SG_COCKPIT, SG_INFO, "Initializing current aircraft HUD" );
239 fgGetString("/sim/hud/path", "Huds/Default/default.xml");
240 SGPath path(globals->get_fg_root());
241 path.append(hud_path);
243 ifstream input(path.c_str());
245 SG_LOG(SG_INPUT, SG_ALERT,
246 "Cannot read Hud configuration from " << path.str());
253 // this chunk of code is not necessarily thread safe if the
254 // compiler optimizer reorders these statements. Note that
255 // "delete ptr" does not set "ptr = NULL". We have to do that
257 fntRenderer *tmp = HUDtext;
262 FGFontCache *fc = globals->get_fontcache();
263 const char* fileName = fgGetString("/sim/hud/font/name", "Helvetica.txf");
264 HUD_Font = fc->getTexFont(fileName);
266 throw sg_io_exception("/sim/hud/font/name is not a texture font",
267 sg_location(fileName));
269 HUD_TextSize = fgGetFloat("/sim/hud/font/size", 10);
271 HUDtext = new fntRenderer();
272 HUDtext->setFont(HUD_Font);
273 HUDtext->setPointSize(HUD_TextSize);
274 HUD_TextList.setFont( HUDtext );
277 HUDprop = new HUD_Properties;
278 return 0; // For now. Later we may use this for an error code.
288 SG_LOG( SG_COCKPIT, SG_INFO, "Initializing current aircraft HUD" );
290 SGPath path(globals->get_fg_root());
291 path.append("Huds/Minimal/default.xml");
294 ifstream input(path.c_str());
296 SG_LOG(SG_INPUT, SG_ALERT,
297 "Cannot read Hud configuration from " << path.str());
304 HUDprop = new HUD_Properties;
305 return 0; // For now. Later we may use this for an error code.
308 //$$$ End - added, Neetha, 28 Nov 2k
313 // Performs a once around the list of calls to instruments installed in
314 // the HUD object with requests for redraw. Kinda. It will when this is
317 void fgUpdateHUD( osg::State* state ) {
319 static const SGPropertyNode *enable3d_node = fgGetNode("/sim/hud/enable3d");
320 if ( HUD_style == 1 && enable3d_node->getBoolValue() ) {
321 fgUpdateHUDVirtual(state);
325 static const float normal_aspect = float(640) / float(480);
326 // note: aspect_ratio is Y/X
327 float current_aspect = 1.0f/globals->get_current_view()->get_aspect_ratio();
328 if ( current_aspect > normal_aspect ) {
329 float aspect_adjust = current_aspect / normal_aspect;
330 float adjust = 320.0f*aspect_adjust - 320.0f;
331 fgUpdateHUD( state, -adjust, 0.0f, 640.0f+adjust, 480.0f );
333 float aspect_adjust = normal_aspect / current_aspect;
334 float adjust = 240.0f*aspect_adjust - 240.0f;
335 fgUpdateHUD( state, 0.0f, -adjust, 640.0f, 480.0f+adjust );
339 void fgUpdateHUDVirtual(osg::State* state)
341 FGViewer* view = globals->get_current_view();
343 // Standard fgfs projection, with essentially meaningless clip
344 // planes (we'll map the whole HUD plane to z=-1)
345 glMatrixMode(GL_PROJECTION);
348 gluPerspective(view->get_v_fov(), 1/view->get_aspect_ratio(), 0.1, 10);
350 glMatrixMode(GL_MODELVIEW);
354 // Standard fgfs view direction computation
356 lookat[0] = -sin(SG_DEGREES_TO_RADIANS * view->getHeadingOffset_deg());
357 lookat[1] = tan(SG_DEGREES_TO_RADIANS * view->getPitchOffset_deg());
358 lookat[2] = -cos(SG_DEGREES_TO_RADIANS * view->getHeadingOffset_deg());
359 if (fabs(lookat[1]) > 9999)
360 lookat[1] = 9999; // FPU sanity
361 gluLookAt(0, 0, 0, lookat[0], lookat[1], lookat[2], 0, 1, 0);
363 // Map the -1:1 square to a 55.0x41.25 degree wide patch at z=1.
364 // This is the default fgfs field of view, which the HUD files are
365 // written to assume.
366 float dx = 0.52056705; // tan(55/2)
367 float dy = dx * 0.75; // assumes 4:3 aspect ratio
369 m[0] = dx; m[4] = 0; m[ 8] = 0; m[12] = 0;
370 m[1] = 0; m[5] = dy; m[ 9] = 0; m[13] = 0;
371 m[2] = 0; m[6] = 0; m[10] = 1; m[14] = 0;
372 m[3] = 0; m[7] = 0; m[11] = 0; m[15] = 1;
375 // Convert the 640x480 "HUD standard" coordinate space to a square
376 // about the origin in the range [-1:1] at depth of -1
377 glScalef(1./320, 1./240, 1);
378 glTranslatef(-320, -240, -1);
384 glMatrixMode(GL_PROJECTION);
386 glMatrixMode(GL_MODELVIEW);
391 void fgUpdateHUD( osg::State* state, GLfloat x_start, GLfloat y_start,
392 GLfloat x_end, GLfloat y_end )
394 glMatrixMode(GL_PROJECTION);
397 gluOrtho2D(x_start, x_end, y_start, y_end);
399 glMatrixMode(GL_MODELVIEW);
405 glMatrixMode(GL_PROJECTION);
407 glMatrixMode(GL_MODELVIEW);
412 void drawHUD(osg::State* state)
414 if ( !HUD_deque.size() ) // Trust everyone, but ALWAYS cut the cards!
417 HUD_TextList.erase();
418 HUD_LineList.erase();
419 // HUD_StippleLineList.erase();
421 glDisable(GL_DEPTH_TEST);
422 glDisable(GL_LIGHTING);
424 static const SGPropertyNode *heading_enabled
425 = fgGetNode("/autopilot/locks/heading", true);
426 static const SGPropertyNode *altitude_enabled
427 = fgGetNode("/autopilot/locks/altitude", true);
429 static char hud_hdg_text[256];
430 static char hud_gps_text0[256];
431 static char hud_gps_text1[256];
432 static char hud_gps_text2[256];
433 static char hud_alt_text[256];
436 if (HUDprop->isTransparent())
437 glBlendFunc(GL_SRC_ALPHA, GL_ONE);
439 glBlendFunc(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA);
441 if (HUDprop->isAntialiased()) {
442 glEnable(GL_LINE_SMOOTH);
443 glAlphaFunc(GL_GREATER, HUDprop->alphaClamp());
444 glHint(GL_LINE_SMOOTH_HINT, GL_DONT_CARE);
451 for_each(HUD_deque.begin(), HUD_deque.end(), HUDdraw());
453 //HUD_TextList.add( fgText(40, 10, get_formated_gmt_time(), 0) );
459 if (strcmp( heading_enabled->getStringValue(), "dg-heading-hold") == 0 ) {
460 snprintf( hud_hdg_text, 256, "hdg = %.1f\n",
461 fgGetDouble("/autopilot/settings/heading-bug-deg") );
462 HUD_TextList.add( fgText( 40, apY, hud_hdg_text ) );
464 } else if ( strcmp(heading_enabled->getStringValue(), "true-heading-hold") == 0 ) {
465 snprintf( hud_hdg_text, 256, "hdg = %.1f\n",
466 fgGetDouble("/autopilot/settings/true-heading-deg") );
467 HUD_TextList.add( fgText( 40, apY, hud_hdg_text ) );
471 // GPS current waypoint information
472 SGPropertyNode_ptr gps = fgGetNode("/instrumentation/gps", true);
473 SGPropertyNode_ptr curWp = gps->getChild("wp")->getChild("wp",1);
475 if ((gps->getDoubleValue("raim") > 0.5) && curWp) {
476 // GPS is receiving a valid signal
477 snprintf(hud_gps_text0, 256, "WPT:%5s BRG:%03.0f %5.1fnm",
478 curWp->getStringValue("ID"),
479 curWp->getDoubleValue("bearing-mag-deg"),
480 curWp->getDoubleValue("distance-nm"));
481 HUD_TextList.add( fgText( 40, apY, hud_gps_text0 ) );
484 // curWp->getStringValue("TTW")
485 snprintf(hud_gps_text2, 256, "ETA %s", curWp->getStringValue("TTW"));
486 HUD_TextList.add( fgText( 40, apY, hud_gps_text2 ) );
489 double courseError = curWp->getDoubleValue("course-error-nm");
490 if (fabs(courseError) >= 0.01) {
491 // generate an arrow indicatinng if the pilot should turn left or right
492 char dir = (courseError < 0.0) ? '<' : '>';
493 snprintf(hud_gps_text1, 256, "GPS TRK:%03.0f XTRK:%c%4.2fnm",
494 gps->getDoubleValue("indicated-track-magnetic-deg"), dir, fabs(courseError));
495 } else { // on course, don't bother showing the XTRK error
496 snprintf(hud_gps_text1, 256, "GPS TRK:%03.0f",
497 gps->getDoubleValue("indicated-track-magnetic-deg"));
500 HUD_TextList.add( fgText( 40, apY, hud_gps_text1) );
502 } // of valid GPS output
506 if ( strcmp( altitude_enabled->getStringValue(), "altitude-hold" ) == 0 ) {
507 snprintf( hud_alt_text, 256, "alt = %.0f\n",
508 fgGetDouble("/autopilot/settings/target-altitude-ft") );
509 HUD_TextList.add( fgText( 40, apY, hud_alt_text ) );
511 } else if ( strcmp( altitude_enabled->getStringValue(), "agl-hold" ) == 0 ){
512 snprintf( hud_alt_text, 256, "agl = %.0f\n",
513 fgGetDouble("/autopilot/settings/target-agl-ft") );
514 HUD_TextList.add( fgText( 40, apY, hud_alt_text ) );
521 // glEnable(GL_LINE_STIPPLE);
522 // glLineStipple( 1, 0x00FF );
523 // HUD_StippleLineList.draw();
524 // glDisable(GL_LINE_STIPPLE);
526 if (HUDprop->isAntialiased()) {
527 glDisable(GL_ALPHA_TEST);
528 glDisable(GL_LINE_SMOOTH);
532 if (HUDprop->isTransparent())
533 glBlendFunc(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA);
535 glEnable(GL_DEPTH_TEST);
536 glEnable(GL_LIGHTING);
540 void fgTextList::draw()
545 vector<fgText>::iterator curString = List.begin();
546 vector<fgText>::iterator lastString = List.end();
548 glPushAttrib(GL_COLOR_BUFFER_BIT);
549 glEnable(GL_TEXTURE_2D);
551 if (HUDprop->isTransparent())
552 glBlendFunc(GL_SRC_ALPHA, GL_ONE);
554 glBlendFunc(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA);
556 if (HUDprop->isAntialiased()) {
557 glEnable(GL_ALPHA_TEST);
558 glAlphaFunc(GL_GREATER, HUDprop->alphaClamp());
562 for (; curString != lastString; curString++)
563 curString->Draw(Font);
566 glDisable(GL_TEXTURE_2D);
571 // HUD property listener class
573 HUD_Properties::HUD_Properties() :
574 _current(fgGetNode("/sim/hud/current-color", true)),
575 _visibility(fgGetNode("/sim/hud/visibility", true)),
576 _antialiasing(fgGetNode("/sim/hud/color/antialiased", true)),
577 _transparency(fgGetNode("/sim/hud/color/transparent", true)),
578 _red(fgGetNode("/sim/hud/color/red", true)),
579 _green(fgGetNode("/sim/hud/color/green", true)),
580 _blue(fgGetNode("/sim/hud/color/blue", true)),
581 _alpha(fgGetNode("/sim/hud/color/alpha", true)),
582 _alpha_clamp(fgGetNode("/sim/hud/color/alpha-clamp", true)),
583 _brightness(fgGetNode("/sim/hud/color/brightness", true)),
590 _visibility->addChangeListener(this);
591 _antialiasing->addChangeListener(this);
592 _transparency->addChangeListener(this);
593 _red->addChangeListener(this);
594 _green->addChangeListener(this);
595 _blue->addChangeListener(this);
596 _alpha->addChangeListener(this);
597 _alpha_clamp->addChangeListener(this);
598 _brightness->addChangeListener(this);
599 _current->addChangeListener(this, true);
603 void HUD_Properties::valueChanged(SGPropertyNode *node)
605 if (!strcmp(node->getName(), "current-color")) {
606 int i = node->getIntValue();
609 SGPropertyNode *n = fgGetNode("/sim/hud/palette", true);
610 if ((n = n->getChild("color", i, false))) {
611 if (n->hasValue("red"))
612 _red->setFloatValue(n->getFloatValue("red", 1.0));
613 if (n->hasValue("green"))
614 _green->setFloatValue(n->getFloatValue("green", 1.0));
615 if (n->hasValue("blue"))
616 _blue->setFloatValue(n->getFloatValue("blue", 1.0));
617 if (n->hasValue("alpha"))
618 _alpha->setFloatValue(n->getFloatValue("alpha", 0.67));
619 if (n->hasValue("alpha-clamp"))
620 _alpha_clamp->setFloatValue(n->getFloatValue("alpha-clamp", 0.01));
621 if (n->hasValue("brightness"))
622 _brightness->setFloatValue(n->getFloatValue("brightness", 0.75));
623 if (n->hasValue("antialiased"))
624 _antialiasing->setBoolValue(n->getBoolValue("antialiased", false));
625 if (n->hasValue("transparent"))
626 _transparency->setBoolValue(n->getBoolValue("transparent", false));
629 _visible = _visibility->getBoolValue();
630 _transparent = _transparency->getBoolValue();
631 _antialiased = _antialiasing->getBoolValue();
632 float brt = _brightness->getFloatValue();
633 _r = clamp(brt * _red->getFloatValue());
634 _g = clamp(brt * _green->getFloatValue());
635 _b = clamp(brt * _blue->getFloatValue());
636 _a = clamp(_alpha->getFloatValue());
637 _cl = clamp(_alpha_clamp->getFloatValue());
641 void HUD_Properties::setColor() const
644 glColor4f(_r, _g, _b, _a);
646 glColor3f(_r, _g, _b);