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 _enableNode;
61 FG3DCloudsListener::FG3DCloudsListener( FGClouds * fgClouds ) :
64 _enableNode = fgGetNode( "/sim/rendering/clouds3d-enable", true );
65 _enableNode->addChangeListener( this );
67 valueChanged( _enableNode );
70 FG3DCloudsListener::~FG3DCloudsListener()
72 _enableNode->removeChangeListener( this );
75 void FG3DCloudsListener::valueChanged( SGPropertyNode * node )
77 _fgClouds->set_3dClouds( _enableNode->getBoolValue() );
80 FGEnvironmentMgr::FGEnvironmentMgr () :
81 _environment(new FGEnvironment()),
82 fgClouds(new FGClouds()),
83 _cloudLayersDirty(true),
84 _altitude_n(fgGetNode("/position/altitude-ft", true)),
85 _longitude_n(fgGetNode( "/position/longitude-deg", true )),
86 _latitude_n( fgGetNode( "/position/latitude-deg", true )),
87 _3dCloudsEnableListener(new FG3DCloudsListener(fgClouds) ),
88 _sky(globals->get_renderer()->getSky())
90 set_subsystem("controller", Environment::LayerInterpolateController::createInstance( fgGetNode("/environment/config", true ) ));
91 set_subsystem("realwx", Environment::RealWxController::createInstance( fgGetNode("/environment/realwx", true ) ), 1.0 );
93 set_subsystem("precipitation", new FGPrecipitationMgr);
94 set_subsystem("terrainsampler", Environment::TerrainSampler::createInstance( fgGetNode("/environment/terrain", true ) ));
95 set_subsystem("ridgelift", new FGRidgeLift);
98 FGEnvironmentMgr::~FGEnvironmentMgr ()
100 SGSubsystem * subsys;
102 subsys = get_subsystem( "ridgelift" );
103 remove_subsystem( "ridgelift" );
106 subsys = get_subsystem( "terrainsampler" );
107 remove_subsystem( "terrainsampler" );
110 subsys = get_subsystem( "precipitation" );
111 remove_subsystem("precipitation");
114 subsys = get_subsystem("realwx");
115 remove_subsystem("realwx");
118 subsys = get_subsystem("controller");
119 remove_subsystem("controller");
125 delete _3dCloudsEnableListener;
129 FGEnvironmentMgr::init ()
131 SG_LOG( SG_ENVIRONMENT, SG_INFO, "Initializing environment subsystem");
132 SGSubsystemGroup::init();
135 // FIXME: is this really part of the environment_mgr?
136 // Initialize the longitude, latitude and altitude to the initial position
137 // of the aircraft so that the atmospheric properties (pressure, temperature
138 // and density) can be initialized accordingly.
139 _altitude_n->setDoubleValue(fgGetDouble("/sim/presets/altitude-ft"));
140 _longitude_n->setDoubleValue(fgGetDouble("/sim/presets/longitude-deg"));
141 _latitude_n->setDoubleValue(fgGetDouble("/sim/presets/latitude-deg"));
143 globals->get_event_mgr()->addTask("updateClosestAirport", this,
144 &FGEnvironmentMgr::updateClosestAirport, 30 );
148 FGEnvironmentMgr::shutdown()
150 globals->get_event_mgr()->removeTask("updateClosestAirport");
154 FGEnvironmentMgr::reinit ()
156 SG_LOG( SG_ENVIRONMENT, SG_INFO, "Reinitializing environment subsystem");
157 SGSubsystemGroup::reinit();
161 FGEnvironmentMgr::bind ()
163 SGSubsystemGroup::bind();
164 _environment->Tie( fgGetNode("/environment", true ) );
166 _tiedProperties.setRoot( fgGetNode( "/environment", true ) );
168 _tiedProperties.Tie( "effective-visibility-m", _sky,
169 &SGSky::get_visibility );
171 _tiedProperties.Tie("rebuild-layers", fgClouds,
172 &FGClouds::get_update_event,
173 &FGClouds::set_update_event);
175 // _tiedProperties.Tie("turbulence/use-cloud-turbulence", &sgEnviro,
176 // &SGEnviro::get_turbulence_enable_state,
177 // &SGEnviro::set_turbulence_enable_state);
179 for (int i = 0; i < MAX_CLOUD_LAYERS; i++) {
180 SGPropertyNode_ptr layerNode = fgGetNode("/environment/clouds",true)->getChild("layer", i, true );
182 _tiedProperties.Tie( layerNode->getNode("span-m",true), this, i,
183 &FGEnvironmentMgr::get_cloud_layer_span_m,
184 &FGEnvironmentMgr::set_cloud_layer_span_m);
186 _tiedProperties.Tie( layerNode->getNode("elevation-ft",true), this, i,
187 &FGEnvironmentMgr::get_cloud_layer_elevation_ft,
188 &FGEnvironmentMgr::set_cloud_layer_elevation_ft);
190 _tiedProperties.Tie( layerNode->getNode("thickness-ft",true), this, i,
191 &FGEnvironmentMgr::get_cloud_layer_thickness_ft,
192 &FGEnvironmentMgr::set_cloud_layer_thickness_ft);
194 _tiedProperties.Tie( layerNode->getNode("transition-ft",true), this, i,
195 &FGEnvironmentMgr::get_cloud_layer_transition_ft,
196 &FGEnvironmentMgr::set_cloud_layer_transition_ft);
198 _tiedProperties.Tie( layerNode->getNode("coverage",true), this, i,
199 &FGEnvironmentMgr::get_cloud_layer_coverage,
200 &FGEnvironmentMgr::set_cloud_layer_coverage);
202 _tiedProperties.Tie( layerNode->getNode("coverage-type",true), this, i,
203 &FGEnvironmentMgr::get_cloud_layer_coverage_type,
204 &FGEnvironmentMgr::set_cloud_layer_coverage_type);
206 _tiedProperties.Tie( layerNode->getNode( "visibility-m",true), this, i,
207 &FGEnvironmentMgr::get_cloud_layer_visibility_m,
208 &FGEnvironmentMgr::set_cloud_layer_visibility_m);
210 _tiedProperties.Tie( layerNode->getNode( "alpha",true), this, i,
211 &FGEnvironmentMgr::get_cloud_layer_maxalpha,
212 &FGEnvironmentMgr::set_cloud_layer_maxalpha);
215 _tiedProperties.setRoot( fgGetNode("/sim/rendering", true ) );
217 _tiedProperties.Tie( "clouds3d-density", _sky,
218 &SGSky::get_3dCloudDensity,
219 &SGSky::set_3dCloudDensity);
221 _tiedProperties.Tie("clouds3d-vis-range", _sky,
222 &SGSky::get_3dCloudVisRange,
223 &SGSky::set_3dCloudVisRange);
225 _tiedProperties.Tie("clouds3d-impostor-range", _sky,
226 &SGSky::get_3dCloudImpostorDistance,
227 &SGSky::set_3dCloudImpostorDistance);
229 _tiedProperties.Tie("clouds3d-lod1-range", _sky,
230 &SGSky::get_3dCloudLoD1Range,
231 &SGSky::set_3dCloudLoD1Range);
233 _tiedProperties.Tie("clouds3d-lod2-range", _sky,
234 &SGSky::get_3dCloudLoD2Range,
235 &SGSky::set_3dCloudLoD2Range);
237 _tiedProperties.Tie("clouds3d-wrap", _sky,
238 &SGSky::get_3dCloudWrap,
239 &SGSky::set_3dCloudWrap);
241 _tiedProperties.Tie("clouds3d-use-impostors", _sky,
242 &SGSky::get_3dCloudUseImpostors,
243 &SGSky::set_3dCloudUseImpostors);
245 // _tiedProperties.Tie("lightning-enable", &sgEnviro,
246 // &SGEnviro::get_lightning_enable_state,
247 // &SGEnviro::set_lightning_enable_state);
252 FGEnvironmentMgr::unbind ()
254 _tiedProperties.Untie();
255 _environment->Untie();
256 SGSubsystemGroup::unbind();
260 FGEnvironmentMgr::update (double dt)
262 SGSubsystemGroup::update(dt);
264 _environment->set_elevation_ft( _altitude_n->getDoubleValue() );
266 simgear::Particles::setWindFrom( _environment->get_wind_from_heading_deg(),
267 _environment->get_wind_speed_kt() );
268 if( _cloudLayersDirty ) {
269 _cloudLayersDirty = false;
270 fgClouds->set_update_event( fgClouds->get_update_event()+1 );
274 fgSetDouble( "/environment/gravitational-acceleration-mps2",
275 Environment::Gravity::instance()->getGravity(SGGeod::fromDegFt(
276 _longitude_n->getDoubleValue(),
277 _latitude_n->getDoubleValue(),
278 _altitude_n->getDoubleValue()
283 FGEnvironmentMgr::updateClosestAirport()
285 SG_LOG(SG_ENVIRONMENT, SG_DEBUG, "FGEnvironmentMgr::update: updating closest airport");
287 SGGeod pos = globals->get_aircraft_position();
288 FGAirport * nearestAirport = FGAirport::findClosest(pos, 100.0);
289 if( nearestAirport == NULL )
291 SG_LOG(SG_ENVIRONMENT,SG_WARN,"FGEnvironmentMgr::update: No airport within 100NM range");
295 const string currentId = fgGetString("/sim/airport/closest-airport-id", "");
296 if (currentId != nearestAirport->ident())
298 SG_LOG(SG_ENVIRONMENT, SG_INFO, "FGEnvironmentMgr::updateClosestAirport: selected:" << nearestAirport->ident());
299 fgSetString("/sim/airport/closest-airport-id",
300 nearestAirport->ident().c_str());
307 FGEnvironmentMgr::getEnvironment () const
309 return *_environment;
313 FGEnvironmentMgr::getEnvironment (double lat, double lon, double alt) const
315 // Always returns the same environment
316 // for now; we'll make it interesting
318 FGEnvironment env = *_environment;
319 env.set_elevation_ft(alt);
324 FGEnvironmentMgr::getEnvironment(const SGGeod& aPos) const
326 // Always returns the same environment
327 // for now; we'll make it interesting
329 FGEnvironment env = *_environment;
330 env.set_elevation_ft(aPos.getElevationFt());
336 FGEnvironmentMgr::get_cloud_layer_span_m (int index) const
338 return _sky->get_cloud_layer(index)->getSpan_m();
342 FGEnvironmentMgr::set_cloud_layer_span_m (int index, double span_m)
344 _sky->get_cloud_layer(index)->setSpan_m(span_m);
348 FGEnvironmentMgr::get_cloud_layer_elevation_ft (int index) const
350 return _sky->get_cloud_layer(index)->getElevation_m() * SG_METER_TO_FEET;
354 FGEnvironmentMgr::set_cloud_layer_elevation_ft (int index, double elevation_ft)
356 FGEnvironment env = *_environment;
357 env.set_elevation_ft(elevation_ft);
359 _sky->get_cloud_layer(index)
360 ->setElevation_m(elevation_ft * SG_FEET_TO_METER);
362 _sky->get_cloud_layer(index)
363 ->setSpeed(env.get_wind_speed_kt() * 0.5151); // 1 kt = 0.5151 m/s
365 _sky->get_cloud_layer(index)
366 ->setDirection(env.get_wind_from_heading_deg());
370 FGEnvironmentMgr::get_cloud_layer_thickness_ft (int index) const
372 return _sky->get_cloud_layer(index)->getThickness_m() * SG_METER_TO_FEET;
376 FGEnvironmentMgr::set_cloud_layer_thickness_ft (int index, double thickness_ft)
378 _sky->get_cloud_layer(index)
379 ->setThickness_m(thickness_ft * SG_FEET_TO_METER);
383 FGEnvironmentMgr::get_cloud_layer_transition_ft (int index) const
385 return _sky->get_cloud_layer(index)->getTransition_m() * SG_METER_TO_FEET;
389 FGEnvironmentMgr::set_cloud_layer_transition_ft (int index,
390 double transition_ft)
392 _sky->get_cloud_layer(index)
393 ->setTransition_m(transition_ft * SG_FEET_TO_METER);
397 FGEnvironmentMgr::get_cloud_layer_coverage (int index) const
399 return _sky->get_cloud_layer(index)->getCoverageString().c_str();
403 FGEnvironmentMgr::set_cloud_layer_coverage (int index,
404 const char * coverage_name)
406 if( _sky->get_cloud_layer(index)->getCoverageString() == coverage_name )
409 _sky->get_cloud_layer(index)->setCoverageString(coverage_name);
410 _cloudLayersDirty = true;
414 FGEnvironmentMgr::get_cloud_layer_coverage_type (int index) const
416 return _sky->get_cloud_layer(index)->getCoverage();
420 FGEnvironmentMgr::get_cloud_layer_visibility_m (int index) const
422 return _sky->get_cloud_layer(index)->getVisibility_m();
426 FGEnvironmentMgr::set_cloud_layer_visibility_m (int index, double visibility_m)
428 _sky->get_cloud_layer(index)->setVisibility_m(visibility_m);
432 FGEnvironmentMgr::get_cloud_layer_maxalpha (int index ) const
434 return _sky->get_cloud_layer(index)->getMaxAlpha();
438 FGEnvironmentMgr::set_cloud_layer_maxalpha (int index, double maxalpha)
440 _sky->get_cloud_layer(index)->setMaxAlpha(maxalpha);
444 FGEnvironmentMgr::set_cloud_layer_coverage_type (int index, int type )
446 if( type < 0 || type >= SGCloudLayer::SG_MAX_CLOUD_COVERAGES ) {
447 SG_LOG(SG_ENVIRONMENT,SG_WARN,"Unknown cloud layer type " << type << " ignored" );
451 if( static_cast<SGCloudLayer::Coverage>(type) == _sky->get_cloud_layer(index)->getCoverage() )
454 _sky->get_cloud_layer(index)->setCoverage(static_cast<SGCloudLayer::Coverage>(type));
455 _cloudLayersDirty = true;
459 // end of environment-mgr.cxx