simgear/scene/sky/cloudfield.cxx

   1 // a layer of 3d clouds
   2 //
   3 // Written by Harald JOHNSEN, started April 2005.
   4 //
   5 // Copyright (C) 2005  Harald JOHNSEN - hjohnsen@evc.net
   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 //
  22
  23 #ifdef HAVE_CONFIG_H
  24 #  include <simgear_config.h>
  25 #endif
  26
  27 #include <osg/Fog>
  28 #include <osg/Texture2D>
  29 #include <osg/PositionAttitudeTransform>
  30 #include <osg/Vec4f>
  31
  32 #include <simgear/compiler.h>
  33
  34 #include <simgear/math/sg_random.h>
  35 #include <simgear/math/sg_geodesy.hxx>
  36
  37 #include <algorithm>
  38 #include <vector>
  39
  40 using std::vector;
  41
  42 #include <simgear/environment/visual_enviro.hxx>
  43 #include <simgear/scene/util/RenderConstants.hxx>
  44 #include <simgear/scene/util/SGUpdateVisitor.hxx>
  45 #include "sky.hxx"
  46 #include "newcloud.hxx"
  47 #include "cloudfield.hxx"
  48
  49 #if defined(__MINGW32__)
  50 #define isnan(x) _isnan(x)
  51 #endif
  52
  53 #if defined (__FreeBSD__)
  54 #  if __FreeBSD_version < 500000
  55      extern "C" {
  56        inline int isnan(double r) { return !(r <= 0 || r >= 0); }
  57      }
  58 #  endif
  59 #endif
  60
  61 using namespace simgear;
  62
  63
  64 float SGCloudField::fieldSize = 50000.0f;
  65 double SGCloudField::timer_dt = 0.0;
  66 float SGCloudField::view_distance = 20000.0f;
  67 SGVec3f SGCloudField::view_vec, SGCloudField::view_X, SGCloudField::view_Y;
  68
  69 // reposition the cloud layer at the specified origin and orientation
  70 bool SGCloudField::reposition( const SGVec3f& p, const SGVec3f& up, double lon, double lat,
  71                                double dt, int asl )
  72 {
  73     osg::Matrix T, LON, LAT;
  74
  75     // Always update the altitude transform, as this allows
  76     // the clouds to rise and fall smoothly depending on environment updates.
  77     altitude_transform->setPosition(osg::Vec3d(0.0, 0.0, (double) asl));
  78
  79     // Calculating the reposition information is expensive.
  80     // Only perform the reposition every 60 frames.
  81     reposition_count = (reposition_count + 1) % 60;
  82     if ((reposition_count != 0) || !defined3D) return false;
  83
  84     SGGeoc pos = SGGeoc::fromGeod(SGGeod::fromRad(lon, lat));
  85
  86     double dist = SGGeodesy::distanceM(cld_pos, pos);
  87
  88     if (dist > (fieldSize * 2)) {
  89         // First time or very large distance
  90         SGVec3<double> cart;
  91         SGGeodesy::SGGeodToCart(SGGeod::fromRad(lon, lat), cart);
  92         T.makeTranslate(toOsg(cart));
  93
  94         LON.makeRotate(lon, osg::Vec3(0, 0, 1));
  95         LAT.makeRotate(90.0 * SGD_DEGREES_TO_RADIANS - lat, osg::Vec3(0, 1, 0));
  96
  97         field_transform->setMatrix( LAT*LON*T );
  98         cld_pos = SGGeoc::fromGeod(SGGeod::fromRad(lon, lat));
  99     } else if (dist > fieldSize) {
 100         // Distance requires repositioning of cloud field.
 101         // We can easily work out the direction to reposition
 102         // from the course between the cloud position and the
 103         // camera position.
 104         SGGeoc pos = SGGeoc::fromGeod(SGGeod::fromRad(lon, lat));
 105
 106         float crs = SGGeoc::courseDeg(cld_pos, pos);
 107         if ((crs < 45.0) || (crs > 315.0)) {
 108             SGGeodesy::advanceRadM(cld_pos, 0.0, fieldSize, cld_pos);
 109         }
 110
 111         if ((crs > 45.0) && (crs < 135.0)) {
 112             SGGeodesy::advanceRadM(cld_pos, SGD_PI_2, fieldSize, cld_pos);
 113         }
 114
 115         if ((crs > 135.0) && (crs < 225.0)) {
 116             SGGeodesy::advanceRadM(cld_pos, SGD_PI, fieldSize, cld_pos);
 117         }
 118
 119         if ((crs > 225.0) && (crs < 315.0)) {
 120             SGGeodesy::advanceRadM(cld_pos, SGD_PI + SGD_PI_2, fieldSize, cld_pos);
 121         }
 122
 123         SGVec3<double> cart;
 124         SGGeodesy::SGGeodToCart(SGGeod::fromRad(cld_pos.getLongitudeRad(), cld_pos.getLatitudeRad()), cart);
 125         T.makeTranslate(toOsg(cart));
 126
 127         LON.makeRotate(cld_pos.getLongitudeRad(), osg::Vec3(0, 0, 1));
 128         LAT.makeRotate(90.0 * SGD_DEGREES_TO_RADIANS - cld_pos.getLatitudeRad(), osg::Vec3(0, 1, 0));
 129
 130         field_transform->setMatrix( LAT*LON*T );
 131     }
 132
 133     // Render the clouds in order from farthest away layer to nearest one.
 134     field_root->getStateSet()->setRenderBinDetails(CLOUDS_BIN, "DepthSortedBin");
 135
 136     return true;
 137 }
 138
 139 SGCloudField::SGCloudField() :
 140         field_root(new osg::Group),
 141         field_transform(new osg::MatrixTransform),
 142         altitude_transform(new osg::PositionAttitudeTransform),
 143         deltax(0.0),
 144         deltay(0.0),
 145         last_course(0.0),
 146         last_coverage(0.0),
 147         coverage(0.0),
 148         reposition_count(0),
 149         defined3D(false)
 150 {
 151     cld_pos = SGGeoc();
 152     field_root->addChild(field_transform.get());
 153     field_root->setName("3D Cloud field root");
 154     osg::StateSet *rootSet = field_root->getOrCreateStateSet();
 155     rootSet->setRenderBinDetails(CLOUDS_BIN, "DepthSortedBin");
 156     rootSet->setAttributeAndModes(getFog());
 157
 158     osg::ref_ptr<osg::Group> quad_root = new osg::Group();
 159
 160     for (int i = 0; i < BRANCH_SIZE; i++) {
 161         for (int j = 0; j < BRANCH_SIZE; j++) {
 162             quad[i][j] = new osg::LOD();
 163             quad[i][j]->setName("Quad");
 164             quad_root->addChild(quad[i][j].get());
 165         }
 166     }
 167
 168     int leafs = QUADTREE_SIZE / BRANCH_SIZE;
 169
 170     for (int x = 0; x < QUADTREE_SIZE; x++) {
 171         for (int y = 0; y < QUADTREE_SIZE; y++) {
 172             field_group[x][y]= new osg::Switch;
 173             field_group[x][y]->setName("3D cloud group");
 174
 175             // Work out where to put this node in the quad tree
 176             int i = x / leafs;
 177             int j = y / leafs;
 178             quad[i][j]->addChild(field_group[x][y].get(), 0.0f, view_distance);
 179         }
 180     }
 181
 182     field_transform->addChild(altitude_transform.get());
 183
 184     // We duplicate the defined field group in a 3x3 array. This way,
 185     // we can simply shift entire groups around.
 186     // TODO: "Bend" the edge groups so when shifted they line up.
 187     // Currently the clouds "jump down" when we reposition them.
 188     for(int x = -1 ; x <= 1 ; x++) {
 189         for(int y = -1 ; y <= 1 ; y++ ) {
 190             osg::ref_ptr<osg::PositionAttitudeTransform> transform =
 191                     new osg::PositionAttitudeTransform;
 192             transform->addChild(quad_root.get());
 193             transform->setPosition(osg::Vec3(x*fieldSize, y * fieldSize, 0.0));
 194
 195             altitude_transform->addChild(transform.get());
 196         }
 197     }
 198 }
 199
 200 SGCloudField::~SGCloudField() {
 201 }
 202
 203
 204 void SGCloudField::clear(void) {
 205     for (int x = 0; x < QUADTREE_SIZE; x++) {
 206         for (int y = 0; y < QUADTREE_SIZE; y++) {
 207             int num_children = field_group[x][y]->getNumChildren();
 208             field_group[x][y]->removeChildren(0, num_children);
 209         }
 210     }
 211
 212     SGCloudField::defined3D = false;
 213 }
 214
 215 // use a table or else we see poping when moving the slider...
 216 static int densTable[][10] = {
 217         {0,0,0,0,0,0,0,0,0,0},
 218         {1,0,0,0,0,0,0,0,0,0},
 219         {1,0,0,0,1,0,0,0,0,0},
 220         {1,0,0,0,1,0,0,1,0,0}, // 30%
 221         {1,0,1,0,1,0,0,1,0,0},
 222         {1,0,1,0,1,0,1,1,0,0}, // 50%
 223         {1,0,1,0,1,0,1,1,0,1},
 224         {1,0,1,1,1,0,1,1,0,1}, // 70%
 225         {1,1,1,1,1,0,1,1,0,1},
 226         {1,1,1,1,1,0,1,1,1,1}, // 90%
 227         {1,1,1,1,1,1,1,1,1,1}
 228 };
 229
 230 void SGCloudField::applyCoverage(void) {
 231
 232         int row = (int) (coverage * 10.0);
 233         if (row > 9) row = 9;
 234         int col = 0;
 235
 236         if (coverage != last_coverage) {
 237             for (int x = 0; x < QUADTREE_SIZE; x++) {
 238                 for (int y = 0; y < QUADTREE_SIZE; y++) {
 239                 // Switch on/off the children depending on the required coverage.
 240                     int num_children = field_group[x][y]->getNumChildren();
 241                     for (int i = 0; i < num_children; i++) {
 242                         if (++col > 9) col = 0;
 243                         if ( densTable[row][col] ) {
 244                             field_group[x][y]->setValue(i, true);
 245                         } else {
 246                             field_group[x][y]->setValue(i, false);
 247                         }
 248                     }
 249                 }
 250             }
 251         }
 252
 253         last_coverage = coverage;
 254 }
 255
 256 void SGCloudField::addCloud( SGVec3f& pos, SGNewCloud *cloud) {
 257         defined3D = true;
 258         osg::ref_ptr<osg::Geode> geode = cloud->genCloud();
 259
 260         // Determine which quadtree to put it in.
 261         int x = (int) floor((pos.x() + fieldSize/2.0) * QUADTREE_SIZE / fieldSize);
 262         if (x >= QUADTREE_SIZE) x = (QUADTREE_SIZE - 1);
 263         if (x < 0) x = 0;
 264
 265         int y = (int) floor((pos.y() + fieldSize/2.0) * QUADTREE_SIZE / fieldSize);
 266         if (y >= QUADTREE_SIZE) y = (QUADTREE_SIZE - 1);
 267         if (y < 0) y = 0;
 268
 269         osg::ref_ptr<osg::PositionAttitudeTransform> transform = new osg::PositionAttitudeTransform;
 270
 271         transform->setPosition(toOsg(pos));
 272         transform->addChild(geode.get());
 273
 274         field_group[x][y]->addChild(transform.get(), true);
 275 }
 276
 277 void SGCloudField::applyVisRange(void) {
 278
 279     for (int x = 0; x < BRANCH_SIZE; x++) {
 280         for (int y = 0; y < BRANCH_SIZE; y++) {
 281             int num_children = quad[x][y]->getNumChildren();
 282             for (int i = 0; i < num_children; i++) {
 283                 quad[x][y]->setRange(i, 0.0f, view_distance);
 284             }
 285         }
 286     }
 287 }
 288
 289 SGCloudField::CloudFog::CloudFog()
 290 {
 291     fog = new osg::Fog;
 292     fog->setMode(osg::Fog::EXP2);
 293     fog->setDataVariance(osg::Object::DYNAMIC);
 294 }
 295
 296 void SGCloudField::updateFog(double visibility, const osg::Vec4f& color)
 297 {
 298     const double sqrt_m_log01 = sqrt(-log(0.01));
 299     osg::Fog* fog = CloudFog::instance()->fog.get();
 300     fog->setColor(color);
 301     fog->setDensity(sqrt_m_log01 / visibility);
 302 }