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 #ifdef HAVE_CONFIG_H
  22 #  include <config.h>
  23 #endif
  24
  25 #include <cstring>
  26
  27 #include <simgear/constants.h>
  28 #include <simgear/debug/logstream.hxx>
  29 #include <simgear/scene/sky/sky.hxx>
  30 #include <simgear/scene/model/particles.hxx>
  31 #include <simgear/structure/event_mgr.hxx>
  32
  33 #include <Main/main.hxx>
  34 #include <Main/fg_props.hxx>
  35 #include <Viewer/renderer.hxx>
  36 #include <FDM/flight.hxx>
  37
  38 #include "environment.hxx"
  39 #include "environment_mgr.hxx"
  40 #include "environment_ctrl.hxx"
  41 #include "realwx_ctrl.hxx"
  42 #include "fgclouds.hxx"
  43 #include "precipitation_mgr.hxx"
  44 #include "ridge_lift.hxx"
  45 #include "terrainsampler.hxx"
  46 #include "Airports/simple.hxx"
  47 #include "gravity.hxx"
  48 #include "magvarmanager.hxx"
  49
  50 class FG3DCloudsListener : public SGPropertyChangeListener {
  51 public:
  52   FG3DCloudsListener( FGClouds * fgClouds );
  53   virtual ~FG3DCloudsListener();
  54
  55   virtual void valueChanged (SGPropertyNode * node);
  56
  57 private:
  58   FGClouds * _fgClouds;
  59   SGPropertyNode_ptr _enableNode;
  60 };
  61
  62 FG3DCloudsListener::FG3DCloudsListener( FGClouds * fgClouds ) :
  63     _fgClouds( fgClouds )
  64 {
  65   _enableNode = fgGetNode( "/sim/rendering/clouds3d-enable", true );
  66   _enableNode->addChangeListener( this );
  67
  68   valueChanged( _enableNode );
  69 }
  70
  71 FG3DCloudsListener::~FG3DCloudsListener()
  72 {
  73   _enableNode->removeChangeListener( this );
  74 }
  75
  76 void FG3DCloudsListener::valueChanged( SGPropertyNode * node )
  77 {
  78   _fgClouds->set_3dClouds( _enableNode->getBoolValue() );
  79 }
  80
  81 FGEnvironmentMgr::FGEnvironmentMgr () :
  82   _environment(new FGEnvironment()),
  83   fgClouds(new FGClouds()),
  84   _cloudLayersDirty(true),
  85   _altitude_n(fgGetNode("/position/altitude-ft", true)),
  86   _longitude_n(fgGetNode( "/position/longitude-deg", true )),
  87   _latitude_n( fgGetNode( "/position/latitude-deg", true )),
  88   _3dCloudsEnableListener(new FG3DCloudsListener(fgClouds) ),
  89   _sky(globals->get_renderer()->getSky())
  90 {
  91   set_subsystem("controller", Environment::LayerInterpolateController::createInstance( fgGetNode("/environment/config", true ) ));
  92   set_subsystem("realwx", Environment::RealWxController::createInstance( fgGetNode("/environment/realwx", true ) ), 1.0 );
  93
  94   set_subsystem("precipitation", new FGPrecipitationMgr);
  95   set_subsystem("terrainsampler", Environment::TerrainSampler::createInstance( fgGetNode("/environment/terrain", true ) ));
  96   set_subsystem("ridgelift", new FGRidgeLift);
  97
  98   set_subsystem("magvar", new FGMagVarManager);
  99 }
 100
 101 FGEnvironmentMgr::~FGEnvironmentMgr ()
 102 {
 103   SGSubsystem * subsys;
 104
 105   subsys = get_subsystem( "ridgelift" );
 106   remove_subsystem( "ridgelift" );
 107   delete subsys;
 108
 109   subsys = get_subsystem( "terrainsampler" );
 110   remove_subsystem( "terrainsampler" );
 111   delete subsys;
 112
 113   subsys = get_subsystem( "precipitation" );
 114   remove_subsystem("precipitation");
 115   delete subsys;
 116
 117   subsys = get_subsystem("realwx");
 118   remove_subsystem("realwx");
 119   delete subsys;
 120
 121   subsys = get_subsystem("controller");
 122   remove_subsystem("controller");
 123   delete subsys;
 124
 125   subsys = get_subsystem("magvar");
 126   remove_subsystem("magvar");
 127   delete subsys;
 128
 129   delete fgClouds;
 130   delete _environment;
 131
 132   delete _3dCloudsEnableListener;
 133 }
 134
 135 SGSubsystem::InitStatus FGEnvironmentMgr::incrementalInit()
 136 {
 137
 138   InitStatus r = SGSubsystemGroup::incrementalInit();
 139   if (r == INIT_DONE) {
 140     fgClouds->Init();
 141
 142     // FIXME: is this really part of the environment_mgr?
 143     // Initialize the longitude, latitude and altitude to the initial position
 144     // of the aircraft so that the atmospheric properties (pressure, temperature
 145     // and density) can be initialized accordingly.
 146     _altitude_n->setDoubleValue(fgGetDouble("/sim/presets/altitude-ft"));
 147     _longitude_n->setDoubleValue(fgGetDouble("/sim/presets/longitude-deg"));
 148     _latitude_n->setDoubleValue(fgGetDouble("/sim/presets/latitude-deg"));
 149
 150     globals->get_event_mgr()->addTask("updateClosestAirport", this,
 151                                       &FGEnvironmentMgr::updateClosestAirport, 30 );
 152   }
 153
 154   return r;
 155 }
 156
 157 void
 158 FGEnvironmentMgr::shutdown()
 159 {
 160   globals->get_event_mgr()->removeTask("updateClosestAirport");
 161   SGSubsystemGroup::shutdown();
 162 }
 163
 164 void
 165 FGEnvironmentMgr::reinit ()
 166 {
 167   SG_LOG( SG_ENVIRONMENT, SG_INFO, "Reinitializing environment subsystem");
 168   SGSubsystemGroup::reinit();
 169 }
 170
 171 void
 172 FGEnvironmentMgr::bind ()
 173 {
 174   SGSubsystemGroup::bind();
 175   _environment->Tie( fgGetNode("/environment", true ) );
 176
 177   _tiedProperties.setRoot( fgGetNode( "/environment", true ) );
 178
 179   _tiedProperties.Tie( "effective-visibility-m", _sky,
 180           &SGSky::get_visibility );
 181
 182   _tiedProperties.Tie("rebuild-layers", fgClouds,
 183           &FGClouds::get_update_event,
 184           &FGClouds::set_update_event);
 185
 186 //  _tiedProperties.Tie("turbulence/use-cloud-turbulence", &sgEnviro,
 187 //          &SGEnviro::get_turbulence_enable_state,
 188 //          &SGEnviro::set_turbulence_enable_state);
 189
 190   for (int i = 0; i < MAX_CLOUD_LAYERS; i++) {
 191       SGPropertyNode_ptr layerNode = fgGetNode("/environment/clouds",true)->getChild("layer", i, true );
 192
 193       _tiedProperties.Tie( layerNode->getNode("span-m",true), this, i,
 194               &FGEnvironmentMgr::get_cloud_layer_span_m,
 195               &FGEnvironmentMgr::set_cloud_layer_span_m);
 196
 197       _tiedProperties.Tie( layerNode->getNode("elevation-ft",true), this, i,
 198               &FGEnvironmentMgr::get_cloud_layer_elevation_ft,
 199               &FGEnvironmentMgr::set_cloud_layer_elevation_ft);
 200
 201       _tiedProperties.Tie( layerNode->getNode("thickness-ft",true), this, i,
 202               &FGEnvironmentMgr::get_cloud_layer_thickness_ft,
 203               &FGEnvironmentMgr::set_cloud_layer_thickness_ft);
 204
 205       _tiedProperties.Tie( layerNode->getNode("transition-ft",true), this, i,
 206               &FGEnvironmentMgr::get_cloud_layer_transition_ft,
 207               &FGEnvironmentMgr::set_cloud_layer_transition_ft);
 208
 209       _tiedProperties.Tie( layerNode->getNode("coverage",true), this, i,
 210               &FGEnvironmentMgr::get_cloud_layer_coverage,
 211               &FGEnvironmentMgr::set_cloud_layer_coverage);
 212
 213       _tiedProperties.Tie( layerNode->getNode("coverage-type",true), this, i,
 214               &FGEnvironmentMgr::get_cloud_layer_coverage_type,
 215               &FGEnvironmentMgr::set_cloud_layer_coverage_type);
 216
 217       _tiedProperties.Tie( layerNode->getNode( "visibility-m",true), this, i,
 218               &FGEnvironmentMgr::get_cloud_layer_visibility_m,
 219               &FGEnvironmentMgr::set_cloud_layer_visibility_m);
 220
 221       _tiedProperties.Tie( layerNode->getNode( "alpha",true), this, i,
 222               &FGEnvironmentMgr::get_cloud_layer_maxalpha,
 223               &FGEnvironmentMgr::set_cloud_layer_maxalpha);
 224   }
 225
 226   _tiedProperties.setRoot( fgGetNode("/sim/rendering", true ) );
 227
 228   _tiedProperties.Tie( "clouds3d-density", _sky,
 229           &SGSky::get_3dCloudDensity,
 230           &SGSky::set_3dCloudDensity);
 231
 232   _tiedProperties.Tie("clouds3d-vis-range", _sky,
 233           &SGSky::get_3dCloudVisRange,
 234           &SGSky::set_3dCloudVisRange);
 235
 236   _tiedProperties.Tie("clouds3d-impostor-range", _sky,
 237           &SGSky::get_3dCloudImpostorDistance,
 238           &SGSky::set_3dCloudImpostorDistance);
 239
 240   _tiedProperties.Tie("clouds3d-lod1-range", _sky,
 241           &SGSky::get_3dCloudLoD1Range,
 242           &SGSky::set_3dCloudLoD1Range);
 243
 244   _tiedProperties.Tie("clouds3d-lod2-range", _sky,
 245           &SGSky::get_3dCloudLoD2Range,
 246           &SGSky::set_3dCloudLoD2Range);
 247
 248   _tiedProperties.Tie("clouds3d-wrap", _sky,
 249           &SGSky::get_3dCloudWrap,
 250           &SGSky::set_3dCloudWrap);
 251
 252   _tiedProperties.Tie("clouds3d-use-impostors", _sky,
 253           &SGSky::get_3dCloudUseImpostors,
 254           &SGSky::set_3dCloudUseImpostors);
 255
 256   _tiedProperties.Tie("minimum-sky-visibility", _sky,
 257           &SGSky::get_minimum_sky_visibility,
 258           &SGSky::set_minimum_sky_visibility);
 259
 260 //  _tiedProperties.Tie("lightning-enable", &sgEnviro,
 261 //          &SGEnviro::get_lightning_enable_state,
 262 //          &SGEnviro::set_lightning_enable_state);
 263
 264 }
 265
 266 void
 267 FGEnvironmentMgr::unbind ()
 268 {
 269   _tiedProperties.Untie();
 270   _environment->Untie();
 271   SGSubsystemGroup::unbind();
 272 }
 273
 274 void
 275 FGEnvironmentMgr::update (double dt)
 276 {
 277   SGSubsystemGroup::update(dt);
 278
 279   _environment->set_elevation_ft( _altitude_n->getDoubleValue() );
 280
 281   simgear::Particles::setWindFrom( _environment->get_wind_from_heading_deg(),
 282                                    _environment->get_wind_speed_kt() );
 283   if( _cloudLayersDirty ) {
 284     _cloudLayersDirty = false;
 285     fgClouds->set_update_event( fgClouds->get_update_event()+1 );
 286   }
 287
 288
 289   fgSetDouble( "/environment/gravitational-acceleration-mps2",
 290     Environment::Gravity::instance()->getGravity(SGGeod::fromDegFt(
 291       _longitude_n->getDoubleValue(),
 292       _latitude_n->getDoubleValue(),
 293       _altitude_n->getDoubleValue()
 294   )));
 295 }
 296
 297 void
 298 FGEnvironmentMgr::updateClosestAirport()
 299 {
 300   SG_LOG(SG_ENVIRONMENT, SG_DEBUG, "FGEnvironmentMgr::update: updating closest airport");
 301
 302   SGGeod pos = globals->get_aircraft_position();
 303   FGAirport * nearestAirport = FGAirport::findClosest(pos, 100.0);
 304   if( nearestAirport == NULL )
 305   {
 306     SG_LOG(SG_ENVIRONMENT,SG_WARN,"FGEnvironmentMgr::update: No airport within 100NM range");
 307   }
 308   else
 309   {
 310     const string currentId = fgGetString("/sim/airport/closest-airport-id", "");
 311     if (currentId != nearestAirport->ident())
 312     {
 313       SG_LOG(SG_ENVIRONMENT, SG_INFO, "FGEnvironmentMgr::updateClosestAirport: selected:" << nearestAirport->ident());
 314       fgSetString("/sim/airport/closest-airport-id",
 315                   nearestAirport->ident().c_str());
 316     }
 317   }
 318
 319 }
 320
 321 FGEnvironment
 322 FGEnvironmentMgr::getEnvironment () const
 323 {
 324   return *_environment;
 325 }
 326
 327 FGEnvironment
 328 FGEnvironmentMgr::getEnvironment (double lat, double lon, double alt) const
 329 {
 330   // Always returns the same environment
 331   // for now; we'll make it interesting
 332   // later.
 333   FGEnvironment env = *_environment;
 334   env.set_elevation_ft(alt);
 335   return env;
 336 }
 337
 338 FGEnvironment
 339 FGEnvironmentMgr::getEnvironment(const SGGeod& aPos) const
 340 {
 341   // Always returns the same environment
 342   // for now; we'll make it interesting
 343   // later.
 344   FGEnvironment env = *_environment;
 345   env.set_elevation_ft(aPos.getElevationFt());
 346   return env;
 347
 348 }
 349
 350 double
 351 FGEnvironmentMgr::get_cloud_layer_span_m (int index) const
 352 {
 353   return _sky->get_cloud_layer(index)->getSpan_m();
 354 }
 355
 356 void
 357 FGEnvironmentMgr::set_cloud_layer_span_m (int index, double span_m)
 358 {
 359   _sky->get_cloud_layer(index)->setSpan_m(span_m);
 360 }
 361
 362 double
 363 FGEnvironmentMgr::get_cloud_layer_elevation_ft (int index) const
 364 {
 365   return _sky->get_cloud_layer(index)->getElevation_m() * SG_METER_TO_FEET;
 366 }
 367
 368 void
 369 FGEnvironmentMgr::set_cloud_layer_elevation_ft (int index, double elevation_ft)
 370 {
 371   FGEnvironment env = *_environment;
 372   env.set_elevation_ft(elevation_ft);
 373
 374   _sky->get_cloud_layer(index)
 375     ->setElevation_m(elevation_ft * SG_FEET_TO_METER);
 376
 377   _sky->get_cloud_layer(index)
 378     ->setSpeed(env.get_wind_speed_kt() * 0.5151);       // 1 kt = 0.5151 m/s
 379
 380   _sky->get_cloud_layer(index)
 381     ->setDirection(env.get_wind_from_heading_deg());
 382 }
 383
 384 double
 385 FGEnvironmentMgr::get_cloud_layer_thickness_ft (int index) const
 386 {
 387   return _sky->get_cloud_layer(index)->getThickness_m() * SG_METER_TO_FEET;
 388 }
 389
 390 void
 391 FGEnvironmentMgr::set_cloud_layer_thickness_ft (int index, double thickness_ft)
 392 {
 393   _sky->get_cloud_layer(index)
 394     ->setThickness_m(thickness_ft * SG_FEET_TO_METER);
 395 }
 396
 397 double
 398 FGEnvironmentMgr::get_cloud_layer_transition_ft (int index) const
 399 {
 400   return _sky->get_cloud_layer(index)->getTransition_m() * SG_METER_TO_FEET;
 401 }
 402
 403 void
 404 FGEnvironmentMgr::set_cloud_layer_transition_ft (int index,
 405                                                  double transition_ft)
 406 {
 407   _sky->get_cloud_layer(index)
 408     ->setTransition_m(transition_ft * SG_FEET_TO_METER);
 409 }
 410
 411 const char *
 412 FGEnvironmentMgr::get_cloud_layer_coverage (int index) const
 413 {
 414   return _sky->get_cloud_layer(index)->getCoverageString().c_str();
 415 }
 416
 417 void
 418 FGEnvironmentMgr::set_cloud_layer_coverage (int index,
 419                                             const char * coverage_name)
 420 {
 421   if( _sky->get_cloud_layer(index)->getCoverageString() == coverage_name )
 422     return;
 423
 424   _sky->get_cloud_layer(index)->setCoverageString(coverage_name);
 425   _cloudLayersDirty = true;
 426 }
 427
 428 int
 429 FGEnvironmentMgr::get_cloud_layer_coverage_type (int index) const
 430 {
 431   return _sky->get_cloud_layer(index)->getCoverage();
 432 }
 433
 434 double
 435 FGEnvironmentMgr::get_cloud_layer_visibility_m (int index) const
 436 {
 437     return _sky->get_cloud_layer(index)->getVisibility_m();
 438 }
 439
 440 void
 441 FGEnvironmentMgr::set_cloud_layer_visibility_m (int index, double visibility_m)
 442 {
 443     _sky->get_cloud_layer(index)->setVisibility_m(visibility_m);
 444 }
 445
 446 double
 447 FGEnvironmentMgr::get_cloud_layer_maxalpha (int index ) const
 448 {
 449     return _sky->get_cloud_layer(index)->getMaxAlpha();
 450 }
 451
 452 void
 453 FGEnvironmentMgr::set_cloud_layer_maxalpha (int index, double maxalpha)
 454 {
 455     _sky->get_cloud_layer(index)->setMaxAlpha(maxalpha);
 456 }
 457
 458 void
 459 FGEnvironmentMgr::set_cloud_layer_coverage_type (int index, int type )
 460 {
 461   if( type < 0 || type >= SGCloudLayer::SG_MAX_CLOUD_COVERAGES ) {
 462     SG_LOG(SG_ENVIRONMENT,SG_WARN,"Unknown cloud layer type " << type << " ignored" );
 463     return;
 464   }
 465
 466   if( static_cast<SGCloudLayer::Coverage>(type) == _sky->get_cloud_layer(index)->getCoverage() )
 467     return;
 468
 469   _sky->get_cloud_layer(index)->setCoverage(static_cast<SGCloudLayer::Coverage>(type));
 470   _cloudLayersDirty = true;
 471 }
 472
 473
 474 // end of environment-mgr.cxx