ADF: code clean-up/documentation

[flightgear.git] / src / Instrumentation / wxradar.hxx

diff --git a/src/Instrumentation/wxradar.hxx b/src/Instrumentation/wxradar.hxx
index b7d145724e5ca4dee0a1dbfee513c2203c989c04..7aff7771718b2be81c13b5b560f3de7d2b8a3223 100644 (file)
--- a/src/Instrumentation/wxradar.hxx
+++ b/src/Instrumentation/wxradar.hxx
@@ -19,8 +19,6 @@
 // You should have received a copy of the GNU General Public License
 // along with this program; if not, write to the Free Software
 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
-//
-//
 
 #ifndef _INST_WXRADAR_HXX
 #define _INST_WXRADAR_HXX
@@ -32,40 +30,33 @@
 
 #include <simgear/props/props.hxx>
 #include <simgear/structure/subsystem_mgr.hxx>
-#include <simgear/environment/visual_enviro.hxx>
 
-#include <AIModel/AIBase.hxx>
-#include <AIModel/AIManager.hxx>
 #include <vector>
 #include <string>
-SG_USING_STD(vector);
-SG_USING_STD(string);
-
-class FGAIBase;
 
 class FGODGauge;
 
 class wxRadarBg : public SGSubsystem, public SGPropertyChangeListener {
 public:
 
-    wxRadarBg ( SGPropertyNode *node );
-    wxRadarBg ();
-    virtual ~wxRadarBg ();
+    wxRadarBg(SGPropertyNode *node);
+    wxRadarBg();
+    virtual ~wxRadarBg();
 
-    virtual void init ();
-    virtual void update (double dt);
-    virtual void valueChanged(SGPropertyNode*);
+    virtual void init();
+    virtual void update(double dt);
+    virtual void valueChanged(SGPropertyNode *);
 
-    double _interval;
+protected:
+    std::string _name;
+    int _num;
     double _time;
-
-    bool _sim_init_done;
-
-    string _name;
-
-    int _num; 
+    double _interval;
+    double _elapsed_time;
+    double _persistance;
 
     SGPropertyNode_ptr _serviceable_node;
+    SGPropertyNode_ptr _sceneryLoaded;
     SGPropertyNode_ptr _Instrument;
     SGPropertyNode_ptr _radar_mode_control_node;
 
@@ -76,20 +67,31 @@ public:
 
     FGODGauge *_odg;
 
+    typedef struct {
+        double bearing;
+        double range;
+        double elevation;
+        double bumpiness;
+        double elapsed_time;
+    }ground_echo;
+
+    typedef std::vector <ground_echo*> ground_echo_vector_type;
+    typedef ground_echo_vector_type::iterator ground_echo_vector_iterator;
+
+    ground_echo_vector_type       ground_echoes;
+    ground_echo_vector_iterator   ground_echoes_iterator;
+
     // Convenience function for creating a property node with a
     // default value
     template<typename DefaultType>
-    SGPropertyNode* getInstrumentNode(const char* name, DefaultType value);
+    SGPropertyNode *getInstrumentNode(const char *name, DefaultType value);
 
 private:
+    std::string _texture_path;
 
-    string _texture_path;
-
-    typedef enum { ARC, MAP, PLAN, ROSE } DisplayMode;
+    typedef enum { ARC, MAP, PLAN, ROSE, BSCAN} DisplayMode;
     DisplayMode _display_mode;
 
-    string _last_switchKnob;
-
     float _range_nm;
     float _scale;   // factor to convert nm to display units
     float _angle_offset;
@@ -98,6 +100,7 @@ private:
 
     double _radar_ref_rng;
     double _lat, _lon;
+    double _antenna_ht;
 
     SGPropertyNode_ptr _Tacan;
     SGPropertyNode_ptr _Radar_controls;
@@ -115,14 +118,16 @@ private:
     SGPropertyNode_ptr _radar_position_node;
     SGPropertyNode_ptr _radar_data_node;
     SGPropertyNode_ptr _radar_symbol_node;
-    
+
     SGPropertyNode_ptr _radar_centre_node;
     SGPropertyNode_ptr _radar_coverage_node;
     SGPropertyNode_ptr _radar_ref_rng_node;
     SGPropertyNode_ptr _radar_hdg_marker_node;
     SGPropertyNode_ptr _radar_rotate_node;
-    SGPropertyNode_ptr _radar_font_node;
+    SGPropertyNode_ptr _radar_tcas_node;
+    SGPropertyNode_ptr _radar_absalt_node;
 
+    SGPropertyNode_ptr _font_node;
     SGPropertyNode_ptr _ai_enabled_node;
 
     osg::ref_ptr<osg::Texture2D> _resultTexture;
@@ -134,53 +139,61 @@ private:
     osg::Vec2Array *_texCoords;
     osg::Matrixf _centerTrans;
     osg::ref_ptr<osgText::Font> _font;
+    osg::Vec4 _font_color;
+    osg::Vec4 _tcas_colors[4];
+    float _font_size;
+    float _font_spacing;
 
-    list_of_SGWxRadarEcho _radarEchoBuffer;
-
-    FGAIManager* _ai;
+// FIXME: implementation of radar echoes missing
+//    list_of_SGWxRadarEcho _radarEchoBuffer;
 
     void update_weather();
     void update_aircraft();
     void update_tacan();
     void update_heading_marker();
-    void update_data(FGAIBase* ac, double radius, double bearing, bool selected);
+    void update_data(const SGPropertyNode *ac, double alt, double heading,
+        double radius, double bearing, bool selected);
+    bool update_tcas(const SGPropertyNode *model,double range,double user_alt,double alt,
+                     double bearing,double radius, bool absMode);
     void center_map();
     void apply_map_offset();
     void updateFont();
     void calcRangeBearing(double lat, double lon, double lat2, double lon2,
-            double &range, double &bearing) const;
+        double &range, double &bearing) const;
 
     bool withinRadarHorizon(double user_alt, double alt, double range);
