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>
32 #include <Main/main.hxx>
33 #include <Main/fg_props.hxx>
34 #include <FDM/flight.hxx>
36 #include "environment.hxx"
37 #include "environment_mgr.hxx"
38 #include "environment_ctrl.hxx"
39 #include "realwx_ctrl.hxx"
40 #include "fgclouds.hxx"
41 #include "precipitation_mgr.hxx"
42 #include "ridge_lift.hxx"
43 #include "terrainsampler.hxx"
44 #include "Airports/simple.hxx"
49 FGEnvironmentMgr::FGEnvironmentMgr () :
50 _environment(new FGEnvironment()),
51 fgClouds(new FGClouds()),
52 _cloudLayersDirty(true),
53 _altitudeNode(fgGetNode("/position/altitude-ft", true)),
54 _longitude_n(fgGetNode( "/position/longitude-deg", true )),
55 _latitude_n( fgGetNode( "/position/latitude-deg", true )),
56 _positionTimeToLive(0.0)
58 set_subsystem("controller", Environment::LayerInterpolateController::createInstance( fgGetNode("/environment/config", true ) ));
59 set_subsystem("realwx", Environment::RealWxController::createInstance( fgGetNode("/environment/realwx", true ) ), 1.0 );
61 set_subsystem("precipitation", new FGPrecipitationMgr);
62 set_subsystem("terrainsampler", Environment::TerrainSampler::createInstance( fgGetNode("/environment/terrain", true ) ));
63 set_subsystem("ridgelift", new FGRidgeLift);
66 FGEnvironmentMgr::~FGEnvironmentMgr ()
70 subsys = get_subsystem( "ridgelift" );
71 remove_subsystem( "ridgelift" );
74 subsys = get_subsystem( "terrainsampler" );
75 remove_subsystem( "terrainsampler" );
78 subsys = get_subsystem( "precipitation" );
79 remove_subsystem("precipitation");
82 subsys = get_subsystem("realwx");
83 remove_subsystem("realwx");
86 subsys = get_subsystem("controller");
87 remove_subsystem("controller");
95 FGEnvironmentMgr::init ()
97 SG_LOG( SG_GENERAL, SG_INFO, "Initializing environment subsystem");
98 SGSubsystemGroup::init();
103 FGEnvironmentMgr::reinit ()
105 SG_LOG( SG_GENERAL, SG_INFO, "Reinitializing environment subsystem");
106 SGSubsystemGroup::reinit();
110 FGEnvironmentMgr::bind ()
112 SGSubsystemGroup::bind();
113 _environment->Tie( fgGetNode("/environment", true ) );
115 _tiedProperties.setRoot( fgGetNode( "/environment", true ) );
117 _tiedProperties.Tie( "effective-visibility-m", thesky,
118 &SGSky::get_visibility );
120 _tiedProperties.Tie("rebuild-layers", fgClouds,
121 &FGClouds::get_update_event,
122 &FGClouds::set_update_event);
124 // _tiedProperties.Tie("turbulence/use-cloud-turbulence", &sgEnviro,
125 // &SGEnviro::get_turbulence_enable_state,
126 // &SGEnviro::set_turbulence_enable_state);
128 for (int i = 0; i < MAX_CLOUD_LAYERS; i++) {
129 SGPropertyNode_ptr layerNode = fgGetNode("/environment/clouds",true)->getChild("layer", i, true );
131 _tiedProperties.Tie( layerNode->getNode("span-m",true), this, i,
132 &FGEnvironmentMgr::get_cloud_layer_span_m,
133 &FGEnvironmentMgr::set_cloud_layer_span_m);
135 _tiedProperties.Tie( layerNode->getNode("elevation-ft",true), this, i,
136 &FGEnvironmentMgr::get_cloud_layer_elevation_ft,
137 &FGEnvironmentMgr::set_cloud_layer_elevation_ft);
139 _tiedProperties.Tie( layerNode->getNode("thickness-ft",true), this, i,
140 &FGEnvironmentMgr::get_cloud_layer_thickness_ft,
141 &FGEnvironmentMgr::set_cloud_layer_thickness_ft);
143 _tiedProperties.Tie( layerNode->getNode("transition-ft",true), this, i,
144 &FGEnvironmentMgr::get_cloud_layer_transition_ft,
145 &FGEnvironmentMgr::set_cloud_layer_transition_ft);
147 _tiedProperties.Tie( layerNode->getNode("coverage",true), this, i,
148 &FGEnvironmentMgr::get_cloud_layer_coverage,
149 &FGEnvironmentMgr::set_cloud_layer_coverage);
151 _tiedProperties.Tie( layerNode->getNode("coverage-type",true), this, i,
152 &FGEnvironmentMgr::get_cloud_layer_coverage_type,
153 &FGEnvironmentMgr::set_cloud_layer_coverage_type);
155 _tiedProperties.Tie( layerNode->getNode( "visibility-m",true), this, i,
156 &FGEnvironmentMgr::get_cloud_layer_visibility_m,
157 &FGEnvironmentMgr::set_cloud_layer_visibility_m);
159 _tiedProperties.Tie( layerNode->getNode( "alpha",true), this, i,
160 &FGEnvironmentMgr::get_cloud_layer_maxalpha,
161 &FGEnvironmentMgr::set_cloud_layer_maxalpha);
164 _tiedProperties.setRoot( fgGetNode("/sim/rendering", true ) );
166 _tiedProperties.Tie( "clouds3d-enable", fgClouds,
167 &FGClouds::get_3dClouds,
168 &FGClouds::set_3dClouds);
170 _tiedProperties.Tie( "clouds3d-density", thesky,
171 &SGSky::get_3dCloudDensity,
172 &SGSky::set_3dCloudDensity);
174 _tiedProperties.Tie("clouds3d-vis-range", thesky,
175 &SGSky::get_3dCloudVisRange,
176 &SGSky::set_3dCloudVisRange);
178 // _tiedProperties.Tie("lightning-enable", &sgEnviro,
179 // &SGEnviro::get_lightning_enable_state,
180 // &SGEnviro::set_lightning_enable_state);
185 FGEnvironmentMgr::unbind ()
187 _tiedProperties.Untie();
188 _environment->Untie();
189 SGSubsystemGroup::unbind();
193 FGEnvironmentMgr::update (double dt)
195 SGSubsystemGroup::update(dt);
197 _environment->set_elevation_ft( _altitudeNode->getDoubleValue() );
199 simgear::Particles::setWindFrom( _environment->get_wind_from_heading_deg(),
200 _environment->get_wind_speed_kt() );
201 if( _cloudLayersDirty ) {
202 _cloudLayersDirty = false;
203 fgClouds->set_update_event( fgClouds->get_update_event()+1 );
206 _positionTimeToLive -= dt;
207 if( _positionTimeToLive <= 0.0 )
209 // update closest airport information
210 _positionTimeToLive = 30.0;
212 SG_LOG(SG_ALL, SG_INFO, "FGEnvironmentMgr::update: updating closest airport");
214 SGGeod pos = SGGeod::fromDeg(_longitude_n->getDoubleValue(),
215 _latitude_n->getDoubleValue());
217 FGAirport * nearestAirport = FGAirport::findClosest(pos, 100.0);
218 if( nearestAirport == NULL )
220 SG_LOG(SG_ALL,SG_WARN,"FGEnvironmentMgr::update: No airport within 100NM range");
224 const string currentId = fgGetString("/sim/airport/closest-airport-id", "");
225 if (currentId != nearestAirport->ident())
227 fgSetString("/sim/airport/closest-airport-id",
228 nearestAirport->ident().c_str());
235 FGEnvironmentMgr::getEnvironment () const
237 return *_environment;
241 FGEnvironmentMgr::getEnvironment (double lat, double lon, double alt) const
243 // Always returns the same environment
244 // for now; we'll make it interesting
246 FGEnvironment env = *_environment;
247 env.set_elevation_ft(alt);
252 FGEnvironmentMgr::getEnvironment(const SGGeod& aPos) const
254 // Always returns the same environment
255 // for now; we'll make it interesting
257 FGEnvironment env = *_environment;
258 env.set_elevation_ft(aPos.getElevationFt());
264 FGEnvironmentMgr::get_cloud_layer_span_m (int index) const
266 return thesky->get_cloud_layer(index)->getSpan_m();
270 FGEnvironmentMgr::set_cloud_layer_span_m (int index, double span_m)
272 thesky->get_cloud_layer(index)->setSpan_m(span_m);
276 FGEnvironmentMgr::get_cloud_layer_elevation_ft (int index) const
278 return thesky->get_cloud_layer(index)->getElevation_m() * SG_METER_TO_FEET;
282 FGEnvironmentMgr::set_cloud_layer_elevation_ft (int index, double elevation_ft)
284 FGEnvironment env = *_environment;
285 env.set_elevation_ft(elevation_ft);
287 thesky->get_cloud_layer(index)
288 ->setElevation_m(elevation_ft * SG_FEET_TO_METER);
290 thesky->get_cloud_layer(index)
291 ->setSpeed(env.get_wind_speed_kt() * 0.5151); // 1 kt = 0.5151 m/s
293 thesky->get_cloud_layer(index)
294 ->setDirection(env.get_wind_from_heading_deg());
298 FGEnvironmentMgr::get_cloud_layer_thickness_ft (int index) const
300 return thesky->get_cloud_layer(index)->getThickness_m() * SG_METER_TO_FEET;
304 FGEnvironmentMgr::set_cloud_layer_thickness_ft (int index, double thickness_ft)
306 thesky->get_cloud_layer(index)
307 ->setThickness_m(thickness_ft * SG_FEET_TO_METER);
311 FGEnvironmentMgr::get_cloud_layer_transition_ft (int index) const
313 return thesky->get_cloud_layer(index)->getTransition_m() * SG_METER_TO_FEET;
317 FGEnvironmentMgr::set_cloud_layer_transition_ft (int index,
318 double transition_ft)
320 thesky->get_cloud_layer(index)
321 ->setTransition_m(transition_ft * SG_FEET_TO_METER);
325 FGEnvironmentMgr::get_cloud_layer_coverage (int index) const
327 return thesky->get_cloud_layer(index)->getCoverageString().c_str();
331 FGEnvironmentMgr::set_cloud_layer_coverage (int index,
332 const char * coverage_name)
334 if( thesky->get_cloud_layer(index)->getCoverageString() == coverage_name )
337 thesky->get_cloud_layer(index)->setCoverageString(coverage_name);
338 _cloudLayersDirty = true;
342 FGEnvironmentMgr::get_cloud_layer_coverage_type (int index) const
344 return thesky->get_cloud_layer(index)->getCoverage();
348 FGEnvironmentMgr::get_cloud_layer_visibility_m (int index) const
350 return thesky->get_cloud_layer(index)->getVisibility_m();
354 FGEnvironmentMgr::set_cloud_layer_visibility_m (int index, double visibility_m)
356 thesky->get_cloud_layer(index)->setVisibility_m(visibility_m);
360 FGEnvironmentMgr::get_cloud_layer_maxalpha (int index ) const
362 return thesky->get_cloud_layer(index)->getMaxAlpha();
366 FGEnvironmentMgr::set_cloud_layer_maxalpha (int index, double maxalpha)
368 thesky->get_cloud_layer(index)->setMaxAlpha(maxalpha);
372 FGEnvironmentMgr::set_cloud_layer_coverage_type (int index, int type )
374 if( type < 0 || type >= SGCloudLayer::SG_MAX_CLOUD_COVERAGES ) {
375 SG_LOG(SG_ALL,SG_WARN,"Unknown cloud layer type " << type << " ignored" );
379 if( static_cast<SGCloudLayer::Coverage>(type) == thesky->get_cloud_layer(index)->getCoverage() )
382 thesky->get_cloud_layer(index)->setCoverage(static_cast<SGCloudLayer::Coverage>(type));
383 _cloudLayersDirty = true;
387 // end of environment-mgr.cxx