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 void
 136 FGEnvironmentMgr::init ()
 137 {
 138   SG_LOG( SG_ENVIRONMENT, SG_INFO, "Initializing environment subsystem");
 139   SGSubsystemGroup::init();
 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 void
 155 FGEnvironmentMgr::shutdown()
 156 {
 157   globals->get_event_mgr()->removeTask("updateClosestAirport");
 158 }
 159
 160 void
 161 FGEnvironmentMgr::reinit ()
 162 {
 163   SG_LOG( SG_ENVIRONMENT, SG_INFO, "Reinitializing environment subsystem");
 164   SGSubsystemGroup::reinit();
 165 }
 166
 167 void
 168 FGEnvironmentMgr::bind ()
 169 {
 170   SGSubsystemGroup::bind();
 171   _environment->Tie( fgGetNode("/environment", true ) );
 172
 173   _tiedProperties.setRoot( fgGetNode( "/environment", true ) );
 174
 175   _tiedProperties.Tie( "effective-visibility-m", _sky,
 176           &SGSky::get_visibility );
 177
 178   _tiedProperties.Tie("rebuild-layers", fgClouds,
 179           &FGClouds::get_update_event,
 180           &FGClouds::set_update_event);
 181
 182 //  _tiedProperties.Tie("turbulence/use-cloud-turbulence", &sgEnviro,
 183 //          &SGEnviro::get_turbulence_enable_state,
 184 //          &SGEnviro::set_turbulence_enable_state);
 185
 186   for (int i = 0; i < MAX_CLOUD_LAYERS; i++) {
 187       SGPropertyNode_ptr layerNode = fgGetNode("/environment/clouds",true)->getChild("layer", i, true );
 188
 189       _tiedProperties.Tie( layerNode->getNode("span-m",true), this, i,
 190               &FGEnvironmentMgr::get_cloud_layer_span_m,
 191               &FGEnvironmentMgr::set_cloud_layer_span_m);
 192
 193       _tiedProperties.Tie( layerNode->getNode("elevation-ft",true), this, i,
 194               &FGEnvironmentMgr::get_cloud_layer_elevation_ft,
 195               &FGEnvironmentMgr::set_cloud_layer_elevation_ft);
 196
 197       _tiedProperties.Tie( layerNode->getNode("thickness-ft",true), this, i,
 198               &FGEnvironmentMgr::get_cloud_layer_thickness_ft,
 199               &FGEnvironmentMgr::set_cloud_layer_thickness_ft);
 200
 201       _tiedProperties.Tie( layerNode->getNode("transition-ft",true), this, i,
 202               &FGEnvironmentMgr::get_cloud_layer_transition_ft,
 203               &FGEnvironmentMgr::set_cloud_layer_transition_ft);
 204
 205       _tiedProperties.Tie( layerNode->getNode("coverage",true), this, i,
 206               &FGEnvironmentMgr::get_cloud_layer_coverage,
 207               &FGEnvironmentMgr::set_cloud_layer_coverage);
 208
 209       _tiedProperties.Tie( layerNode->getNode("coverage-type",true), this, i,
 210               &FGEnvironmentMgr::get_cloud_layer_coverage_type,
 211               &FGEnvironmentMgr::set_cloud_layer_coverage_type);
 212
 213       _tiedProperties.Tie( layerNode->getNode( "visibility-m",true), this, i,
 214               &FGEnvironmentMgr::get_cloud_layer_visibility_m,
 215               &FGEnvironmentMgr::set_cloud_layer_visibility_m);
 216
 217       _tiedProperties.Tie( layerNode->getNode( "alpha",true), this, i,
 218               &FGEnvironmentMgr::get_cloud_layer_maxalpha,
 219               &FGEnvironmentMgr::set_cloud_layer_maxalpha);
 220   }
 221
 222   _tiedProperties.setRoot( fgGetNode("/sim/rendering", true ) );
 223
 224   _tiedProperties.Tie( "clouds3d-density", _sky,
 225           &SGSky::get_3dCloudDensity,
 226           &SGSky::set_3dCloudDensity);
 227
 228   _tiedProperties.Tie("clouds3d-vis-range", _sky,
 229           &SGSky::get_3dCloudVisRange,
 230           &SGSky::set_3dCloudVisRange);
 231
 232   _tiedProperties.Tie("clouds3d-impostor-range", _sky,
 233           &SGSky::get_3dCloudImpostorDistance,
 234           &SGSky::set_3dCloudImpostorDistance);
 235
 236   _tiedProperties.Tie("clouds3d-lod1-range", _sky,
 237           &SGSky::get_3dCloudLoD1Range,
 238           &SGSky::set_3dCloudLoD1Range);
 239
 240   _tiedProperties.Tie("clouds3d-lod2-range", _sky,
 241           &SGSky::get_3dCloudLoD2Range,
 242           &SGSky::set_3dCloudLoD2Range);
 243
 244   _tiedProperties.Tie("clouds3d-wrap", _sky,
 245           &SGSky::get_3dCloudWrap,
 246           &SGSky::set_3dCloudWrap);
 247
 248   _tiedProperties.Tie("clouds3d-use-impostors", _sky,
 249           &SGSky::get_3dCloudUseImpostors,
 250           &SGSky::set_3dCloudUseImpostors);
 251
 252   _tiedProperties.Tie("minimum-sky-visibility", _sky,
 253           &SGSky::get_minimum_sky_visibility,
 254           &SGSky::set_minimum_sky_visibility);
 255
 256 //  _tiedProperties.Tie("lightning-enable", &sgEnviro,
 257 //          &SGEnviro::get_lightning_enable_state,
 258 //          &SGEnviro::set_lightning_enable_state);
 259
 260 }
 261
 262 void
 263 FGEnvironmentMgr::unbind ()
 264 {
 265   _tiedProperties.Untie();
 266   _environment->Untie();
 267   SGSubsystemGroup::unbind();
 268 }
 269
 270 void
 271 FGEnvironmentMgr::update (double dt)
 272 {
 273   SGSubsystemGroup::update(dt);
 274
 275   _environment->set_elevation_ft( _altitude_n->getDoubleValue() );
 276
 277   simgear::Particles::setWindFrom( _environment->get_wind_from_heading_deg(),
 278                                    _environment->get_wind_speed_kt() );
 279   if( _cloudLayersDirty ) {
 280     _cloudLayersDirty = false;
 281     fgClouds->set_update_event( fgClouds->get_update_event()+1 );
 282   }
 283
 284
 285   fgSetDouble( "/environment/gravitational-acceleration-mps2",
 286     Environment::Gravity::instance()->getGravity(SGGeod::fromDegFt(
 287       _longitude_n->getDoubleValue(),
 288       _latitude_n->getDoubleValue(),
 289       _altitude_n->getDoubleValue()
 290   )));
 291 }
 292
 293 void
 294 FGEnvironmentMgr::updateClosestAirport()
 295 {
 296   SG_LOG(SG_ENVIRONMENT, SG_DEBUG, "FGEnvironmentMgr::update: updating closest airport");
 297
 298   SGGeod pos = globals->get_aircraft_position();
 299   FGAirport * nearestAirport = FGAirport::findClosest(pos, 100.0);
 300   if( nearestAirport == NULL )
 301   {
 302     SG_LOG(SG_ENVIRONMENT,SG_WARN,"FGEnvironmentMgr::update: No airport within 100NM range");
 303   }
 304   else
 305   {
 306     const string currentId = fgGetString("/sim/airport/closest-airport-id", "");
 307     if (currentId != nearestAirport->ident())
 308     {
 309       SG_LOG(SG_ENVIRONMENT, SG_INFO, "FGEnvironmentMgr::updateClosestAirport: selected:" << nearestAirport->ident());
 310       fgSetString("/sim/airport/closest-airport-id",
 311                   nearestAirport->ident().c_str());
 312     }
 313   }
 314
 315 }
 316
 317 FGEnvironment
 318 FGEnvironmentMgr::getEnvironment () const
 319 {
 320   return *_environment;
 321 }
 322
 323 FGEnvironment
 324 FGEnvironmentMgr::getEnvironment (double lat, double lon, double alt) const
 325 {
 326   // Always returns the same environment
 327   // for now; we'll make it interesting
 328   // later.
 329   FGEnvironment env = *_environment;
 330   env.set_elevation_ft(alt);
 331   return env;
 332 }
 333
 334 FGEnvironment
 335 FGEnvironmentMgr::getEnvironment(const SGGeod& aPos) const
 336 {
 337   // Always returns the same environment
 338   // for now; we'll make it interesting
 339   // later.
 340   FGEnvironment env = *_environment;
 341   env.set_elevation_ft(aPos.getElevationFt());
 342   return env;
 343
 344 }
 345
 346 double
 347 FGEnvironmentMgr::get_cloud_layer_span_m (int index) const
 348 {
 349   return _sky->get_cloud_layer(index)->getSpan_m();
 350 }
 351
 352 void
 353 FGEnvironmentMgr::set_cloud_layer_span_m (int index, double span_m)
 354 {
 355   _sky->get_cloud_layer(index)->setSpan_m(span_m);
 356 }
 357
 358 double
 359 FGEnvironmentMgr::get_cloud_layer_elevation_ft (int index) const
 360 {
 361   return _sky->get_cloud_layer(index)->getElevation_m() * SG_METER_TO_FEET;
 362 }
 363
 364 void
 365 FGEnvironmentMgr::set_cloud_layer_elevation_ft (int index, double elevation_ft)
 366 {
 367   FGEnvironment env = *_environment;
 368   env.set_elevation_ft(elevation_ft);
 369
 370   _sky->get_cloud_layer(index)
 371     ->setElevation_m(elevation_ft * SG_FEET_TO_METER);
 372
 373   _sky->get_cloud_layer(index)
 374     ->setSpeed(env.get_wind_speed_kt() * 0.5151);       // 1 kt = 0.5151 m/s
 375
 376   _sky->get_cloud_layer(index)
 377     ->setDirection(env.get_wind_from_heading_deg());
 378 }
 379
 380 double
 381 FGEnvironmentMgr::get_cloud_layer_thickness_ft (int index) const
 382 {
 383   return _sky->get_cloud_layer(index)->getThickness_m() * SG_METER_TO_FEET;
 384 }
 385
 386 void
 387 FGEnvironmentMgr::set_cloud_layer_thickness_ft (int index, double thickness_ft)
 388 {
 389   _sky->get_cloud_layer(index)
 390     ->setThickness_m(thickness_ft * SG_FEET_TO_METER);
 391 }
 392
 393 double
 394 FGEnvironmentMgr::get_cloud_layer_transition_ft (int index) const
 395 {
 396   return _sky->get_cloud_layer(index)->getTransition_m() * SG_METER_TO_FEET;
 397 }
 398
 399 void
 400 FGEnvironmentMgr::set_cloud_layer_transition_ft (int index,
 401                                                  double transition_ft)
 402 {
 403   _sky->get_cloud_layer(index)
 404     ->setTransition_m(transition_ft * SG_FEET_TO_METER);
 405 }
 406
 407 const char *
 408 FGEnvironmentMgr::get_cloud_layer_coverage (int index) const
 409 {
 410   return _sky->get_cloud_layer(index)->getCoverageString().c_str();
 411 }
 412
 413 void
 414 FGEnvironmentMgr::set_cloud_layer_coverage (int index,
 415                                             const char * coverage_name)
 416 {
 417   if( _sky->get_cloud_layer(index)->getCoverageString() == coverage_name )
 418     return;
 419
 420   _sky->get_cloud_layer(index)->setCoverageString(coverage_name);
 421   _cloudLayersDirty = true;
 422 }
 423
 424 int
 425 FGEnvironmentMgr::get_cloud_layer_coverage_type (int index) const
 426 {
 427   return _sky->get_cloud_layer(index)->getCoverage();
 428 }
 429
 430 double
 431 FGEnvironmentMgr::get_cloud_layer_visibility_m (int index) const
 432 {
 433     return _sky->get_cloud_layer(index)->getVisibility_m();
 434 }
 435
 436 void
 437 FGEnvironmentMgr::set_cloud_layer_visibility_m (int index, double visibility_m)
 438 {
 439     _sky->get_cloud_layer(index)->setVisibility_m(visibility_m);
 440 }
 441
 442 double
 443 FGEnvironmentMgr::get_cloud_layer_maxalpha (int index ) const
 444 {
 445     return _sky->get_cloud_layer(index)->getMaxAlpha();
 446 }
 447
 448 void
 449 FGEnvironmentMgr::set_cloud_layer_maxalpha (int index, double maxalpha)
 450 {
 451     _sky->get_cloud_layer(index)->setMaxAlpha(maxalpha);
 452 }
 453
 454 void
 455 FGEnvironmentMgr::set_cloud_layer_coverage_type (int index, int type )
 456 {
 457   if( type < 0 || type >= SGCloudLayer::SG_MAX_CLOUD_COVERAGES ) {
 458     SG_LOG(SG_ENVIRONMENT,SG_WARN,"Unknown cloud layer type " << type << " ignored" );
 459     return;
 460   }
 461
 462   if( static_cast<SGCloudLayer::Coverage>(type) == _sky->get_cloud_layer(index)->getCoverage() )
 463     return;
 464
 465   _sky->get_cloud_layer(index)->setCoverage(static_cast<SGCloudLayer::Coverage>(type));
 466   _cloudLayersDirty = true;
 467 }
 468
 469
 470 // end of environment-mgr.cxx