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