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 <Aircraft/aircraft.hxx>
46 //#include <Autopilot/xmlauto.hxx>
47 #include <GUI/new_gui.hxx> // FGFontCache
48 #include <Main/globals.hxx>
49 #include <Scenery/scenery.hxx>
50 #include <Airports/runways.hxx>
55 static HUD_Properties *HUDprop = 0;
59 deque<SGSharedPtr<instr_item> > HUD_deque;
61 fgTextList HUD_TextList;
62 fgLineList HUD_LineList;
63 fgLineList HUD_StippleLineList;
65 fntRenderer *HUDtext = 0;
66 fntTexFont *HUD_Font = 0;
67 float HUD_TextSize = 0;
72 int readHud( istream &input );
73 int readInstrument ( const SGPropertyNode * node);
75 static void drawHUD(osg::State*);
76 static void fgUpdateHUDVirtual(osg::State*);
83 locRECT( UINT left, UINT top, UINT right, UINT bottom);
84 RECT get_rect(void) { return rect; }
87 locRECT :: locRECT( UINT left, UINT top, UINT right, UINT bottom)
100 int readInstrument(const SGPropertyNode * node)
102 static const SGPropertyNode *startup_units_node
103 = fgGetNode("/sim/startup/units");
107 if ( !strcmp(startup_units_node->getStringValue(), "feet") ) {
108 strcpy(units, " ft");
113 const SGPropertyNode * ladder_group = node->getNode("ladders");
115 if (ladder_group != 0) {
116 int nLadders = ladder_group->nChildren();
117 for (int j = 0; j < nLadders; j++) {
118 HIptr = static_cast<instr_item *>(new HudLadder(ladder_group->getChild(j)));
119 HUD_deque.insert(HUD_deque.begin(), HIptr);
123 const SGPropertyNode * card_group = node->getNode("cards");
124 if (card_group != 0) {
125 int nCards = card_group->nChildren();
126 for (int j = 0; j < nCards; j++) {
127 const char *type = card_group->getChild(j)->getStringValue("type", "gauge");
129 if (!strcmp(type, "gauge"))
130 HIptr = static_cast<instr_item *>(new gauge_instr(card_group->getChild(j)));
131 else if (!strcmp(type, "dial") || !strcmp(type, "tape"))
132 HIptr = static_cast<instr_item *>(new hud_card(card_group->getChild(j)));
134 SG_LOG(SG_INPUT, SG_WARN, "HUD: unknown 'card' type: " << type);
137 HUD_deque.insert(HUD_deque.begin(), HIptr);
141 const SGPropertyNode * label_group = node->getNode("labels");
142 if (label_group != 0) {
143 int nLabels = label_group->nChildren();
144 for (int j = 0; j < nLabels; j++) {
145 HIptr = static_cast<instr_item *>(new instr_label(label_group->getChild(j)));
146 HUD_deque.insert(HUD_deque.begin(), HIptr);
150 const SGPropertyNode * tbi_group = node->getNode("tbis");
151 if (tbi_group != 0) {
152 int nTbis = tbi_group->nChildren();
153 for (int j = 0; j < nTbis; j++) {
154 HIptr = static_cast<instr_item *>(new fgTBI_instr(tbi_group->getChild(j)));
155 HUD_deque.insert(HUD_deque.begin(), HIptr);
159 const SGPropertyNode * rwy_group = node->getNode("runways");
160 if (rwy_group != 0) {
161 int nRwy = rwy_group->nChildren();
162 for (int j = 0; j < nRwy; j++) {
163 HIptr = static_cast<instr_item *>(new runway_instr(rwy_group->getChild(j)));
164 HUD_deque.insert(HUD_deque.begin(), HIptr);
168 } //end readinstrument
171 int readHud( istream &input )
177 readProperties(input, &root);
178 } catch (const sg_exception &e) {
179 guiErrorMessage("Error reading HUD: ", e);
184 SG_LOG(SG_INPUT, SG_INFO, "Read properties for " <<
185 root.getStringValue("name"));
187 if (!root.getNode("depreciated"))
188 SG_LOG(SG_INPUT, SG_ALERT, "WARNING: use of depreciated old HUD");
190 HUD_deque.erase( HUD_deque.begin(), HUD_deque.end());
193 SG_LOG(SG_INPUT, SG_INFO, "Reading Hud instruments");
195 const SGPropertyNode * instrument_group = root.getChild("instruments");
196 int nInstruments = instrument_group->nChildren();
198 for (int i = 0; i < nInstruments; i++) {
200 const SGPropertyNode * node = instrument_group->getChild(i);
202 SGPath path( globals->get_fg_root() );
203 path.append(node->getStringValue("path"));
205 SG_LOG(SG_INPUT, SG_INFO, "Reading Instrument "
210 SGPropertyNode root2;
212 readProperties(path.str(), &root2);
213 } catch (const sg_exception &e) {
214 guiErrorMessage("Error reading HUD instrument: ", e);
217 readInstrument(&root2);
226 // Constructs a HUD object and then adds in instruments. At the present
227 // the instruments are hard coded into the routine. Ultimately these need
228 // to be defined by the aircraft's instrumentation records so that the
229 // display for a Piper Cub doesn't show the speed range of a North American
230 // mustange and the engine readouts of a B36!
232 int fgHUDInit( fgAIRCRAFT * /* current_aircraft */ )
237 SG_LOG( SG_COCKPIT, SG_INFO, "Initializing current aircraft HUD" );
240 fgGetString("/sim/hud/path", "Huds/Default/default.xml");
241 SGPath path(globals->get_fg_root());
242 path.append(hud_path);
244 ifstream input(path.c_str());
246 SG_LOG(SG_INPUT, SG_ALERT,
247 "Cannot read Hud configuration from " << path.str());
254 // this chunk of code is not necessarily thread safe if the
255 // compiler optimizer reorders these statements. Note that
256 // "delete ptr" does not set "ptr = NULL". We have to do that
258 fntRenderer *tmp = HUDtext;
263 FGFontCache *fc = globals->get_fontcache();
264 HUD_Font = fc->getTexFont(fgGetString("/sim/hud/font/name", "Helvetica.txf"));
266 throw sg_throwable(string("/sim/hud/font/name is not a texture font"));
268 HUD_TextSize = fgGetFloat("/sim/hud/font/size", 10);
270 HUDtext = new fntRenderer();
271 HUDtext->setFont(HUD_Font);
272 HUDtext->setPointSize(HUD_TextSize);
273 HUD_TextList.setFont( HUDtext );
276 HUDprop = new HUD_Properties;
277 return 0; // For now. Later we may use this for an error code.
282 int fgHUDInit2( fgAIRCRAFT * /* current_aircraft */ )
287 SG_LOG( SG_COCKPIT, SG_INFO, "Initializing current aircraft HUD" );
289 SGPath path(globals->get_fg_root());
290 path.append("Huds/Minimal/default.xml");
293 ifstream input(path.c_str());
295 SG_LOG(SG_INPUT, SG_ALERT,
296 "Cannot read Hud configuration from " << path.str());
303 HUDprop = new HUD_Properties;
304 return 0; // For now. Later we may use this for an error code.
307 //$$$ End - added, Neetha, 28 Nov 2k
312 // Performs a once around the list of calls to instruments installed in
313 // the HUD object with requests for redraw. Kinda. It will when this is
316 void fgUpdateHUD( osg::State* state ) {
318 static const SGPropertyNode *enable3d_node = fgGetNode("/sim/hud/enable3d");
319 if ( HUD_style == 1 && enable3d_node->getBoolValue() ) {
320 fgUpdateHUDVirtual(state);
324 static const float normal_aspect = float(640) / float(480);
325 // note: aspect_ratio is Y/X
326 float current_aspect = 1.0f/globals->get_current_view()->get_aspect_ratio();
327 if ( current_aspect > normal_aspect ) {
328 float aspect_adjust = current_aspect / normal_aspect;
329 float adjust = 320.0f*aspect_adjust - 320.0f;
330 fgUpdateHUD( state, -adjust, 0.0f, 640.0f+adjust, 480.0f );
332 float aspect_adjust = normal_aspect / current_aspect;
333 float adjust = 240.0f*aspect_adjust - 240.0f;
334 fgUpdateHUD( state, 0.0f, -adjust, 640.0f, 480.0f+adjust );
338 void fgUpdateHUDVirtual(osg::State* state)
340 FGViewer* view = globals->get_current_view();
342 // Standard fgfs projection, with essentially meaningless clip
343 // planes (we'll map the whole HUD plane to z=-1)
344 glMatrixMode(GL_PROJECTION);
347 gluPerspective(view->get_v_fov(), 1/view->get_aspect_ratio(), 0.1, 10);
349 glMatrixMode(GL_MODELVIEW);
353 // Standard fgfs view direction computation
355 lookat[0] = -sin(SG_DEGREES_TO_RADIANS * view->getHeadingOffset_deg());
356 lookat[1] = tan(SG_DEGREES_TO_RADIANS * view->getPitchOffset_deg());
357 lookat[2] = -cos(SG_DEGREES_TO_RADIANS * view->getHeadingOffset_deg());
358 if (fabs(lookat[1]) > 9999)
359 lookat[1] = 9999; // FPU sanity
360 gluLookAt(0, 0, 0, lookat[0], lookat[1], lookat[2], 0, 1, 0);
362 // Map the -1:1 square to a 55.0x41.25 degree wide patch at z=1.
363 // This is the default fgfs field of view, which the HUD files are
364 // written to assume.
365 float dx = 0.52056705; // tan(55/2)
366 float dy = dx * 0.75; // assumes 4:3 aspect ratio
368 m[0] = dx; m[4] = 0; m[ 8] = 0; m[12] = 0;
369 m[1] = 0; m[5] = dy; m[ 9] = 0; m[13] = 0;
370 m[2] = 0; m[6] = 0; m[10] = 1; m[14] = 0;
371 m[3] = 0; m[7] = 0; m[11] = 0; m[15] = 1;
374 // Convert the 640x480 "HUD standard" coordinate space to a square
375 // about the origin in the range [-1:1] at depth of -1
376 glScalef(1./320, 1./240, 1);
377 glTranslatef(-320, -240, -1);
383 glMatrixMode(GL_PROJECTION);
385 glMatrixMode(GL_MODELVIEW);
390 void fgUpdateHUD( osg::State* state, GLfloat x_start, GLfloat y_start,
391 GLfloat x_end, GLfloat y_end )
393 glMatrixMode(GL_PROJECTION);
396 gluOrtho2D(x_start, x_end, y_start, y_end);
398 glMatrixMode(GL_MODELVIEW);
404 glMatrixMode(GL_PROJECTION);
406 glMatrixMode(GL_MODELVIEW);
411 void drawHUD(osg::State* state)
413 if ( !HUD_deque.size() ) // Trust everyone, but ALWAYS cut the cards!
416 HUD_TextList.erase();
417 HUD_LineList.erase();
418 // HUD_StippleLineList.erase();
420 glDisable(GL_DEPTH_TEST);
421 glDisable(GL_LIGHTING);
423 static const SGPropertyNode *heading_enabled
424 = fgGetNode("/autopilot/locks/heading", true);
425 static const SGPropertyNode *altitude_enabled
426 = fgGetNode("/autopilot/locks/altitude", true);
428 static char hud_hdg_text[256];
429 static char hud_wp0_text[256];
430 static char hud_wp1_text[256];
431 static char hud_wp2_text[256];
432 static char hud_alt_text[256];
435 if (HUDprop->isTransparent())
436 glBlendFunc(GL_SRC_ALPHA, GL_ONE);
438 glBlendFunc(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA);
440 if (HUDprop->isAntialiased()) {
441 glEnable(GL_LINE_SMOOTH);
442 glAlphaFunc(GL_GREATER, HUDprop->alphaClamp());
443 glHint(GL_LINE_SMOOTH_HINT, GL_DONT_CARE);
450 for_each(HUD_deque.begin(), HUD_deque.end(), HUDdraw());
452 //HUD_TextList.add( fgText(40, 10, get_formated_gmt_time(), 0) );
458 if (strcmp( heading_enabled->getStringValue(), "dg-heading-hold") == 0 ) {
459 snprintf( hud_hdg_text, 256, "hdg = %.1f\n",
460 fgGetDouble("/autopilot/settings/heading-bug-deg") );
461 HUD_TextList.add( fgText( 40, apY, hud_hdg_text ) );
463 } else if ( strcmp(heading_enabled->getStringValue(), "true-heading-hold") == 0 ) {
464 snprintf( hud_hdg_text, 256, "hdg = %.1f\n",
465 fgGetDouble("/autopilot/settings/true-heading-deg") );
466 HUD_TextList.add( fgText( 40, apY, hud_hdg_text ) );
469 string wp0_id = fgGetString( "/autopilot/route-manager/wp[0]/id" );
470 if ( wp0_id.length() > 0 ) {
471 snprintf( hud_wp0_text, 256, "%5s %6.1fnm %s", wp0_id.c_str(),
472 fgGetDouble( "/autopilot/route-manager/wp[0]/dist" ),
473 fgGetString( "/autopilot/route-manager/wp[0]/eta" ) );
474 HUD_TextList.add( fgText( 40, apY, hud_wp0_text ) );
477 string wp1_id = fgGetString( "/autopilot/route-manager/wp[1]/id" );
478 if ( wp1_id.length() > 0 ) {
479 snprintf( hud_wp1_text, 256, "%5s %6.1fnm %s", wp1_id.c_str(),
480 fgGetDouble( "/autopilot/route-manager/wp[1]/dist" ),
481 fgGetString( "/autopilot/route-manager/wp[1]/eta" ) );
482 HUD_TextList.add( fgText( 40, apY, hud_wp1_text ) );
485 string wp2_id = fgGetString( "/autopilot/route-manager/wp-last/id" );
486 if ( wp2_id.length() > 0 ) {
487 snprintf( hud_wp2_text, 256, "%5s %6.1fnm %s", wp2_id.c_str(),
488 fgGetDouble( "/autopilot/route-manager/wp-last/dist" ),
489 fgGetString( "/autopilot/route-manager/wp-last/eta" ) );
490 HUD_TextList.add( fgText( 40, apY, hud_wp2_text ) );
495 if ( strcmp( altitude_enabled->getStringValue(), "altitude-hold" ) == 0 ) {
496 snprintf( hud_alt_text, 256, "alt = %.0f\n",
497 fgGetDouble("/autopilot/settings/target-altitude-ft") );
498 HUD_TextList.add( fgText( 40, apY, hud_alt_text ) );
500 } else if ( strcmp( altitude_enabled->getStringValue(), "agl-hold" ) == 0 ){
501 snprintf( hud_alt_text, 256, "agl = %.0f\n",
502 fgGetDouble("/autopilot/settings/target-agl-ft") );
503 HUD_TextList.add( fgText( 40, apY, hud_alt_text ) );
510 // glEnable(GL_LINE_STIPPLE);
511 // glLineStipple( 1, 0x00FF );
512 // HUD_StippleLineList.draw();
513 // glDisable(GL_LINE_STIPPLE);
515 if (HUDprop->isAntialiased()) {
516 glDisable(GL_ALPHA_TEST);
517 glDisable(GL_LINE_SMOOTH);
521 if (HUDprop->isTransparent())
522 glBlendFunc(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA);
524 glEnable(GL_DEPTH_TEST);
525 glEnable(GL_LIGHTING);
529 void fgTextList::draw()
534 vector<fgText>::iterator curString = List.begin();
535 vector<fgText>::iterator lastString = List.end();
537 glPushAttrib(GL_COLOR_BUFFER_BIT);
538 glEnable(GL_TEXTURE_2D);
540 if (HUDprop->isTransparent())
541 glBlendFunc(GL_SRC_ALPHA, GL_ONE);
543 glBlendFunc(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA);
545 if (HUDprop->isAntialiased()) {
546 glEnable(GL_ALPHA_TEST);
547 glAlphaFunc(GL_GREATER, HUDprop->alphaClamp());
551 for (; curString != lastString; curString++)
552 curString->Draw(Font);
555 glDisable(GL_TEXTURE_2D);
560 // HUD property listener class
562 HUD_Properties::HUD_Properties() :
563 _current(fgGetNode("/sim/hud/current-color", true)),
564 _visibility(fgGetNode("/sim/hud/visibility", true)),
565 _antialiasing(fgGetNode("/sim/hud/color/antialiased", true)),
566 _transparency(fgGetNode("/sim/hud/color/transparent", true)),
567 _red(fgGetNode("/sim/hud/color/red", true)),
568 _green(fgGetNode("/sim/hud/color/green", true)),
569 _blue(fgGetNode("/sim/hud/color/blue", true)),
570 _alpha(fgGetNode("/sim/hud/color/alpha", true)),
571 _alpha_clamp(fgGetNode("/sim/hud/color/alpha-clamp", true)),
572 _brightness(fgGetNode("/sim/hud/color/brightness", true)),
579 _visibility->addChangeListener(this);
580 _antialiasing->addChangeListener(this);
581 _transparency->addChangeListener(this);
582 _red->addChangeListener(this);
583 _green->addChangeListener(this);
584 _blue->addChangeListener(this);
585 _alpha->addChangeListener(this);
586 _alpha_clamp->addChangeListener(this);
587 _brightness->addChangeListener(this);
588 _current->addChangeListener(this, true);
592 void HUD_Properties::valueChanged(SGPropertyNode *node)
594 if (!strcmp(node->getName(), "current-color")) {
595 int i = node->getIntValue();
598 SGPropertyNode *n = fgGetNode("/sim/hud/palette", true);
599 if ((n = n->getChild("color", i, false))) {
600 if (n->hasValue("red"))
601 _red->setFloatValue(n->getFloatValue("red", 1.0));
602 if (n->hasValue("green"))
603 _green->setFloatValue(n->getFloatValue("green", 1.0));
604 if (n->hasValue("blue"))
605 _blue->setFloatValue(n->getFloatValue("blue", 1.0));
606 if (n->hasValue("alpha"))
607 _alpha->setFloatValue(n->getFloatValue("alpha", 0.67));
608 if (n->hasValue("alpha-clamp"))
609 _alpha_clamp->setFloatValue(n->getFloatValue("alpha-clamp", 0.01));
610 if (n->hasValue("brightness"))
611 _brightness->setFloatValue(n->getFloatValue("brightness", 0.75));
612 if (n->hasValue("antialiased"))
613 _antialiasing->setBoolValue(n->getBoolValue("antialiased", false));
614 if (n->hasValue("transparent"))
615 _transparency->setBoolValue(n->getBoolValue("transparent", false));
618 _visible = _visibility->getBoolValue();
619 _transparent = _transparency->getBoolValue();
620 _antialiased = _antialiasing->getBoolValue();
621 float brt = _brightness->getFloatValue();
622 _r = clamp(brt * _red->getFloatValue());
623 _g = clamp(brt * _green->getFloatValue());
624 _b = clamp(brt * _blue->getFloatValue());
625 _a = clamp(_alpha->getFloatValue());
626 _cl = clamp(_alpha_clamp->getFloatValue());
630 void HUD_Properties::setColor() const
633 glColor4f(_r, _g, _b, _a);
635 glColor3f(_r, _g, _b);