1 // environment-mgr.cxx -- manager for natural environment information.
3 // Written by David Megginson, started February 2002.
5 // Copyright (C) 2002 David Megginson - david@megginson.com
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.
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.
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.
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>
33 #include <Main/main.hxx>
34 #include <Main/renderer.hxx>
35 #include <Main/fg_props.hxx>
36 #include <FDM/flight.hxx>
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"
49 class FG3DCloudsListener : public SGPropertyChangeListener {
51 FG3DCloudsListener( FGClouds * fgClouds );
52 virtual ~FG3DCloudsListener();
54 virtual void valueChanged (SGPropertyNode * node);
58 SGPropertyNode_ptr _shaderNode;
59 SGPropertyNode_ptr _enableNode;
62 FG3DCloudsListener::FG3DCloudsListener( FGClouds * fgClouds ) :
65 _shaderNode = fgGetNode( "/sim/rendering/shader-effects", true );
66 _shaderNode->addChangeListener( this );
68 _enableNode = fgGetNode( "/sim/rendering/clouds3d-enable", true );
69 _enableNode->addChangeListener( this );
71 valueChanged( _enableNode );
74 FG3DCloudsListener::~FG3DCloudsListener()
76 _enableNode->removeChangeListener( this );
77 _shaderNode->removeChangeListener( this );
80 void FG3DCloudsListener::valueChanged( SGPropertyNode * node )
82 _fgClouds->set_3dClouds( _enableNode->getBoolValue() && _shaderNode->getBoolValue() );
85 FGEnvironmentMgr::FGEnvironmentMgr () :
86 _environment(new FGEnvironment()),
87 fgClouds(new FGClouds()),
88 _cloudLayersDirty(true),
89 _altitude_n(fgGetNode("/position/altitude-ft", true)),
90 _longitude_n(fgGetNode( "/position/longitude-deg", true )),
91 _latitude_n( fgGetNode( "/position/latitude-deg", true )),
92 _3dCloudsEnableListener(new FG3DCloudsListener(fgClouds) ),
93 _sky(globals->get_renderer()->getSky())
95 set_subsystem("controller", Environment::LayerInterpolateController::createInstance( fgGetNode("/environment/config", true ) ));
96 set_subsystem("realwx", Environment::RealWxController::createInstance( fgGetNode("/environment/realwx", true ) ), 1.0 );
98 set_subsystem("precipitation", new FGPrecipitationMgr);
99 set_subsystem("terrainsampler", Environment::TerrainSampler::createInstance( fgGetNode("/environment/terrain", true ) ));
100 set_subsystem("ridgelift", new FGRidgeLift);
103 FGEnvironmentMgr::~FGEnvironmentMgr ()
105 SGSubsystem * subsys;
107 subsys = get_subsystem( "ridgelift" );
108 remove_subsystem( "ridgelift" );
111 subsys = get_subsystem( "terrainsampler" );
112 remove_subsystem( "terrainsampler" );
115 subsys = get_subsystem( "precipitation" );
116 remove_subsystem("precipitation");
119 subsys = get_subsystem("realwx");
120 remove_subsystem("realwx");
123 subsys = get_subsystem("controller");
124 remove_subsystem("controller");
130 delete _3dCloudsEnableListener;
134 FGEnvironmentMgr::init ()
136 SG_LOG( SG_ENVIRONMENT, SG_INFO, "Initializing environment subsystem");
137 SGSubsystemGroup::init();
140 // FIXME: is this really part of the environment_mgr?
141 // Initialize the longitude, latitude and altitude to the initial position
142 // of the aircraft so that the atmospheric properties (pressure, temperature
143 // and density) can be initialized accordingly.
144 _altitude_n->setDoubleValue(fgGetDouble("/sim/presets/altitude-ft"));
145 _longitude_n->setDoubleValue(fgGetDouble("/sim/presets/longitude-deg"));
146 _latitude_n->setDoubleValue(fgGetDouble("/sim/presets/latitude-deg"));
148 globals->get_event_mgr()->addTask("updateClosestAirport", this,
149 &FGEnvironmentMgr::updateClosestAirport, 30 );
153 FGEnvironmentMgr::shutdown()
155 globals->get_event_mgr()->removeTask("updateClosestAirport");
159 FGEnvironmentMgr::reinit ()
161 SG_LOG( SG_ENVIRONMENT, SG_INFO, "Reinitializing environment subsystem");
162 SGSubsystemGroup::reinit();
166 FGEnvironmentMgr::bind ()
168 SGSubsystemGroup::bind();
169 _environment->Tie( fgGetNode("/environment", true ) );
171 _tiedProperties.setRoot( fgGetNode( "/environment", true ) );
173 _tiedProperties.Tie( "effective-visibility-m", _sky,
174 &SGSky::get_visibility );
176 _tiedProperties.Tie("rebuild-layers", fgClouds,
177 &FGClouds::get_update_event,
178 &FGClouds::set_update_event);
180 // _tiedProperties.Tie("turbulence/use-cloud-turbulence", &sgEnviro,
181 // &SGEnviro::get_turbulence_enable_state,
182 // &SGEnviro::set_turbulence_enable_state);
184 for (int i = 0; i < MAX_CLOUD_LAYERS; i++) {
185 SGPropertyNode_ptr layerNode = fgGetNode("/environment/clouds",true)->getChild("layer", i, true );
187 _tiedProperties.Tie( layerNode->getNode("span-m",true), this, i,
188 &FGEnvironmentMgr::get_cloud_layer_span_m,
189 &FGEnvironmentMgr::set_cloud_layer_span_m);
191 _tiedProperties.Tie( layerNode->getNode("elevation-ft",true), this, i,
192 &FGEnvironmentMgr::get_cloud_layer_elevation_ft,
193 &FGEnvironmentMgr::set_cloud_layer_elevation_ft);
195 _tiedProperties.Tie( layerNode->getNode("thickness-ft",true), this, i,
196 &FGEnvironmentMgr::get_cloud_layer_thickness_ft,
197 &FGEnvironmentMgr::set_cloud_layer_thickness_ft);
199 _tiedProperties.Tie( layerNode->getNode("transition-ft",true), this, i,
200 &FGEnvironmentMgr::get_cloud_layer_transition_ft,
201 &FGEnvironmentMgr::set_cloud_layer_transition_ft);
203 _tiedProperties.Tie( layerNode->getNode("coverage",true), this, i,
204 &FGEnvironmentMgr::get_cloud_layer_coverage,
205 &FGEnvironmentMgr::set_cloud_layer_coverage);
207 _tiedProperties.Tie( layerNode->getNode("coverage-type",true), this, i,
208 &FGEnvironmentMgr::get_cloud_layer_coverage_type,
209 &FGEnvironmentMgr::set_cloud_layer_coverage_type);
211 _tiedProperties.Tie( layerNode->getNode( "visibility-m",true), this, i,
212 &FGEnvironmentMgr::get_cloud_layer_visibility_m,
213 &FGEnvironmentMgr::set_cloud_layer_visibility_m);
215 _tiedProperties.Tie( layerNode->getNode( "alpha",true), this, i,
216 &FGEnvironmentMgr::get_cloud_layer_maxalpha,
217 &FGEnvironmentMgr::set_cloud_layer_maxalpha);
220 _tiedProperties.setRoot( fgGetNode("/sim/rendering", true ) );
222 _tiedProperties.Tie( "clouds3d-density", _sky,
223 &SGSky::get_3dCloudDensity,
224 &SGSky::set_3dCloudDensity);
226 _tiedProperties.Tie("clouds3d-vis-range", _sky,
227 &SGSky::get_3dCloudVisRange,
228 &SGSky::set_3dCloudVisRange);
230 _tiedProperties.Tie("clouds3d-wrap", _sky,
231 &SGSky::get_3dCloudWrap,
232 &SGSky::set_3dCloudWrap);
234 // _tiedProperties.Tie("lightning-enable", &sgEnviro,
235 // &SGEnviro::get_lightning_enable_state,
236 // &SGEnviro::set_lightning_enable_state);
241 FGEnvironmentMgr::unbind ()
243 _tiedProperties.Untie();
244 _environment->Untie();
245 SGSubsystemGroup::unbind();
249 FGEnvironmentMgr::update (double dt)
251 SGSubsystemGroup::update(dt);
253 _environment->set_elevation_ft( _altitude_n->getDoubleValue() );
255 simgear::Particles::setWindFrom( _environment->get_wind_from_heading_deg(),
256 _environment->get_wind_speed_kt() );
257 if( _cloudLayersDirty ) {
258 _cloudLayersDirty = false;
259 fgClouds->set_update_event( fgClouds->get_update_event()+1 );
263 fgSetDouble( "/environment/gravitational-acceleration-mps2",
264 Environment::Gravity::instance()->getGravity(SGGeod::fromDegFt(
265 _longitude_n->getDoubleValue(),
266 _latitude_n->getDoubleValue(),
267 _altitude_n->getDoubleValue()
272 FGEnvironmentMgr::updateClosestAirport()
274 SG_LOG(SG_ENVIRONMENT, SG_DEBUG, "FGEnvironmentMgr::update: updating closest airport");
276 SGGeod pos = globals->get_aircraft_position();
277 FGAirport * nearestAirport = FGAirport::findClosest(pos, 100.0);
278 if( nearestAirport == NULL )
280 SG_LOG(SG_ENVIRONMENT,SG_WARN,"FGEnvironmentMgr::update: No airport within 100NM range");
284 const string currentId = fgGetString("/sim/airport/closest-airport-id", "");
285 if (currentId != nearestAirport->ident())
287 SG_LOG(SG_ENVIRONMENT, SG_INFO, "FGEnvironmentMgr::updateClosestAirport: selected:" << nearestAirport->ident());
288 fgSetString("/sim/airport/closest-airport-id",
289 nearestAirport->ident().c_str());
296 FGEnvironmentMgr::getEnvironment () const
298 return *_environment;
302 FGEnvironmentMgr::getEnvironment (double lat, double lon, double alt) const
304 // Always returns the same environment
305 // for now; we'll make it interesting
307 FGEnvironment env = *_environment;
308 env.set_elevation_ft(alt);
313 FGEnvironmentMgr::getEnvironment(const SGGeod& aPos) const
315 // Always returns the same environment
316 // for now; we'll make it interesting
318 FGEnvironment env = *_environment;
319 env.set_elevation_ft(aPos.getElevationFt());
325 FGEnvironmentMgr::get_cloud_layer_span_m (int index) const
327 return _sky->get_cloud_layer(index)->getSpan_m();
331 FGEnvironmentMgr::set_cloud_layer_span_m (int index, double span_m)
333 _sky->get_cloud_layer(index)->setSpan_m(span_m);
337 FGEnvironmentMgr::get_cloud_layer_elevation_ft (int index) const
339 return _sky->get_cloud_layer(index)->getElevation_m() * SG_METER_TO_FEET;
343 FGEnvironmentMgr::set_cloud_layer_elevation_ft (int index, double elevation_ft)
345 FGEnvironment env = *_environment;
346 env.set_elevation_ft(elevation_ft);
348 _sky->get_cloud_layer(index)
349 ->setElevation_m(elevation_ft * SG_FEET_TO_METER);
351 _sky->get_cloud_layer(index)
352 ->setSpeed(env.get_wind_speed_kt() * 0.5151); // 1 kt = 0.5151 m/s
354 _sky->get_cloud_layer(index)
355 ->setDirection(env.get_wind_from_heading_deg());
359 FGEnvironmentMgr::get_cloud_layer_thickness_ft (int index) const
361 return _sky->get_cloud_layer(index)->getThickness_m() * SG_METER_TO_FEET;
365 FGEnvironmentMgr::set_cloud_layer_thickness_ft (int index, double thickness_ft)
367 _sky->get_cloud_layer(index)
368 ->setThickness_m(thickness_ft * SG_FEET_TO_METER);
372 FGEnvironmentMgr::get_cloud_layer_transition_ft (int index) const
374 return _sky->get_cloud_layer(index)->getTransition_m() * SG_METER_TO_FEET;
378 FGEnvironmentMgr::set_cloud_layer_transition_ft (int index,
379 double transition_ft)
381 _sky->get_cloud_layer(index)
382 ->setTransition_m(transition_ft * SG_FEET_TO_METER);
386 FGEnvironmentMgr::get_cloud_layer_coverage (int index) const
388 return _sky->get_cloud_layer(index)->getCoverageString().c_str();
392 FGEnvironmentMgr::set_cloud_layer_coverage (int index,
393 const char * coverage_name)
395 if( _sky->get_cloud_layer(index)->getCoverageString() == coverage_name )
398 _sky->get_cloud_layer(index)->setCoverageString(coverage_name);
399 _cloudLayersDirty = true;
403 FGEnvironmentMgr::get_cloud_layer_coverage_type (int index) const
405 return _sky->get_cloud_layer(index)->getCoverage();
409 FGEnvironmentMgr::get_cloud_layer_visibility_m (int index) const
411 return _sky->get_cloud_layer(index)->getVisibility_m();
415 FGEnvironmentMgr::set_cloud_layer_visibility_m (int index, double visibility_m)
417 _sky->get_cloud_layer(index)->setVisibility_m(visibility_m);
421 FGEnvironmentMgr::get_cloud_layer_maxalpha (int index ) const
423 return _sky->get_cloud_layer(index)->getMaxAlpha();
427 FGEnvironmentMgr::set_cloud_layer_maxalpha (int index, double maxalpha)
429 _sky->get_cloud_layer(index)->setMaxAlpha(maxalpha);
433 FGEnvironmentMgr::set_cloud_layer_coverage_type (int index, int type )
435 if( type < 0 || type >= SGCloudLayer::SG_MAX_CLOUD_COVERAGES ) {
436 SG_LOG(SG_ENVIRONMENT,SG_WARN,"Unknown cloud layer type " << type << " ignored" );
440 if( static_cast<SGCloudLayer::Coverage>(type) == _sky->get_cloud_layer(index)->getCoverage() )
443 _sky->get_cloud_layer(index)->setCoverage(static_cast<SGCloudLayer::Coverage>(type));
444 _cloudLayersDirty = true;
448 // end of environment-mgr.cxx