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
  48 namespace flightgear
  49 {
  50     class Waypt;
  51 }
  52
  53 typedef std::set<std::string> string_set;
  54 typedef std::vector<SymbolDef*> SymbolDefVector;
  55
  56 class NavDisplay : public SGSubsystem
  57 {
  58 public:
  59
  60     NavDisplay(SGPropertyNode *node);
  61     virtual ~NavDisplay();
  62
  63     virtual void init();
  64     virtual void update(double dt);
  65
  66     void invalidatePositionedCache()
  67     {
  68         _cachedItemsValid = false;
  69     }
  70 protected:
  71     std::string _name;
  72     int _num;
  73     double _time;
  74     double _updateInterval;
  75
  76     SGPropertyNode_ptr _serviceable_node;
  77     SGPropertyNode_ptr _Instrument;
  78     SGPropertyNode_ptr _radar_mode_control_node;
  79     SGPropertyNode_ptr _user_heading_node;
  80     SGPropertyNode_ptr _testModeNode;
  81
  82     FGODGauge *_odg;
  83
  84     // Convenience function for creating a property node with a
  85     // default value
  86     template<typename DefaultType>
  87     SGPropertyNode *getInstrumentNode(const char *name, DefaultType value);
  88
  89 private:
  90     void addSymbolsToScene();
  91     void addSymbolToScene(SymbolInstance* sym);
  92     void limitDisplayedSymbols();
  93
  94     void findItems();
  95     void foundPositionedItem(FGPositioned* pos);
  96     void computePositionedPropsAndHeading(FGPositioned* pos, SGPropertyNode* nd, double& heading);
  97     void computePositionedState(FGPositioned* pos, string_set& states);
  98     void processRoute();
  99     void computeWayptPropsAndHeading(flightgear::Waypt* wpt, const SGGeod& pos, SGPropertyNode* nd, double& heading);
 100     void processNavRadios();
 101     FGNavRecord* processNavRadio(const SGPropertyNode_ptr& radio);
 102     void processAI();
 103     void computeAIStates(const SGPropertyNode* ai, string_set& states);
 104
 105     bool anyRuleForType(const std::string& type) const;
 106     bool anyRuleMatches(const std::string& type, const string_set& states) const;
 107     void findRules(const std::string& type, const string_set& states, SymbolDefVector& rules);
 108
 109     SymbolInstance* addSymbolInstance(const osg::Vec2& proj, double heading, SymbolDef* def, SGPropertyNode* vars);
 110     void addLine(osg::Vec2 a, osg::Vec2 b, const osg::Vec4& color);
 111     osg::Vec2 projectBearingRange(double bearingDeg, double rangeNm) const;
 112     osg::Vec2 projectGeod(const SGGeod& geod) const;
 113     bool isProjectedClipped(const osg::Vec2& projected) const;
 114     void updateFont();
 115
 116     void addTestSymbol(const std::string& type, const std::string& states, const SGGeod& pos, double heading, SGPropertyNode* vars);
 117     void addTestSymbols();
 118
 119     std::string _texture_path;
 120
 121
 122     float _scale;   // factor to convert nm to display units
 123     float _view_heading;
 124
 125     SGPropertyNode_ptr _Radar_controls;
 126
 127
 128
 129     SGPropertyNode_ptr _font_node;
 130     SGPropertyNode_ptr _ai_enabled_node;
 131     SGPropertyNode_ptr _navRadio1Node;
 132     SGPropertyNode_ptr _navRadio2Node;
 133
 134     osg::ref_ptr<osg::Texture2D> _resultTexture;
 135     osg::ref_ptr<osg::Texture2D> _symbolTexture;
 136     osg::ref_ptr<osg::Geode> _radarGeode;
 137     osg::ref_ptr<osg::Geode> _textGeode;
 138
 139     osg::Geometry *_geom;
 140
 141     osg::DrawArrays* _symbolPrimSet;
 142     osg::Vec2Array *_vertices;
 143     osg::Vec2Array *_texCoords;
 144     osg::Vec4Array* _quadColors;
 145
 146     osg::Geometry* _lineGeometry;
 147     osg::DrawArrays* _linePrimSet;
 148     osg::Vec2Array* _lineVertices;
 149     osg::Vec4Array* _lineColors;
 150
 151
 152     osg::Matrixf _centerTrans;
 153     osg::Matrixf _projectMat;
 154
 155     osg::ref_ptr<osgText::Font> _font;
 156     osg::Vec4 _font_color;
 157     float _font_size;
 158     float _font_spacing;
 159
 160     FGRouteMgr* _route;
 161     SGGeod _pos;
 162     double _rangeNm;
 163     SGPropertyNode_ptr _rangeNode;
 164
 165     SymbolDefVector _rules;
 166     FGNavRecord* _nav1Station;
 167     FGNavRecord* _nav2Station;
 168     std::vector<SymbolInstance*> _symbols;
 169     std::set<FGPositioned*> _routeSources;
 170
 171     bool _cachedItemsValid;
 172     SGVec3d _cachedPos;
 173     FGPositioned::List _itemsInRange;
 174     SGPropertyNode_ptr _excessDataNode;
 175
 176     class CacheListener;
 177     std::auto_ptr<CacheListener> _cacheListener;
 178 };
 179
 180 #endif // _INST_ND_HXX