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>
38 # define exception c_exception
44 #include <stdio.h> // char related functions
45 #include <string.h> // strcmp()
49 #include <simgear/constants.h>
50 #include <simgear/debug/logstream.hxx>
51 #include <simgear/misc/sg_path.hxx>
53 #include <Aircraft/aircraft.hxx>
54 //#include <Autopilot/xmlauto.hxx>
55 #include <GUI/new_gui.hxx> // FGFontCache
56 #include <Main/globals.hxx>
57 #include <Scenery/scenery.hxx>
62 static HUD_Properties *HUDprop = 0;
66 deque<instr_item *> HUD_deque;
68 fgTextList HUD_TextList;
69 fgLineList HUD_LineList;
70 fgLineList HUD_StippleLineList;
72 fntRenderer *HUDtext = 0;
73 fntTexFont *HUD_Font = 0;
74 float HUD_TextSize = 0;
79 int readHud( istream &input );
80 int readInstrument ( const SGPropertyNode * node);
82 static void drawHUD(osg::State*);
83 static void fgUpdateHUDVirtual(osg::State*);
90 locRECT( UINT left, UINT top, UINT right, UINT bottom);
91 RECT get_rect(void) { return rect; }
94 locRECT :: locRECT( UINT left, UINT top, UINT right, UINT bottom)
107 int readInstrument(const SGPropertyNode * node)
109 static const SGPropertyNode *startup_units_node
110 = fgGetNode("/sim/startup/units");
114 if ( !strcmp(startup_units_node->getStringValue(), "feet") ) {
115 strcpy(units, " ft");
120 const SGPropertyNode * ladder_group = node->getNode("ladders");
122 if (ladder_group != 0) {
123 int nLadders = ladder_group->nChildren();
124 for (int j = 0; j < nLadders; j++) {
125 HIptr = static_cast<instr_item *>(new HudLadder(ladder_group->getChild(j)));
126 HUD_deque.insert(HUD_deque.begin(), HIptr);
130 const SGPropertyNode * card_group = node->getNode("cards");
131 if (card_group != 0) {
132 int nCards = card_group->nChildren();
133 for (int j = 0; j < nCards; j++) {
134 const char *type = card_group->getChild(j)->getStringValue("type", "gauge");
136 if (!strcmp(type, "gauge"))
137 HIptr = static_cast<instr_item *>(new gauge_instr(card_group->getChild(j)));
138 else if (!strcmp(type, "dial") || !strcmp(type, "tape"))
139 HIptr = static_cast<instr_item *>(new hud_card(card_group->getChild(j)));
141 SG_LOG(SG_INPUT, SG_WARN, "HUD: unknown 'card' type: " << type);
144 HUD_deque.insert(HUD_deque.begin(), HIptr);
148 const SGPropertyNode * label_group = node->getNode("labels");
149 if (label_group != 0) {
150 int nLabels = label_group->nChildren();
151 for (int j = 0; j < nLabels; j++) {
152 HIptr = static_cast<instr_item *>(new instr_label(label_group->getChild(j)));
153 HUD_deque.insert(HUD_deque.begin(), HIptr);
157 const SGPropertyNode * tbi_group = node->getNode("tbis");
158 if (tbi_group != 0) {
159 int nTbis = tbi_group->nChildren();
160 for (int j = 0; j < nTbis; j++) {
161 HIptr = static_cast<instr_item *>(new fgTBI_instr(tbi_group->getChild(j)));
162 HUD_deque.insert(HUD_deque.begin(), HIptr);
166 const SGPropertyNode * rwy_group = node->getNode("runways");
167 if (rwy_group != 0) {
168 int nRwy = rwy_group->nChildren();
169 for (int j = 0; j < nRwy; j++) {
170 HIptr = static_cast<instr_item *>(new runway_instr(rwy_group->getChild(j)));
171 HUD_deque.insert(HUD_deque.begin(), HIptr);
175 } //end readinstrument
178 int readHud( istream &input )
184 readProperties(input, &root);
185 } catch (const sg_exception &e) {
186 guiErrorMessage("Error reading HUD: ", e);
191 SG_LOG(SG_INPUT, SG_INFO, "Read properties for " <<
192 root.getStringValue("name"));
195 HUD_deque.erase( HUD_deque.begin(), HUD_deque.end());
198 SG_LOG(SG_INPUT, SG_INFO, "Reading Hud instruments");
200 const SGPropertyNode * instrument_group = root.getChild("instruments");
201 int nInstruments = instrument_group->nChildren();
203 for (int i = 0; i < nInstruments; i++) {
205 const SGPropertyNode * node = instrument_group->getChild(i);
207 SGPath path( globals->get_fg_root() );
208 path.append(node->getStringValue("path"));
210 SG_LOG(SG_INPUT, SG_INFO, "Reading Instrument "
215 SGPropertyNode root2;
217 readProperties(path.str(), &root2);
218 } catch (const sg_exception &e) {
219 guiErrorMessage("Error reading HUD instrument: ", e);
222 readInstrument(&root2);
231 // Constructs a HUD object and then adds in instruments. At the present
232 // the instruments are hard coded into the routine. Ultimately these need
233 // to be defined by the aircraft's instrumentation records so that the
234 // display for a Piper Cub doesn't show the speed range of a North American
235 // mustange and the engine readouts of a B36!
237 int fgHUDInit( fgAIRCRAFT * /* current_aircraft */ )
242 SG_LOG( SG_COCKPIT, SG_INFO, "Initializing current aircraft HUD" );
245 fgGetString("/sim/hud/path", "Huds/Default/default.xml");
246 SGPath path(globals->get_fg_root());
247 path.append(hud_path);
249 ifstream input(path.c_str());
251 SG_LOG(SG_INPUT, SG_ALERT,
252 "Cannot read Hud configuration from " << path.str());
259 // this chunk of code is not necessarily thread safe if the
260 // compiler optimizer reorders these statements. Note that
261 // "delete ptr" does not set "ptr = NULL". We have to do that
263 fntRenderer *tmp = HUDtext;
268 FGFontCache *fc = globals->get_fontcache();
269 HUD_Font = fc->getTexFont(fgGetString("/sim/hud/font/name", "Helvetica.txf"));
271 throw sg_throwable(string("/sim/hud/font/name is not a texture font"));
273 HUD_TextSize = fgGetFloat("/sim/hud/font/size", 10);
275 HUDtext = new fntRenderer();
276 HUDtext->setFont(HUD_Font);
277 HUDtext->setPointSize(HUD_TextSize);
278 HUD_TextList.setFont( HUDtext );
281 HUDprop = new HUD_Properties;
282 return 0; // For now. Later we may use this for an error code.
287 int fgHUDInit2( fgAIRCRAFT * /* current_aircraft */ )
292 SG_LOG( SG_COCKPIT, SG_INFO, "Initializing current aircraft HUD" );
294 SGPath path(globals->get_fg_root());
295 path.append("Huds/Minimal/default.xml");
298 ifstream input(path.c_str());
300 SG_LOG(SG_INPUT, SG_ALERT,
301 "Cannot read Hud configuration from " << path.str());
308 HUDprop = new HUD_Properties;
309 return 0; // For now. Later we may use this for an error code.
312 //$$$ End - added, Neetha, 28 Nov 2k
317 // Performs a once around the list of calls to instruments installed in
318 // the HUD object with requests for redraw. Kinda. It will when this is
321 void fgUpdateHUD( osg::State* state ) {
323 static const SGPropertyNode *enable3d_node = fgGetNode("/sim/hud/enable3d");
324 if ( HUD_style == 1 && enable3d_node->getBoolValue() ) {
325 fgUpdateHUDVirtual(state);
329 static const float normal_aspect = float(640) / float(480);
330 // note: aspect_ratio is Y/X
331 float current_aspect = 1.0f/globals->get_current_view()->get_aspect_ratio();
332 if ( current_aspect > normal_aspect ) {
333 float aspect_adjust = current_aspect / normal_aspect;
334 float adjust = 320.0f*aspect_adjust - 320.0f;
335 fgUpdateHUD( state, -adjust, 0.0f, 640.0f+adjust, 480.0f );
337 float aspect_adjust = normal_aspect / current_aspect;
338 float adjust = 240.0f*aspect_adjust - 240.0f;
339 fgUpdateHUD( state, 0.0f, -adjust, 640.0f, 480.0f+adjust );
343 void fgUpdateHUDVirtual(osg::State* state)
345 FGViewer* view = globals->get_current_view();
347 // Standard fgfs projection, with essentially meaningless clip
348 // planes (we'll map the whole HUD plane to z=-1)
349 glMatrixMode(GL_PROJECTION);
352 gluPerspective(view->get_v_fov(), 1/view->get_aspect_ratio(), 0.1, 10);
354 glMatrixMode(GL_MODELVIEW);
358 // Standard fgfs view direction computation
360 lookat[0] = -sin(SG_DEGREES_TO_RADIANS * view->getHeadingOffset_deg());
361 lookat[1] = tan(SG_DEGREES_TO_RADIANS * view->getPitchOffset_deg());
362 lookat[2] = -cos(SG_DEGREES_TO_RADIANS * view->getHeadingOffset_deg());
363 if (fabs(lookat[1]) > 9999)
364 lookat[1] = 9999; // FPU sanity
365 gluLookAt(0, 0, 0, lookat[0], lookat[1], lookat[2], 0, 1, 0);
367 // Map the -1:1 square to a 55.0x41.25 degree wide patch at z=1.
368 // This is the default fgfs field of view, which the HUD files are
369 // written to assume.
370 float dx = 0.52056705; // tan(55/2)
371 float dy = dx * 0.75; // assumes 4:3 aspect ratio
373 m[0] = dx; m[4] = 0; m[ 8] = 0; m[12] = 0;
374 m[1] = 0; m[5] = dy; m[ 9] = 0; m[13] = 0;
375 m[2] = 0; m[6] = 0; m[10] = 1; m[14] = 0;
376 m[3] = 0; m[7] = 0; m[11] = 0; m[15] = 1;
379 // Convert the 640x480 "HUD standard" coordinate space to a square
380 // about the origin in the range [-1:1] at depth of -1
381 glScalef(1./320, 1./240, 1);
382 glTranslatef(-320, -240, -1);
388 glMatrixMode(GL_PROJECTION);
390 glMatrixMode(GL_MODELVIEW);
395 void fgUpdateHUD( osg::State* state, GLfloat x_start, GLfloat y_start,
396 GLfloat x_end, GLfloat y_end )
398 glMatrixMode(GL_PROJECTION);
401 gluOrtho2D(x_start, x_end, y_start, y_end);
403 glMatrixMode(GL_MODELVIEW);
409 glMatrixMode(GL_PROJECTION);
411 glMatrixMode(GL_MODELVIEW);
416 void drawHUD(osg::State* state)
418 if ( !HUD_deque.size() ) // Trust everyone, but ALWAYS cut the cards!
421 HUD_TextList.erase();
422 HUD_LineList.erase();
423 // HUD_StippleLineList.erase();
425 glDisable(GL_DEPTH_TEST);
426 glDisable(GL_LIGHTING);
428 static const SGPropertyNode *heading_enabled
429 = fgGetNode("/autopilot/locks/heading", true);
430 static const SGPropertyNode *altitude_enabled
431 = fgGetNode("/autopilot/locks/altitude", true);
433 static char hud_hdg_text[256];
434 static char hud_wp0_text[256];
435 static char hud_wp1_text[256];
436 static char hud_wp2_text[256];
437 static char hud_alt_text[256];
440 if (HUDprop->isTransparent())
441 glBlendFunc(GL_SRC_ALPHA, GL_ONE);
443 glBlendFunc(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA);
445 if (HUDprop->isAntialiased()) {
446 glEnable(GL_LINE_SMOOTH);
447 glAlphaFunc(GL_GREATER, HUDprop->alphaClamp());
448 glHint(GL_LINE_SMOOTH_HINT, GL_DONT_CARE);
455 for_each(HUD_deque.begin(), HUD_deque.end(), HUDdraw());
457 //HUD_TextList.add( fgText(40, 10, get_formated_gmt_time(), 0) );
463 if (strcmp( heading_enabled->getStringValue(), "dg-heading-hold") == 0 ) {
464 snprintf( hud_hdg_text, 256, "hdg = %.1f\n",
465 fgGetDouble("/autopilot/settings/heading-bug-deg") );
466 HUD_TextList.add( fgText( 40, apY, hud_hdg_text ) );
468 } else if ( strcmp(heading_enabled->getStringValue(), "true-heading-hold") == 0 ) {
469 snprintf( hud_hdg_text, 256, "hdg = %.1f\n",
470 fgGetDouble("/autopilot/settings/true-heading-deg") );
471 HUD_TextList.add( fgText( 40, apY, hud_hdg_text ) );
474 string wp0_id = fgGetString( "/autopilot/route-manager/wp[0]/id" );
475 if ( wp0_id.length() > 0 ) {
476 snprintf( hud_wp0_text, 256, "%5s %6.1fnm %s", wp0_id.c_str(),
477 fgGetDouble( "/autopilot/route-manager/wp[0]/dist" ),
478 fgGetString( "/autopilot/route-manager/wp[0]/eta" ) );
479 HUD_TextList.add( fgText( 40, apY, hud_wp0_text ) );
482 string wp1_id = fgGetString( "/autopilot/route-manager/wp[1]/id" );
483 if ( wp1_id.length() > 0 ) {
484 snprintf( hud_wp1_text, 256, "%5s %6.1fnm %s", wp1_id.c_str(),
485 fgGetDouble( "/autopilot/route-manager/wp[1]/dist" ),
486 fgGetString( "/autopilot/route-manager/wp[1]/eta" ) );
487 HUD_TextList.add( fgText( 40, apY, hud_wp1_text ) );
490 string wp2_id = fgGetString( "/autopilot/route-manager/wp-last/id" );
491 if ( wp2_id.length() > 0 ) {
492 snprintf( hud_wp2_text, 256, "%5s %6.1fnm %s", wp2_id.c_str(),
493 fgGetDouble( "/autopilot/route-manager/wp-last/dist" ),
494 fgGetString( "/autopilot/route-manager/wp-last/eta" ) );
495 HUD_TextList.add( fgText( 40, apY, hud_wp2_text ) );
500 if ( strcmp( altitude_enabled->getStringValue(), "altitude-hold" ) == 0 ) {
501 snprintf( hud_alt_text, 256, "alt = %.0f\n",
502 fgGetDouble("/autopilot/settings/target-altitude-ft") );
503 HUD_TextList.add( fgText( 40, apY, hud_alt_text ) );
505 } else if ( strcmp( altitude_enabled->getStringValue(), "agl-hold" ) == 0 ){
506 snprintf( hud_alt_text, 256, "agl = %.0f\n",
507 fgGetDouble("/autopilot/settings/target-agl-ft") );
508 HUD_TextList.add( fgText( 40, apY, hud_alt_text ) );
515 // glEnable(GL_LINE_STIPPLE);
516 // glLineStipple( 1, 0x00FF );
517 // HUD_StippleLineList.draw();
518 // glDisable(GL_LINE_STIPPLE);
520 if (HUDprop->isAntialiased()) {
521 glDisable(GL_ALPHA_TEST);
522 glDisable(GL_LINE_SMOOTH);
526 if (HUDprop->isTransparent())
527 glBlendFunc(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA);
529 glEnable(GL_DEPTH_TEST);
530 glEnable(GL_LIGHTING);
534 void fgTextList::draw()
539 vector<fgText>::iterator curString = List.begin();
540 vector<fgText>::iterator lastString = List.end();
542 glPushAttrib(GL_COLOR_BUFFER_BIT);
544 if (HUDprop->isTransparent())
545 glBlendFunc(GL_SRC_ALPHA, GL_ONE);
547 glBlendFunc(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA);
549 if (HUDprop->isAntialiased()) {
550 glEnable(GL_ALPHA_TEST);
551 glAlphaFunc(GL_GREATER, HUDprop->alphaClamp());
555 for (; curString != lastString; curString++)
556 curString->Draw(Font);
559 glDisable(GL_TEXTURE_2D);
564 // HUD property listener class
566 HUD_Properties::HUD_Properties() :
567 _current(fgGetNode("/sim/hud/current-color", true)),
568 _visibility(fgGetNode("/sim/hud/visibility", true)),
569 _antialiasing(fgGetNode("/sim/hud/color/antialiased", true)),
570 _transparency(fgGetNode("/sim/hud/color/transparent", true)),
571 _red(fgGetNode("/sim/hud/color/red", true)),
572 _green(fgGetNode("/sim/hud/color/green", true)),
573 _blue(fgGetNode("/sim/hud/color/blue", true)),
574 _alpha(fgGetNode("/sim/hud/color/alpha", true)),
575 _alpha_clamp(fgGetNode("/sim/hud/color/alpha-clamp", true)),
576 _brightness(fgGetNode("/sim/hud/color/brightness", true)),
583 _visibility->addChangeListener(this);
584 _antialiasing->addChangeListener(this);
585 _transparency->addChangeListener(this);
586 _red->addChangeListener(this);
587 _green->addChangeListener(this);
588 _blue->addChangeListener(this);
589 _alpha->addChangeListener(this);
590 _alpha_clamp->addChangeListener(this);
591 _brightness->addChangeListener(this);
592 _current->addChangeListener(this, true);
596 void HUD_Properties::valueChanged(SGPropertyNode *node)
598 if (!strcmp(node->getName(), "current-color")) {
599 int i = node->getIntValue();
602 SGPropertyNode *n = fgGetNode("/sim/hud/palette", true);
603 if ((n = n->getChild("color", i, false))) {
604 if (n->hasValue("red"))
605 _red->setFloatValue(n->getFloatValue("red", 1.0));
606 if (n->hasValue("green"))
607 _green->setFloatValue(n->getFloatValue("green", 1.0));
608 if (n->hasValue("blue"))
609 _blue->setFloatValue(n->getFloatValue("blue", 1.0));
610 if (n->hasValue("alpha"))
611 _alpha->setFloatValue(n->getFloatValue("alpha", 0.67));
612 if (n->hasValue("alpha-clamp"))
613 _alpha_clamp->setFloatValue(n->getFloatValue("alpha-clamp", 0.01));
614 if (n->hasValue("brightness"))
615 _brightness->setFloatValue(n->getFloatValue("brightness", 0.75));
616 if (n->hasValue("antialiased"))
617 _antialiasing->setBoolValue(n->getBoolValue("antialiased", false));
618 if (n->hasValue("transparent"))
619 _transparency->setBoolValue(n->getBoolValue("transparent", false));
622 _visible = _visibility->getBoolValue();
623 _transparent = _transparency->getBoolValue();
624 _antialiased = _antialiasing->getBoolValue();
625 float brt = _brightness->getFloatValue();
626 _r = clamp(brt * _red->getFloatValue());
627 _g = clamp(brt * _green->getFloatValue());
628 _b = clamp(brt * _blue->getFloatValue());
629 _a = clamp(_alpha->getFloatValue());
630 _cl = clamp(_alpha_clamp->getFloatValue());
634 void HUD_Properties::setColor() const
637 glColor4f(_r, _g, _b, _a);
639 glColor3f(_r, _g, _b);