simgear/scene/sky/sky.cxx

   1 // sky.cxx -- ssg based sky model
   2 //
   3 // Written by Curtis Olson, started December 1997.
   4 // SSG-ified by Curtis Olson, February 2000.
   5 //
   6 // Copyright (C) 1997-2000  Curtis L. Olson  - http://www.flightgear.org/~curt
   7 //
   8 // This library is free software; you can redistribute it and/or
   9 // modify it under the terms of the GNU Library General Public
  10 // License as published by the Free Software Foundation; either
  11 // version 2 of the License, or (at your option) any later version.
  12 //
  13 // This library is distributed in the hope that it will be useful,
  14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16 // Library General Public License for more details.
  17 //
  18 // You should have received a copy of the GNU General Public License
  19 // along with this program; if not, write to the Free Software
  20 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  21 //
  22 // $Id$
  23
  24 #ifdef HAVE_CONFIG_H
  25 #  include <simgear_config.h>
  26 #endif
  27
  28 #include "sky.hxx"
  29 #include "cloudfield.hxx"
  30 #include "newcloud.hxx"
  31
  32 #include <simgear/math/sg_random.h>
  33 #include <simgear/scene/util/RenderConstants.hxx>
  34 #include <simgear/sg_inlines.h>
  35
  36 #include <osg/StateSet>
  37 #include <osg/Depth>
  38
  39 // Constructor
  40 SGSky::SGSky( void ) {
  41     effective_visibility = visibility = 10000.0;
  42
  43     // near cloud visibility state variables
  44     in_puff = false;
  45     puff_length = 0;
  46     puff_progression = 0;
  47     ramp_up = 0.15;
  48     ramp_down = 0.15;
  49
  50     in_cloud  = -1;
  51
  52     clouds_3d_enabled = false;
  53     clouds_3d_density = 0.8;
  54
  55     pre_root = new osg::Group;
  56     pre_root->setNodeMask(simgear::BACKGROUND_BIT);
  57     osg::StateSet* preStateSet = new osg::StateSet;
  58     preStateSet->setAttribute(new osg::Depth(osg::Depth::LESS, 0.0, 1.0,
  59                                              false));
  60     pre_root->setStateSet(preStateSet);
  61     cloud_root = new osg::Group;
  62     cloud_root->setNodeMask(simgear::MODEL_BIT);
  63
  64     pre_selector = new osg::Switch;
  65
  66     pre_transform = new osg::Group;
  67
  68     _ephTransform = new osg::MatrixTransform;
  69 }
  70
  71
  72 // Destructor
  73 SGSky::~SGSky( void )
  74 {
  75 }
  76
  77
  78 // initialize the sky and connect the components to the scene graph at
  79 // the provided branch
  80 void SGSky::build( double h_radius_m, double v_radius_m,
  81                    double sun_size, double moon_size,
  82                    const SGEphemeris& eph, SGPropertyNode *property_tree_node )
  83 {
  84     dome = new SGSkyDome;
  85     pre_transform->addChild( dome->build( h_radius_m, v_radius_m ) );
  86
  87     pre_transform->addChild(_ephTransform.get());
  88     planets = new SGStars;
  89     _ephTransform->addChild( planets->build(eph.getNumPlanets(), eph.getPlanets(), h_radius_m) );
  90
  91     stars = new SGStars;
  92     _ephTransform->addChild( stars->build(eph.getNumStars(), eph.getStars(), h_radius_m) );
  93
  94     moon = new SGMoon;
  95     _ephTransform->addChild( moon->build(tex_path, moon_size) );
  96
  97     oursun = new SGSun;
  98     _ephTransform->addChild( oursun->build(tex_path, sun_size, property_tree_node ) );
  99
 100     pre_selector->addChild( pre_transform.get() );
 101
 102     pre_root->addChild( pre_selector.get() );
 103 }
 104
 105
 106 // repaint the sky components based on current value of sun_angle,
 107 // sky, and fog colors.
 108 //
 109 // sun angle in degrees relative to verticle
 110 // 0 degrees = high noon
 111 // 90 degrees = sun rise/set
 112 // 180 degrees = darkest midnight
 113 bool SGSky::repaint( const SGSkyColor &sc, const SGEphemeris& eph )
 114 {
 115     if ( effective_visibility > 1000.0 ) {
 116         enable();
 117         dome->repaint( sc.adj_sky_color, sc.sky_color, sc.fog_color,
 118                        sc.sun_angle, effective_visibility );
 119
 120         stars->repaint( sc.sun_angle, eph.getNumStars(), eph.getStars() );
 121         planets->repaint( sc.sun_angle, eph.getNumPlanets(), eph.getPlanets() );
 122         oursun->repaint( sc.sun_angle, effective_visibility );
 123         moon->repaint( sc.moon_angle );
 124
 125         for ( unsigned i = 0; i < cloud_layers.size(); ++i ) {
 126             if (cloud_layers[i]->getCoverage() != SGCloudLayer::SG_CLOUD_CLEAR){
 127                 cloud_layers[i]->repaint( sc.cloud_color );
 128             }
 129         }
 130     } else {
 131         // turn off sky
 132         disable();
 133     }
 134     SGCloudField::updateFog((double)effective_visibility,
 135                             osg::Vec4f(toOsg(sc.fog_color), 1.0f));
 136     return true;
 137 }
 138
 139 // reposition the sky at the specified origin and orientation
 140 //
 141 // lon specifies a rotation about the Z axis
 142 // lat specifies a rotation about the new Y axis
 143 // spin specifies a rotation about the new Z axis (this allows
 144 // additional orientation for the sunrise/set effects and is used by
 145 // the skydome and perhaps clouds.
 146 bool SGSky::reposition( const SGSkyState &st, const SGEphemeris& eph, double dt )
 147 {
 148     double angle = st.gst * 15; // degrees
 149     double angleRad = SGMiscd::deg2rad(angle);
 150
 151     SGVec3f zero_elev, view_up;
 152     double lon, lat, alt;
 153
 154     SGGeod geodZeroViewPos = SGGeod::fromGeodM(st.pos_geod, 0);
 155     zero_elev = toVec3f( SGVec3d::fromGeod(geodZeroViewPos) );
 156
 157     // calculate the scenery up vector
 158     SGQuatd hlOr = SGQuatd::fromLonLat(st.pos_geod);
 159     view_up = toVec3f(hlOr.backTransform(-SGVec3d::e3()));
 160
 161     // viewer location
 162     lon = st.pos_geod.getLongitudeRad();
 163     lat = st.pos_geod.getLatitudeRad();
 164     alt = st.pos_geod.getElevationM();
 165
 166     dome->reposition( zero_elev, alt, lon, lat, st.spin );
 167
 168     osg::Matrix m = osg::Matrix::rotate(angleRad, osg::Vec3(0, 0, -1));
 169     m.postMultTranslate(toOsg(st.pos));
 170     _ephTransform->setMatrix(m);
 171
 172     double sun_ra = eph.getSunRightAscension();
 173     double sun_dec = eph.getSunDeclination();
 174     oursun->reposition( sun_ra, sun_dec, st.sun_dist, lat, alt, st.sun_angle );
 175
 176     double moon_ra = eph.getMoonRightAscension();
 177     double moon_dec = eph.getMoonDeclination();
 178     moon->reposition( moon_ra, moon_dec, st.moon_dist );
 179
 180     for ( unsigned i = 0; i < cloud_layers.size(); ++i ) {
 181         if ( cloud_layers[i]->getCoverage() != SGCloudLayer::SG_CLOUD_CLEAR ) {
 182             cloud_layers[i]->reposition( zero_elev, view_up, lon, lat, alt, dt);
 183         } else
 184           cloud_layers[i]->getNode()->setAllChildrenOff();
 185     }
 186
 187     return true;
 188 }
 189
 190 void
 191 SGSky::add_cloud_layer( SGCloudLayer * layer )
 192 {
 193     cloud_layers.push_back(layer);
 194     cloud_root->addChild(layer->getNode());
 195
 196     layer->set_enable3dClouds(clouds_3d_enabled);
 197 }
 198
 199 const SGCloudLayer *
 200 SGSky::get_cloud_layer (int i) const
 201 {
 202     return cloud_layers[i];
 203 }
 204
 205 SGCloudLayer *
 206 SGSky::get_cloud_layer (int i)
 207 {
 208     return cloud_layers[i];
 209 }
 210
 211 int
 212 SGSky::get_cloud_layer_count () const
 213 {
 214     return cloud_layers.size();
 215 }
 216
 217 double SGSky::get_3dCloudDensity() const {
 218     return SGNewCloud::getDensity();
 219 }
 220
 221 void SGSky::set_3dCloudDensity(double density)
 222 {
 223     SGNewCloud::setDensity(density);
 224 }
 225
 226 float SGSky::get_3dCloudVisRange() const {
 227     return SGCloudField::getVisRange();
 228 }
 229
 230 void SGSky::set_3dCloudVisRange(float vis)
 231 {
 232     SGCloudField::setVisRange(vis);
 233     for ( int i = 0; i < (int)cloud_layers.size(); ++i ) {
 234         cloud_layers[i]->get_layer3D()->applyVisRange();
 235     }
 236 }
 237
 238 void SGSky::texture_path( const string& path ) {
 239         tex_path = SGPath( path );
 240 }
 241
 242 // modify the current visibility based on cloud layers, thickness,
 243 // transition range, and simulated "puffs".
 244 void SGSky::modify_vis( float alt, float time_factor ) {
 245     float effvis = visibility;
 246
 247     for ( int i = 0; i < (int)cloud_layers.size(); ++i ) {
 248         float asl = cloud_layers[i]->getElevation_m();
 249         float thickness = cloud_layers[i]->getThickness_m();
 250         float transition = cloud_layers[i]->getTransition_m();
 251
 252         double ratio = 1.0;
 253
 254         if ( cloud_layers[i]->getCoverage() == SGCloudLayer::SG_CLOUD_CLEAR ) {
 255             // less than 50% coverage -- assume we're in the clear for now
 256             ratio = 1.0;
 257         } else if ( alt < asl - transition ) {
 258             // below cloud layer
 259             ratio = 1.0;
 260         } else if ( alt < asl ) {
 261             // in lower transition
 262             ratio = (asl - alt) / transition;
 263         } else if ( alt < asl + thickness ) {
 264             // in cloud layer
 265             ratio = 0.0;
 266         } else if ( alt < asl + thickness + transition ) {
 267             // in upper transition
 268             ratio = (alt - (asl + thickness)) / transition;
 269         } else {
 270             // above cloud layer
 271             ratio = 1.0;
 272         }
 273
 274         if ( cloud_layers[i]->getCoverage() == SGCloudLayer::SG_CLOUD_CLEAR ||
 275              cloud_layers[i]->get_layer3D()->defined3D) {
 276             // do nothing, clear layers aren't drawn, don't affect
 277             // visibility andn dont' need to be faded in or out.
 278         } else if ( (cloud_layers[i]->getCoverage() ==
 279                      SGCloudLayer::SG_CLOUD_FEW)
 280                     || (cloud_layers[i]->getCoverage() ==
 281                         SGCloudLayer::SG_CLOUD_SCATTERED) )
 282         {
 283             // set the alpha fade value for the cloud layer.  For less
 284             // dense cloud layers we fade the layer to nothing as we
 285             // approach it because we stay clear visibility-wise as we
 286             // pass through it.
 287             float temp = ratio * 2.0;
 288             if ( temp > 1.0 ) { temp = 1.0; }
 289             cloud_layers[i]->setAlpha( temp );
 290
 291             // don't touch visibility
 292         } else {
 293             // maintain full alpha for denser cloud layer types.
 294             // Let's set the value explicitly in case someone changed
 295             // the layer type.
 296             cloud_layers[i]->setAlpha( 1.0 );
 297
 298             // lower visibility as we approach the cloud layer.
 299             // accumulate effects from multiple cloud layers
 300             effvis *= ratio;
 301         }
 302
 303 #if 0
 304         if ( ratio < 1.0 ) {
 305             if ( ! in_puff ) {
 306                 // calc chance of entering cloud puff
 307                 double rnd = sg_random();
 308                 double chance = rnd * rnd * rnd;
 309                 if ( chance > 0.95 /* * (diff - 25) / 50.0 */ ) {
 310                     in_puff = true;
 311                     puff_length = sg_random() * 2.0; // up to 2 seconds
 312                     puff_progression = 0.0;
 313                 }
 314             }
 315
 316             if ( in_puff ) {
 317                 // modify actual_visibility based on puff envelope
 318
 319                 if ( puff_progression <= ramp_up ) {
 320                     double x = SGD_PI_2 * puff_progression / ramp_up;
 321                     double factor = 1.0 - sin( x );
 322                     // cout << "ramp up = " << puff_progression
 323                     //      << "  factor = " << factor << endl;
 324                     effvis = effvis * factor;
 325                 } else if ( puff_progression >= ramp_up + puff_length ) {
 326                     double x = SGD_PI_2 *
 327                         (puff_progression - (ramp_up + puff_length)) /
 328                         ramp_down;
 329                     double factor = sin( x );
 330                     // cout << "ramp down = "
 331                     //      << puff_progression - (ramp_up + puff_length)
 332                     //      << "  factor = " << factor << endl;
 333                     effvis = effvis * factor;
 334                 } else {
 335                     effvis = 0.0;
 336                 }
 337
 338                 /* cout << "len = " << puff_length
 339                    << "  x = " << x
 340                    << "  factor = " << factor
 341                    << "  actual_visibility = " << actual_visibility
 342                    << endl; */
 343
 344                 // time_factor = ( global_multi_loop *
 345                 //                 current_options.get_speed_up() ) /
 346                 //                (double)current_options.get_model_hz();
 347
 348                 puff_progression += time_factor;
 349                 // cout << "time factor = " << time_factor << endl;
 350
 351                 /* cout << "gml = " << global_multi_loop
 352                    << "  speed up = " << current_options.get_speed_up()
 353                    << "  hz = " << current_options.get_model_hz() << endl;
 354                    */
 355
 356                 if ( puff_progression > puff_length + ramp_up + ramp_down) {
 357                     in_puff = false;
 358                 }
 359             }
 360         }
 361 #endif
 362
 363         // never let visibility drop below the layer's configured visibility
 364        effvis = SG_MAX2<float>(cloud_layers[i]->getVisibility_m(), effvis );
 365
 366     } // for
 367
 368     effective_visibility = effvis;
 369 }
 370
 371