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