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/clouds3d-vis-range", thesky,
 192         &SGSky::get_3dCloudVisRange,
 193         &SGSky::set_3dCloudVisRange);
 194   fgTie("/sim/rendering/clouds3d-num-flavours", thesky,
 195         &SGSky::get_3dCloudNumFlavours,
 196         &SGSky::set_3dCloudNumFlavours);
 197   fgTie("/sim/rendering/precipitation-enable", &sgEnviro,
 198           &SGEnviro::get_precipitation_enable_state,
 199           &SGEnviro::set_precipitation_enable_state);
 200   fgTie("/environment/rebuild-layers", fgClouds,
 201       &FGClouds::get_update_event,
 202       &FGClouds::set_update_event);
 203   fgTie("/sim/rendering/lightning-enable", &sgEnviro,
 204       &SGEnviro::get_lightning_enable_state,
 205       &SGEnviro::set_lightning_enable_state);
 206   fgTie("/environment/turbulence/use-cloud-turbulence", &sgEnviro,
 207       &SGEnviro::get_turbulence_enable_state,
 208       &SGEnviro::set_turbulence_enable_state);
 209   sgEnviro.config(fgGetNode("/sim/rendering/precipitation"));
 210 }
 211
 212 void
 213 FGEnvironmentMgr::unbind ()
 214 {
 215   fgUntie("/environment/visibility-m");
 216   fgUntie("/environment/effective-visibility-m");
 217   fgUntie("/environment/temperature-sea-level-degc");
 218   fgUntie("/environment/temperature-degc");
 219   fgUntie("/environment/dewpoint-sea-level-degc");
 220   fgUntie("/environment/dewpoint-degc");
 221   fgUntie("/environment/pressure-sea-level-inhg");
 222   fgUntie("/environment/pressure-inhg");
 223   fgUntie("/environment/density-inhg");
 224   fgUntie("/environment/relative-humidity");
 225   fgUntie("/environment/atmosphere/density-tropo-avg");
 226   fgUntie("/environment/wind-from-north-fps");
 227   fgUntie("/environment/wind-from-east-fps");
 228   fgUntie("/environment/wind-from-down-fps");
 229   fgUntie("/environment/atmosphere/altitude-half-to-sun");
 230   fgUntie("/environment/atmosphere/altitude-troposphere-top");
 231   for (int i = 0; i < MAX_CLOUD_LAYERS; i++) {
 232     char buf[128];
 233     sprintf(buf, "/environment/clouds/layer[%d]/span-m", i);
 234     fgUntie(buf);
 235     sprintf(buf, "/environment/clouds/layer[%d]/elevation-ft", i);
 236     fgUntie(buf);
 237     sprintf(buf, "/environment/clouds/layer[%d]/thickness-ft", i);
 238     fgUntie(buf);
 239     sprintf(buf, "/environment/clouds/layer[%d]/transition-ft", i);
 240     fgUntie(buf);
 241     sprintf(buf, "/environment/clouds/layer[%d]/type", i);
 242     fgUntie(buf);
 243   }
 244   fgUntie("/sim/rendering/clouds3d-enable");
 245   fgUntie("/sim/rendering/clouds3d-vis-range");
 246   fgUntie("/sim/rendering/clouds3d-density");
 247   fgUntie("/sim/rendering/clouds3d-num-flavours");
 248   fgUntie("/sim/rendering/precipitation-enable");
 249   fgUntie("/environment/rebuild-layers");
 250   fgUntie("/sim/rendering/lightning-enable");
 251   fgUntie("/environment/turbulence/use-cloud-turbulence");
 252 }
 253
 254 void
 255 FGEnvironmentMgr::update (double dt)
 256 {
 257   SGSubsystemGroup::update(dt);
 258
 259                                 // FIXME: the FDMs should update themselves
 260   current_aircraft.fdm_state
 261     ->set_Velocities_Local_Airmass(_environment->get_wind_from_north_fps(),
 262                                    _environment->get_wind_from_east_fps(),
 263                                    _environment->get_wind_from_down_fps());
 264   _environment->set_elevation_ft(fgGetDouble("/position/altitude-ft"));
 265   osg::Vec3 windVec(-_environment->get_wind_from_north_fps(),
 266                     -_environment->get_wind_from_east_fps(),
 267                     _environment->get_wind_from_down_fps());
 268   simgear::Particles::setWindVector(windVec * SG_FEET_TO_METER);
 269
 270   _update_fdm();
 271 }
 272
 273 FGEnvironment
 274 FGEnvironmentMgr::getEnvironment () const
 275 {
 276   return *_environment;
 277 }
 278
 279 FGEnvironment
 280 FGEnvironmentMgr::getEnvironment (double lat, double lon, double alt) const
 281 {
 282                                 // Always returns the same environment
 283                                 // for now; we'll make it interesting
 284                                 // later.
 285   FGEnvironment env = *_environment;
 286   env.set_elevation_ft(alt);
 287   return env;
 288 }
 289
 290 FGEnvironment
 291 FGEnvironmentMgr::getEnvironment(const SGGeod& aPos) const
 292 {
 293   // Always returns the same environment
 294   // for now; we'll make it interesting
 295   // later.
 296   FGEnvironment env = *_environment;
 297   env.set_elevation_ft(aPos.getElevationFt());
 298   return env;
 299
 300 }
 301
 302 void
 303 FGEnvironmentMgr::_update_fdm () const
 304 {
 305   //
 306   // Pass atmosphere on to FDM
 307   // FIXME: have FDMs read properties directly.
 308   //
 309   if (fgGetBool("/environment/params/control-fdm-atmosphere")) {
 310                                 // convert from Rankine to Celsius
 311     cur_fdm_state
 312       ->set_Static_temperature((9.0/5.0)
 313                                * (_environment->get_temperature_degc() + 273.15));
 314                                 // convert from inHG to PSF
 315     cur_fdm_state
 316       ->set_Static_pressure(_environment->get_pressure_inhg() * 70.726566);
 317                                 // keep in slugs/ft^3
 318     cur_fdm_state
 319       ->set_Density(_environment->get_density_slugft3());
 320   }
 321 }
 322
 323 double
 324 FGEnvironmentMgr::get_cloud_layer_span_m (int index) const
 325 {
 326   return thesky->get_cloud_layer(index)->getSpan_m();
 327 }
 328
 329 void
 330 FGEnvironmentMgr::set_cloud_layer_span_m (int index, double span_m)
 331 {
 332   thesky->get_cloud_layer(index)->setSpan_m(span_m);
 333 }
 334
 335 double
 336 FGEnvironmentMgr::get_cloud_layer_elevation_ft (int index) const
 337 {
 338   return thesky->get_cloud_layer(index)->getElevation_m() * SG_METER_TO_FEET;
 339 }
 340
 341 void
 342 FGEnvironmentMgr::set_cloud_layer_elevation_ft (int index, double elevation_ft)
 343 {
 344   FGEnvironment env = *_environment;
 345   env.set_elevation_ft(elevation_ft);
 346
 347   thesky->get_cloud_layer(index)
 348     ->setElevation_m(elevation_ft * SG_FEET_TO_METER);
 349
 350   thesky->get_cloud_layer(index)
 351     ->setSpeed(env.get_wind_speed_kt() * 0.5151);       // 1 kt = 0.5151 m/s
 352
 353   thesky->get_cloud_layer(index)
 354     ->setDirection(env.get_wind_from_heading_deg());
 355 }
 356
 357 double
 358 FGEnvironmentMgr::get_cloud_layer_thickness_ft (int index) const
 359 {
 360   return thesky->get_cloud_layer(index)->getThickness_m() * SG_METER_TO_FEET;
 361 }
 362
 363 void
 364 FGEnvironmentMgr::set_cloud_layer_thickness_ft (int index, double thickness_ft)
 365 {
 366   thesky->get_cloud_layer(index)
 367     ->setThickness_m(thickness_ft * SG_FEET_TO_METER);
 368 }
 369
 370 double
 371 FGEnvironmentMgr::get_cloud_layer_transition_ft (int index) const
 372 {
 373   return thesky->get_cloud_layer(index)->getTransition_m() * SG_METER_TO_FEET;
 374 }
 375
 376 void
 377 FGEnvironmentMgr::set_cloud_layer_transition_ft (int index,
 378                                                  double transition_ft)
 379 {
 380   thesky->get_cloud_layer(index)
 381     ->setTransition_m(transition_ft * SG_FEET_TO_METER);
 382 }
 383
 384 const char *
 385 FGEnvironmentMgr::get_cloud_layer_coverage (int index) const
 386 {
 387   switch (thesky->get_cloud_layer(index)->getCoverage()) {
 388   case SGCloudLayer::SG_CLOUD_OVERCAST:
 389     return "overcast";
 390   case SGCloudLayer::SG_CLOUD_BROKEN:
 391     return "broken";
 392   case SGCloudLayer::SG_CLOUD_SCATTERED:
 393     return "scattered";
 394   case SGCloudLayer::SG_CLOUD_FEW:
 395     return "few";
 396   case SGCloudLayer::SG_CLOUD_CIRRUS:
 397     return "cirrus";
 398   case SGCloudLayer::SG_CLOUD_CLEAR:
 399     return "clear";
 400   default:
 401     return "unknown";
 402   }
 403 }
 404
 405 void
 406 FGEnvironmentMgr::set_cloud_layer_coverage (int index,
 407                                             const char * coverage_name)
 408 {
 409   SGCloudLayer::Coverage coverage;
 410   if (!strcmp(coverage_name, "overcast"))
 411     coverage = SGCloudLayer::SG_CLOUD_OVERCAST;
 412   else if (!strcmp(coverage_name, "broken"))
 413     coverage = SGCloudLayer::SG_CLOUD_BROKEN;
 414   else if (!strcmp(coverage_name, "scattered"))
 415     coverage = SGCloudLayer::SG_CLOUD_SCATTERED;
 416   else if (!strcmp(coverage_name, "few"))
 417     coverage = SGCloudLayer::SG_CLOUD_FEW;
 418   else if (!strcmp(coverage_name, "cirrus"))
 419     coverage = SGCloudLayer::SG_CLOUD_CIRRUS;
 420   else if (!strcmp(coverage_name, "clear"))
 421     coverage = SGCloudLayer::SG_CLOUD_CLEAR;
 422   else {
 423     SG_LOG(SG_INPUT, SG_WARN, "Unknown cloud type " << coverage_name);
 424     coverage = SGCloudLayer::SG_CLOUD_CLEAR;
 425   }
 426   thesky->get_cloud_layer(index)->setCoverage(coverage);
 427 }
 428
 429
 430
 431 // end of environment-mgr.cxx