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>
43
#include <osg/Matrixf>
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>
51
#include <Main/viewer.hxx>
56
static HUD_Properties *HUDprop = 0;
60
deque<SGSharedPtr<instr_item> > HUD_deque;
62
fgTextList HUD_TextList;
63
fgLineList HUD_LineList;
64
fgLineList HUD_StippleLineList;
66
fntRenderer *HUDtext = 0;
67
fntTexFont *HUD_Font = 0;
68
float HUD_TextSize = 0;
73
int readHud( istream &input );
74
int readInstrument ( const SGPropertyNode * node);
76
static void drawHUD(osg::State*);
77
static void fgUpdateHUDVirtual(osg::State*);
84
locRECT( UINT left, UINT top, UINT right, UINT bottom);
85
RECT get_rect(void) { return rect; }
88
locRECT :: locRECT( UINT left, UINT top, UINT right, UINT bottom)
101
int readInstrument(const SGPropertyNode * node)
103
static const SGPropertyNode *startup_units_node
104
= fgGetNode("/sim/startup/units");
108
if ( !strcmp(startup_units_node->getStringValue(), "feet") ) {
109
strcpy(units, " ft");
114
const SGPropertyNode * ladder_group = node->getNode("ladders");
116
if (ladder_group != 0) {
117
int nLadders = ladder_group->nChildren();
118
for (int j = 0; j < nLadders; j++) {
119
HIptr = static_cast<instr_item *>(new HudLadder(ladder_group->getChild(j)));
120
HUD_deque.insert(HUD_deque.begin(), HIptr);
124
const SGPropertyNode * card_group = node->getNode("cards");
125
if (card_group != 0) {
126
int nCards = card_group->nChildren();
127
for (int j = 0; j < nCards; j++) {
128
const char *type = card_group->getChild(j)->getStringValue("type", "gauge");
130
if (!strcmp(type, "gauge"))
131
HIptr = static_cast<instr_item *>(new gauge_instr(card_group->getChild(j)));
132
else if (!strcmp(type, "dial") || !strcmp(type, "tape"))
133
HIptr = static_cast<instr_item *>(new hud_card(card_group->getChild(j)));
135
SG_LOG(SG_INPUT, SG_WARN, "HUD: unknown 'card' type: " << type);
138
HUD_deque.insert(HUD_deque.begin(), HIptr);
142
const SGPropertyNode * label_group = node->getNode("labels");
143
if (label_group != 0) {
144
int nLabels = label_group->nChildren();
145
for (int j = 0; j < nLabels; j++) {
146
HIptr = static_cast<instr_item *>(new instr_label(label_group->getChild(j)));
147
HUD_deque.insert(HUD_deque.begin(), HIptr);
151
const SGPropertyNode * tbi_group = node->getNode("tbis");
152
if (tbi_group != 0) {
153
int nTbis = tbi_group->nChildren();
154
for (int j = 0; j < nTbis; j++) {
155
HIptr = static_cast<instr_item *>(new fgTBI_instr(tbi_group->getChild(j)));
156
HUD_deque.insert(HUD_deque.begin(), HIptr);
160
const SGPropertyNode * rwy_group = node->getNode("runways");
161
if (rwy_group != 0) {
162
int nRwy = rwy_group->nChildren();
163
for (int j = 0; j < nRwy; j++) {
164
HIptr = static_cast<instr_item *>(new runway_instr(rwy_group->getChild(j)));
165
HUD_deque.insert(HUD_deque.begin(), HIptr);
169
} //end readinstrument
172
int readHud( istream &input )
178
readProperties(input, &root);
179
} catch (const sg_exception &e) {
180
guiErrorMessage("Error reading HUD: ", e);
185
SG_LOG(SG_INPUT, SG_INFO, "Read properties for " <<
186
root.getStringValue("name"));
188
if (!root.getNode("depreciated"))
189
SG_LOG(SG_INPUT, SG_ALERT, "WARNING: use of depreciated old HUD");
191
HUD_deque.erase( HUD_deque.begin(), HUD_deque.end());
194
SG_LOG(SG_INPUT, SG_INFO, "Reading Hud instruments");
196
const SGPropertyNode * instrument_group = root.getChild("instruments");
197
int nInstruments = instrument_group->nChildren();
199
for (int i = 0; i < nInstruments; i++) {
201
const SGPropertyNode * node = instrument_group->getChild(i);
203
SGPath path( globals->get_fg_root() );
204
path.append(node->getStringValue("path"));
206
SG_LOG(SG_INPUT, SG_INFO, "Reading Instrument "
211
SGPropertyNode root2;
213
readProperties(path.str(), &root2);
214
} catch (const sg_exception &e) {
215
guiErrorMessage("Error reading HUD instrument: ", e);
218
readInstrument(&root2);
227
// Constructs a HUD object and then adds in instruments. At the present
228
// the instruments are hard coded into the routine. Ultimately these need
229
// to be defined by the aircraft's instrumentation records so that the
230
// display for a Piper Cub doesn't show the speed range of a North American
231
// mustange and the engine readouts of a B36!
233
int fgHUDInit( fgAIRCRAFT * /* current_aircraft */ )
238
SG_LOG( SG_COCKPIT, SG_INFO, "Initializing current aircraft HUD" );
241
fgGetString("/sim/hud/path", "Huds/Default/default.xml");
242
SGPath path(globals->get_fg_root());
243
path.append(hud_path);
245
ifstream input(path.c_str());
247
SG_LOG(SG_INPUT, SG_ALERT,
248
"Cannot read Hud configuration from " << path.str());
255
// this chunk of code is not necessarily thread safe if the
256
// compiler optimizer reorders these statements. Note that
257
// "delete ptr" does not set "ptr = NULL". We have to do that
259
fntRenderer *tmp = HUDtext;
264
FGFontCache *fc = globals->get_fontcache();
265
const char* fileName = fgGetString("/sim/hud/font/name", "Helvetica.txf");
266
HUD_Font = fc->getTexFont(fileName);
268
throw sg_io_exception("/sim/hud/font/name is not a texture font",
269
sg_location(fileName));
271
HUD_TextSize = fgGetFloat("/sim/hud/font/size", 10);
273
HUDtext = new fntRenderer();
274
HUDtext->setFont(HUD_Font);
275
HUDtext->setPointSize(HUD_TextSize);
276
HUD_TextList.setFont( HUDtext );
279
HUDprop = new HUD_Properties;
280
return 0; // For now. Later we may use this for an error code.
285
int fgHUDInit2( fgAIRCRAFT * /* current_aircraft */ )
290
SG_LOG( SG_COCKPIT, SG_INFO, "Initializing current aircraft HUD" );
292
SGPath path(globals->get_fg_root());
293
path.append("Huds/Minimal/default.xml");
296
ifstream input(path.c_str());
298
SG_LOG(SG_INPUT, SG_ALERT,
299
"Cannot read Hud configuration from " << path.str());
306
HUDprop = new HUD_Properties;
307
return 0; // For now. Later we may use this for an error code.
310
//$$$ End - added, Neetha, 28 Nov 2k
315
// Performs a once around the list of calls to instruments installed in
316
// the HUD object with requests for redraw. Kinda. It will when this is
319
void fgUpdateHUD( osg::State* state ) {
321
static const SGPropertyNode *enable3d_node = fgGetNode("/sim/hud/enable3d");
322
if ( HUD_style == 1 && enable3d_node->getBoolValue() ) {
323
fgUpdateHUDVirtual(state);
327
static const float normal_aspect = float(640) / float(480);
328
// note: aspect_ratio is Y/X
329
float current_aspect = 1.0f/globals->get_current_view()->get_aspect_ratio();
330
if ( current_aspect > normal_aspect ) {
331
float aspect_adjust = current_aspect / normal_aspect;
332
float adjust = 320.0f*aspect_adjust - 320.0f;
333
fgUpdateHUD( state, -adjust, 0.0f, 640.0f+adjust, 480.0f );
335
float aspect_adjust = normal_aspect / current_aspect;
336
float adjust = 240.0f*aspect_adjust - 240.0f;
337
fgUpdateHUD( state, 0.0f, -adjust, 640.0f, 480.0f+adjust );
341
void fgUpdateHUDVirtual(osg::State* state)
344
FGViewer* view = globals->get_current_view();
346
// Standard fgfs projection, with essentially meaningless clip
347
// planes (we'll map the whole HUD plane to z=-1)
348
glMatrixMode(GL_PROJECTION);
351
= Matrixf::perspective(view->get_v_fov(), 1/view->get_aspect_ratio(),
353
glLoadMatrix(proj.ptr());
355
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
Matrixf mv = Matrixf::lookAt(Vec3f(0.0, 0.0, 0.0), lookat,
366
Vec3f(0.0, 1.0, 0.0));
367
glLoadMatrix(mv.ptr());
369
// Map the -1:1 square to a 55.0x41.25 degree wide patch at z=1.
370
// This is the default fgfs field of view, which the HUD files are
371
// written to assume.
372
float dx = 0.52056705; // tan(55/2)
373
float dy = dx * 0.75; // assumes 4:3 aspect ratio
375
m[0] = dx; m[4] = 0; m[ 8] = 0; m[12] = 0;
376
m[1] = 0; m[5] = dy; m[ 9] = 0; m[13] = 0;
377
m[2] = 0; m[6] = 0; m[10] = 1; m[14] = 0;
378
m[3] = 0; m[7] = 0; m[11] = 0; m[15] = 1;
381
// Convert the 640x480 "HUD standard" coordinate space to a square
382
// about the origin in the range [-1:1] at depth of -1
383
glScalef(1./320, 1./240, 1);
384
glTranslatef(-320, -240, -1);
390
glMatrixMode(GL_PROJECTION);
392
glMatrixMode(GL_MODELVIEW);
397
void fgUpdateHUD( osg::State* state, GLfloat x_start, GLfloat y_start,
398
GLfloat x_end, GLfloat y_end )
401
glMatrixMode(GL_PROJECTION);
403
Matrixf proj = Matrixf::ortho2D(x_start, x_end, y_start, y_end);
404
glLoadMatrix(proj.ptr());
406
glMatrixMode(GL_MODELVIEW);
412
glMatrixMode(GL_PROJECTION);
414
glMatrixMode(GL_MODELVIEW);
419
void drawHUD(osg::State* state)
421
if ( !HUD_deque.size() ) // Trust everyone, but ALWAYS cut the cards!
424
HUD_TextList.erase();
425
HUD_LineList.erase();
426
// HUD_StippleLineList.erase();
428
glDisable(GL_DEPTH_TEST);
429
glDisable(GL_LIGHTING);
431
static const SGPropertyNode *heading_enabled
432
= fgGetNode("/autopilot/locks/heading", true);
433
static const SGPropertyNode *altitude_enabled
434
= fgGetNode("/autopilot/locks/altitude", true);
436
static char hud_hdg_text[256];
437
static char hud_gps_text0[256];
438
static char hud_gps_text1[256];
439
static char hud_gps_text2[256];
440
static char hud_alt_text[256];
443
if (HUDprop->isTransparent())
444
glBlendFunc(GL_SRC_ALPHA, GL_ONE);
446
glBlendFunc(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA);
448
if (HUDprop->isAntialiased()) {
449
glEnable(GL_LINE_SMOOTH);
450
glAlphaFunc(GL_GREATER, HUDprop->alphaClamp());
451
glHint(GL_LINE_SMOOTH_HINT, GL_DONT_CARE);
458
for_each(HUD_deque.begin(), HUD_deque.end(), HUDdraw());
460
//HUD_TextList.add( fgText(40, 10, get_formated_gmt_time(), 0) );
466
if (strcmp( heading_enabled->getStringValue(), "dg-heading-hold") == 0 ) {
467
snprintf( hud_hdg_text, 256, "hdg = %.1f\n",
468
fgGetDouble("/autopilot/settings/heading-bug-deg") );
469
HUD_TextList.add( fgText( 40, apY, hud_hdg_text ) );
471
} else if ( strcmp(heading_enabled->getStringValue(), "true-heading-hold") == 0 ) {
472
snprintf( hud_hdg_text, 256, "hdg = %.1f\n",
473
fgGetDouble("/autopilot/settings/true-heading-deg") );
474
HUD_TextList.add( fgText( 40, apY, hud_hdg_text ) );
478
// GPS current waypoint information
479
SGPropertyNode_ptr gps = fgGetNode("/instrumentation/gps", true);
480
SGPropertyNode_ptr curWp = gps->getChild("wp")->getChild("wp",1);
482
if ((gps->getDoubleValue("raim") > 0.5) && curWp) {
483
// GPS is receiving a valid signal
484
snprintf(hud_gps_text0, 256, "WPT:%5s BRG:%03.0f %5.1fnm",
485
curWp->getStringValue("ID"),
486
curWp->getDoubleValue("bearing-mag-deg"),
487
curWp->getDoubleValue("distance-nm"));
488
HUD_TextList.add( fgText( 40, apY, hud_gps_text0 ) );
491
// curWp->getStringValue("TTW")
492
snprintf(hud_gps_text2, 256, "ETA %s", curWp->getStringValue("TTW"));
493
HUD_TextList.add( fgText( 40, apY, hud_gps_text2 ) );
496
double courseError = curWp->getDoubleValue("course-error-nm");
497
if (fabs(courseError) >= 0.01) {
498
// generate an arrow indicatinng if the pilot should turn left or right
499
char dir = (courseError < 0.0) ? '<' : '>';
500
snprintf(hud_gps_text1, 256, "GPS TRK:%03.0f XTRK:%c%4.2fnm",
501
gps->getDoubleValue("indicated-track-magnetic-deg"), dir, fabs(courseError));
502
} else { // on course, don't bother showing the XTRK error
503
snprintf(hud_gps_text1, 256, "GPS TRK:%03.0f",
504
gps->getDoubleValue("indicated-track-magnetic-deg"));
507
HUD_TextList.add( fgText( 40, apY, hud_gps_text1) );
509
} // of valid GPS output
513
if ( strcmp( altitude_enabled->getStringValue(), "altitude-hold" ) == 0 ) {
514
snprintf( hud_alt_text, 256, "alt = %.0f\n",
515
fgGetDouble("/autopilot/settings/target-altitude-ft") );
516
HUD_TextList.add( fgText( 40, apY, hud_alt_text ) );
518
} else if ( strcmp( altitude_enabled->getStringValue(), "agl-hold" ) == 0 ){
519
snprintf( hud_alt_text, 256, "agl = %.0f\n",
520
fgGetDouble("/autopilot/settings/target-agl-ft") );
521
HUD_TextList.add( fgText( 40, apY, hud_alt_text ) );
528
// glEnable(GL_LINE_STIPPLE);
529
// glLineStipple( 1, 0x00FF );
530
// HUD_StippleLineList.draw();
531
// glDisable(GL_LINE_STIPPLE);
533
if (HUDprop->isAntialiased()) {
534
glDisable(GL_ALPHA_TEST);
535
glDisable(GL_LINE_SMOOTH);
539
if (HUDprop->isTransparent())
540
glBlendFunc(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA);
542
glEnable(GL_DEPTH_TEST);
543
glEnable(GL_LIGHTING);
547
void fgTextList::draw()
552
vector<fgText>::iterator curString = List.begin();
553
vector<fgText>::iterator lastString = List.end();
555
glPushAttrib(GL_COLOR_BUFFER_BIT);
556
glEnable(GL_TEXTURE_2D);
558
if (HUDprop->isTransparent())
559
glBlendFunc(GL_SRC_ALPHA, GL_ONE);
561
glBlendFunc(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA);
563
if (HUDprop->isAntialiased()) {
564
glEnable(GL_ALPHA_TEST);
565
glAlphaFunc(GL_GREATER, HUDprop->alphaClamp());
569
for (; curString != lastString; curString++)
570
curString->Draw(Font);
573
glDisable(GL_TEXTURE_2D);
578
// HUD property listener class
580
HUD_Properties::HUD_Properties() :
581
_current(fgGetNode("/sim/hud/current-color", true)),
582
_visibility(fgGetNode("/sim/hud/visibility", true)),
583
_antialiasing(fgGetNode("/sim/hud/color/antialiased", true)),
584
_transparency(fgGetNode("/sim/hud/color/transparent", true)),
585
_red(fgGetNode("/sim/hud/color/red", true)),
586
_green(fgGetNode("/sim/hud/color/green", true)),
587
_blue(fgGetNode("/sim/hud/color/blue", true)),
588
_alpha(fgGetNode("/sim/hud/color/alpha", true)),
589
_alpha_clamp(fgGetNode("/sim/hud/color/alpha-clamp", true)),
590
_brightness(fgGetNode("/sim/hud/color/brightness", true)),
597
_visibility->addChangeListener(this);
598
_antialiasing->addChangeListener(this);
599
_transparency->addChangeListener(this);
600
_red->addChangeListener(this);
601
_green->addChangeListener(this);
602
_blue->addChangeListener(this);
603
_alpha->addChangeListener(this);
604
_alpha_clamp->addChangeListener(this);
605
_brightness->addChangeListener(this);
606
_current->addChangeListener(this, true);
610
void HUD_Properties::valueChanged(SGPropertyNode *node)
612
if (!strcmp(node->getName(), "current-color")) {
613
int i = node->getIntValue();
616
SGPropertyNode *n = fgGetNode("/sim/hud/palette", true);
617
if ((n = n->getChild("color", i, false))) {
618
if (n->hasValue("red"))
619
_red->setFloatValue(n->getFloatValue("red", 1.0));
620
if (n->hasValue("green"))
621
_green->setFloatValue(n->getFloatValue("green", 1.0));
622
if (n->hasValue("blue"))
623
_blue->setFloatValue(n->getFloatValue("blue", 1.0));
624
if (n->hasValue("alpha"))
625
_alpha->setFloatValue(n->getFloatValue("alpha", 0.67));
626
if (n->hasValue("alpha-clamp"))
627
_alpha_clamp->setFloatValue(n->getFloatValue("alpha-clamp", 0.01));
628
if (n->hasValue("brightness"))
629
_brightness->setFloatValue(n->getFloatValue("brightness", 0.75));
630
if (n->hasValue("antialiased"))
631
_antialiasing->setBoolValue(n->getBoolValue("antialiased", false));
632
if (n->hasValue("transparent"))
633
_transparency->setBoolValue(n->getBoolValue("transparent", false));
636
_visible = _visibility->getBoolValue();
637
_transparent = _transparency->getBoolValue();
638
_antialiased = _antialiasing->getBoolValue();
639
float brt = _brightness->getFloatValue();
640
_r = clamp(brt * _red->getFloatValue());
641
_g = clamp(brt * _green->getFloatValue());
642
_b = clamp(brt * _blue->getFloatValue());
643
_a = clamp(_alpha->getFloatValue());
644
_cl = clamp(_alpha_clamp->getFloatValue());
648
void HUD_Properties::setColor() const
651
glColor4f(_r, _g, _b, _a);
653
glColor3f(_r, _g, _b);