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/Program>
  29 #include <osg/Uniform>
  30 #include <osg/ref_ptr>
  31 #include <osg/Texture2D>
  32 #include <osg/NodeVisitor>
  33 #include <osg/PositionAttitudeTransform>
  34 #include <osg/Material>
  35 #include <osgUtil/UpdateVisitor>
  36 #include <osgDB/ReadFile>
  37 #include <osgDB/FileUtils>
  38
  39
  40 #include <simgear/compiler.h>
  41
  42 #include <plib/sg.h>
  43 #include <simgear/math/sg_random.h>
  44 #include <simgear/misc/sg_path.hxx>
  45 #include <simgear/misc/PathOptions.hxx>
  46 #include <simgear/scene/model/model.hxx>
  47 #include <simgear/scene/util/StateAttributeFactory.hxx>
  48 #include <simgear/scene/util/SGUpdateVisitor.hxx>
  49
  50 #include <algorithm>
  51 #include <osg/GLU>
  52
  53 #include "cloudfield.hxx"
  54 #include "newcloud.hxx"
  55 #include "CloudShaderGeometry.hxx"
  56
  57 using namespace simgear;
  58 using namespace osg;
  59
  60 typedef std::map<std::string, osg::ref_ptr<osg::StateSet> > StateSetMap;
  61
  62 static StateSetMap cloudTextureMap;
  63
  64 static char vertexShaderSource[] =
  65     "#version 120\n"
  66     "\n"
  67     "varying float fogFactor;\n"
  68     "attribute float textureIndexX;\n"
  69     "attribute float textureIndexY;\n"
  70     "attribute float wScale;\n"
  71     "attribute float hScale;\n"
  72     "attribute float shade;\n"
  73     "attribute float cloud_height;\n"
  74     "void main(void)\n"
  75     "{\n"
  76     "  gl_TexCoord[0] = gl_MultiTexCoord0 + vec4(textureIndexX, textureIndexY, 0.0, 0.0);\n"
  77     "  vec4 ep = gl_ModelViewMatrixInverse * vec4(0.0,0.0,0.0,1.0);\n"
  78     "  vec4 l  = gl_ModelViewMatrixInverse * vec4(0.0,0.0,1.0,1.0);\n"
  79     "  vec3 u = normalize(ep.xyz - l.xyz);\n"
  80 // Find a rotation matrix that rotates 1,0,0 into u. u, r and w are
  81 // the columns of that matrix.
  82     "  vec3 absu = abs(u);\n"
  83     "  vec3 r = normalize(vec3(-u.y, u.x, 0));\n"
  84     "  vec3 w = cross(u, r);\n"
  85 // Do the matrix multiplication by [ u r w pos]. Assume no
  86 // scaling in the homogeneous component of pos.
  87     "  gl_Position = vec4(0.0, 0.0, 0.0, 1.0);\n"
  88     "  gl_Position.xyz = gl_Vertex.x * u * wScale;\n"
  89     "  gl_Position.xyz += gl_Vertex.y * r * hScale;\n"
  90     "  gl_Position.xyz += gl_Vertex.z * w;\n"
  91     "  gl_Position.xyz += gl_Color.xyz;\n"
  92 // Determine a lighting normal based on the vertex position from the
  93 // center of the cloud, so that sprite on the opposite side of the cloud to the sun are darker.
  94     "  float n = dot(normalize(gl_LightSource[0].position.xyz), normalize(mat3x3(gl_ModelViewMatrix) * gl_Position.xyz));\n"
  95 // Determine the position - used for fog and shading calculations
  96     "  vec3 ecPosition = vec3(gl_ModelViewMatrix * gl_Position);\n"
  97     "  float fogCoord = abs(ecPosition.z);\n"
  98     "  float fract = smoothstep(0.0, cloud_height, gl_Position.z + cloud_height);\n"
  99 // Final position of the sprite
 100     "  gl_Position = gl_ModelViewProjectionMatrix * gl_Position;\n"
 101 // Limit the normal range from [0,1.0], and apply the shading (vertical factor)
 102     "  n = min(smoothstep(-0.5, 0.5, n), shade * (1.0 - fract) + fract);\n"
 103 // This lighting normal is then used to mix between almost pure ambient (0) and diffuse (1.0) light
 104     "  vec4 backlight = 0.9 * gl_LightSource[0].ambient + 0.1 * gl_LightSource[0].diffuse;\n"
 105     "  gl_FrontColor = mix(backlight, gl_LightSource[0].diffuse, n);\n"
 106     "  gl_FrontColor += gl_FrontLightModelProduct.sceneColor;\n"
 107 // As we get within 100m of the sprite, it is faded out
 108     "  gl_FrontColor.a = smoothstep(10.0, 100.0, fogCoord);\n"
 109     "  gl_BackColor = gl_FrontColor;\n"
 110 // Fog doesn't affect clouds as much as other objects.
 111     "  fogFactor = exp( -gl_Fog.density * fogCoord * 0.5);\n"
 112     "  fogFactor = clamp(fogFactor, 0.0, 1.0);\n"
 113     "}\n";
 114
 115 static char fragmentShaderSource[] =
 116     "uniform sampler2D baseTexture; \n"
 117     "varying float fogFactor;\n"
 118     "\n"
 119     "void main(void)\n"
 120     "{\n"
 121     "  vec4 base = texture2D( baseTexture, gl_TexCoord[0].st);\n"
 122     "  vec4 finalColor = base * gl_Color;\n"
 123     "  gl_FragColor = mix(gl_Fog.color, finalColor, fogFactor );\n"
 124     "}\n";
 125
 126 class SGCloudFogUpdateCallback : public osg::StateAttribute::Callback {
 127     public:
 128         virtual void operator () (osg::StateAttribute* sa, osg::NodeVisitor* nv)
 129         {
 130             SGUpdateVisitor* updateVisitor = static_cast<SGUpdateVisitor*>(nv);
 131             osg::Fog* fog = static_cast<osg::Fog*>(sa);
 132             fog->setMode(osg::Fog::EXP);
 133             fog->setColor(updateVisitor->getFogColor().osg());
 134             fog->setDensity(updateVisitor->getFogExpDensity());
 135         }
 136 };
 137
 138 SGNewCloud::SGNewCloud(const SGPath &tex_path,
 139                        string tex,
 140                        double min_w,
 141                        double max_w,
 142                        double min_h,
 143                        double max_h,
 144                        double min_sprite_w,
 145                        double max_sprite_w,
 146                        double min_sprite_h,
 147                        double max_sprite_h,
 148                        double b,
 149                        int n,
 150                        int nt_x,
 151                        int nt_y) :
 152         min_width(min_w),
 153         max_width(max_w),
 154         min_height(min_h),
 155         max_height(max_h),
 156         min_sprite_width(min_sprite_w),
 157         max_sprite_width(max_sprite_w),
 158         min_sprite_height(min_sprite_h),
 159         max_sprite_height(max_sprite_h),
 160         bottom_shade(b),
 161         num_sprites(n),
 162         num_textures_x(nt_x),
 163         num_textures_y(nt_y),
 164         texture(tex)
 165 {
 166     // Create a new StateSet for the texture, if required.
 167     StateSetMap::iterator iter = cloudTextureMap.find(texture);
 168
 169     if (iter == cloudTextureMap.end()) {
 170         stateSet = new osg::StateSet;
 171
 172         osg::ref_ptr<osgDB::ReaderWriter::Options> options = makeOptionsFromPath(tex_path);
 173
 174         osg::Texture2D *tex = new osg::Texture2D;
 175         tex->setWrap( osg::Texture2D::WRAP_S, osg::Texture2D::CLAMP );
 176         tex->setWrap( osg::Texture2D::WRAP_T, osg::Texture2D::CLAMP );
 177         tex->setImage(osgDB::readImageFile(texture, options.get()));
 178
 179         StateAttributeFactory* attribFactory = StateAttributeFactory::instance();
 180
 181         stateSet->setMode(GL_LIGHTING,  osg::StateAttribute::ON);
 182         stateSet->setMode(GL_CULL_FACE, osg::StateAttribute::OFF);
 183
 184         // Fog handling
 185         osg::Fog* fog = new osg::Fog;
 186         fog->setUpdateCallback(new SGCloudFogUpdateCallback);
 187         stateSet->setAttributeAndModes(fog);
 188         stateSet->setDataVariance(osg::Object::DYNAMIC);
 189
 190         stateSet->setAttributeAndModes(attribFactory->getSmoothShadeModel());
 191         stateSet->setAttributeAndModes(attribFactory->getStandardBlendFunc());
 192
 193         stateSet->setTextureAttributeAndModes(0, tex, osg::StateAttribute::ON );
 194         stateSet->setRenderBinDetails(osg::StateSet::TRANSPARENT_BIN, "DepthSortedBin");
 195
 196         static ref_ptr<AlphaFunc> alphaFunc;
 197         static ref_ptr<Program> program;
 198         static ref_ptr<Uniform> baseTextureSampler;
 199         static ref_ptr<Material> material;
 200
 201         // Generate the shader etc, if we don't already have one.
 202         if (!program.valid()) {
 203             alphaFunc = new AlphaFunc;
 204             alphaFunc->setFunction(AlphaFunc::GREATER,0.001f);
 205             program  = new Program;
 206             baseTextureSampler = new osg::Uniform("baseTexture", 0);
 207             Shader* vertex_shader = new Shader(Shader::VERTEX, vertexShaderSource);
 208             program->addShader(vertex_shader);
 209             program->addBindAttribLocation("textureIndexX", CloudShaderGeometry::TEXTURE_INDEX_X);
 210             program->addBindAttribLocation("textureIndexY", CloudShaderGeometry::TEXTURE_INDEX_Y);
 211             program->addBindAttribLocation("wScale", CloudShaderGeometry::WIDTH);
 212             program->addBindAttribLocation("hScale", CloudShaderGeometry::HEIGHT);
 213             program->addBindAttribLocation("shade", CloudShaderGeometry::SHADE);
 214             program->addBindAttribLocation("cloud_height", CloudShaderGeometry::CLOUD_HEIGHT);
 215
 216             Shader* fragment_shader = new Shader(Shader::FRAGMENT, fragmentShaderSource);
 217             program->addShader(fragment_shader);
 218             material = new Material;
 219             // Don´t track vertex color
 220             material->setColorMode(Material::OFF);
 221
 222             // We don't actually use the material information either - see shader.
 223             material->setAmbient(Material::FRONT_AND_BACK,
 224                                  Vec4(0.5f, 0.5f, 0.5f, 1.0f));
 225             material->setDiffuse(Material::FRONT_AND_BACK,
 226                                  Vec4(0.5f, 0.5f, 0.5f, 1.0f));
 227         }
 228
 229         stateSet->setAttributeAndModes(alphaFunc.get());
 230         stateSet->setAttribute(program.get());
 231         stateSet->addUniform(baseTextureSampler.get());
 232         stateSet->setMode(GL_VERTEX_PROGRAM_TWO_SIDE, StateAttribute::ON);
 233         stateSet->setAttribute(material.get());
 234
 235         // Add the newly created texture to the map for use later.
 236         cloudTextureMap.insert(StateSetMap::value_type(texture,  stateSet));
 237     } else {
 238         stateSet = iter->second.get();
 239     }
 240
 241     quad = createOrthQuad(min_sprite_width, min_sprite_height, num_textures_x, num_textures_y);
 242 }
 243
 244 SGNewCloud::~SGNewCloud() {
 245 }
 246
 247 osg::Geometry* SGNewCloud::createOrthQuad(float w, float h, int varieties_x, int varieties_y)
 248 {
 249     // Create front and back polygons so we don't need to screw around
 250     // with two-sided lighting in the shader.
 251     osg::Vec3Array& v = *(new osg::Vec3Array(4));
 252     osg::Vec3Array& n = *(new osg::Vec3Array(4));
 253     osg::Vec2Array& t = *(new osg::Vec2Array(4));
 254
 255     float cw = w*0.5f;
 256
 257     v[0].set(0.0f, -cw, 0.0f);
 258     v[1].set(0.0f,  cw, 0.0f);
 259     v[2].set(0.0f,  cw, h);
 260     v[3].set(0.0f, -cw, h);
 261
 262     // The texture coordinate range is not the
 263     // entire coordinate space - as the texture
 264     // has a number of different clouds on it.
 265     float tx = 1.0f/varieties_x;
 266     float ty = 1.0f/varieties_y;
 267
 268     t[0].set(0.0f, 0.0f);
 269     t[1].set(  tx, 0.0f);
 270     t[2].set(  tx, ty);
 271     t[3].set(0.0f, ty);
 272
 273     // The normal isn't actually use in lighting.
 274     n[0].set(1.0f, -1.0f, -1.0f);
 275     n[1].set(1.0f,  1.0f, -1.0f);
 276     n[2].set(1.0f,  1.0f,  1.0f);
 277     n[3].set(1.0f, -1.0f,  1.0f);
 278
 279     osg::Geometry *geom = new osg::Geometry;
 280
 281     geom->setVertexArray(&v);
 282     geom->setTexCoordArray(0, &t);
 283     geom->setNormalArray(&n);
 284     geom->setNormalBinding(Geometry::BIND_PER_VERTEX);
 285     // No color for now; that's used to pass the position.
 286     geom->addPrimitiveSet(new osg::DrawArrays(osg::PrimitiveSet::QUADS,0,4));
 287
 288     return geom;
 289 }
 290
 291 // return a random number between -n/2 and n/2, tending to 0
 292 static float Rnd(float n) {
 293     return n * (-0.5f + (sg_random() + sg_random()) / 2.0f);
 294 }
 295
 296 osg::ref_ptr<Geode> SGNewCloud::genCloud() {
 297     Geode* geode = new Geode;
 298     CloudShaderGeometry* sg = new CloudShaderGeometry(num_textures_x, num_textures_y);
 299
 300     // Determine how big this specific cloud instance is. Note that we subtract
 301     // the sprite size because the width/height is used to define the limits of
 302     // the center of the sprites, not their edges.
 303     float width = min_width + sg_random() * (max_width - min_width) - min_sprite_width;
 304     float height = min_height + sg_random() * (max_height - min_height) - min_sprite_height;
 305
 306     // Determine the cull distance. This is used to remove sprites that are too close together.
 307     // The value is squared as we use vector calculations.
 308     float cull_distance_squared = min_sprite_height * min_sprite_height * 0.05f;
 309
 310     for (int i = 0; i < num_sprites; i++)
 311     {
 312         // Determine the position of the sprite. Rather than being completely random,
 313         // we place them on the surface of a distorted sphere. However, we place
 314         // the first and second sprites on the top and bottom, and the third in the
 315         // center of the sphere (and at maximum size) to ensure good coverage and
 316         // reduce the chance of there being "holes" in our cloud.
 317         float x, y, z;
 318
 319         if (i == 0) {
 320             x = 0;
 321             y = 0;
 322             z = height * 0.5f;
 323         } else if (i == 1) {
 324             x = 0;
 325             y = 0;
 326             z = - height * 0.5f;
 327         } else if (i == 2) {
 328             x = 0;
 329             y = 0;
 330             z = 0;
 331         } else {
 332             double theta = sg_random() * SGD_2PI;
 333             double elev  = sg_random() * SGD_PI;
 334             x = width * cos(theta) * 0.5f * sin(elev);
 335             y = width * sin(theta) * 0.5f * sin(elev);
 336             z = height * cos(elev) * 0.5f;
 337         }
 338
 339         SGVec3f *pos = new SGVec3f(x, y, z);
 340
 341         // Determine the height and width as scaling factors on the minimum size (used to create the quad)
 342         float sprite_width = 1.0f + sg_random() * (max_sprite_width - min_sprite_width) / min_sprite_width;
 343         float sprite_height = 1.0f + sg_random() * (max_sprite_height - min_sprite_height) / min_sprite_height;
 344
 345         if (i == 2) {
 346             // The center sprite is always maximum size to fill up any holes.
 347             sprite_width = 1.0f + (max_sprite_width - min_sprite_width) / min_sprite_width;
 348             sprite_height = 1.0f + (max_sprite_height - min_sprite_height) / min_sprite_height;
 349         }
 350
 351         // Determine the sprite texture indexes;
 352         int index_x = (int) floor(sg_random() * num_textures_x);
 353         if (index_x == num_textures_x) { index_x--; }
 354
 355         int index_y = (int) floor(sg_random() * num_textures_y);
 356         if (index_y == num_textures_y) { index_y--; }
 357
 358         sg->addSprite(*pos,
 359                       index_x,
 360                       index_y,
 361                       sprite_width,
 362                       sprite_height,
 363                       bottom_shade,
 364                       cull_distance_squared,
 365                       height * 0.5f);
 366     }
 367
 368     sg->setGeometry(quad);
 369     geode->addDrawable(sg);
 370     geode->setName("3D cloud");
 371     geode->setStateSet(stateSet.get());
 372     return geode;
 373 }