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