-    bool inRadarRange(int type, double range);
+    bool inRadarRange(double sigma, double range);
 
     float calcRelBearing(float bearing, float heading);
-    
+    float calcRelBearingDeg(float bearing, float heading);
 };
 
+
 template<> inline
-SGPropertyNode* wxRadarBg::getInstrumentNode(const char* name, bool value)
+SGPropertyNode *wxRadarBg::getInstrumentNode(const char *name, bool value)
 {
-    SGPropertyNode* result = _Instrument->getNode(name, true);
-    if (result->getType() == SGPropertyNode::NONE)
+    SGPropertyNode *result = _Instrument->getNode(name, true);
+    if (!result->hasValue())
         result->setBoolValue(value);
     return result;
 }
 
+
 template<> inline
-SGPropertyNode* wxRadarBg::getInstrumentNode(const char* name, double value)
+SGPropertyNode *wxRadarBg::getInstrumentNode(const char *name, double value)
 {
-    SGPropertyNode* result = _Instrument->getNode(name, true);
-    if (result->getType() == SGPropertyNode::NONE)
+    SGPropertyNode *result = _Instrument->getNode(name, true);
+    if (!result->hasValue())
         result->setDoubleValue(value);
     return result;
 }
 
+
 template<> inline
-SGPropertyNode* wxRadarBg::getInstrumentNode(const char* name,
-                                             const char* value)
+SGPropertyNode *wxRadarBg::getInstrumentNode(const char *name, const char *value)
 {
-    SGPropertyNode* result = _Instrument->getNode(name, true);
-    if (result->getType() == SGPropertyNode::NONE)
+    SGPropertyNode *result = _Instrument->getNode(name, true);
+    if (result->hasValue())
         result->setStringValue(value);
     return result;
 }