1 // navigation display texture
3 // Written by James Turner, forked from wxradar code
6 // This program is free software; you can redistribute it and/or
7 // modify it under the terms of the GNU General Public License as
8 // published by the Free Software Foundation; either version 2 of the
9 // License, or (at your option) any later version.
11 // This program is distributed in the hope that it will be useful, but
12 // WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 // General Public License for more details.
16 // You should have received a copy of the GNU General Public License
17 // along with this program; if not, write to the Free Software
18 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
26 #include "NavDisplay.hxx"
29 #include <boost/foreach.hpp>
33 #include <osg/Geometry>
34 #include <osg/Matrixf>
35 #include <osg/PrimitiveSet>
36 #include <osg/StateSet>
37 #include <osg/LineWidth>
38 #include <osg/Version>
40 #include <simgear/constants.h>
41 #include <simgear/misc/sg_path.hxx>
42 #include <simgear/scene/model/model.hxx>
43 #include <simgear/structure/exception.hxx>
44 #include <simgear/misc/sg_path.hxx>
45 #include <simgear/misc/strutils.hxx>
46 #include <simgear/math/sg_geodesy.hxx>
50 #include <iostream> // for cout, endl
52 using std::stringstream;
54 using std::setprecision;
63 #include <Main/fg_props.hxx>
64 #include <Main/globals.hxx>
65 #include <Cockpit/panel.hxx>
66 #include <Navaids/routePath.hxx>
67 #include <Autopilot/route_mgr.hxx>
68 #include <Navaids/navrecord.hxx>
69 #include <Navaids/navlist.hxx>
70 #include <Navaids/fix.hxx>
71 #include <Airports/simple.hxx>
72 #include <Airports/runways.hxx>
74 #include "instrument_mgr.hxx"
75 #include "od_gauge.hxx"
77 static const char *DEFAULT_FONT = "typewriter.txf";
80 osg::Matrixf degRotation(float angle)
82 return osg::Matrixf::rotate(angle * SG_DEGREES_TO_RADIANS, 0.0f, 0.0f, -1.0f);
85 static osg::Vec4 readColor(SGPropertyNode* colorNode, const osg::Vec4& c)
88 result.r() = colorNode->getDoubleValue("red", c.r());
89 result.g() = colorNode->getDoubleValue("green", c.g());
90 result.b() = colorNode->getDoubleValue("blue", c.b());
91 result.a() = colorNode->getDoubleValue("alpha", c.a());
95 static osgText::Text::AlignmentType readAlignment(const std::string& t)
97 if (t == "left-top") {
98 return osgText::Text::LEFT_TOP;
99 } else if (t == "left-center") {
100 return osgText::Text::LEFT_CENTER;
101 } else if (t == "left-bottom") {
102 return osgText::Text::LEFT_BOTTOM;
103 } else if (t == "center-top") {
104 return osgText::Text::CENTER_TOP;
105 } else if (t == "center-center") {
106 return osgText::Text::CENTER_CENTER;
107 } else if (t == "center-bottom") {
108 return osgText::Text::CENTER_BOTTOM;
109 } else if (t == "right-top") {
110 return osgText::Text::RIGHT_TOP;
111 } else if (t == "right-center") {
112 return osgText::Text::RIGHT_CENTER;
113 } else if (t == "right-bottom") {
114 return osgText::Text::RIGHT_BOTTOM;
115 } else if (t == "left-baseline") {
116 return osgText::Text::LEFT_BASE_LINE;
117 } else if (t == "center-baseline") {
118 return osgText::Text::CENTER_BASE_LINE;
119 } else if (t == "right-baseline") {
120 return osgText::Text::RIGHT_BASE_LINE;
123 return osgText::Text::BASE_LINE;
126 static string formatPropertyValue(SGPropertyNode* nd, const string& format)
129 static char buf[512];
130 if (format.find('d') != string::npos) {
131 ::snprintf(buf, 512, format.c_str(), nd->getIntValue());
135 if (format.find('s') != string::npos) {
136 ::snprintf(buf, 512, format.c_str(), nd->getStringValue());
140 // assume it's a double/float
141 ::snprintf(buf, 512, format.c_str(), nd->getDoubleValue());
145 static osg::Vec2 mult(const osg::Vec2& v, const osg::Matrixf& m)
147 osg::Vec3 r = m.preMult(osg::Vec3(v.x(), v.y(), 0.0));
148 return osg::Vec2(r.x(), r.y());
151 class NavDisplay::CacheListener : public SGPropertyChangeListener
154 CacheListener(NavDisplay *nd) :
158 virtual void valueChanged (SGPropertyNode * prop)
160 _nd->invalidatePositionedCache();
161 SG_LOG(SG_INSTR, SG_INFO, "invalidating NavDisplay cache");
167 class NavDisplay::ForceUpdateListener : public SGPropertyChangeListener
170 ForceUpdateListener(NavDisplay *nd) :
174 virtual void valueChanged (SGPropertyNode * prop)
176 SG_LOG(SG_INSTR, SG_INFO, "forcing NavDisplay update");
183 ///////////////////////////////////////////////////////////////////
193 bool initFromNode(SGPropertyNode* node, NavDisplay* owner)
195 if (!node->getChild("type")) {
199 type = node->getStringValue("type");
200 SGPropertyNode* enableNode = node->getChild("enable");
202 enable.reset(sgReadCondition(fgGetNode("/"), enableNode));
206 while (node->hasChild("state", n)) {
207 string m = node->getChild("state", n++)->getStringValue();
209 excluded_states.insert(m.substr(1));
211 required_states.insert(m);
213 } // of matches parsing
218 void setDefinition(SymbolDef* d)
223 SymbolDef* getDefinition() const
224 { return definition; }
226 bool matches(const string_set& states) const
228 BOOST_FOREACH(const string& s, required_states) {
229 if (states.count(s) == 0) {
234 BOOST_FOREACH(const string& s, excluded_states) {
235 if (states.count(s) != 0) {
246 enabled = enable->test();
252 bool enabled; // cached enabled state
255 SymbolDef* definition;
257 std::auto_ptr<SGCondition> enable;
258 string_set required_states;
259 string_set excluded_states;
266 bool initFromNode(SGPropertyNode* node, NavDisplay* owner)
268 if (node->getChild("type")) {
269 SymbolRule* builtinRule = new SymbolRule;
270 builtinRule->initFromNode(node, owner);
271 builtinRule->setDefinition(this);
272 owner->addRule(builtinRule);
275 if (node->hasChild("width")) {
276 float w = node->getFloatValue("width");
277 float h = node->getFloatValue("height", w);
283 xy0.x() = node->getFloatValue("x0", 0.0);
284 xy0.y() = node->getFloatValue("y0", 0.0);
285 xy1.x() = node->getFloatValue("x1", 5);
286 xy1.y() = node->getFloatValue("y1", 5);
289 double texSize = node->getFloatValue("texture-size", owner->textureSize());
291 uv0.x() = node->getFloatValue("u0", 0) / texSize;
292 uv0.y() = node->getFloatValue("v0", 0) / texSize;
293 uv1.x() = node->getFloatValue("u1", 1) / texSize;
294 uv1.y() = node->getFloatValue("v1", 1) / texSize;
296 color = readColor(node->getChild("color"), osg::Vec4(1, 1, 1, 1));
297 priority = node->getIntValue("priority", 0);
298 zOrder = node->getIntValue("zOrder", 0);
299 rotateToHeading = node->getBoolValue("rotate-to-heading", false);
300 roundPos = node->getBoolValue("round-position", true);
302 if (node->hasChild("text")) {
304 alignment = readAlignment(node->getStringValue("text-align"));
305 textTemplate = node->getStringValue("text");
306 textOffset.x() = node->getFloatValue("text-offset-x", 0);
307 textOffset.y() = node->getFloatValue("text-offset-y", 0);
308 textColor = readColor(node->getChild("text-color"), color);
311 drawLine = node->getBoolValue("draw-line", false);
312 lineColor = readColor(node->getChild("line-color"), color);
313 drawRouteLeg = node->getBoolValue("draw-leg", false);
315 stretchSymbol = node->getBoolValue("stretch-symbol", false);
317 stretchY2 = node->getFloatValue("y2");
318 stretchY3 = node->getFloatValue("y3");
319 stretchV2 = node->getFloatValue("v2") / texSize;
320 stretchV3 = node->getFloatValue("v3") / texSize;
332 bool rotateToHeading;
333 bool roundPos; ///< should position be rounded to integer values
336 osg::Vec2 textOffset;
337 osgText::Text::AlignmentType alignment;
343 // symbol stretching creates three quads (instead of one) - a start,
344 // middle and end quad, positioned along the line of the symbol.
345 // X (and U) axis values determined by the values above, so we only need
346 // to define the Y (and V) values to build the other quads.
348 double stretchY2, stretchY3;
349 double stretchV2, stretchV3;
358 SymbolInstance(const osg::Vec2& p, double h, SymbolDef* def, SGPropertyNode* vars) :
365 osg::Vec2 pos; // projected position
368 SymbolDef* definition;
369 SGPropertyNode_ptr props;
373 assert(definition->hasText);
378 size_t pos = definition->textTemplate.find('{', lastPos);
379 if (pos == string::npos) { // no more replacements
380 r.append(definition->textTemplate.substr(lastPos));
384 r.append(definition->textTemplate.substr(lastPos, pos - lastPos));
386 size_t endReplacement = definition->textTemplate.find('}', pos+1);
387 if (endReplacement <= pos) {
388 return "bad replacement";
391 string spec = definition->textTemplate.substr(pos + 1, endReplacement - (pos + 1));
392 // look for formatter in spec
393 size_t colonPos = spec.find(':');
394 if (colonPos == string::npos) {
395 // simple replacement
396 r.append(props->getStringValue(spec));
398 string format = spec.substr(colonPos + 1);
399 string prop = spec.substr(0, colonPos);
400 r.append(formatPropertyValue(props->getNode(prop), format));
403 lastPos = endReplacement + 1;
410 //////////////////////////////////////////////////////////////////
412 NavDisplay::NavDisplay(SGPropertyNode *node) :
413 _name(node->getStringValue("name", "nd")),
414 _num(node->getIntValue("number", 0)),
416 _updateInterval(node->getDoubleValue("update-interval-sec", 0.1)),
425 _Instrument = fgGetNode(string("/instrumentation/" + _name).c_str(), _num, true);
426 _font_node = _Instrument->getNode("font", true);
428 #define INITFONT(p, val, type) if (!_font_node->hasValue(p)) _font_node->set##type##Value(p, val)
429 INITFONT("name", DEFAULT_FONT, String);
430 INITFONT("size", 8, Float);
431 INITFONT("line-spacing", 0.25, Float);
432 INITFONT("color/red", 0, Float);
433 INITFONT("color/green", 0.8, Float);
434 INITFONT("color/blue", 0, Float);
435 INITFONT("color/alpha", 1, Float);
438 _textureSize = _Instrument->getNode("symbol-texture-size", true)->getIntValue();
439 SGPropertyNode* symbolsNode = node->getNode("symbols");
440 SGPropertyNode* symbol;
442 map<string, SymbolDef*> definitionDict;
443 for (int i = 0; (symbol = symbolsNode->getChild("symbol", i)) != NULL; ++i) {
444 SymbolDef* def = new SymbolDef;
445 if (!def->initFromNode(symbol, this)) {
450 const char* id = symbol->getStringValue("id");
451 if (id && strlen(id)) {
452 definitionDict[id] = def;
455 _definitions.push_back(def);
456 } // of symbol definition parsing
458 SGPropertyNode* rulesNode = node->getNode("rules");
460 SGPropertyNode* rule;
462 for (int i = 0; (rule = rulesNode->getChild("rule", i)) != NULL; ++i) {
463 SymbolRule* r = new SymbolRule;
464 if (!r->initFromNode(rule, this)) {
469 const char* id = symbol->getStringValue("symbol");
470 if (id && strlen(id) && (definitionDict.find(id) != definitionDict.end())) {
471 r->setDefinition(definitionDict[id]);
473 SG_LOG(SG_INSTR, SG_WARN, "symbol rule has missing/unknown definition id:" << id);
479 } // of symbol rule parsing
485 NavDisplay::~NavDisplay()
493 _cachedItemsValid = false;
494 _cacheListener.reset(new CacheListener(this));
495 _forceUpdateListener.reset(new ForceUpdateListener(this));
497 _serviceable_node = _Instrument->getNode("serviceable", true);
498 _rangeNode = _Instrument->getNode("range", true);
499 if (!_rangeNode->hasValue()) {
500 _rangeNode->setDoubleValue(40.0);
502 _rangeNode->addChangeListener(_cacheListener.get());
503 _rangeNode->addChangeListener(_forceUpdateListener.get());
505 _xCenterNode = _Instrument->getNode("x-center");
506 if (!_xCenterNode->hasValue()) {
507 _xCenterNode->setDoubleValue(0.5);
509 _xCenterNode->addChangeListener(_forceUpdateListener.get());
510 _yCenterNode = _Instrument->getNode("y-center");
511 if (!_yCenterNode->hasValue()) {
512 _yCenterNode->setDoubleValue(0.5);
514 _yCenterNode->addChangeListener(_forceUpdateListener.get());
516 // texture name to use in 2D and 3D instruments
517 _texture_path = _Instrument->getStringValue("radar-texture-path",
518 "Aircraft/Instruments/Textures/od_wxradar.rgb");
520 string path = _Instrument->getStringValue("symbol-texture-path",
521 "Aircraft/Instruments/Textures/nd-symbols.png");
522 SGPath tpath = globals->resolve_aircraft_path(path);
523 if (!tpath.exists()) {
524 SG_LOG(SG_INSTR, SG_WARN, "ND symbol texture not found:" << path);
527 // no mipmap or else alpha will mix with pixels on the border of shapes, ruining the effect
528 _symbolTexture = SGLoadTexture2D(tpath, NULL, false, false);
530 _odg = new FGODGauge;
531 _odg->setSize(_Instrument->getIntValue("texture-size", 512));
533 _route = static_cast<FGRouteMgr*>(globals->get_subsystem("route-manager"));
535 _navRadio1Node = fgGetNode("/instrumentation/nav[0]", true);
536 _navRadio2Node = fgGetNode("/instrumentation/nav[1]", true);
538 _excessDataNode = _Instrument->getChild("excess-data", 0, true);
539 _excessDataNode->setBoolValue(false);
540 _testModeNode = _Instrument->getChild("test-mode", 0, true);
541 _testModeNode->setBoolValue(false);
543 // OSG geometry setup
544 _radarGeode = new osg::Geode;
546 _geom = new osg::Geometry;
547 _geom->setUseDisplayList(false);
549 osg::StateSet *stateSet = _geom->getOrCreateStateSet();
550 stateSet->setTextureAttributeAndModes(0, _symbolTexture.get());
551 stateSet->setDataVariance(osg::Object::STATIC);
553 // Initially allocate space for 128 quads
554 _vertices = new osg::Vec2Array;
555 _vertices->setDataVariance(osg::Object::DYNAMIC);
556 _vertices->reserve(128 * 4);
557 _geom->setVertexArray(_vertices);
558 _texCoords = new osg::Vec2Array;
559 _texCoords->setDataVariance(osg::Object::DYNAMIC);
560 _texCoords->reserve(128 * 4);
561 _geom->setTexCoordArray(0, _texCoords);
563 _quadColors = new osg::Vec4Array;
564 _quadColors->setDataVariance(osg::Object::DYNAMIC);
565 _geom->setColorBinding(osg::Geometry::BIND_PER_VERTEX);
566 _geom->setColorArray(_quadColors);
568 _symbolPrimSet = new osg::DrawArrays(osg::PrimitiveSet::QUADS);
569 _symbolPrimSet->setDataVariance(osg::Object::DYNAMIC);
570 _geom->addPrimitiveSet(_symbolPrimSet);
572 _geom->setInitialBound(osg::BoundingBox(osg::Vec3f(-256.0f, -256.0f, 0.0f),
573 osg::Vec3f(256.0f, 256.0f, 0.0f)));
575 _radarGeode->addDrawable(_geom);
577 // Texture in the 2D panel system
578 FGTextureManager::addTexture(_texture_path.c_str(), _odg->getTexture());
580 _lineGeometry = new osg::Geometry;
581 _lineGeometry->setUseDisplayList(false);
582 stateSet = _lineGeometry->getOrCreateStateSet();
583 osg::LineWidth *lw = new osg::LineWidth();
585 stateSet->setAttribute(lw);
587 _lineVertices = new osg::Vec2Array;
588 _lineVertices->setDataVariance(osg::Object::DYNAMIC);
589 _lineVertices->reserve(128 * 4);
590 _lineGeometry->setVertexArray(_lineVertices);
593 _lineColors = new osg::Vec4Array;
594 _lineColors->setDataVariance(osg::Object::DYNAMIC);
595 _lineGeometry->setColorBinding(osg::Geometry::BIND_PER_VERTEX);
596 _lineGeometry->setColorArray(_lineColors);
598 _linePrimSet = new osg::DrawArrays(osg::PrimitiveSet::LINES);
599 _linePrimSet->setDataVariance(osg::Object::DYNAMIC);
600 _lineGeometry->addPrimitiveSet(_linePrimSet);
602 _lineGeometry->setInitialBound(osg::BoundingBox(osg::Vec3f(-256.0f, -256.0f, 0.0f),
603 osg::Vec3f(256.0f, 256.0f, 0.0f)));
605 _radarGeode->addDrawable(_lineGeometry);
607 _textGeode = new osg::Geode;
609 osg::Camera *camera = _odg->getCamera();
610 camera->addChild(_radarGeode.get());
611 camera->addChild(_textGeode.get());
612 osg::Texture2D* tex = _odg->getTexture();
613 camera->setProjectionMatrixAsOrtho2D(0, tex->getTextureWidth(),
614 0, tex->getTextureHeight());
620 NavDisplay::update (double delta_time_sec)
622 if (!fgGetBool("sim/sceneryloaded", false)) {
626 if (!_odg || !_serviceable_node->getBoolValue()) {
627 _Instrument->setStringValue("status", "");
632 _forceUpdate = false;
635 _time += delta_time_sec;
636 if (_time < _updateInterval){
639 _time -= _updateInterval;
642 _rangeNm = _rangeNode->getFloatValue();
643 if (_testModeNode->getBoolValue()) {
645 } else if (_Instrument->getBoolValue("aircraft-heading-up", true)) {
646 _view_heading = fgGetDouble("/orientation/heading-deg");
648 _view_heading = _Instrument->getFloatValue("heading-up-deg", 0.0);
651 double xCenterFrac = _xCenterNode->getDoubleValue();
652 double yCenterFrac = _yCenterNode->getDoubleValue();
653 int pixelSize = _odg->size();
655 int rangePixels = _Instrument->getIntValue("range-pixels", -1);
656 if (rangePixels < 0) {
657 // hacky - assume (as is very common) that x-frac doesn't vary, and
658 // y-frac is used to position the center at either the top or bottom of
659 // the pixel area. Measure from the center to the furthest edge (top or bottom)
660 rangePixels = pixelSize * std::max(fabs(1.0 - yCenterFrac), fabs(yCenterFrac));
663 _scale = rangePixels / _rangeNm;
664 _Instrument->setDoubleValue("scale", _scale);
667 _centerTrans = osg::Matrixf::translate(xCenterFrac * pixelSize,
668 yCenterFrac * pixelSize, 0.0);
670 // scale from nm to display units, rotate so aircraft heading is up
671 // (as opposed to north), and compensate for centering
672 _projectMat = osg::Matrixf::scale(_scale, _scale, 1.0) *
673 degRotation(-_view_heading) * _centerTrans;
675 _pos = globals->get_aircraft_position();
677 // invalidate the cache of positioned items, if we travelled more than 1nm
678 if (_cachedItemsValid) {
679 SGVec3d cartNow(SGVec3d::fromGeod(_pos));
680 double movedNm = dist(_cachedPos, cartNow) * SG_METER_TO_NM;
681 _cachedItemsValid = (movedNm < 1.0);
682 if (!_cachedItemsValid) {
683 SG_LOG(SG_INSTR, SG_INFO, "invalidating NavDisplay cache due to moving: " << movedNm);
688 _lineVertices->clear();
689 _lineColors->clear();
690 _quadColors->clear();
692 _textGeode->removeDrawables(0, _textGeode->getNumDrawables());
694 BOOST_FOREACH(SymbolInstance* si, _symbols) {
699 BOOST_FOREACH(SymbolRule* r, _rules) {
703 if (_testModeNode->getBoolValue()) {
710 limitDisplayedSymbols();
715 _symbolPrimSet->set(osg::PrimitiveSet::QUADS, 0, _vertices->size());
716 _symbolPrimSet->dirty();
717 _linePrimSet->set(osg::PrimitiveSet::LINES, 0, _lineVertices->size());
718 _linePrimSet->dirty();
723 NavDisplay::updateFont()
725 float red = _font_node->getFloatValue("color/red");
726 float green = _font_node->getFloatValue("color/green");
727 float blue = _font_node->getFloatValue("color/blue");
728 float alpha = _font_node->getFloatValue("color/alpha");
729 _font_color.set(red, green, blue, alpha);
731 _font_size = _font_node->getFloatValue("size");
732 _font_spacing = _font_size * _font_node->getFloatValue("line-spacing");
733 string path = _font_node->getStringValue("name", DEFAULT_FONT);
736 if (path[0] != '/') {
737 tpath = globals->get_fg_root();
738 tpath.append("Fonts");
744 osg::ref_ptr<osgDB::ReaderWriter::Options> fontOptions = new osgDB::ReaderWriter::Options("monochrome");
745 osg::ref_ptr<osgText::Font> font = osgText::readFontFile(tpath.c_str(), fontOptions.get());
749 _font->setMinFilterHint(osg::Texture::NEAREST);
750 _font->setMagFilterHint(osg::Texture::NEAREST);
751 _font->setGlyphImageMargin(0);
752 _font->setGlyphImageMarginRatio(0);
756 void NavDisplay::addSymbolToScene(SymbolInstance* sym)
758 SymbolDef* def = sym->definition;
762 verts[1] = osg::Vec2(def->xy1.x(), def->xy0.y());
764 verts[3] = osg::Vec2(def->xy0.x(), def->xy1.y());
766 if (def->rotateToHeading) {
767 osg::Matrixf m(degRotation(sym->headingDeg - _view_heading));
768 for (int i=0; i<4; ++i) {
769 verts[i] = mult(verts[i], m);
773 osg::Vec2 pos = sym->pos;
775 pos = osg::Vec2((int) pos.x(), (int) pos.y());
778 _texCoords->push_back(def->uv0);
779 _texCoords->push_back(osg::Vec2(def->uv1.x(), def->uv0.y()));
780 _texCoords->push_back(def->uv1);
781 _texCoords->push_back(osg::Vec2(def->uv0.x(), def->uv1.y()));
783 for (int i=0; i<4; ++i) {
784 _vertices->push_back(verts[i] + pos);
785 _quadColors->push_back(def->color);
788 if (def->stretchSymbol) {
789 osg::Vec2 stretchVerts[4];
790 stretchVerts[0] = osg::Vec2(def->xy0.x(), def->stretchY2);
791 stretchVerts[1] = osg::Vec2(def->xy1.x(), def->stretchY2);
792 stretchVerts[2] = osg::Vec2(def->xy1.x(), def->stretchY3);
793 stretchVerts[3] = osg::Vec2(def->xy0.x(), def->stretchY3);
795 osg::Matrixf m(degRotation(sym->headingDeg - _view_heading));
796 for (int i=0; i<4; ++i) {
797 stretchVerts[i] = mult(stretchVerts[i], m);
801 _vertices->push_back(verts[2] + pos);
802 _vertices->push_back(stretchVerts[1] + sym->endPos);
803 _vertices->push_back(stretchVerts[0] + sym->endPos);
804 _vertices->push_back(verts[3] + pos);
806 _texCoords->push_back(def->uv1);
807 _texCoords->push_back(osg::Vec2(def->uv1.x(), def->stretchV2));
808 _texCoords->push_back(osg::Vec2(def->uv0.x(), def->stretchV2));
809 _texCoords->push_back(osg::Vec2(def->uv0.x(), def->uv1.y()));
811 for (int i=0; i<4; ++i) {
812 _quadColors->push_back(def->color);
815 // quad three, for the end portion
816 for (int i=0; i<4; ++i) {
817 _vertices->push_back(stretchVerts[i] + sym->endPos);
818 _quadColors->push_back(def->color);
821 _texCoords->push_back(osg::Vec2(def->uv0.x(), def->stretchV2));
822 _texCoords->push_back(osg::Vec2(def->uv1.x(), def->stretchV2));
823 _texCoords->push_back(osg::Vec2(def->uv1.x(), def->stretchV3));
824 _texCoords->push_back(osg::Vec2(def->uv0.x(), def->stretchV3));
828 addLine(sym->pos, sym->endPos, def->lineColor);
835 osgText::Text* t = new osgText::Text;
836 t->setFont(_font.get());
837 t->setFontResolution(12, 12);
838 t->setCharacterSize(_font_size);
839 t->setLineSpacing(_font_spacing);
840 t->setColor(def->textColor);
841 t->setAlignment(def->alignment);
842 t->setText(sym->text());
845 osg::Vec2 textPos = def->textOffset + pos;
846 // ensure we use ints here, or text visual quality goes bad
847 t->setPosition(osg::Vec3((int)textPos.x(), (int)textPos.y(), 0));
848 _textGeode->addDrawable(t);
851 class OrderByPriority
854 bool operator()(SymbolInstance* a, SymbolInstance* b)
856 return a->definition->priority > b->definition->priority;
860 void NavDisplay::limitDisplayedSymbols()
862 unsigned int maxSymbols = _Instrument->getIntValue("max-symbols", 100);
863 if (_symbols.size() <= maxSymbols) {
864 _excessDataNode->setBoolValue(false);
868 std::sort(_symbols.begin(), _symbols.end(), OrderByPriority());
869 _symbols.resize(maxSymbols);
870 _excessDataNode->setBoolValue(true);
876 bool operator()(SymbolInstance* a, SymbolInstance* b)
878 return a->definition->zOrder > b->definition->zOrder;
882 void NavDisplay::addSymbolsToScene()
884 std::sort(_symbols.begin(), _symbols.end(), OrderByZ());
885 BOOST_FOREACH(SymbolInstance* sym, _symbols) {
886 addSymbolToScene(sym);
890 void NavDisplay::addLine(osg::Vec2 a, osg::Vec2 b, const osg::Vec4& color)
892 _lineVertices->push_back(a);
893 _lineVertices->push_back(b);
894 _lineColors->push_back(color);
895 _lineColors->push_back(color);
898 osg::Vec2 NavDisplay::projectBearingRange(double bearingDeg, double rangeNm) const
900 osg::Vec3 p(0, rangeNm, 0.0);
901 p = degRotation(bearingDeg).preMult(p);
902 p = _projectMat.preMult(p);
903 return osg::Vec2(p.x(), p.y());
906 osg::Vec2 NavDisplay::projectGeod(const SGGeod& geod) const
908 double rangeM, bearing, az2;
909 SGGeodesy::inverse(_pos, geod, bearing, az2, rangeM);
910 return projectBearingRange(bearing, rangeM * SG_METER_TO_NM);
913 class Filter : public FGPositioned::Filter
916 double minRunwayLengthFt;
918 virtual bool pass(FGPositioned* aPos) const
920 if (aPos->type() == FGPositioned::FIX) {
921 string ident(aPos->ident());
922 // ignore fixes which end in digits
923 if ((ident.size() > 4) && isdigit(ident[3]) && isdigit(ident[4])) {
928 if (aPos->type() == FGPositioned::AIRPORT) {
929 FGAirport* apt = (FGAirport*) aPos;
930 if (!apt->hasHardRunwayOfLengthFt(minRunwayLengthFt)) {
938 virtual FGPositioned::Type minType() const {
939 return FGPositioned::AIRPORT;
942 virtual FGPositioned::Type maxType() const {
943 return FGPositioned::OBSTACLE;
947 void NavDisplay::findItems()
949 if (!_cachedItemsValid) {
950 SG_LOG(SG_INSTR, SG_INFO, "re-validating NavDisplay cache");
952 filt.minRunwayLengthFt = 2000;
953 _itemsInRange = FGPositioned::findWithinRange(_pos, _rangeNm, &filt);
954 _cachedItemsValid = true;
955 _cachedPos = SGVec3d::fromGeod(_pos);
958 BOOST_FOREACH(FGPositioned* pos, _itemsInRange) {
959 foundPositionedItem(pos);
963 void NavDisplay::processRoute()
965 _routeSources.clear();
966 RoutePath path(_route->waypts());
967 int current = _route->currentIndex();
969 for (int w=0; w<_route->numWaypts(); ++w) {
970 flightgear::WayptRef wpt(_route->wayptAtIndex(w));
971 _routeSources.insert(wpt->source());
974 state.insert("on-active-route");
977 state.insert("passed");
981 state.insert("current-wp");
985 state.insert("future");
988 if (w == (current + 1)) {
989 state.insert("next-wp");
992 SymbolRuleVector rules;
993 findRules("waypoint" , state, rules);
995 return; // no rules matched, we can skip this item
998 SGGeod g = path.positionForIndex(w);
999 SGPropertyNode* vars = _route->wayptNodeAtIndex(w);
1001 computeWayptPropsAndHeading(wpt, g, vars, heading);
1003 osg::Vec2 projected = projectGeod(g);
1004 BOOST_FOREACH(SymbolRule* r, rules) {
1005 addSymbolInstance(projected, heading, r->getDefinition(), vars);
1007 if (r->getDefinition()->drawRouteLeg) {
1008 SGGeodVec gv(path.pathForIndex(w));
1010 osg::Vec2 pr = projectGeod(gv[0]);
1011 for (unsigned int i=1; i<gv.size(); ++i) {
1012 osg::Vec2 p = projectGeod(gv[i]);
1013 addLine(pr, p, r->getDefinition()->lineColor);
1017 } // of leg drawing enabled
1018 } // of matching rules iteration
1019 } // of waypoints iteration
1022 void NavDisplay::computeWayptPropsAndHeading(flightgear::Waypt* wpt, const SGGeod& pos, SGPropertyNode* nd, double& heading)
1025 SGGeodesy::inverse(_pos, pos, heading, az2, rangeM);
1026 nd->setIntValue("radial", heading);
1027 nd->setDoubleValue("distance-nm", rangeM * SG_METER_TO_NM);
1029 heading = nd->getDoubleValue("leg-bearing-true-deg");
1032 void NavDisplay::processNavRadios()
1034 _nav1Station = processNavRadio(_navRadio1Node);
1035 _nav2Station = processNavRadio(_navRadio2Node);
1037 foundPositionedItem(_nav1Station);
1038 foundPositionedItem(_nav2Station);
1041 FGNavRecord* NavDisplay::processNavRadio(const SGPropertyNode_ptr& radio)
1043 double mhz = radio->getDoubleValue("frequencies/selected-mhz", 0.0);
1044 FGNavRecord* nav = globals->get_navlist()->findByFreq(mhz, _pos);
1045 if (!nav || (nav->ident() != radio->getStringValue("nav-id"))) {
1046 // station was not found
1054 bool NavDisplay::anyRuleForType(const string& type) const
1056 BOOST_FOREACH(SymbolRule* r, _rules) {
1061 if (r->type == type) {
1069 bool NavDisplay::anyRuleMatches(const string& type, const string_set& states) const
1071 BOOST_FOREACH(SymbolRule* r, _rules) {
1072 if (!r->enabled || (r->type != type)) {
1076 if (r->matches(states)) {
1079 } // of rules iteration
1084 void NavDisplay::findRules(const string& type, const string_set& states, SymbolRuleVector& rules)
1086 BOOST_FOREACH(SymbolRule* candidate, _rules) {
1087 if (!candidate->enabled || (candidate->type != type)) {
1091 if (candidate->matches(states)) {
1092 rules.push_back(candidate);
1097 void NavDisplay::foundPositionedItem(FGPositioned* pos)
1103 string type = FGPositioned::nameForType(pos->type());
1104 if (!anyRuleForType(type)) {
1105 return; // not diplayed at all, we're done
1109 computePositionedState(pos, states);
1111 SymbolRuleVector rules;
1112 findRules(type, states, rules);
1113 if (rules.empty()) {
1114 return; // no rules matched, we can skip this item
1117 SGPropertyNode_ptr vars(new SGPropertyNode);
1119 computePositionedPropsAndHeading(pos, vars, heading);
1121 osg::Vec2 projected = projectGeod(pos->geod());
1122 if (pos->type() == FGPositioned::RUNWAY) {
1123 FGRunway* rwy = (FGRunway*) pos;
1124 projected = projectGeod(rwy->threshold());
1127 BOOST_FOREACH(SymbolRule* r, rules) {
1128 SymbolInstance* ins = addSymbolInstance(projected, heading, r->getDefinition(), vars);
1129 if (pos->type() == FGPositioned::RUNWAY) {
1130 FGRunway* rwy = (FGRunway*) pos;
1131 ins->endPos = projectGeod(rwy->end());
1136 void NavDisplay::computePositionedPropsAndHeading(FGPositioned* pos, SGPropertyNode* nd, double& heading)
1138 nd->setStringValue("id", pos->ident());
1139 nd->setStringValue("name", pos->name());
1140 nd->setDoubleValue("elevation-ft", pos->elevation());
1141 nd->setIntValue("heading-deg", 0);
1144 switch (pos->type()) {
1145 case FGPositioned::VOR:
1146 case FGPositioned::LOC:
1147 case FGPositioned::TACAN: {
1148 FGNavRecord* nav = static_cast<FGNavRecord*>(pos);
1149 nd->setDoubleValue("frequency-mhz", nav->get_freq());
1151 if (pos == _nav1Station) {
1152 heading = _navRadio1Node->getDoubleValue("radials/target-radial-deg");
1153 } else if (pos == _nav2Station) {
1154 heading = _navRadio2Node->getDoubleValue("radials/target-radial-deg");
1157 nd->setIntValue("heading-deg", heading);
1161 case FGPositioned::AIRPORT:
1162 case FGPositioned::SEAPORT:
1163 case FGPositioned::HELIPORT:
1167 case FGPositioned::RUNWAY: {
1168 FGRunway* rwy = static_cast<FGRunway*>(pos);
1169 heading = rwy->headingDeg();
1170 nd->setDoubleValue("heading-deg", heading);
1171 nd->setIntValue("length-ft", rwy->lengthFt());
1172 nd->setStringValue("airport", rwy->airport()->ident());
1181 void NavDisplay::computePositionedState(FGPositioned* pos, string_set& states)
1183 if (_routeSources.count(pos) != 0) {
1184 states.insert("on-active-route");
1187 switch (pos->type()) {
1188 case FGPositioned::VOR:
1189 case FGPositioned::LOC:
1190 if (pos == _nav1Station) {
1191 states.insert("tuned");
1192 states.insert("nav1");
1195 if (pos == _nav2Station) {
1196 states.insert("tuned");
1197 states.insert("nav2");
1201 case FGPositioned::AIRPORT:
1202 case FGPositioned::SEAPORT:
1203 case FGPositioned::HELIPORT:
1205 // once the FMS system has some way to tell us about them, of course
1207 if (pos == _route->departureAirport()) {
1208 states.insert("departure");
1211 if (pos == _route->destinationAirport()) {
1212 states.insert("destination");
1216 case FGPositioned::RUNWAY:
1217 if (pos == _route->departureRunway()) {
1218 states.insert("departure");
1221 if (pos == _route->destinationRunway()) {
1222 states.insert("destination");
1226 case FGPositioned::OBSTACLE:
1228 FGObstacle* obs = (FGObstacle*) pos;
1230 states.insert("lit");
1233 if (obj->getHeightAGLFt() >= 1000) {
1234 states.insert("greater-1000-ft");
1241 } // FGPositioned::Type switch
1244 static string mapAINodeToType(SGPropertyNode* model)
1246 // assume all multiplayer items are aircraft for the moment. Not ideal.
1247 if (!strcmp(model->getName(), "multiplayer")) {
1248 return "ai-aircraft";
1251 return string("ai-") + model->getName();
1254 void NavDisplay::processAI()
1256 SGPropertyNode *ai = fgGetNode("/ai/models", true);
1257 for (int i = ai->nChildren() - 1; i >= 0; i--) {
1258 SGPropertyNode *model = ai->getChild(i);
1259 if (!model->nChildren()) {
1263 // prefix types with 'ai-', to avoid any chance of namespace collisions
1264 // with fg-positioned.
1266 computeAIStates(model, ss);
1267 SymbolRuleVector rules;
1268 findRules(mapAINodeToType(model), ss, rules);
1269 if (rules.empty()) {
1270 return; // no rules matched, we can skip this item
1273 double heading = model->getDoubleValue("orientation/true-heading-deg");
1274 SGGeod aiModelPos = SGGeod::fromDegFt(model->getDoubleValue("position/longitude-deg"),
1275 model->getDoubleValue("position/latitude-deg"),
1276 model->getDoubleValue("position/altitude-ft"));
1277 // compute some additional props
1278 int fl = (aiModelPos.getElevationFt() / 1000);
1279 model->setIntValue("flight-level", fl * 10);
1281 osg::Vec2 projected = projectGeod(aiModelPos);
1282 BOOST_FOREACH(SymbolRule* r, rules) {
1283 addSymbolInstance(projected, heading, r->getDefinition(), (SGPropertyNode*) model);
1285 } // of ai models iteration
1288 void NavDisplay::computeAIStates(const SGPropertyNode* ai, string_set& states)
1290 int threatLevel = ai->getIntValue("tcas/threat-level",-1);
1291 if (threatLevel < 1)
1294 states.insert("tcas");
1296 std::ostringstream os;
1297 os << "tcas-threat-level-" << threatLevel;
1298 states.insert(os.str());
1300 double vspeed = ai->getDoubleValue("velocities/vertical-speed-fps");
1301 if (vspeed < -3.0) {
1302 states.insert("descending");
1303 } else if (vspeed > 3.0) {
1304 states.insert("climbing");
1308 SymbolInstance* NavDisplay::addSymbolInstance(const osg::Vec2& proj, double heading, SymbolDef* def, SGPropertyNode* vars)
1310 if (isProjectedClipped(proj)) {
1314 SymbolInstance* sym = new SymbolInstance(proj, heading, def, vars);
1315 _symbols.push_back(sym);
1319 bool NavDisplay::isProjectedClipped(const osg::Vec2& projected) const
1321 double size = _odg->size();
1322 return (projected.x() < 0.0) ||
1323 (projected.y() < 0.0) ||
1324 (projected.x() >= size) ||
1325 (projected.y() >= size);
1328 void NavDisplay::addTestSymbol(const std::string& type, const std::string& states, const SGGeod& pos, double heading, SGPropertyNode* vars)
1330 string_set stateSet;
1331 BOOST_FOREACH(std::string s, simgear::strutils::split(states, ",")) {
1335 SymbolRuleVector rules;
1336 findRules(type, stateSet, rules);
1337 if (rules.empty()) {
1338 return; // no rules matched, we can skip this item
1341 osg::Vec2 projected = projectGeod(pos);
1342 BOOST_FOREACH(SymbolRule* r, rules) {
1343 addSymbolInstance(projected, heading, r->getDefinition(), vars);
1347 void NavDisplay::addTestSymbols()
1349 _pos = SGGeod::fromDeg(-122.3748889, 37.6189722); // KSFO
1353 SGGeodesy::direct(_pos, 45.0, 20.0 * SG_NM_TO_METER, a1, dummy);
1355 addTestSymbol("airport", "", a1, 0.0, NULL);
1357 SGGeodesy::direct(_pos, 95.0, 40.0 * SG_NM_TO_METER, a1, dummy);
1359 addTestSymbol("vor", "", a1, 0.0, NULL);
1361 SGGeodesy::direct(_pos, 120, 80.0 * SG_NM_TO_METER, a1, dummy);
1363 addTestSymbol("airport", "destination", a1, 0.0, NULL);
1365 SGGeodesy::direct(_pos, 80.0, 20.0 * SG_NM_TO_METER, a1, dummy);
1366 addTestSymbol("fix", "", a1, 0.0, NULL);
1369 SGGeodesy::direct(_pos, 140.0, 20.0 * SG_NM_TO_METER, a1, dummy);
1370 addTestSymbol("fix", "", a1, 0.0, NULL);
1372 SGGeodesy::direct(_pos, 110.0, 10.0 * SG_NM_TO_METER, a1, dummy);
1373 addTestSymbol("fix", "", a1, 0.0, NULL);
1375 SGGeodesy::direct(_pos, 110.0, 5.0 * SG_NM_TO_METER, a1, dummy);
1376 addTestSymbol("fix", "", a1, 0.0, NULL);
1379 void NavDisplay::addRule(SymbolRule* r)
1381 _rules.push_back(r);