Reset: ensure FGODGuage shutsdown cleanly.
[fg:hoorays-flightgear.git] / src / Cockpit / wxradar.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_WXRADAR_HXX
24 #define _INST_WXRADAR_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
34 #include <vector>
35 #include <string>
36
37 class FGODGauge;
38
39 class wxRadarBg : public SGSubsystem, public SGPropertyChangeListener {
40 public:
41
42     wxRadarBg(SGPropertyNode *node);
43     wxRadarBg();
44     virtual ~wxRadarBg();
45
46     virtual void init();
47     virtual void shutdown();
48     
49     virtual void update(double dt);
50     virtual void valueChanged(SGPropertyNode *);
51
52 protected:
53     std::string _name;
54     int _num;
55     double _time;
56     double _interval;
57     double _elapsed_time;
58     double _persistance;
59
60     SGPropertyNode_ptr _serviceable_node;
61     SGPropertyNode_ptr _sceneryLoaded;
62     SGPropertyNode_ptr _Instrument;
63     SGPropertyNode_ptr _radar_mode_control_node;
64
65     SGPropertyNode_ptr _user_lat_node;
66     SGPropertyNode_ptr _user_lon_node;
67     SGPropertyNode_ptr _user_heading_node;
68     SGPropertyNode_ptr _user_alt_node;
69
70     FGODGauge *_odg;
71
72     typedef struct {
73         double bearing;
74         double range;
75         double elevation;
76         double bumpiness;
77         double elapsed_time;
78     }ground_echo;
79
80     typedef std::vector <ground_echo*> ground_echo_vector_type;
81     typedef ground_echo_vector_type::iterator ground_echo_vector_iterator;
82
83     ground_echo_vector_type       ground_echoes;
84     ground_echo_vector_iterator   ground_echoes_iterator;
85
86     // Convenience function for creating a property node with a
87     // default value
88     template<typename DefaultType>
89     SGPropertyNode *getInstrumentNode(const char *name, DefaultType value);
90
91 private:
92     std::string _texture_path;
93
94     typedef enum { ARC, MAP, PLAN, ROSE, BSCAN} DisplayMode;
95     DisplayMode _display_mode;
96
97     float _range_nm;
98     float _scale;   // factor to convert nm to display units
99     float _angle_offset;
100     float _view_heading;
101     float _x_offset, _y_offset;
102
103     double _radar_ref_rng;
104     double _lat, _lon;
105     double _antenna_ht;
106
107     SGPropertyNode_ptr _Tacan;
108     SGPropertyNode_ptr _Radar_controls;
109
110     SGPropertyNode_ptr _user_speed_east_fps_node;
111     SGPropertyNode_ptr _user_speed_north_fps_node;
112
113     SGPropertyNode_ptr _tacan_serviceable_node;
114     SGPropertyNode_ptr _tacan_distance_node;
115     SGPropertyNode_ptr _tacan_name_node;
116     SGPropertyNode_ptr _tacan_bearing_node;
117     SGPropertyNode_ptr _tacan_in_range_node;
118
119     SGPropertyNode_ptr _radar_weather_node;
120     SGPropertyNode_ptr _radar_position_node;
121     SGPropertyNode_ptr _radar_data_node;
122     SGPropertyNode_ptr _radar_symbol_node;
123
124     SGPropertyNode_ptr _radar_centre_node;
125     SGPropertyNode_ptr _radar_coverage_node;
126     SGPropertyNode_ptr _radar_ref_rng_node;
127     SGPropertyNode_ptr _radar_hdg_marker_node;
128     SGPropertyNode_ptr _radar_rotate_node;
129     SGPropertyNode_ptr _radar_tcas_node;
130     SGPropertyNode_ptr _radar_absalt_node;
131
132     SGPropertyNode_ptr _font_node;
133     SGPropertyNode_ptr _ai_enabled_node;
134
135     osg::ref_ptr<osg::Texture2D> _resultTexture;
136     osg::ref_ptr<osg::Texture2D> _wxEcho;
137     osg::ref_ptr<osg::Geode> _radarGeode;
138     osg::ref_ptr<osg::Geode> _textGeode;
139     osg::Geometry *_geom;
140     osg::Vec2Array *_vertices;
141     osg::Vec2Array *_texCoords;
142     osg::Matrixf _centerTrans;
143     osg::ref_ptr<osgText::Font> _font;
144     osg::Vec4 _font_color;
145     osg::Vec4 _tcas_colors[4];
146     float _font_size;
147     float _font_spacing;
148
149 // FIXME: implementation of radar echoes missing
150 //    list_of_SGWxRadarEcho _radarEchoBuffer;
151
152     void update_weather();
153     void update_aircraft();
154     void update_tacan();
155     void update_heading_marker();
156     void update_data(const SGPropertyNode *ac, double alt, double heading,
157         double radius, double bearing, bool selected);
158     bool update_tcas(const SGPropertyNode *model,double range,double user_alt,double alt,
159                      double bearing,double radius, bool absMode);
160     void center_map();
161     void apply_map_offset();
162     void updateFont();
163     void calcRangeBearing(double lat, double lon, double lat2, double lon2,
164         double &range, double &bearing) const;
165
166     bool withinRadarHorizon(double user_alt, double alt, double range);
167     bool inRadarRange(double sigma, double range);
168
169     float calcRelBearing(float bearing, float heading);
170     float calcRelBearingDeg(float bearing, float heading);
171 };
172
173
174 template<> inline
175 SGPropertyNode *wxRadarBg::getInstrumentNode(const char *name, bool value)
176 {
177     SGPropertyNode *result = _Instrument->getNode(name, true);
178     if (!result->hasValue())
179         result->setBoolValue(value);
180     return result;
181 }
182
183
184 template<> inline
185 SGPropertyNode *wxRadarBg::getInstrumentNode(const char *name, double value)
186 {
187     SGPropertyNode *result = _Instrument->getNode(name, true);
188     if (!result->hasValue())
189         result->setDoubleValue(value);
190     return result;
191 }
192
193
194 template<> inline
195 SGPropertyNode *wxRadarBg::getInstrumentNode(const char *name, const char *value)
196 {
197     SGPropertyNode *result = _Instrument->getNode(name, true);
198     if (result->hasValue())
199         result->setStringValue(value);
200     return result;
201 }
202
203
204 #endif // _INST_WXRADAR_HXX