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>
30 #include <boost/algorithm/string/case_conv.hpp>
34 #include <osg/Geometry>
35 #include <osg/Matrixf>
36 #include <osg/PrimitiveSet>
37 #include <osg/StateSet>
38 #include <osg/LineWidth>
39 #include <osg/Version>
41 #include <simgear/constants.h>
42 #include <simgear/misc/sg_path.hxx>
43 #include <simgear/scene/model/model.hxx>
44 #include <simgear/structure/exception.hxx>
45 #include <simgear/misc/sg_path.hxx>
46 #include <simgear/misc/strutils.hxx>
47 #include <simgear/math/sg_geodesy.hxx>
51 #include <iostream> // for cout, endl
53 using std::stringstream;
55 using std::setprecision;
64 #include <Main/fg_props.hxx>
65 #include <Main/globals.hxx>
66 #include <Cockpit/panel.hxx>
67 #include <Navaids/routePath.hxx>
68 #include <Autopilot/route_mgr.hxx>
69 #include <Navaids/navrecord.hxx>
70 #include <Navaids/navlist.hxx>
71 #include <Navaids/fix.hxx>
72 #include <Airports/simple.hxx>
73 #include <Airports/runways.hxx>
75 #include "instrument_mgr.hxx"
76 #include "od_gauge.hxx"
78 static const char *DEFAULT_FONT = "typewriter.txf";
81 osg::Matrixf degRotation(float angle)
83 return osg::Matrixf::rotate(angle * SG_DEGREES_TO_RADIANS, 0.0f, 0.0f, -1.0f);
86 static osg::Vec4 readColor(SGPropertyNode* colorNode, const osg::Vec4& c)
89 result.r() = colorNode->getDoubleValue("red", c.r());
90 result.g() = colorNode->getDoubleValue("green", c.g());
91 result.b() = colorNode->getDoubleValue("blue", c.b());
92 result.a() = colorNode->getDoubleValue("alpha", c.a());
96 static osgText::Text::AlignmentType readAlignment(const std::string& t)
98 if (t == "left-top") {
99 return osgText::Text::LEFT_TOP;
100 } else if (t == "left-center") {
101 return osgText::Text::LEFT_CENTER;
102 } else if (t == "left-bottom") {
103 return osgText::Text::LEFT_BOTTOM;
104 } else if (t == "center-top") {
105 return osgText::Text::CENTER_TOP;
106 } else if (t == "center-center") {
107 return osgText::Text::CENTER_CENTER;
108 } else if (t == "center-bottom") {
109 return osgText::Text::CENTER_BOTTOM;
110 } else if (t == "right-top") {
111 return osgText::Text::RIGHT_TOP;
112 } else if (t == "right-center") {
113 return osgText::Text::RIGHT_CENTER;
114 } else if (t == "right-bottom") {
115 return osgText::Text::RIGHT_BOTTOM;
116 } else if (t == "left-baseline") {
117 return osgText::Text::LEFT_BASE_LINE;
118 } else if (t == "center-baseline") {
119 return osgText::Text::CENTER_BASE_LINE;
120 } else if (t == "right-baseline") {
121 return osgText::Text::RIGHT_BASE_LINE;
124 return osgText::Text::BASE_LINE;
127 static string formatPropertyValue(SGPropertyNode* nd, const string& format)
130 static char buf[512];
131 if (format.find('d') != string::npos) {
132 ::snprintf(buf, 512, format.c_str(), nd->getIntValue());
136 if (format.find('s') != string::npos) {
137 ::snprintf(buf, 512, format.c_str(), nd->getStringValue());
141 // assume it's a double/float
142 ::snprintf(buf, 512, format.c_str(), nd->getDoubleValue());
146 static osg::Vec2 mult(const osg::Vec2& v, const osg::Matrixf& m)
148 osg::Vec3 r = m.preMult(osg::Vec3(v.x(), v.y(), 0.0));
149 return osg::Vec2(r.x(), r.y());
152 class NavDisplay::CacheListener : public SGPropertyChangeListener
155 CacheListener(NavDisplay *nd) :
159 virtual void valueChanged (SGPropertyNode * prop)
161 _nd->invalidatePositionedCache();
162 SG_LOG(SG_INSTR, SG_INFO, "invalidating NavDisplay cache");
168 class NavDisplay::ForceUpdateListener : public SGPropertyChangeListener
171 ForceUpdateListener(NavDisplay *nd) :
175 virtual void valueChanged (SGPropertyNode * prop)
177 SG_LOG(SG_INSTR, SG_INFO, "forcing NavDisplay update");
184 ///////////////////////////////////////////////////////////////////
194 bool initFromNode(SGPropertyNode* node, NavDisplay* owner)
196 if (!node->getChild("type")) {
200 type = node->getStringValue("type");
201 boost::to_lower(type);
202 SGPropertyNode* enableNode = node->getChild("enable");
204 enable.reset(sgReadCondition(fgGetNode("/"), enableNode));
208 while (node->hasChild("state", n)) {
209 string m = node->getChild("state", n++)->getStringValue();
211 excluded_states.insert(m.substr(1));
213 required_states.insert(m);
215 } // of matches parsing
220 void setDefinition(SymbolDef* d)
225 SymbolDef* getDefinition() const
226 { return definition; }
228 bool matches(const string_set& states) const
230 BOOST_FOREACH(const string& s, required_states) {
231 if (states.count(s) == 0) {
236 BOOST_FOREACH(const string& s, excluded_states) {
237 if (states.count(s) != 0) {
248 enabled = enable->test();
254 bool enabled; // cached enabled state
257 SymbolDef* definition;
259 std::auto_ptr<SGCondition> enable;
260 string_set required_states;
261 string_set excluded_states;
268 bool initFromNode(SGPropertyNode* node, NavDisplay* owner)
270 if (node->getChild("type")) {
271 SymbolRule* builtinRule = new SymbolRule;
272 builtinRule->initFromNode(node, owner);
273 builtinRule->setDefinition(this);
274 owner->addRule(builtinRule);
277 if (node->hasChild("width")) {
278 float w = node->getFloatValue("width");
279 float h = node->getFloatValue("height", w);
285 xy0.x() = node->getFloatValue("x0", 0.0);
286 xy0.y() = node->getFloatValue("y0", 0.0);
287 xy1.x() = node->getFloatValue("x1", 5);
288 xy1.y() = node->getFloatValue("y1", 5);
291 double texSize = node->getFloatValue("texture-size", owner->textureSize());
293 uv0.x() = node->getFloatValue("u0", 0) / texSize;
294 uv0.y() = node->getFloatValue("v0", 0) / texSize;
295 uv1.x() = node->getFloatValue("u1", 1) / texSize;
296 uv1.y() = node->getFloatValue("v1", 1) / texSize;
298 color = readColor(node->getChild("color"), osg::Vec4(1, 1, 1, 1));
299 priority = node->getIntValue("priority", 0);
300 zOrder = node->getIntValue("zOrder", 0);
301 rotateToHeading = node->getBoolValue("rotate-to-heading", false);
302 roundPos = node->getBoolValue("round-position", true);
304 if (node->hasChild("text")) {
306 alignment = readAlignment(node->getStringValue("text-align"));
307 textTemplate = node->getStringValue("text");
308 textOffset.x() = node->getFloatValue("text-offset-x", 0);
309 textOffset.y() = node->getFloatValue("text-offset-y", 0);
310 textColor = readColor(node->getChild("text-color"), color);
313 drawLine = node->getBoolValue("draw-line", false);
314 lineColor = readColor(node->getChild("line-color"), color);
315 drawRouteLeg = node->getBoolValue("draw-leg", false);
317 stretchSymbol = node->getBoolValue("stretch-symbol", false);
319 stretchY2 = node->getFloatValue("y2");
320 stretchY3 = node->getFloatValue("y3");
321 stretchV2 = node->getFloatValue("v2") / texSize;
322 stretchV3 = node->getFloatValue("v3") / texSize;
334 bool rotateToHeading;
335 bool roundPos; ///< should position be rounded to integer values
338 osg::Vec2 textOffset;
339 osgText::Text::AlignmentType alignment;
345 // symbol stretching creates three quads (instead of one) - a start,
346 // middle and end quad, positioned along the line of the symbol.
347 // X (and U) axis values determined by the values above, so we only need
348 // to define the Y (and V) values to build the other quads.
350 double stretchY2, stretchY3;
351 double stretchV2, stretchV3;
360 SymbolInstance(const osg::Vec2& p, double h, SymbolDef* def, SGPropertyNode* vars) :
367 osg::Vec2 pos; // projected position
370 SymbolDef* definition;
371 SGPropertyNode_ptr props;
375 assert(definition->hasText);
380 size_t pos = definition->textTemplate.find('{', lastPos);
381 if (pos == string::npos) { // no more replacements
382 r.append(definition->textTemplate.substr(lastPos));
386 r.append(definition->textTemplate.substr(lastPos, pos - lastPos));
388 size_t endReplacement = definition->textTemplate.find('}', pos+1);
389 if (endReplacement <= pos) {
390 return "bad replacement";
393 string spec = definition->textTemplate.substr(pos + 1, endReplacement - (pos + 1));
394 // look for formatter in spec
395 size_t colonPos = spec.find(':');
396 if (colonPos == string::npos) {
397 // simple replacement
398 r.append(props->getStringValue(spec));
400 string format = spec.substr(colonPos + 1);
401 string prop = spec.substr(0, colonPos);
402 r.append(formatPropertyValue(props->getNode(prop), format));
405 lastPos = endReplacement + 1;
412 //////////////////////////////////////////////////////////////////
414 NavDisplay::NavDisplay(SGPropertyNode *node) :
415 _name(node->getStringValue("name", "nd")),
416 _num(node->getIntValue("number", 0)),
418 _updateInterval(node->getDoubleValue("update-interval-sec", 0.1)),
427 _Instrument = fgGetNode(string("/instrumentation/" + _name).c_str(), _num, true);
428 _font_node = _Instrument->getNode("font", true);
430 #define INITFONT(p, val, type) if (!_font_node->hasValue(p)) _font_node->set##type##Value(p, val)
431 INITFONT("name", DEFAULT_FONT, String);
432 INITFONT("size", 8, Float);
433 INITFONT("line-spacing", 0.25, Float);
434 INITFONT("color/red", 0, Float);
435 INITFONT("color/green", 0.8, Float);
436 INITFONT("color/blue", 0, Float);
437 INITFONT("color/alpha", 1, Float);
440 _textureSize = _Instrument->getNode("symbol-texture-size", true)->getIntValue();
441 SGPropertyNode* symbolsNode = node->getNode("symbols");
442 SGPropertyNode* symbol;
444 map<string, SymbolDef*> definitionDict;
445 for (int i = 0; (symbol = symbolsNode->getChild("symbol", i)) != NULL; ++i) {
446 SymbolDef* def = new SymbolDef;
447 if (!def->initFromNode(symbol, this)) {
452 const char* id = symbol->getStringValue("id");
453 if (id && strlen(id)) {
454 definitionDict[id] = def;
457 _definitions.push_back(def);
458 } // of symbol definition parsing
460 SGPropertyNode* rulesNode = node->getNode("rules");
462 SGPropertyNode* rule;
464 for (int i = 0; (rule = rulesNode->getChild("rule", i)) != NULL; ++i) {
465 SymbolRule* r = new SymbolRule;
466 if (!r->initFromNode(rule, this)) {
471 const char* id = symbol->getStringValue("symbol");
472 if (id && strlen(id) && (definitionDict.find(id) != definitionDict.end())) {
473 r->setDefinition(definitionDict[id]);
475 SG_LOG(SG_INSTR, SG_WARN, "symbol rule has missing/unknown definition id:" << id);
481 } // of symbol rule parsing
487 NavDisplay::~NavDisplay()
495 _cachedItemsValid = false;
496 _cacheListener.reset(new CacheListener(this));
497 _forceUpdateListener.reset(new ForceUpdateListener(this));
499 _serviceable_node = _Instrument->getNode("serviceable", true);
500 _rangeNode = _Instrument->getNode("range", true);
501 if (!_rangeNode->hasValue()) {
502 _rangeNode->setDoubleValue(40.0);
504 _rangeNode->addChangeListener(_cacheListener.get());
505 _rangeNode->addChangeListener(_forceUpdateListener.get());
507 _xCenterNode = _Instrument->getNode("x-center");
508 if (!_xCenterNode->hasValue()) {
509 _xCenterNode->setDoubleValue(0.5);
511 _xCenterNode->addChangeListener(_forceUpdateListener.get());
512 _yCenterNode = _Instrument->getNode("y-center");
513 if (!_yCenterNode->hasValue()) {
514 _yCenterNode->setDoubleValue(0.5);
516 _yCenterNode->addChangeListener(_forceUpdateListener.get());
518 // texture name to use in 2D and 3D instruments
519 _texture_path = _Instrument->getStringValue("radar-texture-path",
520 "Aircraft/Instruments/Textures/od_wxradar.rgb");
522 string path = _Instrument->getStringValue("symbol-texture-path",
523 "Aircraft/Instruments/Textures/nd-symbols.png");
524 SGPath tpath = globals->resolve_aircraft_path(path);
525 if (!tpath.exists()) {
526 SG_LOG(SG_INSTR, SG_WARN, "ND symbol texture not found:" << path);
529 // no mipmap or else alpha will mix with pixels on the border of shapes, ruining the effect
530 _symbolTexture = SGLoadTexture2D(tpath, NULL, false, false);
532 _odg = new FGODGauge;
533 _odg->setSize(_Instrument->getIntValue("texture-size", 512));
535 _route = static_cast<FGRouteMgr*>(globals->get_subsystem("route-manager"));
537 _navRadio1Node = fgGetNode("/instrumentation/nav[0]", true);
538 _navRadio2Node = fgGetNode("/instrumentation/nav[1]", true);
540 _excessDataNode = _Instrument->getChild("excess-data", 0, true);
541 _excessDataNode->setBoolValue(false);
542 _testModeNode = _Instrument->getChild("test-mode", 0, true);
543 _testModeNode->setBoolValue(false);
545 _viewHeadingNode = _Instrument->getChild("view-heading-deg", 0, true);
546 // OSG geometry setup
547 _radarGeode = new osg::Geode;
549 _geom = new osg::Geometry;
550 _geom->setUseDisplayList(false);
552 osg::StateSet *stateSet = _geom->getOrCreateStateSet();
553 stateSet->setTextureAttributeAndModes(0, _symbolTexture.get());
554 stateSet->setDataVariance(osg::Object::STATIC);
556 // Initially allocate space for 128 quads
557 _vertices = new osg::Vec2Array;
558 _vertices->setDataVariance(osg::Object::DYNAMIC);
559 _vertices->reserve(128 * 4);
560 _geom->setVertexArray(_vertices);
561 _texCoords = new osg::Vec2Array;
562 _texCoords->setDataVariance(osg::Object::DYNAMIC);
563 _texCoords->reserve(128 * 4);
564 _geom->setTexCoordArray(0, _texCoords);
566 _quadColors = new osg::Vec4Array;
567 _quadColors->setDataVariance(osg::Object::DYNAMIC);
568 _geom->setColorBinding(osg::Geometry::BIND_PER_VERTEX);
569 _geom->setColorArray(_quadColors);
571 _symbolPrimSet = new osg::DrawArrays(osg::PrimitiveSet::QUADS);
572 _symbolPrimSet->setDataVariance(osg::Object::DYNAMIC);
573 _geom->addPrimitiveSet(_symbolPrimSet);
575 _geom->setInitialBound(osg::BoundingBox(osg::Vec3f(-256.0f, -256.0f, 0.0f),
576 osg::Vec3f(256.0f, 256.0f, 0.0f)));
578 _radarGeode->addDrawable(_geom);
580 // Texture in the 2D panel system
581 FGTextureManager::addTexture(_texture_path.c_str(), _odg->getTexture());
583 _lineGeometry = new osg::Geometry;
584 _lineGeometry->setUseDisplayList(false);
585 stateSet = _lineGeometry->getOrCreateStateSet();
586 osg::LineWidth *lw = new osg::LineWidth();
588 stateSet->setAttribute(lw);
590 _lineVertices = new osg::Vec2Array;
591 _lineVertices->setDataVariance(osg::Object::DYNAMIC);
592 _lineVertices->reserve(128 * 4);
593 _lineGeometry->setVertexArray(_lineVertices);
596 _lineColors = new osg::Vec4Array;
597 _lineColors->setDataVariance(osg::Object::DYNAMIC);
598 _lineGeometry->setColorBinding(osg::Geometry::BIND_PER_VERTEX);
599 _lineGeometry->setColorArray(_lineColors);
601 _linePrimSet = new osg::DrawArrays(osg::PrimitiveSet::LINES);
602 _linePrimSet->setDataVariance(osg::Object::DYNAMIC);
603 _lineGeometry->addPrimitiveSet(_linePrimSet);
605 _lineGeometry->setInitialBound(osg::BoundingBox(osg::Vec3f(-256.0f, -256.0f, 0.0f),
606 osg::Vec3f(256.0f, 256.0f, 0.0f)));
608 _radarGeode->addDrawable(_lineGeometry);
610 _textGeode = new osg::Geode;
612 osg::Camera *camera = _odg->getCamera();
613 camera->addChild(_radarGeode.get());
614 camera->addChild(_textGeode.get());
615 osg::Texture2D* tex = _odg->getTexture();
616 camera->setProjectionMatrixAsOrtho2D(0, tex->getTextureWidth(),
617 0, tex->getTextureHeight());
623 NavDisplay::update (double delta_time_sec)
625 if (!fgGetBool("sim/sceneryloaded", false)) {
629 if (!_odg || !_serviceable_node->getBoolValue()) {
630 _Instrument->setStringValue("status", "");
635 _forceUpdate = false;
638 _time += delta_time_sec;
639 if (_time < _updateInterval){
642 _time -= _updateInterval;
645 _rangeNm = _rangeNode->getFloatValue();
646 if (_testModeNode->getBoolValue()) {
648 } else if (_Instrument->getBoolValue("aircraft-heading-up", true)) {
649 _view_heading = fgGetDouble("/orientation/heading-deg");
651 _view_heading = _Instrument->getFloatValue("heading-up-deg", 0.0);
653 _viewHeadingNode->setDoubleValue(_view_heading);
655 double xCenterFrac = _xCenterNode->getDoubleValue();
656 double yCenterFrac = _yCenterNode->getDoubleValue();
657 int pixelSize = _odg->size();
659 int rangePixels = _Instrument->getIntValue("range-pixels", -1);
660 if (rangePixels < 0) {
661 // hacky - assume (as is very common) that x-frac doesn't vary, and
662 // y-frac is used to position the center at either the top or bottom of
663 // the pixel area. Measure from the center to the furthest edge (top or bottom)
664 rangePixels = pixelSize * std::max(fabs(1.0 - yCenterFrac), fabs(yCenterFrac));
667 _scale = rangePixels / _rangeNm;
668 _Instrument->setDoubleValue("scale", _scale);
671 _centerTrans = osg::Matrixf::translate(xCenterFrac * pixelSize,
672 yCenterFrac * pixelSize, 0.0);
674 // scale from nm to display units, rotate so aircraft heading is up
675 // (as opposed to north), and compensate for centering
676 _projectMat = osg::Matrixf::scale(_scale, _scale, 1.0) *
677 degRotation(-_view_heading) * _centerTrans;
679 _pos = globals->get_aircraft_position();
681 // invalidate the cache of positioned items, if we travelled more than 1nm
682 if (_cachedItemsValid) {
683 SGVec3d cartNow(SGVec3d::fromGeod(_pos));
684 double movedNm = dist(_cachedPos, cartNow) * SG_METER_TO_NM;
685 _cachedItemsValid = (movedNm < 1.0);
686 if (!_cachedItemsValid) {
687 SG_LOG(SG_INSTR, SG_INFO, "invalidating NavDisplay cache due to moving: " << movedNm);
692 _lineVertices->clear();
693 _lineColors->clear();
694 _quadColors->clear();
696 _textGeode->removeDrawables(0, _textGeode->getNumDrawables());
698 BOOST_FOREACH(SymbolInstance* si, _symbols) {
703 BOOST_FOREACH(SymbolRule* r, _rules) {
707 if (_testModeNode->getBoolValue()) {
714 limitDisplayedSymbols();
719 _symbolPrimSet->set(osg::PrimitiveSet::QUADS, 0, _vertices->size());
720 _symbolPrimSet->dirty();
721 _linePrimSet->set(osg::PrimitiveSet::LINES, 0, _lineVertices->size());
722 _linePrimSet->dirty();
727 NavDisplay::updateFont()
729 float red = _font_node->getFloatValue("color/red");
730 float green = _font_node->getFloatValue("color/green");
731 float blue = _font_node->getFloatValue("color/blue");
732 float alpha = _font_node->getFloatValue("color/alpha");
733 _font_color.set(red, green, blue, alpha);
735 _font_size = _font_node->getFloatValue("size");
736 _font_spacing = _font_size * _font_node->getFloatValue("line-spacing");
737 string path = _font_node->getStringValue("name", DEFAULT_FONT);
740 if (path[0] != '/') {
741 tpath = globals->get_fg_root();
742 tpath.append("Fonts");
748 osg::ref_ptr<osgDB::ReaderWriter::Options> fontOptions = new osgDB::ReaderWriter::Options("monochrome");
749 osg::ref_ptr<osgText::Font> font = osgText::readFontFile(tpath.c_str(), fontOptions.get());
753 _font->setMinFilterHint(osg::Texture::NEAREST);
754 _font->setMagFilterHint(osg::Texture::NEAREST);
755 _font->setGlyphImageMargin(0);
756 _font->setGlyphImageMarginRatio(0);
760 void NavDisplay::addSymbolToScene(SymbolInstance* sym)
762 SymbolDef* def = sym->definition;
766 verts[1] = osg::Vec2(def->xy1.x(), def->xy0.y());
768 verts[3] = osg::Vec2(def->xy0.x(), def->xy1.y());
770 if (def->rotateToHeading) {
771 osg::Matrixf m(degRotation(sym->headingDeg - _view_heading));
772 for (int i=0; i<4; ++i) {
773 verts[i] = mult(verts[i], m);
777 osg::Vec2 pos = sym->pos;
779 pos = osg::Vec2((int) pos.x(), (int) pos.y());
782 _texCoords->push_back(def->uv0);
783 _texCoords->push_back(osg::Vec2(def->uv1.x(), def->uv0.y()));
784 _texCoords->push_back(def->uv1);
785 _texCoords->push_back(osg::Vec2(def->uv0.x(), def->uv1.y()));
787 for (int i=0; i<4; ++i) {
788 _vertices->push_back(verts[i] + pos);
789 _quadColors->push_back(def->color);
792 if (def->stretchSymbol) {
793 osg::Vec2 stretchVerts[4];
794 stretchVerts[0] = osg::Vec2(def->xy0.x(), def->stretchY2);
795 stretchVerts[1] = osg::Vec2(def->xy1.x(), def->stretchY2);
796 stretchVerts[2] = osg::Vec2(def->xy1.x(), def->stretchY3);
797 stretchVerts[3] = osg::Vec2(def->xy0.x(), def->stretchY3);
799 osg::Matrixf m(degRotation(sym->headingDeg - _view_heading));
800 for (int i=0; i<4; ++i) {
801 stretchVerts[i] = mult(stretchVerts[i], m);
805 _vertices->push_back(verts[2] + pos);
806 _vertices->push_back(stretchVerts[1] + sym->endPos);
807 _vertices->push_back(stretchVerts[0] + sym->endPos);
808 _vertices->push_back(verts[3] + pos);
810 _texCoords->push_back(def->uv1);
811 _texCoords->push_back(osg::Vec2(def->uv1.x(), def->stretchV2));
812 _texCoords->push_back(osg::Vec2(def->uv0.x(), def->stretchV2));
813 _texCoords->push_back(osg::Vec2(def->uv0.x(), def->uv1.y()));
815 for (int i=0; i<4; ++i) {
816 _quadColors->push_back(def->color);
819 // quad three, for the end portion
820 for (int i=0; i<4; ++i) {
821 _vertices->push_back(stretchVerts[i] + sym->endPos);
822 _quadColors->push_back(def->color);
825 _texCoords->push_back(osg::Vec2(def->uv0.x(), def->stretchV2));
826 _texCoords->push_back(osg::Vec2(def->uv1.x(), def->stretchV2));
827 _texCoords->push_back(osg::Vec2(def->uv1.x(), def->stretchV3));
828 _texCoords->push_back(osg::Vec2(def->uv0.x(), def->stretchV3));
832 addLine(sym->pos, sym->endPos, def->lineColor);
839 osgText::Text* t = new osgText::Text;
840 t->setFont(_font.get());
841 t->setFontResolution(12, 12);
842 t->setCharacterSize(_font_size);
843 t->setLineSpacing(_font_spacing);
844 t->setColor(def->textColor);
845 t->setAlignment(def->alignment);
846 t->setText(sym->text());
849 osg::Vec2 textPos = def->textOffset + pos;
850 // ensure we use ints here, or text visual quality goes bad
851 t->setPosition(osg::Vec3((int)textPos.x(), (int)textPos.y(), 0));
852 _textGeode->addDrawable(t);
855 class OrderByPriority
858 bool operator()(SymbolInstance* a, SymbolInstance* b)
860 return a->definition->priority > b->definition->priority;
864 void NavDisplay::limitDisplayedSymbols()
866 unsigned int maxSymbols = _Instrument->getIntValue("max-symbols", 100);
867 if (_symbols.size() <= maxSymbols) {
868 _excessDataNode->setBoolValue(false);
872 std::sort(_symbols.begin(), _symbols.end(), OrderByPriority());
873 _symbols.resize(maxSymbols);
874 _excessDataNode->setBoolValue(true);
880 bool operator()(SymbolInstance* a, SymbolInstance* b)
882 return a->definition->zOrder > b->definition->zOrder;
886 void NavDisplay::addSymbolsToScene()
888 std::sort(_symbols.begin(), _symbols.end(), OrderByZ());
889 BOOST_FOREACH(SymbolInstance* sym, _symbols) {
890 addSymbolToScene(sym);
894 void NavDisplay::addLine(osg::Vec2 a, osg::Vec2 b, const osg::Vec4& color)
896 _lineVertices->push_back(a);
897 _lineVertices->push_back(b);
898 _lineColors->push_back(color);
899 _lineColors->push_back(color);
902 osg::Vec2 NavDisplay::projectBearingRange(double bearingDeg, double rangeNm) const
904 osg::Vec3 p(0, rangeNm, 0.0);
905 p = degRotation(bearingDeg).preMult(p);
906 p = _projectMat.preMult(p);
907 return osg::Vec2(p.x(), p.y());
910 osg::Vec2 NavDisplay::projectGeod(const SGGeod& geod) const
912 double rangeM, bearing, az2;
913 SGGeodesy::inverse(_pos, geod, bearing, az2, rangeM);
914 return projectBearingRange(bearing, rangeM * SG_METER_TO_NM);
917 class Filter : public FGPositioned::Filter
920 double minRunwayLengthFt;
922 virtual bool pass(FGPositioned* aPos) const
924 if (aPos->type() == FGPositioned::FIX) {
925 string ident(aPos->ident());
926 // ignore fixes which end in digits
927 if ((ident.size() > 4) && isdigit(ident[3]) && isdigit(ident[4])) {
932 if (aPos->type() == FGPositioned::AIRPORT) {
933 FGAirport* apt = (FGAirport*) aPos;
934 if (!apt->hasHardRunwayOfLengthFt(minRunwayLengthFt)) {
942 virtual FGPositioned::Type minType() const {
943 return FGPositioned::AIRPORT;
946 virtual FGPositioned::Type maxType() const {
947 return FGPositioned::OBSTACLE;
951 void NavDisplay::findItems()
953 if (!_cachedItemsValid) {
954 SG_LOG(SG_INSTR, SG_INFO, "re-validating NavDisplay cache");
956 filt.minRunwayLengthFt = 2000;
957 _itemsInRange = FGPositioned::findWithinRange(_pos, _rangeNm, &filt);
958 _cachedItemsValid = true;
959 _cachedPos = SGVec3d::fromGeod(_pos);
962 BOOST_FOREACH(FGPositioned* pos, _itemsInRange) {
963 foundPositionedItem(pos);
967 void NavDisplay::processRoute()
969 _routeSources.clear();
970 RoutePath path(_route->waypts());
971 int current = _route->currentIndex();
973 for (int w=0; w<_route->numWaypts(); ++w) {
974 flightgear::WayptRef wpt(_route->wayptAtIndex(w));
975 _routeSources.insert(wpt->source());
978 state.insert("on-active-route");
981 state.insert("passed");
985 state.insert("current-wp");
989 state.insert("future");
992 if (w == (current + 1)) {
993 state.insert("next-wp");
996 SymbolRuleVector rules;
997 findRules("waypoint" , state, rules);
999 return; // no rules matched, we can skip this item
1002 SGGeod g = path.positionForIndex(w);
1003 SGPropertyNode* vars = _route->wayptNodeAtIndex(w);
1005 computeWayptPropsAndHeading(wpt, g, vars, heading);
1007 osg::Vec2 projected = projectGeod(g);
1008 BOOST_FOREACH(SymbolRule* r, rules) {
1009 addSymbolInstance(projected, heading, r->getDefinition(), vars);
1011 if (r->getDefinition()->drawRouteLeg) {
1012 SGGeodVec gv(path.pathForIndex(w));
1014 osg::Vec2 pr = projectGeod(gv[0]);
1015 for (unsigned int i=1; i<gv.size(); ++i) {
1016 osg::Vec2 p = projectGeod(gv[i]);
1017 addLine(pr, p, r->getDefinition()->lineColor);
1021 } // of leg drawing enabled
1022 } // of matching rules iteration
1023 } // of waypoints iteration
1026 void NavDisplay::computeWayptPropsAndHeading(flightgear::Waypt* wpt, const SGGeod& pos, SGPropertyNode* nd, double& heading)
1029 SGGeodesy::inverse(_pos, pos, heading, az2, rangeM);
1030 nd->setIntValue("radial", heading);
1031 nd->setDoubleValue("distance-nm", rangeM * SG_METER_TO_NM);
1033 heading = nd->getDoubleValue("leg-bearing-true-deg");
1036 void NavDisplay::processNavRadios()
1038 _nav1Station = processNavRadio(_navRadio1Node);
1039 _nav2Station = processNavRadio(_navRadio2Node);
1041 foundPositionedItem(_nav1Station);
1042 foundPositionedItem(_nav2Station);
1045 FGNavRecord* NavDisplay::processNavRadio(const SGPropertyNode_ptr& radio)
1047 double mhz = radio->getDoubleValue("frequencies/selected-mhz", 0.0);
1048 FGNavRecord* nav = globals->get_navlist()->findByFreq(mhz, _pos);
1049 if (!nav || (nav->ident() != radio->getStringValue("nav-id"))) {
1050 // station was not found
1058 bool NavDisplay::anyRuleForType(const string& type) const
1060 BOOST_FOREACH(SymbolRule* r, _rules) {
1065 if (r->type == type) {
1073 bool NavDisplay::anyRuleMatches(const string& type, const string_set& states) const
1075 BOOST_FOREACH(SymbolRule* r, _rules) {
1076 if (!r->enabled || (r->type != type)) {
1080 if (r->matches(states)) {
1083 } // of rules iteration
1088 void NavDisplay::findRules(const string& type, const string_set& states, SymbolRuleVector& rules)
1090 BOOST_FOREACH(SymbolRule* candidate, _rules) {
1091 if (!candidate->enabled || (candidate->type != type)) {
1095 if (candidate->matches(states)) {
1096 rules.push_back(candidate);
1101 void NavDisplay::foundPositionedItem(FGPositioned* pos)
1107 string type = FGPositioned::nameForType(pos->type());
1108 //boost::to_lower(type);
1109 if (!anyRuleForType(type)) {
1110 return; // not diplayed at all, we're done
1114 computePositionedState(pos, states);
1116 SymbolRuleVector rules;
1117 findRules(type, states, rules);
1118 if (rules.empty()) {
1119 return; // no rules matched, we can skip this item
1122 SGPropertyNode_ptr vars(new SGPropertyNode);
1124 computePositionedPropsAndHeading(pos, vars, heading);
1126 osg::Vec2 projected = projectGeod(pos->geod());
1127 if (pos->type() == FGPositioned::RUNWAY) {
1128 FGRunway* rwy = (FGRunway*) pos;
1129 projected = projectGeod(rwy->threshold());
1132 BOOST_FOREACH(SymbolRule* r, rules) {
1133 SymbolInstance* ins = addSymbolInstance(projected, heading, r->getDefinition(), vars);
1134 if (pos->type() == FGPositioned::RUNWAY) {
1135 FGRunway* rwy = (FGRunway*) pos;
1136 ins->endPos = projectGeod(rwy->end());
1141 void NavDisplay::computePositionedPropsAndHeading(FGPositioned* pos, SGPropertyNode* nd, double& heading)
1143 nd->setStringValue("id", pos->ident());
1144 nd->setStringValue("name", pos->name());
1145 nd->setDoubleValue("elevation-ft", pos->elevation());
1146 nd->setIntValue("heading-deg", 0);
1149 switch (pos->type()) {
1150 case FGPositioned::VOR:
1151 case FGPositioned::LOC:
1152 case FGPositioned::TACAN: {
1153 FGNavRecord* nav = static_cast<FGNavRecord*>(pos);
1154 nd->setDoubleValue("frequency-mhz", nav->get_freq());
1156 if (pos == _nav1Station) {
1157 heading = _navRadio1Node->getDoubleValue("radials/target-radial-deg");
1158 } else if (pos == _nav2Station) {
1159 heading = _navRadio2Node->getDoubleValue("radials/target-radial-deg");
1162 nd->setIntValue("heading-deg", heading);
1166 case FGPositioned::AIRPORT:
1167 case FGPositioned::SEAPORT:
1168 case FGPositioned::HELIPORT:
1172 case FGPositioned::RUNWAY: {
1173 FGRunway* rwy = static_cast<FGRunway*>(pos);
1174 heading = rwy->headingDeg();
1175 nd->setDoubleValue("heading-deg", heading);
1176 nd->setIntValue("length-ft", rwy->lengthFt());
1177 nd->setStringValue("airport", rwy->airport()->ident());
1186 void NavDisplay::computePositionedState(FGPositioned* pos, string_set& states)
1188 if (_routeSources.count(pos) != 0) {
1189 states.insert("on-active-route");
1192 switch (pos->type()) {
1193 case FGPositioned::VOR:
1194 case FGPositioned::LOC:
1195 if (pos == _nav1Station) {
1196 states.insert("tuned");
1197 states.insert("nav1");
1200 if (pos == _nav2Station) {
1201 states.insert("tuned");
1202 states.insert("nav2");
1206 case FGPositioned::AIRPORT:
1207 case FGPositioned::SEAPORT:
1208 case FGPositioned::HELIPORT:
1210 // once the FMS system has some way to tell us about them, of course
1212 if (pos == _route->departureAirport()) {
1213 states.insert("departure");
1216 if (pos == _route->destinationAirport()) {
1217 states.insert("destination");
1221 case FGPositioned::RUNWAY:
1222 if (pos == _route->departureRunway()) {
1223 states.insert("departure");
1226 if (pos == _route->destinationRunway()) {
1227 states.insert("destination");
1231 case FGPositioned::OBSTACLE:
1233 FGObstacle* obs = (FGObstacle*) pos;
1235 states.insert("lit");
1238 if (obj->getHeightAGLFt() >= 1000) {
1239 states.insert("greater-1000-ft");
1246 } // FGPositioned::Type switch
1249 static string mapAINodeToType(SGPropertyNode* model)
1251 // assume all multiplayer items are aircraft for the moment. Not ideal.
1252 if (!strcmp(model->getName(), "multiplayer")) {
1253 return "ai-aircraft";
1256 return string("ai-") + model->getName();
1259 void NavDisplay::processAI()
1261 SGPropertyNode *ai = fgGetNode("/ai/models", true);
1262 for (int i = ai->nChildren() - 1; i >= 0; i--) {
1263 SGPropertyNode *model = ai->getChild(i);
1264 if (!model->nChildren()) {
1268 // prefix types with 'ai-', to avoid any chance of namespace collisions
1269 // with fg-positioned.
1271 computeAIStates(model, ss);
1272 SymbolRuleVector rules;
1273 findRules(mapAINodeToType(model), ss, rules);
1274 if (rules.empty()) {
1275 return; // no rules matched, we can skip this item
1278 double heading = model->getDoubleValue("orientation/true-heading-deg");
1279 SGGeod aiModelPos = SGGeod::fromDegFt(model->getDoubleValue("position/longitude-deg"),
1280 model->getDoubleValue("position/latitude-deg"),
1281 model->getDoubleValue("position/altitude-ft"));
1282 // compute some additional props
1283 int fl = (aiModelPos.getElevationFt() / 1000);
1284 model->setIntValue("flight-level", fl * 10);
1286 osg::Vec2 projected = projectGeod(aiModelPos);
1287 BOOST_FOREACH(SymbolRule* r, rules) {
1288 addSymbolInstance(projected, heading, r->getDefinition(), (SGPropertyNode*) model);
1290 } // of ai models iteration
1293 void NavDisplay::computeAIStates(const SGPropertyNode* ai, string_set& states)
1295 int threatLevel = ai->getIntValue("tcas/threat-level",-1);
1296 if (threatLevel < 1)
1299 states.insert("tcas");
1301 std::ostringstream os;
1302 os << "tcas-threat-level-" << threatLevel;
1303 states.insert(os.str());
1305 double vspeed = ai->getDoubleValue("velocities/vertical-speed-fps");
1306 if (vspeed < -3.0) {
1307 states.insert("descending");
1308 } else if (vspeed > 3.0) {
1309 states.insert("climbing");
1313 SymbolInstance* NavDisplay::addSymbolInstance(const osg::Vec2& proj, double heading, SymbolDef* def, SGPropertyNode* vars)
1315 if (isProjectedClipped(proj)) {
1319 SymbolInstance* sym = new SymbolInstance(proj, heading, def, vars);
1320 _symbols.push_back(sym);
1324 bool NavDisplay::isProjectedClipped(const osg::Vec2& projected) const
1326 double size = _odg->size();
1327 return (projected.x() < 0.0) ||
1328 (projected.y() < 0.0) ||
1329 (projected.x() >= size) ||
1330 (projected.y() >= size);
1333 void NavDisplay::addTestSymbol(const std::string& type, const std::string& states, const SGGeod& pos, double heading, SGPropertyNode* vars)
1335 string_set stateSet;
1336 BOOST_FOREACH(std::string s, simgear::strutils::split(states, ",")) {
1340 SymbolRuleVector rules;
1341 findRules(type, stateSet, rules);
1342 if (rules.empty()) {
1343 return; // no rules matched, we can skip this item
1346 osg::Vec2 projected = projectGeod(pos);
1347 BOOST_FOREACH(SymbolRule* r, rules) {
1348 addSymbolInstance(projected, heading, r->getDefinition(), vars);
1352 void NavDisplay::addTestSymbols()
1354 _pos = SGGeod::fromDeg(-122.3748889, 37.6189722); // KSFO
1358 SGGeodesy::direct(_pos, 45.0, 20.0 * SG_NM_TO_METER, a1, dummy);
1360 addTestSymbol("airport", "", a1, 0.0, NULL);
1362 SGGeodesy::direct(_pos, 95.0, 40.0 * SG_NM_TO_METER, a1, dummy);
1364 addTestSymbol("vor", "", a1, 0.0, NULL);
1366 SGGeodesy::direct(_pos, 120, 80.0 * SG_NM_TO_METER, a1, dummy);
1368 addTestSymbol("airport", "destination", a1, 0.0, NULL);
1370 SGGeodesy::direct(_pos, 80.0, 20.0 * SG_NM_TO_METER, a1, dummy);
1371 addTestSymbol("fix", "", a1, 0.0, NULL);
1374 SGGeodesy::direct(_pos, 140.0, 20.0 * SG_NM_TO_METER, a1, dummy);
1375 addTestSymbol("fix", "", a1, 0.0, NULL);
1377 SGGeodesy::direct(_pos, 110.0, 10.0 * SG_NM_TO_METER, a1, dummy);
1378 addTestSymbol("fix", "", a1, 0.0, NULL);
1380 SGGeodesy::direct(_pos, 110.0, 5.0 * SG_NM_TO_METER, a1, dummy);
1381 addTestSymbol("fix", "", a1, 0.0, NULL);
1384 void NavDisplay::addRule(SymbolRule* r)
1386 _rules.push_back(r);