flightgear/src/Cockpit/wxradar.hxx

// Wx Radar background texture
//
// Written by Harald JOHNSEN, started May 2005.
// With major amendments by Vivian MEAZZA May 2007
// Ported to OSG by Tim MOORE Jun 2007
//
// Copyright (C) 2005  Harald JOHNSEN - hjohnsen@evc.net
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License as
// published by the Free Software Foundation; either version 2 of the
// License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// General Public License for more details.
//
// 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

#include <osg/ref_ptr>
#include <osg/Geode>
#include <osg/Texture2D>
#include <osgText/Text>

#include <simgear/props/props.hxx>
#include <simgear/structure/subsystem_mgr.hxx>

#include <vector>
#include <string>

class FGODGauge;

class wxRadarBg : public SGSubsystem, public SGPropertyChangeListener {
public:

    wxRadarBg(SGPropertyNode *node);
    wxRadarBg();
    virtual ~wxRadarBg();

    virtual void init();
    virtual void update(double dt);
    virtual void valueChanged(SGPropertyNode *);

protected:
    std::string _name;
    int _num;
    double _time;
    double _interval;
    double _elapsed_time;
    double _persistance;

    SGPropertyNode_ptr _serviceable_node;
    SGPropertyNode_ptr _sceneryLoaded;
    SGPropertyNode_ptr _Instrument;
    SGPropertyNode_ptr _radar_mode_control_node;

    SGPropertyNode_ptr _user_lat_node;
    SGPropertyNode_ptr _user_lon_node;
    SGPropertyNode_ptr _user_heading_node;
    SGPropertyNode_ptr _user_alt_node;

    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);

private:
    std::string _texture_path;

    typedef enum { ARC, MAP, PLAN, ROSE, BSCAN} DisplayMode;
    DisplayMode _display_mode;

    float _range_nm;
    float _scale;   // factor to convert nm to display units
    float _angle_offset;
    float _view_heading;
    float _x_offset, _y_offset;

    double _radar_ref_rng;
    double _lat, _lon;
    double _antenna_ht;

    SGPropertyNode_ptr _Tacan;
    SGPropertyNode_ptr _Radar_controls;

    SGPropertyNode_ptr _user_speed_east_fps_node;
    SGPropertyNode_ptr _user_speed_north_fps_node;

    SGPropertyNode_ptr _tacan_serviceable_node;
    SGPropertyNode_ptr _tacan_distance_node;
    SGPropertyNode_ptr _tacan_name_node;
    SGPropertyNode_ptr _tacan_bearing_node;
    SGPropertyNode_ptr _tacan_in_range_node;

    SGPropertyNode_ptr _radar_weather_node;
    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_tcas_node;
    SGPropertyNode_ptr _radar_absalt_node;

    SGPropertyNode_ptr _font_node;
    SGPropertyNode_ptr _ai_enabled_node;

    osg::ref_ptr<osg::Texture2D> _resultTexture;
    osg::ref_ptr<osg::Texture2D> _wxEcho;
    osg::ref_ptr<osg::Geode> _radarGeode;
    osg::ref_ptr<osg::Geode> _textGeode;
    osg::Geometry *_geom;
    osg::Vec2Array *_vertices;
    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;

// 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(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;

    bool withinRadarHorizon(double user_alt, double alt, 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 *result = _Instrument->getNode(name, true);
    if (!result->hasValue())
        result->setBoolValue(value);
    return result;
}


template<> inline
SGPropertyNode *wxRadarBg::getInstrumentNode(const char *name, double value)
{
    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 *result = _Instrument->getNode(name, true);
    if (result->hasValue())
        result->setStringValue(value);
    return result;
}


#endif // _INST_WXRADAR_HXX