src/Environment/environment_mgr.cxx

   1 // environment-mgr.cxx -- manager for natural environment information.
   2 //
   3 // Written by David Megginson, started February 2002.
   4 //
   5 // Copyright (C) 2002  David Megginson - david@megginson.com
   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 // $Id$
  22
  23 #ifdef HAVE_CONFIG_H
  24 #  include <config.h>
  25 #endif
  26
  27 #include <simgear/constants.h>
  28 #include <simgear/debug/logstream.hxx>
  29 #include <simgear/scene/sky/sky.hxx>
  30 #include <simgear/environment/visual_enviro.hxx>
  31 #include <simgear/scene/model/particles.hxx>
  32
  33 #include <Main/main.hxx>
  34 #include <Main/fg_props.hxx>
  35 #include <Aircraft/aircraft.hxx>
  36 #include <FDM/flight.hxx>
  37
  38 #include "environment.hxx"
  39 #include "environment_ctrl.hxx"
  40 #include "environment_mgr.hxx"
  41 #include "fgclouds.hxx"
  42 #include "precipitation_mgr.hxx"
  43
  44 class SGSky;
  45 extern SGSky *thesky;
  46
  47
  48
  49 FGEnvironmentMgr::FGEnvironmentMgr ()
  50   : _environment(new FGEnvironment)
  51 {
  52
  53    if (fgGetBool("/environment/params/real-world-weather-fetch") == true)
  54        _controller = new FGMetarEnvironmentCtrl;
  55    else
  56        _controller = new FGInterpolateEnvironmentCtrl;
  57
  58   _controller->setEnvironment(_environment);
  59   set_subsystem("controller", _controller, 0.5);
  60   fgClouds = new FGClouds( _controller );
  61   _precipitationManager = new FGPrecipitationMgr;
  62   set_subsystem("precipitation", _precipitationManager);
  63 }
  64
  65 FGEnvironmentMgr::~FGEnvironmentMgr ()
  66 {
  67   delete _environment;
  68   remove_subsystem("controller");
  69   remove_subsystem("precipitation");
  70   delete _controller;
  71   delete fgClouds;
  72   delete _precipitationManager;
  73 }
  74
  75 void
  76 FGEnvironmentMgr::init ()
  77 {
  78   SG_LOG( SG_GENERAL, SG_INFO, "Initializing environment subsystem");
  79   SGSubsystemGroup::init();
  80   _update_fdm();
  81 }
  82
  83 void
  84 FGEnvironmentMgr::reinit ()
  85 {
  86   SG_LOG( SG_GENERAL, SG_INFO, "Reinitializing environment subsystem");
  87   SGSubsystemGroup::reinit();
  88   _update_fdm();
  89 }
  90
  91 void
  92 FGEnvironmentMgr::bind ()
  93 {
  94   fgTie("/environment/visibility-m", _environment,
  95         &FGEnvironment::get_visibility_m, &FGEnvironment::set_visibility_m);
  96   fgSetArchivable("/environment/visibility-m");
  97   fgTie("/environment/effective-visibility-m", thesky,
  98        &SGSky::get_visibility );
  99   fgTie("/environment/temperature-sea-level-degc", _environment,
 100         &FGEnvironment::get_temperature_sea_level_degc,
 101         &FGEnvironment::set_temperature_sea_level_degc);
 102   fgSetArchivable("/environment/temperature-sea-level-degc");
 103   fgTie("/environment/temperature-degc", _environment,
 104         &FGEnvironment::get_temperature_degc); // FIXME: read-only for now
 105   fgTie("/environment/temperature-degf", _environment,
 106         &FGEnvironment::get_temperature_degf); // FIXME: read-only for now
 107   fgTie("/environment/dewpoint-sea-level-degc", _environment,
 108         &FGEnvironment::get_dewpoint_sea_level_degc,
 109         &FGEnvironment::set_dewpoint_sea_level_degc);
 110   fgSetArchivable("/environment/dewpoint-sea-level-degc");
 111   fgTie("/environment/dewpoint-degc", _environment,
 112         &FGEnvironment::get_dewpoint_degc); // FIXME: read-only for now
 113   fgTie("/environment/pressure-sea-level-inhg", _environment,
 114         &FGEnvironment::get_pressure_sea_level_inhg,
 115         &FGEnvironment::set_pressure_sea_level_inhg);
 116   fgSetArchivable("/environment/pressure-sea-level-inhg");
 117   fgTie("/environment/pressure-inhg", _environment,
 118         &FGEnvironment::get_pressure_inhg); // FIXME: read-only for now
 119   fgTie("/environment/density-slugft3", _environment,
 120         &FGEnvironment::get_density_slugft3); // read-only
 121   fgTie("/environment/relative-humidity", _environment,
 122         &FGEnvironment::get_relative_humidity); //ro
 123   fgTie("/environment/atmosphere/density-tropo-avg", _environment,
 124         &FGEnvironment::get_density_tropo_avg_kgm3); //ro
 125   fgTie("/environment/atmosphere/altitude-half-to-sun", _environment,
 126         &FGEnvironment::get_altitude_half_to_sun_m,
 127         &FGEnvironment::set_altitude_half_to_sun_m);
 128   fgTie("/environment/atmosphere/altitude-troposphere-top", _environment,
 129         &FGEnvironment::get_altitude_tropo_top_m,
 130         &FGEnvironment::set_altitude_tropo_top_m);
 131   fgTie("/environment/wind-from-heading-deg", _environment,
 132         &FGEnvironment::get_wind_from_heading_deg,
 133         &FGEnvironment::set_wind_from_heading_deg);
 134   fgTie("/environment/wind-speed-kt", _environment,
 135         &FGEnvironment::get_wind_speed_kt, &FGEnvironment::set_wind_speed_kt);
 136   fgTie("/environment/wind-from-north-fps", _environment,
 137         &FGEnvironment::get_wind_from_north_fps,
 138         &FGEnvironment::set_wind_from_north_fps);
 139   fgSetArchivable("/environment/wind-from-north-fps");
 140   fgTie("/environment/wind-from-east-fps", _environment,
 141         &FGEnvironment::get_wind_from_east_fps,
 142         &FGEnvironment::set_wind_from_east_fps);
 143   fgSetArchivable("/environment/wind-from-east-fps");
 144   fgTie("/environment/wind-from-down-fps", _environment,
 145         &FGEnvironment::get_wind_from_down_fps,
 146         &FGEnvironment::set_wind_from_down_fps);
 147   fgSetArchivable("/environment/wind-from-down-fps");
 148   fgTie("/environment/turbulence/magnitude-norm", _environment,
 149         &FGEnvironment::get_turbulence_magnitude_norm,
 150         &FGEnvironment::set_turbulence_magnitude_norm);
 151   fgSetArchivable("/environment/turbulence/magnitude-norm");
 152   fgTie("/environment/turbulence/rate-hz", _environment,
 153         &FGEnvironment::get_turbulence_rate_hz,
 154         &FGEnvironment::set_turbulence_rate_hz);
 155   fgSetArchivable("/environment/turbulence/rate-hz");
 156
 157   for (int i = 0; i < MAX_CLOUD_LAYERS; i++) {
 158     char buf[128];
 159     sprintf(buf, "/environment/clouds/layer[%d]/span-m", i);
 160     fgTie(buf, this, i,
 161           &FGEnvironmentMgr::get_cloud_layer_span_m,
 162           &FGEnvironmentMgr::set_cloud_layer_span_m);
 163     fgSetArchivable(buf);
 164     sprintf(buf, "/environment/clouds/layer[%d]/elevation-ft", i);
 165     fgTie(buf, this, i,
 166           &FGEnvironmentMgr::get_cloud_layer_elevation_ft,
 167           &FGEnvironmentMgr::set_cloud_layer_elevation_ft);
 168     fgSetArchivable(buf);
 169     sprintf(buf, "/environment/clouds/layer[%d]/thickness-ft", i);
 170     fgTie(buf, this, i,
 171           &FGEnvironmentMgr::get_cloud_layer_thickness_ft,
 172           &FGEnvironmentMgr::set_cloud_layer_thickness_ft);
 173     fgSetArchivable(buf);
 174     sprintf(buf, "/environment/clouds/layer[%d]/transition-ft", i);
 175     fgTie(buf, this, i,
 176           &FGEnvironmentMgr::get_cloud_layer_transition_ft,
 177           &FGEnvironmentMgr::set_cloud_layer_transition_ft);
 178     fgSetArchivable(buf);
 179     sprintf(buf, "/environment/clouds/layer[%d]/coverage", i);
 180     fgTie(buf, this, i,
 181           &FGEnvironmentMgr::get_cloud_layer_coverage,
 182           &FGEnvironmentMgr::set_cloud_layer_coverage);
 183     fgSetArchivable(buf);
 184   }
 185   fgTie("/sim/rendering/clouds3d-enable", fgClouds,
 186           &FGClouds::get_3dClouds,
 187           &FGClouds::set_3dClouds);
 188   fgTie("/sim/rendering/clouds3d-density", thesky,
 189           &SGSky::get_3dCloudDensity,
 190           &SGSky::set_3dCloudDensity);
 191   fgTie("/sim/rendering/precipitation-enable", &sgEnviro,
 192           &SGEnviro::get_precipitation_enable_state,
 193           &SGEnviro::set_precipitation_enable_state);
 194   fgTie("/environment/rebuild-layers", fgClouds,
 195       &FGClouds::get_update_event,
 196       &FGClouds::set_update_event);
 197   fgTie("/sim/rendering/lightning-enable", &sgEnviro,
 198       &SGEnviro::get_lightning_enable_state,
 199       &SGEnviro::set_lightning_enable_state);
 200   fgTie("/environment/turbulence/use-cloud-turbulence", &sgEnviro,
 201       &SGEnviro::get_turbulence_enable_state,
 202       &SGEnviro::set_turbulence_enable_state);
 203   sgEnviro.config(fgGetNode("/sim/rendering/precipitation"));
 204 }
 205
 206 void
 207 FGEnvironmentMgr::unbind ()
 208 {
 209   fgUntie("/environment/visibility-m");
 210   fgUntie("/environment/effective-visibility-m");
 211   fgUntie("/environment/temperature-sea-level-degc");
 212   fgUntie("/environment/temperature-degc");
 213   fgUntie("/environment/dewpoint-sea-level-degc");
 214   fgUntie("/environment/dewpoint-degc");
 215   fgUntie("/environment/pressure-sea-level-inhg");
 216   fgUntie("/environment/pressure-inhg");
 217   fgUntie("/environment/density-inhg");
 218   fgUntie("/environment/relative-humidity");
 219   fgUntie("/environment/atmosphere/density-tropo-avg");
 220   fgUntie("/environment/wind-from-north-fps");
 221   fgUntie("/environment/wind-from-east-fps");
 222   fgUntie("/environment/wind-from-down-fps");
 223   fgUntie("/environment/atmosphere/altitude-half-to-sun");
 224   fgUntie("/environment/atmosphere/altitude-troposphere-top");
 225   for (int i = 0; i < MAX_CLOUD_LAYERS; i++) {
 226     char buf[128];
 227     sprintf(buf, "/environment/clouds/layer[%d]/span-m", i);
 228     fgUntie(buf);
 229     sprintf(buf, "/environment/clouds/layer[%d]/elevation-ft", i);
 230     fgUntie(buf);
 231     sprintf(buf, "/environment/clouds/layer[%d]/thickness-ft", i);
 232     fgUntie(buf);
 233     sprintf(buf, "/environment/clouds/layer[%d]/transition-ft", i);
 234     fgUntie(buf);
 235     sprintf(buf, "/environment/clouds/layer[%d]/type", i);
 236     fgUntie(buf);
 237   }
 238   fgUntie("/sim/rendering/clouds3d-enable");
 239   fgUntie("/sim/rendering/clouds3d-vis-range");
 240   fgUntie("/sim/rendering/clouds3d-density");
 241   fgUntie("/sim/rendering/clouds3d-cache-size");
 242   fgUntie("/sim/rendering/clouds3d-cache-resolution");
 243   fgUntie("/sim/rendering/precipitation-enable");
 244   fgUntie("/environment/rebuild-layers");
 245   fgUntie("/sim/rendering/lightning-enable");
 246   fgUntie("/environment/turbulence/use-cloud-turbulence");
 247 }
 248
 249 void
 250 FGEnvironmentMgr::update (double dt)
 251 {
 252   SGSubsystemGroup::update(dt);
 253
 254                                 // FIXME: the FDMs should update themselves
 255   current_aircraft.fdm_state
 256     ->set_Velocities_Local_Airmass(_environment->get_wind_from_north_fps(),
 257                                    _environment->get_wind_from_east_fps(),
 258                                    _environment->get_wind_from_down_fps());
 259   _environment->set_elevation_ft(fgGetDouble("/position/altitude-ft"));
 260   osg::Vec3 windVec(-_environment->get_wind_from_north_fps(),
 261                     -_environment->get_wind_from_east_fps(),
 262                     _environment->get_wind_from_down_fps());
 263   simgear::Particles::setWindVector(windVec * SG_FEET_TO_METER);
 264
 265   _update_fdm();
 266 }
 267
 268 FGEnvironment
 269 FGEnvironmentMgr::getEnvironment () const
 270 {
 271   return *_environment;
 272 }
 273
 274 FGEnvironment
 275 FGEnvironmentMgr::getEnvironment (double lat, double lon, double alt) const
 276 {
 277                                 // Always returns the same environment
 278                                 // for now; we'll make it interesting
 279                                 // later.
 280   FGEnvironment env = *_environment;
 281   env.set_elevation_ft(alt);
 282   return env;
 283 }
 284
 285 FGEnvironment
 286 FGEnvironmentMgr::getEnvironment(const SGGeod& aPos) const
 287 {
 288   // Always returns the same environment
 289   // for now; we'll make it interesting
 290   // later.
 291   FGEnvironment env = *_environment;
 292   env.set_elevation_ft(aPos.getElevationFt());
 293   return env;
 294
 295 }
 296
 297 void
 298 FGEnvironmentMgr::_update_fdm () const
 299 {
 300   //
 301   // Pass atmosphere on to FDM
 302   // FIXME: have FDMs read properties directly.
 303   //
 304   if (fgGetBool("/environment/params/control-fdm-atmosphere")) {
 305                                 // convert from Rankine to Celsius
 306     cur_fdm_state
 307       ->set_Static_temperature((9.0/5.0)
 308                                * (_environment->get_temperature_degc() + 273.15));
 309                                 // convert from inHG to PSF
 310     cur_fdm_state
 311       ->set_Static_pressure(_environment->get_pressure_inhg() * 70.726566);
 312                                 // keep in slugs/ft^3
 313     cur_fdm_state
 314       ->set_Density(_environment->get_density_slugft3());
 315   }
 316 }
 317
 318 double
 319 FGEnvironmentMgr::get_cloud_layer_span_m (int index) const
 320 {
 321   return thesky->get_cloud_layer(index)->getSpan_m();
 322 }
 323
 324 void
 325 FGEnvironmentMgr::set_cloud_layer_span_m (int index, double span_m)
 326 {
 327   thesky->get_cloud_layer(index)->setSpan_m(span_m);
 328 }
 329
 330 double
 331 FGEnvironmentMgr::get_cloud_layer_elevation_ft (int index) const
 332 {
 333   return thesky->get_cloud_layer(index)->getElevation_m() * SG_METER_TO_FEET;
 334 }
 335
 336 void
 337 FGEnvironmentMgr::set_cloud_layer_elevation_ft (int index, double elevation_ft)
 338 {
 339   FGEnvironment env = *_environment;
 340   env.set_elevation_ft(elevation_ft);
 341
 342   thesky->get_cloud_layer(index)
 343     ->setElevation_m(elevation_ft * SG_FEET_TO_METER);
 344
 345   thesky->get_cloud_layer(index)
 346     ->setSpeed(env.get_wind_speed_kt() * 0.5151);       // 1 kt = 0.5151 m/s
 347
 348   thesky->get_cloud_layer(index)
 349     ->setDirection(env.get_wind_from_heading_deg());
 350 }
 351
 352 double
 353 FGEnvironmentMgr::get_cloud_layer_thickness_ft (int index) const
 354 {
 355   return thesky->get_cloud_layer(index)->getThickness_m() * SG_METER_TO_FEET;
 356 }
 357
 358 void
 359 FGEnvironmentMgr::set_cloud_layer_thickness_ft (int index, double thickness_ft)
 360 {
 361   thesky->get_cloud_layer(index)
 362     ->setThickness_m(thickness_ft * SG_FEET_TO_METER);
 363 }
 364
 365 double
 366 FGEnvironmentMgr::get_cloud_layer_transition_ft (int index) const
 367 {
 368   return thesky->get_cloud_layer(index)->getTransition_m() * SG_METER_TO_FEET;
 369 }
 370
 371 void
 372 FGEnvironmentMgr::set_cloud_layer_transition_ft (int index,
 373                                                  double transition_ft)
 374 {
 375   thesky->get_cloud_layer(index)
 376     ->setTransition_m(transition_ft * SG_FEET_TO_METER);
 377 }
 378
 379 const char *
 380 FGEnvironmentMgr::get_cloud_layer_coverage (int index) const
 381 {
 382   switch (thesky->get_cloud_layer(index)->getCoverage()) {
 383   case SGCloudLayer::SG_CLOUD_OVERCAST:
 384     return "overcast";
 385   case SGCloudLayer::SG_CLOUD_BROKEN:
 386     return "broken";
 387   case SGCloudLayer::SG_CLOUD_SCATTERED:
 388     return "scattered";
 389   case SGCloudLayer::SG_CLOUD_FEW:
 390     return "few";
 391   case SGCloudLayer::SG_CLOUD_CIRRUS:
 392     return "cirrus";
 393   case SGCloudLayer::SG_CLOUD_CLEAR:
 394     return "clear";
 395   default:
 396     return "unknown";
 397   }
 398 }
 399
 400 void
 401 FGEnvironmentMgr::set_cloud_layer_coverage (int index,
 402                                             const char * coverage_name)
 403 {
 404   SGCloudLayer::Coverage coverage;
 405   if (!strcmp(coverage_name, "overcast"))
 406     coverage = SGCloudLayer::SG_CLOUD_OVERCAST;
 407   else if (!strcmp(coverage_name, "broken"))
 408     coverage = SGCloudLayer::SG_CLOUD_BROKEN;
 409   else if (!strcmp(coverage_name, "scattered"))
 410     coverage = SGCloudLayer::SG_CLOUD_SCATTERED;
 411   else if (!strcmp(coverage_name, "few"))
 412     coverage = SGCloudLayer::SG_CLOUD_FEW;
 413   else if (!strcmp(coverage_name, "cirrus"))
 414     coverage = SGCloudLayer::SG_CLOUD_CIRRUS;
 415   else if (!strcmp(coverage_name, "clear"))
 416     coverage = SGCloudLayer::SG_CLOUD_CLEAR;
 417   else {
 418     SG_LOG(SG_INPUT, SG_WARN, "Unknown cloud type " << coverage_name);
 419     coverage = SGCloudLayer::SG_CLOUD_CLEAR;
 420   }
 421   thesky->get_cloud_layer(index)->setCoverage(coverage);
 422 }
 423
 424
 425
 426 // end of environment-mgr.cxx