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;
61 #include <Main/fg_props.hxx>
62 #include <Main/globals.hxx>
63 #include <Cockpit/panel.hxx>
64 #include <Navaids/routePath.hxx>
65 #include <Autopilot/route_mgr.hxx>
66 #include <Navaids/navrecord.hxx>
67 #include <Navaids/navlist.hxx>
68 #include <Navaids/fix.hxx>
69 #include <Airports/simple.hxx>
70 #include <Airports/runways.hxx>
72 #include "instrument_mgr.hxx"
73 #include "od_gauge.hxx"
75 static const char *DEFAULT_FONT = "typewriter.txf";
78 osg::Matrixf degRotation(float angle)
80 return osg::Matrixf::rotate(angle * SG_DEGREES_TO_RADIANS, 0.0f, 0.0f, -1.0f);
83 static osg::Vec4 readColor(SGPropertyNode* colorNode, const osg::Vec4& c)
86 result.r() = colorNode->getDoubleValue("red", c.r());
87 result.g() = colorNode->getDoubleValue("green", c.g());
88 result.b() = colorNode->getDoubleValue("blue", c.b());
89 result.a() = colorNode->getDoubleValue("alpha", c.a());
93 static osgText::Text::AlignmentType readAlignment(const std::string& t)
95 if (t == "left-top") {
96 return osgText::Text::LEFT_TOP;
97 } else if (t == "left-center") {
98 return osgText::Text::LEFT_CENTER;
99 } else if (t == "left-bottom") {
100 return osgText::Text::LEFT_BOTTOM;
101 } else if (t == "center-top") {
102 return osgText::Text::CENTER_TOP;
103 } else if (t == "center-center") {
104 return osgText::Text::CENTER_CENTER;
105 } else if (t == "center-bottom") {
106 return osgText::Text::CENTER_BOTTOM;
107 } else if (t == "right-top") {
108 return osgText::Text::RIGHT_TOP;
109 } else if (t == "right-center") {
110 return osgText::Text::RIGHT_CENTER;
111 } else if (t == "right-bottom") {
112 return osgText::Text::RIGHT_BOTTOM;
113 } else if (t == "left-baseline") {
114 return osgText::Text::LEFT_BASE_LINE;
115 } else if (t == "center-baseline") {
116 return osgText::Text::CENTER_BASE_LINE;
117 } else if (t == "right-baseline") {
118 return osgText::Text::RIGHT_BASE_LINE;
121 return osgText::Text::BASE_LINE;
124 static string formatPropertyValue(SGPropertyNode* nd, const string& format)
127 static char buf[512];
128 if (format.find('d') != string::npos) {
129 ::snprintf(buf, 512, format.c_str(), nd->getIntValue());
133 if (format.find('s') != string::npos) {
134 ::snprintf(buf, 512, format.c_str(), nd->getStringValue());
138 // assume it's a double/float
139 ::snprintf(buf, 512, format.c_str(), nd->getDoubleValue());
143 static osg::Vec2 mult(const osg::Vec2& v, const osg::Matrixf& m)
145 osg::Vec3 r = m.preMult(osg::Vec3(v.x(), v.y(), 0.0));
146 return osg::Vec2(r.x(), r.y());
149 class NavDisplay::CacheListener : public SGPropertyChangeListener
152 CacheListener(NavDisplay *nd) :
156 virtual void valueChanged (SGPropertyNode * prop)
158 _nd->invalidatePositionedCache();
159 SG_LOG(SG_INSTR, SG_INFO, "invalidating NavDisplay cache");
165 class NavDisplay::ForceUpdateListener : public SGPropertyChangeListener
168 ForceUpdateListener(NavDisplay *nd) :
172 virtual void valueChanged (SGPropertyNode * prop)
174 SG_LOG(SG_INSTR, SG_INFO, "forcing NavDisplay update");
181 ///////////////////////////////////////////////////////////////////
190 bool initFromNode(SGPropertyNode* node, NavDisplay* owner)
192 type = node->getStringValue("type");
193 SGPropertyNode* enableNode = node->getChild("enable");
195 enable = sgReadCondition(fgGetNode("/"), enableNode);
199 while (node->hasChild("state", n)) {
200 string m = node->getChild("state", n++)->getStringValue();
202 excluded_states.insert(m.substr(1));
204 required_states.insert(m);
206 } // of matches parsing
208 if (node->hasChild("width")) {
209 float w = node->getFloatValue("width");
210 float h = node->getFloatValue("height", w);
216 xy0.x() = node->getFloatValue("x0", 0.0);
217 xy0.y() = node->getFloatValue("y0", 0.0);
218 xy1.x() = node->getFloatValue("x1", 5);
219 xy1.y() = node->getFloatValue("y1", 5);
222 double texSize = node->getFloatValue("texture-size", owner->textureSize());
224 uv0.x() = node->getFloatValue("u0", 0) / texSize;
225 uv0.y() = node->getFloatValue("v0", 0) / texSize;
226 uv1.x() = node->getFloatValue("u1", 1) / texSize;
227 uv1.y() = node->getFloatValue("v1", 1) / texSize;
229 color = readColor(node->getChild("color"), osg::Vec4(1, 1, 1, 1));
230 priority = node->getIntValue("priority", 0);
231 zOrder = node->getIntValue("zOrder", 0);
232 rotateToHeading = node->getBoolValue("rotate-to-heading", false);
233 roundPos = node->getBoolValue("round-position", true);
235 if (node->hasChild("text")) {
237 alignment = readAlignment(node->getStringValue("text-align"));
238 textTemplate = node->getStringValue("text");
239 textOffset.x() = node->getFloatValue("text-offset-x", 0);
240 textOffset.y() = node->getFloatValue("text-offset-y", 0);
241 textColor = readColor(node->getChild("text-color"), color);
244 drawLine = node->getBoolValue("draw-line", false);
245 lineColor = readColor(node->getChild("line-color"), color);
246 drawRouteLeg = node->getBoolValue("draw-leg", false);
248 stretchSymbol = node->getBoolValue("stretch-symbol", false);
250 stretchY2 = node->getFloatValue("y2");
251 stretchY3 = node->getFloatValue("y3");
252 stretchV2 = node->getFloatValue("v2") / texSize;
253 stretchV3 = node->getFloatValue("v3") / texSize;
260 bool enabled; // cached enabled state
263 string_set required_states;
264 string_set excluded_states;
272 bool rotateToHeading;
273 bool roundPos; ///< should position be rounded to integer values
276 osg::Vec2 textOffset;
277 osgText::Text::AlignmentType alignment;
283 // symbol stretching creates three quads (instead of one) - a start,
284 // middle and end quad, positioned along the line of the symbol.
285 // X (and U) axis values determined by the values above, so we only need
286 // to define the Y (and V) values to build the other quads.
288 double stretchY2, stretchY3;
289 double stretchV2, stretchV3;
293 bool matches(const string_set& states) const
295 BOOST_FOREACH(const string& s, required_states) {
296 if (states.count(s) == 0) {
301 BOOST_FOREACH(const string& s, excluded_states) {
302 if (states.count(s) != 0) {
314 SymbolInstance(const osg::Vec2& p, double h, SymbolDef* def, SGPropertyNode* vars) :
321 osg::Vec2 pos; // projected position
324 SymbolDef* definition;
325 SGPropertyNode_ptr props;
329 assert(definition->hasText);
334 size_t pos = definition->textTemplate.find('{', lastPos);
335 if (pos == string::npos) { // no more replacements
336 r.append(definition->textTemplate.substr(lastPos));
340 r.append(definition->textTemplate.substr(lastPos, pos - lastPos));
342 size_t endReplacement = definition->textTemplate.find('}', pos+1);
343 if (endReplacement <= pos) {
344 return "bad replacement";
347 string spec = definition->textTemplate.substr(pos + 1, endReplacement - (pos + 1));
348 // look for formatter in spec
349 size_t colonPos = spec.find(':');
350 if (colonPos == string::npos) {
351 // simple replacement
352 r.append(props->getStringValue(spec));
354 string format = spec.substr(colonPos + 1);
355 string prop = spec.substr(0, colonPos);
356 r.append(formatPropertyValue(props->getNode(prop), format));
359 lastPos = endReplacement + 1;
366 //////////////////////////////////////////////////////////////////
368 NavDisplay::NavDisplay(SGPropertyNode *node) :
369 _name(node->getStringValue("name", "nd")),
370 _num(node->getIntValue("number", 0)),
372 _updateInterval(node->getDoubleValue("update-interval-sec", 0.1)),
382 _Instrument = fgGetNode(string("/instrumentation/" + _name).c_str(), _num, true);
383 _font_node = _Instrument->getNode("font", true);
385 #define INITFONT(p, val, type) if (!_font_node->hasValue(p)) _font_node->set##type##Value(p, val)
386 INITFONT("name", DEFAULT_FONT, String);
387 INITFONT("size", 8, Float);
388 INITFONT("line-spacing", 0.25, Float);
389 INITFONT("color/red", 0, Float);
390 INITFONT("color/green", 0.8, Float);
391 INITFONT("color/blue", 0, Float);
392 INITFONT("color/alpha", 1, Float);
395 _textureSize = _Instrument->getNode("symbol-teture-size", true)->getIntValue();
396 SGPropertyNode* symbolsNode = node->getNode("symbols");
397 SGPropertyNode* symbol;
399 for (int i = 0; (symbol = symbolsNode->getChild("symbol", i)) != NULL; ++i) {
400 SymbolDef* def = new SymbolDef;
401 if (!def->initFromNode(symbol, this)) {
406 _rules.push_back(def);
407 } // of symbol definition parsing
411 NavDisplay::~NavDisplay()
419 _cachedItemsValid = false;
420 _cacheListener.reset(new CacheListener(this));
421 _forceUpdateListener.reset(new ForceUpdateListener(this));
423 _serviceable_node = _Instrument->getNode("serviceable", true);
424 _rangeNode = _Instrument->getNode("range", true);
425 _rangeNode->setDoubleValue(40.0);
426 _rangeNode->addChangeListener(_cacheListener.get());
427 _rangeNode->addChangeListener(_forceUpdateListener.get());
429 _xCenterNode = _Instrument->getNode("x-center");
430 _xCenterNode->setDoubleValue(0.5);
431 _xCenterNode->addChangeListener(_forceUpdateListener.get());
432 _yCenterNode = _Instrument->getNode("y-center");
433 _yCenterNode->setDoubleValue(0.5);
434 _yCenterNode->addChangeListener(_forceUpdateListener.get());
436 // texture name to use in 2D and 3D instruments
437 _texture_path = _Instrument->getStringValue("radar-texture-path",
438 "Aircraft/Instruments/Textures/od_wxradar.rgb");
439 _resultTexture = FGTextureManager::createTexture(_texture_path.c_str(), false);
441 string path = _Instrument->getStringValue("symbol-texture-path",
442 "Aircraft/Instruments/Textures/nd-symbols.png");
443 SGPath tpath = globals->resolve_aircraft_path(path);
444 if (!tpath.exists()) {
445 SG_LOG(SG_INSTR, SG_WARN, "ND symbol texture not found:" << path);
448 // no mipmap or else alpha will mix with pixels on the border of shapes, ruining the effect
449 _symbolTexture = SGLoadTexture2D(tpath, NULL, false, false);
451 FGInstrumentMgr *imgr = (FGInstrumentMgr *)globals->get_subsystem("instrumentation");
452 _odg = (FGODGauge *)imgr->get_subsystem("od_gauge");
453 _odg->setSize(_Instrument->getIntValue("texture-size", 512));
455 _route = static_cast<FGRouteMgr*>(globals->get_subsystem("route-manager"));
457 _navRadio1Node = fgGetNode("/instrumentation/nav[0]", true);
458 _navRadio2Node = fgGetNode("/instrumentation/nav[1]", true);
460 _excessDataNode = _Instrument->getChild("excess-data", 0, true);
461 _excessDataNode->setBoolValue(false);
462 _testModeNode = _Instrument->getChild("test-mode", 0, true);
463 _testModeNode->setBoolValue(false);
465 // OSG geometry setup
466 _radarGeode = new osg::Geode;
468 _geom = new osg::Geometry;
469 _geom->setUseDisplayList(false);
471 osg::StateSet *stateSet = _geom->getOrCreateStateSet();
472 stateSet->setTextureAttributeAndModes(0, _symbolTexture.get());
473 stateSet->setDataVariance(osg::Object::STATIC);
475 // Initially allocate space for 128 quads
476 _vertices = new osg::Vec2Array;
477 _vertices->setDataVariance(osg::Object::DYNAMIC);
478 _vertices->reserve(128 * 4);
479 _geom->setVertexArray(_vertices);
480 _texCoords = new osg::Vec2Array;
481 _texCoords->setDataVariance(osg::Object::DYNAMIC);
482 _texCoords->reserve(128 * 4);
483 _geom->setTexCoordArray(0, _texCoords);
485 _quadColors = new osg::Vec4Array;
486 _quadColors->setDataVariance(osg::Object::DYNAMIC);
487 _geom->setColorBinding(osg::Geometry::BIND_PER_VERTEX);
488 _geom->setColorArray(_quadColors);
490 _symbolPrimSet = new osg::DrawArrays(osg::PrimitiveSet::QUADS);
491 _symbolPrimSet->setDataVariance(osg::Object::DYNAMIC);
492 _geom->addPrimitiveSet(_symbolPrimSet);
494 _geom->setInitialBound(osg::BoundingBox(osg::Vec3f(-256.0f, -256.0f, 0.0f),
495 osg::Vec3f(256.0f, 256.0f, 0.0f)));
497 _radarGeode->addDrawable(_geom);
499 // Texture in the 2D panel system
500 FGTextureManager::addTexture(_texture_path.c_str(), _odg->getTexture());
502 _lineGeometry = new osg::Geometry;
503 _lineGeometry->setUseDisplayList(false);
504 stateSet = _lineGeometry->getOrCreateStateSet();
505 osg::LineWidth *lw = new osg::LineWidth();
507 stateSet->setAttribute(lw);
509 _lineVertices = new osg::Vec2Array;
510 _lineVertices->setDataVariance(osg::Object::DYNAMIC);
511 _lineVertices->reserve(128 * 4);
512 _lineGeometry->setVertexArray(_lineVertices);
515 _lineColors = new osg::Vec4Array;
516 _lineColors->setDataVariance(osg::Object::DYNAMIC);
517 _lineGeometry->setColorBinding(osg::Geometry::BIND_PER_VERTEX);
518 _lineGeometry->setColorArray(_lineColors);
520 _linePrimSet = new osg::DrawArrays(osg::PrimitiveSet::LINES);
521 _linePrimSet->setDataVariance(osg::Object::DYNAMIC);
522 _lineGeometry->addPrimitiveSet(_linePrimSet);
524 _lineGeometry->setInitialBound(osg::BoundingBox(osg::Vec3f(-256.0f, -256.0f, 0.0f),
525 osg::Vec3f(256.0f, 256.0f, 0.0f)));
527 _radarGeode->addDrawable(_lineGeometry);
529 _textGeode = new osg::Geode;
531 osg::Camera *camera = _odg->getCamera();
532 camera->addChild(_radarGeode.get());
533 camera->addChild(_textGeode.get());
534 osg::Texture2D* tex = _odg->getTexture();
535 camera->setProjectionMatrixAsOrtho2D(0, tex->getTextureWidth(),
536 0, tex->getTextureHeight());
542 NavDisplay::update (double delta_time_sec)
544 if (!fgGetBool("sim/sceneryloaded", false)) {
548 if (!_odg || !_serviceable_node->getBoolValue()) {
549 _Instrument->setStringValue("status", "");
554 _forceUpdate = false;
557 _time += delta_time_sec;
558 if (_time < _updateInterval){
561 _time -= _updateInterval;
564 _rangeNm = _rangeNode->getFloatValue();
565 if (_testModeNode->getBoolValue()) {
567 } else if (_Instrument->getBoolValue("aircraft-heading-up", true)) {
568 _view_heading = fgGetDouble("/orientation/heading-deg");
570 _view_heading = _Instrument->getFloatValue("heading-up-deg", 0.0);
573 double xCenterFrac = _xCenterNode->getDoubleValue();
574 double yCenterFrac = _yCenterNode->getDoubleValue();
575 int pixelSize = _odg->size();
577 int rangePixels = _Instrument->getIntValue("range-pixels", -1);
578 if (rangePixels < 0) {
579 // hacky - assume (as is very common) that x-frac doesn't vary, and
580 // y-frac is used to position the center at either the top or bottom of
581 // the pixel area. Measure from the center to the furthest edge (top or bottom)
582 rangePixels = pixelSize * std::max(fabs(1.0 - yCenterFrac), fabs(yCenterFrac));
585 _scale = rangePixels / _rangeNm;
586 _Instrument->setDoubleValue("scale", _scale);
589 _centerTrans = osg::Matrixf::translate(xCenterFrac * pixelSize,
590 yCenterFrac * pixelSize, 0.0);
592 // scale from nm to display units, rotate so aircraft heading is up
593 // (as opposed to north), and compensate for centering
594 _projectMat = osg::Matrixf::scale(_scale, _scale, 1.0) *
595 degRotation(-_view_heading) * _centerTrans;
597 _pos = globals->get_aircraft_position();
599 // invalidate the cache of positioned items, if we travelled more than 1nm
600 if (_cachedItemsValid) {
601 SGVec3d cartNow(SGVec3d::fromGeod(_pos));
602 double movedNm = dist(_cachedPos, cartNow) * SG_METER_TO_NM;
603 _cachedItemsValid = (movedNm < 1.0);
604 if (!_cachedItemsValid) {
605 SG_LOG(SG_INSTR, SG_INFO, "invalidating NavDisplay cache due to moving: " << movedNm);
610 _lineVertices->clear();
611 _lineColors->clear();
612 _quadColors->clear();
614 _textGeode->removeDrawables(0, _textGeode->getNumDrawables());
616 BOOST_FOREACH(SymbolInstance* si, _symbols) {
621 BOOST_FOREACH(SymbolDef* def, _rules) {
623 def->enabled = def->enable->test();
629 if (_testModeNode->getBoolValue()) {
636 limitDisplayedSymbols();
641 _symbolPrimSet->set(osg::PrimitiveSet::QUADS, 0, _vertices->size());
642 _symbolPrimSet->dirty();
643 _linePrimSet->set(osg::PrimitiveSet::LINES, 0, _lineVertices->size());
644 _linePrimSet->dirty();
649 NavDisplay::updateFont()
651 float red = _font_node->getFloatValue("color/red");
652 float green = _font_node->getFloatValue("color/green");
653 float blue = _font_node->getFloatValue("color/blue");
654 float alpha = _font_node->getFloatValue("color/alpha");
655 _font_color.set(red, green, blue, alpha);
657 _font_size = _font_node->getFloatValue("size");
658 _font_spacing = _font_size * _font_node->getFloatValue("line-spacing");
659 string path = _font_node->getStringValue("name", DEFAULT_FONT);
662 if (path[0] != '/') {
663 tpath = globals->get_fg_root();
664 tpath.append("Fonts");
670 osg::ref_ptr<osgDB::ReaderWriter::Options> fontOptions = new osgDB::ReaderWriter::Options("monochrome");
671 osg::ref_ptr<osgText::Font> font = osgText::readFontFile(tpath.c_str(), fontOptions.get());
675 _font->setMinFilterHint(osg::Texture::NEAREST);
676 _font->setMagFilterHint(osg::Texture::NEAREST);
677 _font->setGlyphImageMargin(0);
678 _font->setGlyphImageMarginRatio(0);
682 void NavDisplay::addSymbolToScene(SymbolInstance* sym)
684 SymbolDef* def = sym->definition;
688 verts[1] = osg::Vec2(def->xy1.x(), def->xy0.y());
690 verts[3] = osg::Vec2(def->xy0.x(), def->xy1.y());
692 if (def->rotateToHeading) {
693 osg::Matrixf m(degRotation(sym->headingDeg - _view_heading));
694 for (int i=0; i<4; ++i) {
695 verts[i] = mult(verts[i], m);
699 osg::Vec2 pos = sym->pos;
701 pos = osg::Vec2((int) pos.x(), (int) pos.y());
704 _texCoords->push_back(def->uv0);
705 _texCoords->push_back(osg::Vec2(def->uv1.x(), def->uv0.y()));
706 _texCoords->push_back(def->uv1);
707 _texCoords->push_back(osg::Vec2(def->uv0.x(), def->uv1.y()));
709 for (int i=0; i<4; ++i) {
710 _vertices->push_back(verts[i] + pos);
711 _quadColors->push_back(def->color);
714 if (def->stretchSymbol) {
715 osg::Vec2 stretchVerts[4];
716 stretchVerts[0] = osg::Vec2(def->xy0.x(), def->stretchY2);
717 stretchVerts[1] = osg::Vec2(def->xy1.x(), def->stretchY2);
718 stretchVerts[2] = osg::Vec2(def->xy1.x(), def->stretchY3);
719 stretchVerts[3] = osg::Vec2(def->xy0.x(), def->stretchY3);
721 osg::Matrixf m(degRotation(sym->headingDeg - _view_heading));
722 for (int i=0; i<4; ++i) {
723 stretchVerts[i] = mult(stretchVerts[i], m);
727 _vertices->push_back(verts[2] + pos);
728 _vertices->push_back(stretchVerts[1] + sym->endPos);
729 _vertices->push_back(stretchVerts[0] + sym->endPos);
730 _vertices->push_back(verts[3] + pos);
732 _texCoords->push_back(def->uv1);
733 _texCoords->push_back(osg::Vec2(def->uv1.x(), def->stretchV2));
734 _texCoords->push_back(osg::Vec2(def->uv0.x(), def->stretchV2));
735 _texCoords->push_back(osg::Vec2(def->uv0.x(), def->uv1.y()));
737 for (int i=0; i<4; ++i) {
738 _quadColors->push_back(def->color);
741 // quad three, for the end portion
742 for (int i=0; i<4; ++i) {
743 _vertices->push_back(stretchVerts[i] + sym->endPos);
744 _quadColors->push_back(def->color);
747 _texCoords->push_back(osg::Vec2(def->uv0.x(), def->stretchV2));
748 _texCoords->push_back(osg::Vec2(def->uv1.x(), def->stretchV2));
749 _texCoords->push_back(osg::Vec2(def->uv1.x(), def->stretchV3));
750 _texCoords->push_back(osg::Vec2(def->uv0.x(), def->stretchV3));
754 addLine(sym->pos, sym->endPos, def->lineColor);
761 osgText::Text* t = new osgText::Text;
762 t->setFont(_font.get());
763 t->setFontResolution(12, 12);
764 t->setCharacterSize(_font_size);
765 t->setLineSpacing(_font_spacing);
766 t->setColor(def->textColor);
767 t->setAlignment(def->alignment);
768 t->setText(sym->text());
771 osg::Vec2 textPos = def->textOffset + pos;
772 // ensure we use ints here, or text visual quality goes bad
773 t->setPosition(osg::Vec3((int)textPos.x(), (int)textPos.y(), 0));
774 _textGeode->addDrawable(t);
777 class OrderByPriority
780 bool operator()(SymbolInstance* a, SymbolInstance* b)
782 return a->definition->priority > b->definition->priority;
786 void NavDisplay::limitDisplayedSymbols()
788 unsigned int maxSymbols = _Instrument->getIntValue("max-symbols", 100);
789 if (_symbols.size() <= maxSymbols) {
790 _excessDataNode->setBoolValue(false);
794 std::sort(_symbols.begin(), _symbols.end(), OrderByPriority());
795 _symbols.resize(maxSymbols);
796 _excessDataNode->setBoolValue(true);
802 bool operator()(SymbolInstance* a, SymbolInstance* b)
804 return a->definition->zOrder > b->definition->zOrder;
808 void NavDisplay::addSymbolsToScene()
810 std::sort(_symbols.begin(), _symbols.end(), OrderByZ());
811 BOOST_FOREACH(SymbolInstance* sym, _symbols) {
812 addSymbolToScene(sym);
816 void NavDisplay::addLine(osg::Vec2 a, osg::Vec2 b, const osg::Vec4& color)
818 _lineVertices->push_back(a);
819 _lineVertices->push_back(b);
820 _lineColors->push_back(color);
821 _lineColors->push_back(color);
824 osg::Vec2 NavDisplay::projectBearingRange(double bearingDeg, double rangeNm) const
826 osg::Vec3 p(0, rangeNm, 0.0);
827 p = degRotation(bearingDeg).preMult(p);
828 p = _projectMat.preMult(p);
829 return osg::Vec2(p.x(), p.y());
832 osg::Vec2 NavDisplay::projectGeod(const SGGeod& geod) const
834 double rangeM, bearing, az2;
835 SGGeodesy::inverse(_pos, geod, bearing, az2, rangeM);
836 return projectBearingRange(bearing, rangeM * SG_METER_TO_NM);
839 class Filter : public FGPositioned::Filter
842 double minRunwayLengthFt;
844 virtual bool pass(FGPositioned* aPos) const
846 if (aPos->type() == FGPositioned::FIX) {
847 string ident(aPos->ident());
848 // ignore fixes which end in digits
849 if ((ident.size() > 4) && isdigit(ident[3]) && isdigit(ident[4])) {
854 if (aPos->type() == FGPositioned::AIRPORT) {
855 FGAirport* apt = (FGAirport*) aPos;
856 if (!apt->hasHardRunwayOfLengthFt(minRunwayLengthFt)) {
864 virtual FGPositioned::Type minType() const {
865 return FGPositioned::AIRPORT;
868 virtual FGPositioned::Type maxType() const {
869 return FGPositioned::OBSTACLE;
873 void NavDisplay::findItems()
875 if (!_cachedItemsValid) {
876 SG_LOG(SG_INSTR, SG_INFO, "re-validating NavDisplay cache");
878 filt.minRunwayLengthFt = 2000;
879 _itemsInRange = FGPositioned::findWithinRange(_pos, _rangeNm, &filt);
880 _cachedItemsValid = true;
881 _cachedPos = SGVec3d::fromGeod(_pos);
884 BOOST_FOREACH(FGPositioned* pos, _itemsInRange) {
885 foundPositionedItem(pos);
889 void NavDisplay::processRoute()
891 _routeSources.clear();
892 RoutePath path(_route->waypts());
893 int current = _route->currentIndex();
895 for (int w=0; w<_route->numWaypts(); ++w) {
896 flightgear::WayptRef wpt(_route->wayptAtIndex(w));
897 _routeSources.insert(wpt->source());
900 state.insert("on-active-route");
903 state.insert("passed");
907 state.insert("current-wp");
911 state.insert("future");
914 if (w == (current + 1)) {
915 state.insert("next-wp");
918 SymbolDefVector rules;
919 findRules("waypoint" , state, rules);
921 return; // no rules matched, we can skip this item
924 SGGeod g = path.positionForIndex(w);
925 SGPropertyNode* vars = _route->wayptNodeAtIndex(w);
927 computeWayptPropsAndHeading(wpt, g, vars, heading);
929 osg::Vec2 projected = projectGeod(g);
930 BOOST_FOREACH(SymbolDef* r, rules) {
931 addSymbolInstance(projected, heading, r, vars);
933 if (r->drawRouteLeg) {
934 SGGeodVec gv(path.pathForIndex(w));
936 osg::Vec2 pr = projectGeod(gv[0]);
937 for (unsigned int i=1; i<gv.size(); ++i) {
938 osg::Vec2 p = projectGeod(gv[i]);
939 addLine(pr, p, r->lineColor);
943 } // of leg drawing enabled
944 } // of matching rules iteration
945 } // of waypoints iteration
948 void NavDisplay::computeWayptPropsAndHeading(flightgear::Waypt* wpt, const SGGeod& pos, SGPropertyNode* nd, double& heading)
951 SGGeodesy::inverse(_pos, pos, heading, az2, rangeM);
952 nd->setIntValue("radial", heading);
953 nd->setDoubleValue("distance-nm", rangeM * SG_METER_TO_NM);
955 heading = nd->getDoubleValue("leg-bearing-true-deg");
958 void NavDisplay::processNavRadios()
960 _nav1Station = processNavRadio(_navRadio1Node);
961 _nav2Station = processNavRadio(_navRadio2Node);
963 foundPositionedItem(_nav1Station);
964 foundPositionedItem(_nav2Station);
967 FGNavRecord* NavDisplay::processNavRadio(const SGPropertyNode_ptr& radio)
969 double mhz = radio->getDoubleValue("frequencies/selected-mhz", 0.0);
970 FGNavRecord* nav = globals->get_navlist()->findByFreq(mhz, _pos);
971 if (!nav || (nav->ident() != radio->getStringValue("nav-id"))) {
972 // station was not found
980 bool NavDisplay::anyRuleForType(const string& type) const
982 BOOST_FOREACH(SymbolDef* r, _rules) {
987 if (r->type == type) {
995 bool NavDisplay::anyRuleMatches(const string& type, const string_set& states) const
997 BOOST_FOREACH(SymbolDef* r, _rules) {
998 if (!r->enabled || (r->type != type)) {
1002 if (r->matches(states)) {
1005 } // of rules iteration
1010 void NavDisplay::findRules(const string& type, const string_set& states, SymbolDefVector& rules)
1012 BOOST_FOREACH(SymbolDef* candidate, _rules) {
1013 if (!candidate->enabled || (candidate->type != type)) {
1017 if (candidate->matches(states)) {
1018 rules.push_back(candidate);
1023 void NavDisplay::foundPositionedItem(FGPositioned* pos)
1029 string type = FGPositioned::nameForType(pos->type());
1030 if (!anyRuleForType(type)) {
1031 return; // not diplayed at all, we're done
1035 computePositionedState(pos, states);
1037 SymbolDefVector rules;
1038 findRules(type, states, rules);
1039 if (rules.empty()) {
1040 return; // no rules matched, we can skip this item
1043 SGPropertyNode_ptr vars(new SGPropertyNode);
1045 computePositionedPropsAndHeading(pos, vars, heading);
1047 osg::Vec2 projected = projectGeod(pos->geod());
1048 if (pos->type() == FGPositioned::RUNWAY) {
1049 FGRunway* rwy = (FGRunway*) pos;
1050 projected = projectGeod(rwy->threshold());
1053 BOOST_FOREACH(SymbolDef* r, rules) {
1054 SymbolInstance* ins = addSymbolInstance(projected, heading, r, vars);
1055 if (pos->type() == FGPositioned::RUNWAY) {
1056 FGRunway* rwy = (FGRunway*) pos;
1057 ins->endPos = projectGeod(rwy->end());
1062 void NavDisplay::computePositionedPropsAndHeading(FGPositioned* pos, SGPropertyNode* nd, double& heading)
1064 nd->setStringValue("id", pos->ident());
1065 nd->setStringValue("name", pos->name());
1066 nd->setDoubleValue("elevation-ft", pos->elevation());
1067 nd->setIntValue("heading-deg", 0);
1070 switch (pos->type()) {
1071 case FGPositioned::VOR:
1072 case FGPositioned::LOC:
1073 case FGPositioned::TACAN: {
1074 FGNavRecord* nav = static_cast<FGNavRecord*>(pos);
1075 nd->setDoubleValue("frequency-mhz", nav->get_freq());
1077 if (pos == _nav1Station) {
1078 heading = _navRadio1Node->getDoubleValue("radials/target-radial-deg");
1079 } else if (pos == _nav2Station) {
1080 heading = _navRadio2Node->getDoubleValue("radials/target-radial-deg");
1083 nd->setIntValue("heading-deg", heading);
1087 case FGPositioned::AIRPORT:
1088 case FGPositioned::SEAPORT:
1089 case FGPositioned::HELIPORT:
1093 case FGPositioned::RUNWAY: {
1094 FGRunway* rwy = static_cast<FGRunway*>(pos);
1095 heading = rwy->headingDeg();
1096 nd->setDoubleValue("heading-deg", heading);
1097 nd->setIntValue("length-ft", rwy->lengthFt());
1098 nd->setStringValue("airport", rwy->airport()->ident());
1107 void NavDisplay::computePositionedState(FGPositioned* pos, string_set& states)
1109 if (_routeSources.count(pos) != 0) {
1110 states.insert("on-active-route");
1113 switch (pos->type()) {
1114 case FGPositioned::VOR:
1115 case FGPositioned::LOC:
1116 if (pos == _nav1Station) {
1117 states.insert("tuned");
1118 states.insert("nav1");
1121 if (pos == _nav2Station) {
1122 states.insert("tuned");
1123 states.insert("nav2");
1127 case FGPositioned::AIRPORT:
1128 case FGPositioned::SEAPORT:
1129 case FGPositioned::HELIPORT:
1131 // once the FMS system has some way to tell us about them, of course
1133 if (pos == _route->departureAirport()) {
1134 states.insert("departure");
1137 if (pos == _route->destinationAirport()) {
1138 states.insert("destination");
1142 case FGPositioned::RUNWAY:
1143 if (pos == _route->departureRunway()) {
1144 states.insert("departure");
1147 if (pos == _route->destinationRunway()) {
1148 states.insert("destination");
1152 case FGPositioned::OBSTACLE:
1154 FGObstacle* obs = (FGObstacle*) pos;
1156 states.insert("lit");
1159 if (obj->getHeightAGLFt() >= 1000) {
1160 states.insert("greater-1000-ft");
1167 } // FGPositioned::Type switch
1170 static string mapAINodeToType(SGPropertyNode* model)
1172 // assume all multiplayer items are aircraft for the moment. Not ideal.
1173 if (!strcmp(model->getName(), "multiplayer")) {
1174 return "ai-aircraft";
1177 return string("ai-") + model->getName();
1180 void NavDisplay::processAI()
1182 SGPropertyNode *ai = fgGetNode("/ai/models", true);
1183 for (int i = ai->nChildren() - 1; i >= 0; i--) {
1184 SGPropertyNode *model = ai->getChild(i);
1185 if (!model->nChildren()) {
1189 // prefix types with 'ai-', to avoid any chance of namespace collisions
1190 // with fg-positioned.
1192 computeAIStates(model, ss);
1193 SymbolDefVector rules;
1194 findRules(mapAINodeToType(model), ss, rules);
1195 if (rules.empty()) {
1196 return; // no rules matched, we can skip this item
1199 double heading = model->getDoubleValue("orientation/true-heading-deg");
1200 SGGeod aiModelPos = SGGeod::fromDegFt(model->getDoubleValue("position/longitude-deg"),
1201 model->getDoubleValue("position/latitude-deg"),
1202 model->getDoubleValue("position/altitude-ft"));
1203 // compute some additional props
1204 int fl = (aiModelPos.getElevationFt() / 1000);
1205 model->setIntValue("flight-level", fl * 10);
1207 osg::Vec2 projected = projectGeod(aiModelPos);
1208 BOOST_FOREACH(SymbolDef* r, rules) {
1209 addSymbolInstance(projected, heading, r, (SGPropertyNode*) model);
1211 } // of ai models iteration
1214 void NavDisplay::computeAIStates(const SGPropertyNode* ai, string_set& states)
1216 int threatLevel = ai->getIntValue("tcas/threat-level",-1);
1217 if (threatLevel < 1)
1220 states.insert("tcas");
1222 std::ostringstream os;
1223 os << "tcas-threat-level-" << threatLevel;
1224 states.insert(os.str());
1226 double vspeed = ai->getDoubleValue("velocities/vertical-speed-fps");
1227 if (vspeed < -3.0) {
1228 states.insert("descending");
1229 } else if (vspeed > 3.0) {
1230 states.insert("climbing");
1234 SymbolInstance* NavDisplay::addSymbolInstance(const osg::Vec2& proj, double heading, SymbolDef* def, SGPropertyNode* vars)
1236 if (isProjectedClipped(proj)) {
1240 SymbolInstance* sym = new SymbolInstance(proj, heading, def, vars);
1241 _symbols.push_back(sym);
1245 bool NavDisplay::isProjectedClipped(const osg::Vec2& projected) const
1247 double size = _odg->size();
1248 return (projected.x() < 0.0) ||
1249 (projected.y() < 0.0) ||
1250 (projected.x() >= size) ||
1251 (projected.y() >= size);
1254 void NavDisplay::addTestSymbol(const std::string& type, const std::string& states, const SGGeod& pos, double heading, SGPropertyNode* vars)
1256 string_set stateSet;
1257 BOOST_FOREACH(std::string s, simgear::strutils::split(states, ",")) {
1261 SymbolDefVector rules;
1262 findRules(type, stateSet, rules);
1263 if (rules.empty()) {
1264 return; // no rules matched, we can skip this item
1267 osg::Vec2 projected = projectGeod(pos);
1268 BOOST_FOREACH(SymbolDef* r, rules) {
1269 addSymbolInstance(projected, heading, r, vars);
1273 void NavDisplay::addTestSymbols()
1275 _pos = SGGeod::fromDeg(-122.3748889, 37.6189722); // KSFO
1279 SGGeodesy::direct(_pos, 45.0, 20.0 * SG_NM_TO_METER, a1, dummy);
1281 addTestSymbol("airport", "", a1, 0.0, NULL);
1283 SGGeodesy::direct(_pos, 95.0, 40.0 * SG_NM_TO_METER, a1, dummy);
1285 addTestSymbol("vor", "", a1, 0.0, NULL);
1287 SGGeodesy::direct(_pos, 120, 80.0 * SG_NM_TO_METER, a1, dummy);
1289 addTestSymbol("airport", "destination", a1, 0.0, NULL);
1291 SGGeodesy::direct(_pos, 80.0, 20.0 * SG_NM_TO_METER, a1, dummy);
1292 addTestSymbol("fix", "", a1, 0.0, NULL);
1295 SGGeodesy::direct(_pos, 140.0, 20.0 * SG_NM_TO_METER, a1, dummy);
1296 addTestSymbol("fix", "", a1, 0.0, NULL);
1298 SGGeodesy::direct(_pos, 110.0, 10.0 * SG_NM_TO_METER, a1, dummy);
1299 addTestSymbol("fix", "", a1, 0.0, NULL);
1301 SGGeodesy::direct(_pos, 110.0, 5.0 * SG_NM_TO_METER, a1, dummy);
1302 addTestSymbol("fix", "", a1, 0.0, NULL);