src/Instrumentation/NavDisplay.hxx

   1 // Wx Radar background texture
   2 //
   3 // Written by Harald JOHNSEN, started May 2005.
   4 // With major amendments by Vivian MEAZZA May 2007
   5 // Ported to OSG by Tim MOORE Jun 2007
   6 //
   7 // Copyright (C) 2005  Harald JOHNSEN - hjohnsen@evc.net
   8 //
   9 // This program is free software; you can redistribute it and/or
  10 // modify it under the terms of the GNU General Public License as
  11 // published by the Free Software Foundation; either version 2 of the
  12 // License, or (at your option) any later version.
  13 //
  14 // This program is distributed in the hope that it will be useful, but
  15 // WITHOUT ANY WARRANTY; without even the implied warranty of
  16 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17 // General Public License for more details.
  18 //
  19 // You should have received a copy of the GNU General Public License
  20 // along with this program; if not, write to the Free Software
  21 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  22
  23 #ifndef _INST_ND_HXX
  24 #define _INST_ND_HXX
  25
  26 #include <osg/ref_ptr>
  27 #include <osg/Geode>
  28 #include <osg/Texture2D>
  29 #include <osgText/Text>
  30
  31 #include <simgear/props/props.hxx>
  32 #include <simgear/structure/subsystem_mgr.hxx>
  33 #include <simgear/math/sg_geodesy.hxx>
  34
  35 #include <vector>
  36 #include <string>
  37 #include <memory>
  38
  39 #include <Navaids/positioned.hxx>
  40
  41 class FGODGauge;
  42 class FGRouteMgr;
  43 class FGNavRecord;
  44
  45 class SymbolInstance;
  46 class SymbolDef;
  47 class SymbolRule;
  48
  49 namespace flightgear
  50 {
  51     class Waypt;
  52 }
  53
  54 typedef std::set<std::string> string_set;
  55 typedef std::vector<SymbolRule*> SymbolRuleVector;
  56 typedef std::vector<SymbolDef*> SymbolDefVector;
  57
  58 class NavDisplay : public SGSubsystem
  59 {
  60 public:
  61
  62     NavDisplay(SGPropertyNode *node);
  63     virtual ~NavDisplay();
  64
  65     virtual void init();
  66     virtual void update(double dt);
  67
  68     void invalidatePositionedCache()
  69     {
  70         _cachedItemsValid = false;
  71     }
  72
  73     double textureSize() const
  74     { return _textureSize; }
  75
  76     void forceUpdate()
  77     { _forceUpdate = true; }
  78
  79     bool anyRuleForType(const std::string& type) const;
  80     bool isPositionedShown(FGPositioned* pos);
  81 protected:
  82     std::string _name;
  83     int _num;
  84     double _time;
  85     double _updateInterval;
  86     bool _forceUpdate;
  87
  88     SGPropertyNode_ptr _serviceable_node;
  89     SGPropertyNode_ptr _Instrument;
  90     SGPropertyNode_ptr _radar_mode_control_node;
  91     SGPropertyNode_ptr _user_heading_node;
  92     SGPropertyNode_ptr _testModeNode;
  93
  94     FGODGauge *_odg;
  95
  96     // Convenience function for creating a property node with a
  97     // default value
  98     template<typename DefaultType>
  99     SGPropertyNode *getInstrumentNode(const char *name, DefaultType value);
 100
 101 private:
 102     friend class SymbolRule;
 103     friend class SymbolDef;
 104
 105     void addRule(SymbolRule*);
 106
 107     void addSymbolsToScene();
 108     void addSymbolToScene(SymbolInstance* sym);
 109     void limitDisplayedSymbols();
 110
 111     void findItems();
 112     void isPositionedShownInner(FGPositioned* pos, SymbolRuleVector& rules);
 113     void foundPositionedItem(FGPositioned* pos);
 114     void computePositionedPropsAndHeading(FGPositioned* pos, SGPropertyNode* nd, double& heading);
 115     void computePositionedState(FGPositioned* pos, string_set& states);
 116     void processRoute();
 117     void computeWayptPropsAndHeading(flightgear::Waypt* wpt, const SGGeod& pos, SGPropertyNode* nd, double& heading);
 118     void processNavRadios();
 119     FGNavRecord* processNavRadio(const SGPropertyNode_ptr& radio);
 120     void processAI();
 121     void computeAIStates(const SGPropertyNode* ai, string_set& states);
 122
 123     void findRules(const std::string& type, const string_set& states, SymbolRuleVector& rules);
 124
 125     SymbolInstance* addSymbolInstance(const osg::Vec2& proj, double heading, SymbolDef* def, SGPropertyNode* vars);
 126     void addLine(osg::Vec2 a, osg::Vec2 b, const osg::Vec4& color);
 127     osg::Vec2 projectBearingRange(double bearingDeg, double rangeNm) const;
 128     osg::Vec2 projectGeod(const SGGeod& geod) const;
 129     bool isProjectedClipped(const osg::Vec2& projected) const;
 130     void updateFont();
 131
 132     void addTestSymbol(const std::string& type, const std::string& states, const SGGeod& pos, double heading, SGPropertyNode* vars);
 133     void addTestSymbols();
 134
 135     std::string _texture_path;
 136     unsigned int _textureSize;
 137
 138     float _scale;   // factor to convert nm to display units
 139     float _view_heading;
 140
 141     SGPropertyNode_ptr _Radar_controls;
 142
 143
 144
 145     SGPropertyNode_ptr _font_node;
 146     SGPropertyNode_ptr _ai_enabled_node;
 147     SGPropertyNode_ptr _navRadio1Node;
 148     SGPropertyNode_ptr _navRadio2Node;
 149     SGPropertyNode_ptr _xCenterNode, _yCenterNode;
 150     SGPropertyNode_ptr _viewHeadingNode;
 151
 152     osg::ref_ptr<osg::Texture2D> _symbolTexture;
 153     osg::ref_ptr<osg::Geode> _radarGeode;
 154     osg::ref_ptr<osg::Geode> _textGeode;
 155
 156     osg::Geometry *_geom;
 157
 158     osg::DrawArrays* _symbolPrimSet;
 159     osg::Vec2Array *_vertices;
 160     osg::Vec2Array *_texCoords;
 161     osg::Vec4Array* _quadColors;
 162
 163     osg::Geometry* _lineGeometry;
 164     osg::DrawArrays* _linePrimSet;
 165     osg::Vec2Array* _lineVertices;
 166     osg::Vec4Array* _lineColors;
 167
 168
 169     osg::Matrixf _centerTrans;
 170     osg::Matrixf _projectMat;
 171
 172     osg::ref_ptr<osgText::Font> _font;
 173     osg::Vec4 _font_color;
 174     float _font_size;
 175     float _font_spacing;
 176
 177     FGRouteMgr* _route;
 178     SGGeod _pos;
 179     double _rangeNm;
 180     SGPropertyNode_ptr _rangeNode;
 181
 182     SymbolDefVector _definitions;
 183     SymbolRuleVector _rules;
 184     FGNavRecord* _nav1Station;
 185     FGNavRecord* _nav2Station;
 186     std::vector<SymbolInstance*> _symbols;
 187     std::set<FGPositioned*> _routeSources;
 188
 189     bool _cachedItemsValid;
 190     SGVec3d _cachedPos;
 191     FGPositioned::List _itemsInRange;
 192     SGPropertyNode_ptr _excessDataNode;
 193     int _maxSymbols;
 194
 195     class CacheListener;
 196     std::auto_ptr<CacheListener> _cacheListener;
 197
 198     class ForceUpdateListener;
 199     std::auto_ptr<ForceUpdateListener> _forceUpdateListener;
 200 };
 201
 202 #endif // _INST_ND_HXX