1 // a layer of 3d clouds
3 // Written by Harald JOHNSEN, started April 2005.
5 // Copyright (C) 2005 Harald JOHNSEN - hjohnsen@evc.net
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.
24 # include <simgear_config.h>
28 #include <osg/Texture2D>
29 #include <osg/PositionAttitudeTransform>
32 #include <simgear/compiler.h>
35 #include <simgear/math/sg_random.h>
36 #include <simgear/math/sg_geodesy.hxx>
37 #include <simgear/math/polar3d.hxx>
44 #include <simgear/environment/visual_enviro.hxx>
45 #include <simgear/scene/util/RenderConstants.hxx>
46 #include <simgear/scene/util/SGUpdateVisitor.hxx>
48 #include "newcloud.hxx"
49 #include "cloudfield.hxx"
51 #if defined(__MINGW32__)
52 #define isnan(x) _isnan(x)
55 #if defined (__FreeBSD__)
56 # if __FreeBSD_version < 500000
58 inline int isnan(double r) { return !(r <= 0 || r >= 0); }
63 using namespace simgear;
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;
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,
75 osg::Matrix T, LON, LAT;
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));
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;
86 SGGeoc pos = SGGeoc::fromGeod(SGGeod::fromRad(lon, lat));
88 double dist = SGGeodesy::distanceM(cld_pos, pos);
90 if (dist > (fieldSize * 2)) {
91 // First time or very large distance
93 SGGeodesy::SGGeodToCart(SGGeod::fromRad(lon, lat), cart);
94 T.makeTranslate(toOsg(cart));
96 LON.makeRotate(lon, osg::Vec3(0, 0, 1));
97 LAT.makeRotate(90.0 * SGD_DEGREES_TO_RADIANS - lat, osg::Vec3(0, 1, 0));
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
106 SGGeoc pos = SGGeoc::fromGeod(SGGeod::fromRad(lon, lat));
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);
113 if ((crs > 45.0) && (crs < 135.0)) {
114 SGGeodesy::advanceRadM(cld_pos, SGD_PI_2, fieldSize, cld_pos);
117 if ((crs > 135.0) && (crs < 225.0)) {
118 SGGeodesy::advanceRadM(cld_pos, SGD_PI, fieldSize, cld_pos);
121 if ((crs > 225.0) && (crs < 315.0)) {
122 SGGeodesy::advanceRadM(cld_pos, SGD_PI + SGD_PI_2, fieldSize, cld_pos);
126 SGGeodesy::SGGeodToCart(SGGeod::fromRad(cld_pos.getLongitudeRad(), cld_pos.getLatitudeRad()), cart);
127 T.makeTranslate(toOsg(cart));
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));
132 field_transform->setMatrix( LAT*LON*T );
135 field_root->getStateSet()->setRenderBinDetails(asl, "DepthSortedBin");
140 SGCloudField::SGCloudField() :
141 field_root(new osg::Group),
142 field_transform(new osg::MatrixTransform),
143 altitude_transform(new osg::PositionAttitudeTransform),
153 field_root->addChild(field_transform.get());
154 field_root->setName("3D Cloud field root");
155 osg::StateSet *rootSet = field_root->getOrCreateStateSet();
156 rootSet->setRenderBinDetails(CLOUDS_BIN, "DepthSortedBin");
157 rootSet->setAttributeAndModes(getFog());
159 osg::ref_ptr<osg::Group> quad_root = new osg::Group();
161 for (int i = 0; i < BRANCH_SIZE; i++) {
162 for (int j = 0; j < BRANCH_SIZE; j++) {
163 quad[i][j] = new osg::LOD();
164 quad[i][j]->setName("Quad");
165 quad_root->addChild(quad[i][j].get());
169 int leafs = QUADTREE_SIZE / BRANCH_SIZE;
171 for (int x = 0; x < QUADTREE_SIZE; x++) {
172 for (int y = 0; y < QUADTREE_SIZE; y++) {
173 field_group[x][y]= new osg::Switch;
174 field_group[x][y]->setName("3D cloud group");
176 // Work out where to put this node in the quad tree
179 quad[i][j]->addChild(field_group[x][y].get(), 0.0f, view_distance);
183 field_transform->addChild(altitude_transform.get());
185 // We duplicate the defined field group in a 3x3 array. This way,
186 // we can simply shift entire groups around.
187 // TODO: "Bend" the edge groups so when shifted they line up.
188 // Currently the clouds "jump down" when we reposition them.
189 for(int x = -1 ; x <= 1 ; x++) {
190 for(int y = -1 ; y <= 1 ; y++ ) {
191 osg::ref_ptr<osg::PositionAttitudeTransform> transform =
192 new osg::PositionAttitudeTransform;
193 transform->addChild(quad_root.get());
194 transform->setPosition(osg::Vec3(x*fieldSize, y * fieldSize, 0.0));
196 altitude_transform->addChild(transform.get());
201 SGCloudField::~SGCloudField() {
205 void SGCloudField::clear(void) {
206 for (int x = 0; x < QUADTREE_SIZE; x++) {
207 for (int y = 0; y < QUADTREE_SIZE; y++) {
208 int num_children = field_group[x][y]->getNumChildren();
209 field_group[x][y]->removeChildren(0, num_children);
213 SGCloudField::defined3D = false;
216 // use a table or else we see poping when moving the slider...
217 static int densTable[][10] = {
218 {0,0,0,0,0,0,0,0,0,0},
219 {1,0,0,0,0,0,0,0,0,0},
220 {1,0,0,0,1,0,0,0,0,0},
221 {1,0,0,0,1,0,0,1,0,0}, // 30%
222 {1,0,1,0,1,0,0,1,0,0},
223 {1,0,1,0,1,0,1,1,0,0}, // 50%
224 {1,0,1,0,1,0,1,1,0,1},
225 {1,0,1,1,1,0,1,1,0,1}, // 70%
226 {1,1,1,1,1,0,1,1,0,1},
227 {1,1,1,1,1,0,1,1,1,1}, // 90%
228 {1,1,1,1,1,1,1,1,1,1}
231 void SGCloudField::applyCoverage(void) {
233 int row = (int) (coverage * 10.0);
234 if (row > 9) row = 9;
237 if (coverage != last_coverage) {
238 for (int x = 0; x < QUADTREE_SIZE; x++) {
239 for (int y = 0; y < QUADTREE_SIZE; y++) {
240 // Switch on/off the children depending on the required coverage.
241 int num_children = field_group[x][y]->getNumChildren();
242 for (int i = 0; i < num_children; i++) {
243 if (++col > 9) col = 0;
244 if ( densTable[row][col] ) {
245 field_group[x][y]->setValue(i, true);
247 field_group[x][y]->setValue(i, false);
254 last_coverage = coverage;
257 void SGCloudField::addCloud( SGVec3f& pos, SGNewCloud *cloud) {
259 osg::ref_ptr<osg::Geode> geode = cloud->genCloud();
261 // Determine which quadtree to put it in.
262 int x = (int) floor((pos.x() + fieldSize/2.0) * QUADTREE_SIZE / fieldSize);
263 if (x >= QUADTREE_SIZE) x = (QUADTREE_SIZE - 1);
266 int y = (int) floor((pos.y() + fieldSize/2.0) * QUADTREE_SIZE / fieldSize);
267 if (y >= QUADTREE_SIZE) y = (QUADTREE_SIZE - 1);
270 osg::ref_ptr<osg::PositionAttitudeTransform> transform = new osg::PositionAttitudeTransform;
272 transform->setPosition(toOsg(pos));
273 transform->addChild(geode.get());
275 field_group[x][y]->addChild(transform.get(), true);
278 void SGCloudField::applyVisRange(void) {
280 for (int x = 0; x < BRANCH_SIZE; x++) {
281 for (int y = 0; y < BRANCH_SIZE; y++) {
282 int num_children = quad[x][y]->getNumChildren();
283 for (int i = 0; i < num_children; i++) {
284 quad[x][y]->setRange(i, 0.0f, view_distance);
290 SGCloudField::CloudFog::CloudFog()
293 fog->setMode(osg::Fog::EXP2);
294 fog->setDataVariance(osg::Object::DYNAMIC);
297 void SGCloudField::updateFog(double visibility, const osg::Vec4f& color)
299 const double sqrt_m_log01 = sqrt(-log(0.01));
300 osg::Fog* fog = CloudFog::instance()->fog.get();
301 fog->setColor(color);
302 fog->setDensity(sqrt_m_log01 / visibility);