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>
43 #include <Aircraft/aircraft.hxx>
44 //#include <Autopilot/xmlauto.hxx>
45 #include <GUI/new_gui.hxx> // FGFontCache
46 #include <Main/globals.hxx>
47 #include <Scenery/scenery.hxx>
52 static HUD_Properties *HUDprop = 0;
56 deque<SGSharedPtr<instr_item> > HUD_deque;
58 fgTextList HUD_TextList;
59 fgLineList HUD_LineList;
60 fgLineList HUD_StippleLineList;
62 fntRenderer *HUDtext = 0;
63 fntTexFont *HUD_Font = 0;
64 float HUD_TextSize = 0;
69 int readHud( istream &input );
70 int readInstrument ( const SGPropertyNode * node);
72 static void drawHUD(osg::State*);
73 static void fgUpdateHUDVirtual(osg::State*);
80 locRECT( UINT left, UINT top, UINT right, UINT bottom);
81 RECT get_rect(void) { return rect; }
84 locRECT :: locRECT( UINT left, UINT top, UINT right, UINT bottom)
97 int readInstrument(const SGPropertyNode * node)
99 static const SGPropertyNode *startup_units_node
100 = fgGetNode("/sim/startup/units");
104 if ( !strcmp(startup_units_node->getStringValue(), "feet") ) {
105 strcpy(units, " ft");
110 const SGPropertyNode * ladder_group = node->getNode("ladders");
112 if (ladder_group != 0) {
113 int nLadders = ladder_group->nChildren();
114 for (int j = 0; j < nLadders; j++) {
115 HIptr = static_cast<instr_item *>(new HudLadder(ladder_group->getChild(j)));
116 HUD_deque.insert(HUD_deque.begin(), HIptr);
120 const SGPropertyNode * card_group = node->getNode("cards");
121 if (card_group != 0) {
122 int nCards = card_group->nChildren();
123 for (int j = 0; j < nCards; j++) {
124 const char *type = card_group->getChild(j)->getStringValue("type", "gauge");
126 if (!strcmp(type, "gauge"))
127 HIptr = static_cast<instr_item *>(new gauge_instr(card_group->getChild(j)));
128 else if (!strcmp(type, "dial") || !strcmp(type, "tape"))
129 HIptr = static_cast<instr_item *>(new hud_card(card_group->getChild(j)));
131 SG_LOG(SG_INPUT, SG_WARN, "HUD: unknown 'card' type: " << type);
134 HUD_deque.insert(HUD_deque.begin(), HIptr);
138 const SGPropertyNode * label_group = node->getNode("labels");
139 if (label_group != 0) {
140 int nLabels = label_group->nChildren();
141 for (int j = 0; j < nLabels; j++) {
142 HIptr = static_cast<instr_item *>(new instr_label(label_group->getChild(j)));
143 HUD_deque.insert(HUD_deque.begin(), HIptr);
147 const SGPropertyNode * tbi_group = node->getNode("tbis");
148 if (tbi_group != 0) {
149 int nTbis = tbi_group->nChildren();
150 for (int j = 0; j < nTbis; j++) {
151 HIptr = static_cast<instr_item *>(new fgTBI_instr(tbi_group->getChild(j)));
152 HUD_deque.insert(HUD_deque.begin(), HIptr);
156 const SGPropertyNode * rwy_group = node->getNode("runways");
157 if (rwy_group != 0) {
158 int nRwy = rwy_group->nChildren();
159 for (int j = 0; j < nRwy; j++) {
160 HIptr = static_cast<instr_item *>(new runway_instr(rwy_group->getChild(j)));
161 HUD_deque.insert(HUD_deque.begin(), HIptr);
165 } //end readinstrument
168 int readHud( istream &input )
174 readProperties(input, &root);
175 } catch (const sg_exception &e) {
176 guiErrorMessage("Error reading HUD: ", e);
181 SG_LOG(SG_INPUT, SG_INFO, "Read properties for " <<
182 root.getStringValue("name"));
184 if (!root.getNode("depreciated"))
185 SG_LOG(SG_INPUT, SG_ALERT, "WARNING: use of depreciated old HUD");
187 HUD_deque.erase( HUD_deque.begin(), HUD_deque.end());
190 SG_LOG(SG_INPUT, SG_INFO, "Reading Hud instruments");
192 const SGPropertyNode * instrument_group = root.getChild("instruments");
193 int nInstruments = instrument_group->nChildren();
195 for (int i = 0; i < nInstruments; i++) {
197 const SGPropertyNode * node = instrument_group->getChild(i);
199 SGPath path( globals->get_fg_root() );
200 path.append(node->getStringValue("path"));
202 SG_LOG(SG_INPUT, SG_INFO, "Reading Instrument "
207 SGPropertyNode root2;
209 readProperties(path.str(), &root2);
210 } catch (const sg_exception &e) {
211 guiErrorMessage("Error reading HUD instrument: ", e);
214 readInstrument(&root2);
223 // Constructs a HUD object and then adds in instruments. At the present
224 // the instruments are hard coded into the routine. Ultimately these need
225 // to be defined by the aircraft's instrumentation records so that the
226 // display for a Piper Cub doesn't show the speed range of a North American
227 // mustange and the engine readouts of a B36!
229 int fgHUDInit( fgAIRCRAFT * /* current_aircraft */ )
234 SG_LOG( SG_COCKPIT, SG_INFO, "Initializing current aircraft HUD" );
237 fgGetString("/sim/hud/path", "Huds/Default/default.xml");
238 SGPath path(globals->get_fg_root());
239 path.append(hud_path);
241 ifstream input(path.c_str());
243 SG_LOG(SG_INPUT, SG_ALERT,
244 "Cannot read Hud configuration from " << path.str());
251 // this chunk of code is not necessarily thread safe if the
252 // compiler optimizer reorders these statements. Note that
253 // "delete ptr" does not set "ptr = NULL". We have to do that
255 fntRenderer *tmp = HUDtext;
260 FGFontCache *fc = globals->get_fontcache();
261 HUD_Font = fc->getTexFont(fgGetString("/sim/hud/font/name", "Helvetica.txf"));
263 throw sg_throwable(string("/sim/hud/font/name is not a texture font"));
265 HUD_TextSize = fgGetFloat("/sim/hud/font/size", 10);
267 HUDtext = new fntRenderer();
268 HUDtext->setFont(HUD_Font);
269 HUDtext->setPointSize(HUD_TextSize);
270 HUD_TextList.setFont( HUDtext );
273 HUDprop = new HUD_Properties;
274 return 0; // For now. Later we may use this for an error code.
279 int fgHUDInit2( fgAIRCRAFT * /* current_aircraft */ )
284 SG_LOG( SG_COCKPIT, SG_INFO, "Initializing current aircraft HUD" );
286 SGPath path(globals->get_fg_root());
287 path.append("Huds/Minimal/default.xml");
290 ifstream input(path.c_str());
292 SG_LOG(SG_INPUT, SG_ALERT,
293 "Cannot read Hud configuration from " << path.str());
300 HUDprop = new HUD_Properties;
301 return 0; // For now. Later we may use this for an error code.
304 //$$$ End - added, Neetha, 28 Nov 2k
309 // Performs a once around the list of calls to instruments installed in
310 // the HUD object with requests for redraw. Kinda. It will when this is
313 void fgUpdateHUD( osg::State* state ) {
315 static const SGPropertyNode *enable3d_node = fgGetNode("/sim/hud/enable3d");
316 if ( HUD_style == 1 && enable3d_node->getBoolValue() ) {
317 fgUpdateHUDVirtual(state);
321 static const float normal_aspect = float(640) / float(480);
322 // note: aspect_ratio is Y/X
323 float current_aspect = 1.0f/globals->get_current_view()->get_aspect_ratio();
324 if ( current_aspect > normal_aspect ) {
325 float aspect_adjust = current_aspect / normal_aspect;
326 float adjust = 320.0f*aspect_adjust - 320.0f;
327 fgUpdateHUD( state, -adjust, 0.0f, 640.0f+adjust, 480.0f );
329 float aspect_adjust = normal_aspect / current_aspect;
330 float adjust = 240.0f*aspect_adjust - 240.0f;
331 fgUpdateHUD( state, 0.0f, -adjust, 640.0f, 480.0f+adjust );
335 void fgUpdateHUDVirtual(osg::State* state)
337 FGViewer* view = globals->get_current_view();
339 // Standard fgfs projection, with essentially meaningless clip
340 // planes (we'll map the whole HUD plane to z=-1)
341 glMatrixMode(GL_PROJECTION);
344 gluPerspective(view->get_v_fov(), 1/view->get_aspect_ratio(), 0.1, 10);
346 glMatrixMode(GL_MODELVIEW);
350 // Standard fgfs view direction computation
352 lookat[0] = -sin(SG_DEGREES_TO_RADIANS * view->getHeadingOffset_deg());
353 lookat[1] = tan(SG_DEGREES_TO_RADIANS * view->getPitchOffset_deg());
354 lookat[2] = -cos(SG_DEGREES_TO_RADIANS * view->getHeadingOffset_deg());
355 if (fabs(lookat[1]) > 9999)
356 lookat[1] = 9999; // FPU sanity
357 gluLookAt(0, 0, 0, lookat[0], lookat[1], lookat[2], 0, 1, 0);
359 // Map the -1:1 square to a 55.0x41.25 degree wide patch at z=1.
360 // This is the default fgfs field of view, which the HUD files are
361 // written to assume.
362 float dx = 0.52056705; // tan(55/2)
363 float dy = dx * 0.75; // assumes 4:3 aspect ratio
365 m[0] = dx; m[4] = 0; m[ 8] = 0; m[12] = 0;
366 m[1] = 0; m[5] = dy; m[ 9] = 0; m[13] = 0;
367 m[2] = 0; m[6] = 0; m[10] = 1; m[14] = 0;
368 m[3] = 0; m[7] = 0; m[11] = 0; m[15] = 1;
371 // Convert the 640x480 "HUD standard" coordinate space to a square
372 // about the origin in the range [-1:1] at depth of -1
373 glScalef(1./320, 1./240, 1);
374 glTranslatef(-320, -240, -1);
380 glMatrixMode(GL_PROJECTION);
382 glMatrixMode(GL_MODELVIEW);
387 void fgUpdateHUD( osg::State* state, GLfloat x_start, GLfloat y_start,
388 GLfloat x_end, GLfloat y_end )
390 glMatrixMode(GL_PROJECTION);
393 gluOrtho2D(x_start, x_end, y_start, y_end);
395 glMatrixMode(GL_MODELVIEW);
401 glMatrixMode(GL_PROJECTION);
403 glMatrixMode(GL_MODELVIEW);
408 void drawHUD(osg::State* state)
410 if ( !HUD_deque.size() ) // Trust everyone, but ALWAYS cut the cards!
413 HUD_TextList.erase();
414 HUD_LineList.erase();
415 // HUD_StippleLineList.erase();
417 glDisable(GL_DEPTH_TEST);
418 glDisable(GL_LIGHTING);
420 static const SGPropertyNode *heading_enabled
421 = fgGetNode("/autopilot/locks/heading", true);
422 static const SGPropertyNode *altitude_enabled
423 = fgGetNode("/autopilot/locks/altitude", true);
425 static char hud_hdg_text[256];
426 static char hud_wp0_text[256];
427 static char hud_wp1_text[256];
428 static char hud_wp2_text[256];
429 static char hud_alt_text[256];
432 if (HUDprop->isTransparent())
433 glBlendFunc(GL_SRC_ALPHA, GL_ONE);
435 glBlendFunc(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA);
437 if (HUDprop->isAntialiased()) {
438 glEnable(GL_LINE_SMOOTH);
439 glAlphaFunc(GL_GREATER, HUDprop->alphaClamp());
440 glHint(GL_LINE_SMOOTH_HINT, GL_DONT_CARE);
447 for_each(HUD_deque.begin(), HUD_deque.end(), HUDdraw());
449 //HUD_TextList.add( fgText(40, 10, get_formated_gmt_time(), 0) );
455 if (strcmp( heading_enabled->getStringValue(), "dg-heading-hold") == 0 ) {
456 snprintf( hud_hdg_text, 256, "hdg = %.1f\n",
457 fgGetDouble("/autopilot/settings/heading-bug-deg") );
458 HUD_TextList.add( fgText( 40, apY, hud_hdg_text ) );
460 } else if ( strcmp(heading_enabled->getStringValue(), "true-heading-hold") == 0 ) {
461 snprintf( hud_hdg_text, 256, "hdg = %.1f\n",
462 fgGetDouble("/autopilot/settings/true-heading-deg") );
463 HUD_TextList.add( fgText( 40, apY, hud_hdg_text ) );
466 string wp0_id = fgGetString( "/autopilot/route-manager/wp[0]/id" );
467 if ( wp0_id.length() > 0 ) {
468 snprintf( hud_wp0_text, 256, "%5s %6.1fnm %s", wp0_id.c_str(),
469 fgGetDouble( "/autopilot/route-manager/wp[0]/dist" ),
470 fgGetString( "/autopilot/route-manager/wp[0]/eta" ) );
471 HUD_TextList.add( fgText( 40, apY, hud_wp0_text ) );
474 string wp1_id = fgGetString( "/autopilot/route-manager/wp[1]/id" );
475 if ( wp1_id.length() > 0 ) {
476 snprintf( hud_wp1_text, 256, "%5s %6.1fnm %s", wp1_id.c_str(),
477 fgGetDouble( "/autopilot/route-manager/wp[1]/dist" ),
478 fgGetString( "/autopilot/route-manager/wp[1]/eta" ) );
479 HUD_TextList.add( fgText( 40, apY, hud_wp1_text ) );
482 string wp2_id = fgGetString( "/autopilot/route-manager/wp-last/id" );
483 if ( wp2_id.length() > 0 ) {
484 snprintf( hud_wp2_text, 256, "%5s %6.1fnm %s", wp2_id.c_str(),
485 fgGetDouble( "/autopilot/route-manager/wp-last/dist" ),
486 fgGetString( "/autopilot/route-manager/wp-last/eta" ) );
487 HUD_TextList.add( fgText( 40, apY, hud_wp2_text ) );
492 if ( strcmp( altitude_enabled->getStringValue(), "altitude-hold" ) == 0 ) {
493 snprintf( hud_alt_text, 256, "alt = %.0f\n",
494 fgGetDouble("/autopilot/settings/target-altitude-ft") );
495 HUD_TextList.add( fgText( 40, apY, hud_alt_text ) );
497 } else if ( strcmp( altitude_enabled->getStringValue(), "agl-hold" ) == 0 ){
498 snprintf( hud_alt_text, 256, "agl = %.0f\n",
499 fgGetDouble("/autopilot/settings/target-agl-ft") );
500 HUD_TextList.add( fgText( 40, apY, hud_alt_text ) );
507 // glEnable(GL_LINE_STIPPLE);
508 // glLineStipple( 1, 0x00FF );
509 // HUD_StippleLineList.draw();
510 // glDisable(GL_LINE_STIPPLE);
512 if (HUDprop->isAntialiased()) {
513 glDisable(GL_ALPHA_TEST);
514 glDisable(GL_LINE_SMOOTH);
518 if (HUDprop->isTransparent())
519 glBlendFunc(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA);
521 glEnable(GL_DEPTH_TEST);
522 glEnable(GL_LIGHTING);
526 void fgTextList::draw()
531 vector<fgText>::iterator curString = List.begin();
532 vector<fgText>::iterator lastString = List.end();
534 glPushAttrib(GL_COLOR_BUFFER_BIT);
535 glEnable(GL_TEXTURE_2D);
537 if (HUDprop->isTransparent())
538 glBlendFunc(GL_SRC_ALPHA, GL_ONE);
540 glBlendFunc(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA);
542 if (HUDprop->isAntialiased()) {
543 glEnable(GL_ALPHA_TEST);
544 glAlphaFunc(GL_GREATER, HUDprop->alphaClamp());
548 for (; curString != lastString; curString++)
549 curString->Draw(Font);
552 glDisable(GL_TEXTURE_2D);
557 // HUD property listener class
559 HUD_Properties::HUD_Properties() :
560 _current(fgGetNode("/sim/hud/current-color", true)),
561 _visibility(fgGetNode("/sim/hud/visibility", true)),
562 _antialiasing(fgGetNode("/sim/hud/color/antialiased", true)),
563 _transparency(fgGetNode("/sim/hud/color/transparent", true)),
564 _red(fgGetNode("/sim/hud/color/red", true)),
565 _green(fgGetNode("/sim/hud/color/green", true)),
566 _blue(fgGetNode("/sim/hud/color/blue", true)),
567 _alpha(fgGetNode("/sim/hud/color/alpha", true)),
568 _alpha_clamp(fgGetNode("/sim/hud/color/alpha-clamp", true)),
569 _brightness(fgGetNode("/sim/hud/color/brightness", true)),
576 _visibility->addChangeListener(this);
577 _antialiasing->addChangeListener(this);
578 _transparency->addChangeListener(this);
579 _red->addChangeListener(this);
580 _green->addChangeListener(this);
581 _blue->addChangeListener(this);
582 _alpha->addChangeListener(this);
583 _alpha_clamp->addChangeListener(this);
584 _brightness->addChangeListener(this);
585 _current->addChangeListener(this, true);
589 void HUD_Properties::valueChanged(SGPropertyNode *node)
591 if (!strcmp(node->getName(), "current-color")) {
592 int i = node->getIntValue();
595 SGPropertyNode *n = fgGetNode("/sim/hud/palette", true);
596 if ((n = n->getChild("color", i, false))) {
597 if (n->hasValue("red"))
598 _red->setFloatValue(n->getFloatValue("red", 1.0));
599 if (n->hasValue("green"))
600 _green->setFloatValue(n->getFloatValue("green", 1.0));
601 if (n->hasValue("blue"))
602 _blue->setFloatValue(n->getFloatValue("blue", 1.0));
603 if (n->hasValue("alpha"))
604 _alpha->setFloatValue(n->getFloatValue("alpha", 0.67));
605 if (n->hasValue("alpha-clamp"))
606 _alpha_clamp->setFloatValue(n->getFloatValue("alpha-clamp", 0.01));
607 if (n->hasValue("brightness"))
608 _brightness->setFloatValue(n->getFloatValue("brightness", 0.75));
609 if (n->hasValue("antialiased"))
610 _antialiasing->setBoolValue(n->getBoolValue("antialiased", false));
611 if (n->hasValue("transparent"))
612 _transparency->setBoolValue(n->getBoolValue("transparent", false));
615 _visible = _visibility->getBoolValue();
616 _transparent = _transparency->getBoolValue();
617 _antialiased = _antialiasing->getBoolValue();
618 float brt = _brightness->getFloatValue();
619 _r = clamp(brt * _red->getFloatValue());
620 _g = clamp(brt * _green->getFloatValue());
621 _b = clamp(brt * _blue->getFloatValue());
622 _a = clamp(_alpha->getFloatValue());
623 _cl = clamp(_alpha_clamp->getFloatValue());
627 void HUD_Properties::setColor() const
630 glColor4f(_r, _g, _b, _a);
632 glColor3f(_r, _g, _b);