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>
34 #include <simgear/math/sg_random.h>
35 #include <simgear/math/sg_geodesy.hxx>
36 #include <simgear/scene/util/SGSceneUserData.hxx>
46 #include <simgear/environment/visual_enviro.hxx>
47 #include <simgear/scene/util/RenderConstants.hxx>
48 #include <simgear/scene/util/SGUpdateVisitor.hxx>
50 #include "newcloud.hxx"
51 #include "cloudfield.hxx"
53 #if defined(__MINGW32__)
54 #define isnan(x) _isnan(x)
57 #if defined (__FreeBSD__)
58 # if __FreeBSD_version < 500000
60 inline int isnan(double r) { return !(r <= 0 || r >= 0); }
65 using namespace simgear;
67 float SGCloudField::fieldSize = 50000.0f;
68 double SGCloudField::timer_dt = 0.0;
69 float SGCloudField::view_distance = 20000.0f;
70 bool SGCloudField::wrap = true;
71 float SGCloudField::RADIUS_LEVEL_1 = 20000.0f;
72 float SGCloudField::RADIUS_LEVEL_2 = 5000.0f;
74 SGVec3f SGCloudField::view_vec, SGCloudField::view_X, SGCloudField::view_Y;
77 // Reposition the cloud layer at the specified origin and orientation
78 bool SGCloudField::reposition( const SGVec3f& p, const SGVec3f& up, double lon, double lat,
79 double dt, int asl, float speed, float direction ) {
80 // Determine any movement of the placed clouds
81 if (placed_root->getNumChildren() == 0) return false;
84 SGGeodesy::SGGeodToCart(SGGeod::fromRadFt(lon, lat, 0.0f), cart);
85 osg::Vec3f osg_pos = toOsg(cart);
86 osg::Quat orient = toOsg(SGQuatd::fromLonLatRad(lon, lat) * SGQuatd::fromRealImag(0, SGVec3d(0, 1, 0)));
88 // Always update the altitude transform, as this allows
89 // the clouds to rise and fall smoothly depending on environment updates.
90 osg::Vec3f alt = orient * osg::Vec3f(0.0f, 0.0f, (float) asl);
91 altitude_transform->setPosition(alt);
93 // Similarly, always determine the effects of the wind
94 osg::Vec3f wind = osg::Vec3f(-cos((direction + 180)* SGD_DEGREES_TO_RADIANS) * speed * dt,
95 sin((direction + 180)* SGD_DEGREES_TO_RADIANS) * speed * dt,
97 //cout << "Wind: " << direction << "@" << speed << "\n";
99 osg::Vec3f windosg = field_transform->getAttitude() * wind;
100 field_transform->setPosition(field_transform->getPosition() + windosg);
103 // If we're not wrapping the cloudfield, then we make no effort to reposition
107 if ((old_pos - osg_pos).length() > fieldSize*2) {
108 // Big movement - reposition centered to current location.
109 field_transform->setPosition(osg_pos);
110 field_transform->setAttitude(orient);
113 // delta is the vector from the old position to the new position in cloud-coords
114 osg::Vec3f delta = field_transform->getAttitude().inverse() * (osg_pos - old_pos);
115 //cout << "Delta: " << delta.length() << "\n";
117 for (unsigned int i = 0; i < placed_root->getNumChildren(); i++) {
118 osg::ref_ptr<osg::LOD> lodnode1 = (osg::LOD*) placed_root->getChild(i);
119 osg::Vec3f v = delta - lodnode1->getCenter();
121 if ((v.x() < -0.5*fieldSize) ||
122 (v.x() > 0.5*fieldSize) ||
123 (v.y() < -0.5*fieldSize) ||
124 (v.y() > 0.5*fieldSize) ) {
125 //cout << "V: " << v.x() << ", " << v.y() << "\n";
127 osg::Vec3f shift = osg::Vec3f(0.0f, 0.0f, 0.0f);
128 if (v.x() > 0.5*fieldSize) { shift += osg::Vec3f(fieldSize, 0.0f, 0.0f); }
129 if (v.x() < -0.5*fieldSize) { shift -= osg::Vec3f(fieldSize, 0.0f, 0.0f); }
131 if (v.y() > 0.5*fieldSize) { shift += osg::Vec3f(0.0f, fieldSize, 0.0f); }
132 if (v.y() < -0.5*fieldSize) { shift -= osg::Vec3f(0.0f, fieldSize, 0.0f); }
134 //cout << "Shift: " << shift.x() << ", " << shift.y() << "\n\n";
136 for (unsigned int j = 0; j < lodnode1->getNumChildren(); j++) {
137 osg::ref_ptr<osg::LOD> lodnode2 = (osg::LOD*) lodnode1->getChild(j);
138 for (unsigned int k = 0; k < lodnode2->getNumChildren(); k++) {
139 osg::ref_ptr<osg::PositionAttitudeTransform> pat =(osg::PositionAttitudeTransform*) lodnode2->getChild(k);
140 pat->setPosition(pat->getPosition() + shift);
147 // Render the clouds in order from farthest away layer to nearest one.
148 field_root->getStateSet()->setRenderBinDetails(CLOUDS_BIN, "DepthSortedBin");
152 SGCloudField::SGCloudField() :
153 field_root(new osg::Group),
154 field_transform(new osg::PositionAttitudeTransform),
155 altitude_transform(new osg::PositionAttitudeTransform)
157 old_pos = osg::Vec3f(0.0f, 0.0f, 0.0f);
158 field_root->addChild(field_transform.get());
159 field_root->setName("3D Cloud field root");
160 osg::StateSet *rootSet = field_root->getOrCreateStateSet();
161 rootSet->setRenderBinDetails(CLOUDS_BIN, "DepthSortedBin");
162 rootSet->setAttributeAndModes(getFog());
164 field_transform->addChild(altitude_transform.get());
165 placed_root = new osg::Group();
166 altitude_transform->addChild(placed_root);
169 SGCloudField::~SGCloudField() {
173 void SGCloudField::clear(void) {
175 for(CloudHash::const_iterator itr = cloud_hash.begin(), end = cloud_hash.end();
178 removeCloudFromTree(itr->second);
184 void SGCloudField::applyVisRange(void)
186 for (unsigned int i = 0; i < placed_root->getNumChildren(); i++) {
187 osg::ref_ptr<osg::LOD> lodnode1 = (osg::LOD*) placed_root->getChild(i);
188 for (unsigned int j = 0; j < lodnode1->getNumChildren(); j++) {
189 osg::ref_ptr<osg::LOD> lodnode2 = (osg::LOD*) lodnode1->getChild(j);
190 for (unsigned int k = 0; k < lodnode2->getNumChildren(); k++) {
191 lodnode2->setRange(k, 0.0f, view_distance);
197 bool SGCloudField::addCloud(float lon, float lat, float alt, int index, osg::ref_ptr<EffectGeode> geode) {
198 return addCloud(lon, lat, alt, 0.0f, 0.0f, index, geode);
201 bool SGCloudField::addCloud(float lon, float lat, float alt, float x, float y, int index, osg::ref_ptr<EffectGeode> geode) {
202 // If this cloud index already exists, don't replace it.
203 if (cloud_hash[index]) return false;
205 osg::ref_ptr<osg::PositionAttitudeTransform> transform = new osg::PositionAttitudeTransform;
207 transform->addChild(geode.get());
208 addCloudToTree(transform, lon, lat, alt, x, y);
209 cloud_hash[index] = transform;
213 // Remove a give cloud from inside the tree, without removing it from the cloud hash
214 void SGCloudField::removeCloudFromTree(osg::ref_ptr<osg::PositionAttitudeTransform> transform)
216 osg::ref_ptr<osg::Group> lodnode = transform->getParent(0);
217 lodnode->removeChild(transform);
219 // Clean up the LOD nodes if required
220 if (lodnode->getNumChildren() == 0) {
221 osg::ref_ptr<osg::Group> lodnode1 = lodnode->getParent(0);
223 lodnode1->removeChild(lodnode);
225 if (lodnode1->getNumChildren() == 0) {
226 placed_root->removeChild(lodnode1);
231 void SGCloudField::addCloudToTree(osg::ref_ptr<osg::PositionAttitudeTransform> transform,
232 float lon, float lat, float alt, float x, float y) {
233 // Work out where this cloud should go in OSG coordinates.
235 SGGeodesy::SGGeodToCart(SGGeod::fromDegFt(lon, lat, alt), cart);
237 // Convert to the scenegraph orientation where we just rotate around
238 // the y axis 180 degrees.
239 osg::Quat orient = toOsg(SGQuatd::fromLonLatDeg(lon, lat) * SGQuatd::fromRealImag(0, SGVec3d(0, 1, 0)));
240 osg::Vec3f pos = toOsg(cart) + orient * osg::Vec3f(x, y, 0.0f);
242 if (old_pos == osg::Vec3f(0.0f, 0.0f, 0.0f)) {
244 SGVec3<double> fieldcenter;
245 SGGeodesy::SGGeodToCart(SGGeod::fromDegFt(lon, lat, 0.0f), fieldcenter);
247 field_transform->setPosition(toOsg(fieldcenter));
248 field_transform->setAttitude(orient);
249 old_pos = toOsg(fieldcenter);
252 pos = pos - field_transform->getPosition();
254 pos = orient.inverse() * pos;
256 // We have a two level dynamic quad tree which the cloud will be added
257 // to. If there are no appropriate nodes in the quad tree, they are
258 // created as required.
260 osg::ref_ptr<osg::LOD> lodnode1;
261 osg::ref_ptr<osg::LOD> lodnode;
263 for (unsigned int i = 0; (!found) && (i < placed_root->getNumChildren()); i++) {
264 lodnode1 = (osg::LOD*) placed_root->getChild(i);
265 if ((lodnode1->getCenter() - pos).length2() < RADIUS_LEVEL_1*RADIUS_LEVEL_1) {
266 // New cloud is within RADIUS_LEVEL_1 of the center of the LOD node.
267 //cout << "Adding cloud to existing LoD level 1 node. Distance:" << (lodnode1->getCenter() - pos).length() << "\n";
273 lodnode1 = new osg::LOD();
274 placed_root->addChild(lodnode1.get());
275 //cout << "Adding cloud to new LoD node\n";
278 // Now check if there is a second level LOD node at an appropriate distance
281 for (unsigned int j = 0; (!found) && (j < lodnode1->getNumChildren()); j++) {
282 lodnode = (osg::LOD*) lodnode1->getChild(j);
283 if ((lodnode->getCenter() - pos).length2() < RADIUS_LEVEL_2*RADIUS_LEVEL_2) {
284 // We've found the right leaf LOD node
285 //cout << "Found existing LOD leaf node. Distance:"<< (lodnode->getCenter() - pos).length() << "\n";
291 // No suitable leave node was found, so we need to add one.
292 lodnode = new osg::LOD();
293 lodnode1->addChild(lodnode, 0.0f, 4*RADIUS_LEVEL_1);
294 //cout << "Adding cloud to new LoD node\n";
297 transform->setPosition(pos);
298 lodnode->addChild(transform.get(), 0.0f, view_distance);
300 lodnode->dirtyBound();
301 lodnode1->dirtyBound();
302 field_root->dirtyBound();
305 bool SGCloudField::deleteCloud(int identifier) {
306 osg::ref_ptr<osg::PositionAttitudeTransform> transform = cloud_hash[identifier];
307 if (transform == NULL) return false;
309 removeCloudFromTree(transform);
310 cloud_hash.erase(identifier);
315 bool SGCloudField::repositionCloud(int identifier, float lon, float lat, float alt) {
316 return repositionCloud(identifier, lon, lat, alt, 0.0f, 0.0f);
319 bool SGCloudField::repositionCloud(int identifier, float lon, float lat, float alt, float x, float y) {
320 osg::ref_ptr<osg::PositionAttitudeTransform> transform = cloud_hash[identifier];
322 if (transform == NULL) return false;
324 removeCloudFromTree(transform);
325 addCloudToTree(transform, lon, lat, alt, x, y);
329 bool SGCloudField::isDefined3D(void) {
330 return (cloud_hash.size() > 0);
333 SGCloudField::CloudFog::CloudFog() {
335 fog->setMode(osg::Fog::EXP2);
336 fog->setDataVariance(osg::Object::DYNAMIC);
339 void SGCloudField::updateFog(double visibility, const osg::Vec4f& color) {
340 const double sqrt_m_log01 = sqrt(-log(0.01));
341 osg::Fog* fog = CloudFog::instance()->fog.get();
342 fog->setColor(color);
343 fog->setDensity(sqrt_m_log01 / visibility);