simgear/scene/sky/newcloud.cxx

   1 // 3D cloud class
   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/AlphaFunc>
  28 #include <osg/Depth>
  29 #include <osg/Program>
  30 #include <osg/Uniform>
  31 #include <osg/ref_ptr>
  32 #include <osg/Texture2D>
  33 #include <osg/NodeVisitor>
  34 #include <osg/PositionAttitudeTransform>
  35 #include <osg/Material>
  36 #include <osgUtil/UpdateVisitor>
  37 #include <osgDB/ReadFile>
  38 #include <osgDB/FileUtils>
  39
  40
  41 #include <simgear/compiler.h>
  42
  43 #include <simgear/math/sg_random.h>
  44 #include <simgear/misc/sg_path.hxx>
  45 #include <simgear/props/props.hxx>
  46 #include <simgear/scene/model/model.hxx>
  47 #include <simgear/scene/util/SGReaderWriterOptions.hxx>
  48 #include <simgear/scene/util/StateAttributeFactory.hxx>
  49 #include <simgear/scene/util/SGUpdateVisitor.hxx>
  50 #include <simgear/scene/util/RenderConstants.hxx>
  51
  52 #include <algorithm>
  53 #include <osg/BlendFunc>
  54 #include <osg/GLU>
  55 #include <osg/ShadeModel>
  56
  57 #include "cloudfield.hxx"
  58 #include "newcloud.hxx"
  59 #include "CloudShaderGeometry.hxx"
  60
  61 using namespace simgear;
  62 using namespace osg;
  63 using namespace std;
  64
  65
  66 namespace
  67 {
  68 typedef std::map<std::string, osg::observer_ptr<Effect> > EffectMap;
  69 EffectMap effectMap;
  70 }
  71
  72 float SGNewCloud::sprite_density = 1.0;
  73
  74 SGNewCloud::SGNewCloud(const SGPath &texture_root, const SGPropertyNode *cld_def)
  75 {
  76     min_width = cld_def->getFloatValue("min-cloud-width-m", 500.0);
  77     max_width = cld_def->getFloatValue("max-cloud-width-m", min_width*2);
  78     min_height = cld_def->getFloatValue("min-cloud-height-m", 400.0);
  79     max_height = cld_def->getFloatValue("max-cloud-height-m", min_height*2);
  80     min_sprite_width = cld_def->getFloatValue("min-sprite-width-m", 200.0);
  81     max_sprite_width = cld_def->getFloatValue("max-sprite-width-m", min_sprite_width*1.5);
  82     min_sprite_height = cld_def->getFloatValue("min-sprite-height-m", 150);
  83     max_sprite_height = cld_def->getFloatValue("max-sprite-height-m", min_sprite_height*1.5);
  84     num_sprites = cld_def->getIntValue("num-sprites", 20);
  85     num_textures_x = cld_def->getIntValue("num-textures-x", 4);
  86     num_textures_y = cld_def->getIntValue("num-textures-y", 4);
  87     height_map_texture = cld_def->getBoolValue("height-map-texture", false);
  88
  89     min_bottom_lighting_factor = cld_def->getFloatValue("min-bottom-lighting-factor", 1.0);
  90     max_bottom_lighting_factor = cld_def->getFloatValue("max-bottom-lighting-factor", min(min_bottom_lighting_factor  + 0.1, 1.0));
  91
  92     min_middle_lighting_factor = cld_def->getFloatValue("min-middle-lighting-factor", 1.0);
  93     max_middle_lighting_factor = cld_def->getFloatValue("max-middle-lighting-factor", min(min_middle_lighting_factor  + 0.1, 1.0));
  94
  95     min_top_lighting_factor = cld_def->getFloatValue("min-top-lighting-factor", 1.0);
  96     max_top_lighting_factor = cld_def->getFloatValue("max-top-lighting-factor", min(min_top_lighting_factor  + 0.1, 1.0));
  97
  98     min_shade_lighting_factor = cld_def->getFloatValue("min-shade-lighting-factor", 0.5);
  99     max_shade_lighting_factor = cld_def->getFloatValue("max-shade-lighting-factor", min(min_shade_lighting_factor  + 0.1, 1.0));
 100
 101     zscale = cld_def->getFloatValue("z-scale", 1.0);
 102     texture = cld_def->getStringValue("texture", "cl_cumulus.png");
 103
 104     // Create a new Effect for the texture, if required.
 105     EffectMap::iterator iter = effectMap.find(texture);
 106
 107     if ((iter == effectMap.end())||
 108         (!iter->second.lock(effect)))
 109     {
 110         SGPropertyNode_ptr pcloudEffect = new SGPropertyNode;
 111         makeChild(pcloudEffect, "inherits-from")->setValue("Effects/cloud");
 112         setValue(makeChild(makeChild(makeChild(pcloudEffect, "parameters"),
 113                                      "texture"),
 114                            "image"),
 115                  texture);
 116         ref_ptr<SGReaderWriterOptions> options;
 117         options = SGReaderWriterOptions::fromPath(texture_root.str());
 118         effect = makeEffect(pcloudEffect, true, options.get());
 119         if (effect.valid())
 120         {
 121             if (iter == effectMap.end())
 122                 effectMap.insert(EffectMap::value_type(texture, effect));
 123             else
 124                 iter->second = effect; // update existing, but empty observer
 125         }
 126     }
 127 }
 128
 129 SGNewCloud::~SGNewCloud() {
 130 }
 131
 132 #if 0
 133 // return a random number between -n/2 and n/2, tending to 0
 134 static float Rnd(float n) {
 135     return n * (-0.5f + (sg_random() + sg_random()) / 2.0f);
 136 }
 137 #endif
 138
 139 osg::ref_ptr<EffectGeode> SGNewCloud::genCloud() {
 140
 141     osg::ref_ptr<EffectGeode> geode = new EffectGeode;
 142
 143     // Determine how big this specific cloud instance is. Note that we subtract
 144     // the sprite size because the width/height is used to define the limits of
 145     // the center of the sprites, not their edges.
 146     float width = min_width + sg_random() * (max_width - min_width) - min_sprite_width;
 147     float height = min_height + sg_random() * (max_height - min_height) - min_sprite_height;
 148
 149     if (width  < 0.0) { width  = 0.0; }
 150     if (height < 0.0) { height = 0.0; }
 151
 152     // Determine appropriate shading factors
 153     float top_factor = min_top_lighting_factor + sg_random() * (max_top_lighting_factor - min_top_lighting_factor);
 154     float middle_factor = min_middle_lighting_factor + sg_random() * (max_middle_lighting_factor - min_middle_lighting_factor);
 155     float bottom_factor = min_bottom_lighting_factor + sg_random() * (max_bottom_lighting_factor - min_bottom_lighting_factor);
 156     float shade_factor = min_shade_lighting_factor + sg_random() * (max_shade_lighting_factor - min_shade_lighting_factor);
 157
 158     //printf("Cloud: %2f, %2f, %2f, %2f\n", top_factor, middle_factor, bottom_factor, shade_factor);
 159
 160     CloudShaderGeometry* sg = new CloudShaderGeometry(num_textures_x,
 161                                                       num_textures_y,
 162                                                       max_width + max_sprite_width,
 163                                                       max_height + max_sprite_height,
 164                                                       top_factor,
 165                                                       middle_factor,
 166                                                       bottom_factor,
 167                                                       shade_factor,
 168                                                       height,
 169                                                       zscale);
 170
 171     // Determine the cull distance. This is used to remove sprites that are too close together.
 172     // The value is squared as we use vector calculations.
 173     float cull_distance_squared = min_sprite_height * min_sprite_height * 0.1f;
 174
 175     // The number of sprites we actually use is a function of the (user-controlled) density
 176     int n_sprites = num_sprites * sprite_density * (0.5f + sg_random());
 177
 178     for (int i = 0; i < n_sprites; i++)
 179     {
 180         // Determine the position of the sprite. Rather than being completely random,
 181         // we place them on the surface of a distorted sphere. However, we place
 182         // the first sprite in the center of the sphere (and at maximum size) to
 183               // ensure good coverage and reduce the chance of there being "holes" in the
 184               // middle of our cloud. Also note that (0,0,0) defines the _bottom_ of the
 185               // cloud, not the middle.
 186
 187         float x, y, z;
 188
 189         if (i == 0) {
 190             x = 0;
 191             y = 0;
 192             z = height * 0.5;
 193         } else {
 194             float theta = sg_random() * SGD_2PI;
 195             float elev  = sg_random() * SGD_PI;
 196             x = width * cos(theta) * 0.5f * sin(elev);
 197             y = width * sin(theta) * 0.5f * sin(elev);
 198             z = height * cos(elev) * 0.5f + height * 0.5f;
 199         }
 200
 201         // Determine the height and width
 202         float sprite_width = min_sprite_width + sg_random() * (max_sprite_width - min_sprite_width);
 203         float sprite_height = min_sprite_height + sg_random() * (max_sprite_height - min_sprite_height);
 204
 205         // Sprites are never taller than square.
 206         if (sprite_height > sprite_width )
 207         {
 208             sprite_height = sprite_width;
 209         }
 210
 211         if (i == 0) {
 212             // The center sprite is always maximum size to fill up any holes.
 213             sprite_width = max_sprite_width;
 214             sprite_height = max_sprite_height;
 215         }
 216
 217         // If the center of the sprite is less than half the sprite heightthe sprite will extend
 218         // below the bottom of the cloud and must be shifted upwards. This is particularly important
 219         // for cumulus clouds which have a very well defined base.
 220         if (z < 0.5f * sprite_height)
 221         {
 222             z = 0.5f * sprite_height;
 223         }
 224
 225         // Determine the sprite texture indexes.
 226         int index_x = (int) floor(sg_random() * num_textures_x);
 227         if (index_x >= num_textures_x) { index_x = num_textures_x - 1; }
 228
 229         int index_y = (int) floor(sg_random() * num_textures_y);
 230
 231         if (height_map_texture) {
 232           // The y index depends on the position of the sprite within the cloud.
 233           // This allows cloud designers to have particular sprites for the base
 234           // and tops of the cloud.
 235           index_y = (int) floor((z / height) * num_textures_y);
 236         }
 237
 238         if (index_y >= num_textures_y) { index_y = num_textures_y - 1; }
 239
 240         sg->addSprite(SGVec3f(x, y, z),
 241                       index_x,
 242                       index_y,
 243                       sprite_width,
 244                       sprite_height,
 245                       cull_distance_squared);
 246     }
 247
 248     sg->generateGeometry();
 249     geode->addDrawable(sg);
 250     geode->setName("3D cloud");
 251     geode->setEffect(effect.get());
 252     geode->setNodeMask( ~simgear::MODELLIGHT_BIT );
 253
 254     return geode;
 255 }
 256