src/Instrumentation/wxradar.cxx

   1 // Wx Radar background texture
   2 //
   3 // Written by Harald JOHNSEN, started May 2005.
   4 //
   5 // Copyright (C) 2005  Harald JOHNSEN
   6 //
   7 // This program is free software; you can redistribute it and/or
   8 // modify it under the terms of the GNU General Public License as
   9 // published by the Free Software Foundation; either version 2 of the
  10 // License, or (at your option) any later version.
  11 //
  12 // This program is distributed in the hope that it will be useful, but
  13 // WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 // General Public License for more details.
  16 //
  17 // You should have received a copy of the GNU General Public License
  18 // along with this program; if not, write to the Free Software
  19 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  20 //
  21 //
  22
  23 #ifdef HAVE_CONFIG_H
  24 #  include "config.h"
  25 #endif
  26
  27 #include <plib/sg.h>
  28 #include <Main/fg_props.hxx>
  29 #include <Main/globals.hxx>
  30 #include <Cockpit/panel.hxx>
  31 #include <Cockpit/hud.hxx>
  32
  33 #include <simgear/constants.h>
  34 #include <simgear/misc/sg_path.hxx>
  35 #include <simgear/environment/visual_enviro.hxx>
  36 #include "instrument_mgr.hxx"
  37 #include "od_gauge.hxx"
  38 #include "wxradar.hxx"
  39
  40 // texture name to use in 2D and 3D instruments
  41 static const char *odgauge_name = "Aircraft/Instruments/Textures/od_wxradar.rgb";
  42
  43 wxRadarBg::wxRadarBg ( SGPropertyNode *node) :
  44     name("wxRadar"),
  45     num(0),
  46     resultTexture( 0 ),
  47     wxEcho( 0 ),
  48     last_switchKnob( "off" ),
  49     sim_init_done ( false ),
  50     odg( 0 )
  51 {
  52     int i;
  53     for ( i = 0; i < node->nChildren(); ++i ) {
  54         SGPropertyNode *child = node->getChild(i);
  55         string cname = child->getName();
  56         string cval = child->getStringValue();
  57         if ( cname == "name" ) {
  58             name = cval;
  59         } else if ( cname == "number" ) {
  60             num = child->getIntValue();
  61         } else {
  62             SG_LOG( SG_INSTR, SG_WARN, "Error in wxRadar config logic" );
  63             if ( name.length() ) {
  64                 SG_LOG( SG_INSTR, SG_WARN, "Section = " << name );
  65             }
  66         }
  67     }
  68 }
  69
  70 wxRadarBg::wxRadarBg ()
  71 {
  72 }
  73
  74 wxRadarBg::~wxRadarBg ()
  75 {
  76 }
  77
  78 void
  79 wxRadarBg::init ()
  80 {
  81     string branch;
  82     branch = "/instrumentation/" + name;
  83
  84     _Instrument = fgGetNode(branch.c_str(), num, true );
  85     _serviceable_node = _Instrument->getChild("serviceable", 0, true);
  86     resultTexture = FGTextureManager::createTexture( odgauge_name );
  87     SGPath tpath(globals->get_fg_root());
  88     tpath.append("Aircraft/Instruments/Textures/wxecho.rgb");
  89     // no mipmap or else alpha will mix with pixels on the border of shapes, ruining the effect
  90     wxEcho = new ssgTexture( tpath.c_str(), false, false, false);
  91
  92     _Instrument->setFloatValue("trk", 0.0);
  93     _Instrument->setFloatValue("tilt", 0.0);
  94     _Instrument->setStringValue("status","");
  95     // those properties are used by a radar instrument of a MFD
  96     // input switch = OFF | TST | STBY | ON
  97     // input mode = WX | WXA | MAP
  98     // ouput status = STBY | TEST | WX | WXA | MAP | blank
  99     // input lightning = true | false
 100     // input TRK = +/- n degrees
 101     // input TILT = +/- n degree
 102     // input autotilt = true | false
 103     // input range = n nm (20/40/80)
 104     // input display-mode = arc | rose | map | plan
 105
 106     FGInstrumentMgr *imgr = (FGInstrumentMgr *) globals->get_subsystem("instrumentation");
 107     odg = (FGODGauge *) imgr->get_subsystem("od_gauge");
 108 }
 109
 110 void
 111 wxRadarBg::update (double delta_time_sec)
 112 {
 113     if ( ! sim_init_done ) {
 114         if ( ! fgGetBool("sim/sceneryloaded", false) )
 115             return;
 116         sim_init_done = true;
 117     }
 118     if ( !odg || ! _serviceable_node->getBoolValue() ) {
 119         _Instrument->setStringValue("status","");
 120         return;
 121     }
 122     string switchKnob = _Instrument->getStringValue("switch", "on");
 123     string modeButton = _Instrument->getStringValue("mode", "wx");
 124     bool drawLightning = _Instrument->getBoolValue("lightning", true);
 125     float range_nm = _Instrument->getFloatValue("range", 40.0);
 126     float range_m = range_nm * SG_NM_TO_METER;
 127
 128     if ( last_switchKnob != switchKnob ) {
 129         // since 3D models don't share textures with the rest of the world
 130         // we must locate them and replace their handle by hand
 131         // only do that when the instrument is turned on
 132         if ( last_switchKnob == "off" )
 133             odg->set_texture( odgauge_name, resultTexture->getHandle());
 134         last_switchKnob = switchKnob;
 135     }
 136     FGViewer *current__view = globals->get_current_view();
 137     if ( current__view->getInternal() &&
 138         (current__view->getHeadingOffset_deg() <= 15.0 || current__view->getHeadingOffset_deg() >= 345.0) &&
 139         (current__view->getPitchOffset_deg() <= 15.0 || current__view->getPitchOffset_deg() >= 350.0) ) {
 140
 141         // we don't update the radar echo if the pilot looks around
 142         // this is a copy
 143         radarEchoBuffer = *sgEnviro.get_radar_echo();
 144     }
 145     odg->beginCapture(256);
 146     odg->Clear();
 147
 148     glMatrixMode(GL_MODELVIEW);
 149     glLoadIdentity();
 150     glPushMatrix();
 151     glPolygonMode(GL_FRONT_AND_BACK, GL_FILL);
 152     glBindTexture(GL_TEXTURE_2D, 0);
 153
 154     if ( switchKnob == "off" ) {
 155         _Instrument->setStringValue("status","");
 156     } else if ( switchKnob == "stby" ) {
 157         _Instrument->setStringValue("status","STBY");
 158     } else if ( switchKnob == "tst" ) {
 159         _Instrument->setStringValue("status","TST");
 160         // find something interesting to do...
 161     } else {
 162         string display_mode = _Instrument->getStringValue("display-mode", "arc");
 163
 164         // pretend we have a scan angle bigger then the FOV
 165         // TODO:check real fov, enlarge if < nn, and do clipping if > mm
 166         const float fovFactor = 1.45f;
 167         float view_heading = get_heading() * SG_DEGREES_TO_RADIANS;
 168         float range = 200.0f / range_nm;
 169         _Instrument->setStringValue("status", modeButton.c_str());
 170         if ( display_mode == "arc" ) {
 171             glTranslatef(0.0f, -180.0f, 0.0f);
 172             range = 2*180.0f / range_nm;
 173         } else if ( display_mode == "map" ) {
 174 //            float view_heading = get_track() * SG_DEGREES_TO_RADIANS;
 175         } else if ( display_mode == "plan" ) {
 176             // no sense I presume
 177             view_heading = 0;
 178         } else {
 179             // rose
 180         }
 181         range /= SG_NM_TO_METER;
 182         // we will rotate the echo quads, this gives a better rendering
 183         const float rot_x = cos ( view_heading );
 184         const float rot_y = sin ( view_heading );
 185
 186         list_of_SGWxRadarEcho *radarEcho = &radarEchoBuffer;
 187         list_of_SGWxRadarEcho::iterator iradarEcho;
 188         const float LWClevel[] = { 0.1f, 0.5f, 2.1f };
 189         const float symbolSize = 1.0f / 8.0f ;
 190         // draw the radar echo, we do that in 3 passes, one for each color level
 191         // this is to 'merge' same colors together
 192         glBindTexture(GL_TEXTURE_2D, wxEcho->getHandle() );
 193         glColor3f(1.0f, 1.0f, 1.0f);
 194         glBegin( GL_QUADS );
 195
 196         for (int level = 0; level <= 2 ; level++ ) {
 197             float col = level * symbolSize;
 198             for (iradarEcho = radarEcho->begin() ; iradarEcho != radarEcho->end() ; iradarEcho++ ) {
 199                 int cloudId = (iradarEcho->cloudId) ;
 200                 bool upgrade = ((cloudId >> 5) & 1);
 201                 float lwc = iradarEcho->LWC + (upgrade ? 1.0f : 0.0f);
 202                 // skip ns
 203                 if ( iradarEcho->LWC >= 0.5 && iradarEcho->LWC <= 0.6)
 204                     continue;
 205                 if ( (! iradarEcho->lightning) && ( lwc >= LWClevel[level]) ) {
 206                     float dist = sgSqrt( iradarEcho->dist );
 207                     float size = iradarEcho->radius * 2.0;
 208                     if ( dist - size > range_m )
 209                         continue;
 210                     dist = dist * range;
 211                     size = size * range;
 212                     // compute the relative angle from the view direction
 213                     float angle = ( view_heading + iradarEcho->heading );
 214                     if ( angle > SG_PI )
 215                         angle -= 2.0*SG_PI;
 216                     if ( angle < - SG_PI )
 217                         angle += 2.0*SG_PI;
 218                     // and apply a fov factor to simulate a greater scan angle
 219                     angle =  angle * fovFactor + SG_PI / 2.0;
 220                     float x = cos( angle ) * dist;
 221                     float y = sin( angle ) * dist;
 222                     // use different shapes so the display is less boring
 223                     float row = symbolSize * (float) (4 + (cloudId & 3) );
 224                     float size_x = rot_x * size;
 225                     float size_y = rot_y * size;
 226                     glTexCoord2f( col, row);
 227                     glVertex2f( x - size_x, y - size_y);
 228                     glTexCoord2f( col+symbolSize, row);
 229                     glVertex2f( x + size_y, y - size_x);
 230                     glTexCoord2f( col+symbolSize, row+symbolSize);
 231                     glVertex2f( x + size_x, y + size_y);
 232                     glTexCoord2f( col, row+symbolSize);
 233                     glVertex2f( x - size_y, y + size_x);
 234                 }
 235             }
 236         }
 237         glEnd(); // GL_QUADS
 238
 239         // draw lightning echos
 240         if ( drawLightning ) {
 241             float col = 3 * symbolSize;
 242             float row = 4 * symbolSize;
 243             for (iradarEcho = radarEcho->begin() ; iradarEcho != radarEcho->end() ; iradarEcho++ ) {
 244                 if ( iradarEcho->lightning ) {
 245                     float dist = iradarEcho->dist;
 246                     dist = dist * range;
 247                     float angle = (view_heading - iradarEcho->heading);
 248                     if ( angle > SG_PI )
 249                         angle -= 2.0*SG_PI;
 250                     if ( angle < - SG_PI )
 251                         angle += 2.0*SG_PI;
 252                     angle =  angle * fovFactor - SG_PI / 2.0;
 253                     float x = cos( angle ) * dist;
 254                     float y = sin( angle ) * dist;
 255                     glColor3f(1.0f, 1.0f, 1.0f);
 256                     float size = symbolSize * 0.5f;
 257                     glBegin( GL_QUADS );
 258                         glTexCoord2f( col, row);
 259                         glVertex2f( x - size, y - size);
 260                         glTexCoord2f( col+symbolSize, row);
 261                         glVertex2f( x + size, y - size);
 262                         glTexCoord2f( col+symbolSize, row+symbolSize);
 263                         glVertex2f( x + size, y + size);
 264                         glTexCoord2f( col, row+symbolSize);
 265                         glVertex2f( x - size, y + size);
 266                     glEnd();
 267                 }
 268             }
 269         }
 270         // erase what is out of sight of antenna
 271         /*
 272             |\     /|
 273             | \   / |
 274             |  \ /  |
 275             ---------
 276             |       |
 277             |       |
 278             ---------
 279         */
 280         float yOffset = 180.0f, xOffset = 256.0f;
 281
 282         if ( display_mode != "arc" ) {
 283             yOffset = 40.0f;
 284             xOffset = 240.0f;
 285         }
 286
 287         if ( display_mode != "plan" ) {
 288             glDisable(GL_BLEND);
 289             glColor4f(1.0f, 0.0f, 0.0f, 0.01f);
 290             glBegin( GL_QUADS );
 291             glTexCoord2f( 0.5f, 0.25f);
 292             glVertex2f(-xOffset, 0.0 + yOffset);
 293             glTexCoord2f( 1.0f, 0.25f);
 294             glVertex2f(xOffset, 0.0 + yOffset);
 295             glTexCoord2f( 1.0f, 0.5f);
 296             glVertex2f(xOffset, 256.0 + yOffset);
 297             glTexCoord2f( 0.5f, 0.5f);
 298             glVertex2f(-xOffset, 256.0 + yOffset);
 299             glEnd();
 300
 301             glColor4f(0.0f, 0.0f, 0.0f, 0.0f);
 302 //          glColor4f(0.0f, 1.0f, 0.0f, 1.0f);
 303             glDisable(GL_ALPHA_TEST);
 304             glBindTexture(GL_TEXTURE_2D, 0);
 305
 306             glBegin( GL_TRIANGLES );
 307             glVertex2f(0.0, 0.0);
 308             glVertex2f(-256.0, 0.0);
 309             glVertex2f(-256.0, 256.0 * tan(30*SG_DEGREES_TO_RADIANS));
 310
 311             glVertex2f(0.0, 0.0);
 312             glVertex2f(256.0, 0.0);
 313             glVertex2f(256.0, 256.0 * tan(30*SG_DEGREES_TO_RADIANS));
 314
 315             glVertex2f(-256, 0.0);
 316             glVertex2f(256.0, 0.0);
 317             glVertex2f(-256.0, -256.0);
 318
 319             glVertex2f(256, 0.0);
 320             glVertex2f(256.0, -256.0);
 321             glVertex2f(-256.0, -256.0);
 322             glEnd();
 323         }
 324
 325         // DEBUG only
 326 /*      glColor4f(1.0f, 0.0f, 0.0f, 1.0f);
 327         glBegin( GL_LINES );
 328         glVertex2f(0.0, 0.0);
 329         glVertex2f(-256.0, 256.0);
 330         glVertex2f(0.0, 0.0);
 331         glVertex2f(256.0, 256.0);
 332         glEnd();*/
 333
 334         glEnable(GL_BLEND);
 335         glEnable(GL_ALPHA_TEST);
 336     }
 337     glPopMatrix();
 338     odg->endCapture( resultTexture->getHandle() );
 339 }