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>
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>
40 #include <simgear/compiler.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>
53 #include "cloudfield.hxx"
54 #include "newcloud.hxx"
55 #include "CloudShaderGeometry.hxx"
57 using namespace simgear;
60 typedef std::map<std::string, osg::ref_ptr<osg::StateSet> > StateSetMap;
61 typedef std::vector< osg::ref_ptr<osg::Geode> > GeodeList;
62 typedef std::map<std::string, GeodeList*> CloudMap;
64 StateSetMap cloudTextureMap;
65 static CloudMap cloudMap;
66 double SGNewCloud::sprite_density = 1.0;
67 unsigned int SGNewCloud::num_flavours = 10;
69 static char vertexShaderSource[] =
72 "varying float fogFactor;\n"
73 "attribute vec3 usrAttr1;\n"
74 "attribute vec3 usrAttr2;\n"
75 "float textureIndexX = usrAttr1.r;\n"
76 "float textureIndexY = usrAttr1.g;\n"
77 "float wScale = usrAttr1.b;\n"
78 "float hScale = usrAttr2.r;\n"
79 "float shade = usrAttr2.g;\n"
80 "float cloud_height = usrAttr2.b;\n"
83 " gl_TexCoord[0] = gl_MultiTexCoord0 + vec4(textureIndexX, textureIndexY, 0.0, 0.0);\n"
84 " vec4 ep = gl_ModelViewMatrixInverse * vec4(0.0,0.0,0.0,1.0);\n"
85 " vec4 l = gl_ModelViewMatrixInverse * vec4(0.0,0.0,1.0,1.0);\n"
86 " vec3 u = normalize(ep.xyz - l.xyz);\n"
87 // Find a rotation matrix that rotates 1,0,0 into u. u, r and w are
88 // the columns of that matrix.
89 " vec3 absu = abs(u);\n"
90 " vec3 r = normalize(vec3(-u.y, u.x, 0));\n"
91 " vec3 w = cross(u, r);\n"
92 // Do the matrix multiplication by [ u r w pos]. Assume no
93 // scaling in the homogeneous component of pos.
94 " gl_Position = vec4(0.0, 0.0, 0.0, 1.0);\n"
95 " gl_Position.xyz = gl_Vertex.x * u * wScale;\n"
96 " gl_Position.xyz += gl_Vertex.y * r * hScale;\n"
97 " gl_Position.xyz += gl_Vertex.z * w;\n"
98 " gl_Position.xyz += gl_Color.xyz;\n"
99 // Determine a lighting normal based on the vertex position from the
100 // center of the cloud, so that sprite on the opposite side of the cloud to the sun are darker.
101 " float n = dot(normalize(gl_LightSource[0].position.xyz), normalize(mat3x3(gl_ModelViewMatrix) * gl_Position.xyz));\n"
102 // Determine the position - used for fog and shading calculations
103 " vec3 ecPosition = vec3(gl_ModelViewMatrix * gl_Position);\n"
104 " float fogCoord = abs(ecPosition.z);\n"
105 " float fract = smoothstep(0.0, cloud_height, gl_Position.z + cloud_height);\n"
106 // Final position of the sprite
107 " gl_Position = gl_ModelViewProjectionMatrix * gl_Position;\n"
108 // Limit the normal range from [0,1.0], and apply the shading (vertical factor)
109 " n = min(smoothstep(-0.5, 0.5, n), shade * (1.0 - fract) + fract);\n"
110 // This lighting normal is then used to mix between almost pure ambient (0) and diffuse (1.0) light
111 " vec4 backlight = 0.9 * gl_LightSource[0].ambient + 0.1 * gl_LightSource[0].diffuse;\n"
112 " gl_FrontColor = mix(backlight, gl_LightSource[0].diffuse, n);\n"
113 " gl_FrontColor += gl_FrontLightModelProduct.sceneColor;\n"
114 // As we get within 100m of the sprite, it is faded out
115 " gl_FrontColor.a = smoothstep(10.0, 100.0, fogCoord);\n"
116 " gl_BackColor = gl_FrontColor;\n"
117 // Fog doesn't affect clouds as much as other objects.
118 " fogFactor = exp( -gl_Fog.density * fogCoord * 0.5);\n"
119 " fogFactor = clamp(fogFactor, 0.0, 1.0);\n"
122 static char fragmentShaderSource[] =
123 "uniform sampler2D baseTexture; \n"
124 "varying float fogFactor;\n"
128 " vec4 base = texture2D( baseTexture, gl_TexCoord[0].st);\n"
129 " vec4 finalColor = base * gl_Color;\n"
130 " gl_FragColor = mix(gl_Fog.color, finalColor, fogFactor );\n"
133 class SGCloudFogUpdateCallback : public osg::StateAttribute::Callback {
135 virtual void operator () (osg::StateAttribute* sa, osg::NodeVisitor* nv)
137 SGUpdateVisitor* updateVisitor = static_cast<SGUpdateVisitor*>(nv);
138 osg::Fog* fog = static_cast<osg::Fog*>(sa);
139 fog->setMode(osg::Fog::EXP);
140 fog->setColor(updateVisitor->getFogColor().osg());
141 fog->setDensity(updateVisitor->getFogExpDensity());
145 SGNewCloud::SGNewCloud(string type,
146 const SGPath &tex_path,
164 min_sprite_width(min_sprite_w),
165 max_sprite_width(max_sprite_w),
166 min_sprite_height(min_sprite_h),
167 max_sprite_height(max_sprite_h),
170 num_textures_x(nt_x),
171 num_textures_y(nt_y),
175 // Create a new StateSet for the texture, if required.
176 StateSetMap::iterator iter = SGCloudField::cloudTextureMap.find(texture);
178 if (iter == SGCloudField::cloudTextureMap.end()) {
179 stateSet = new osg::StateSet;
181 osg::ref_ptr<osgDB::ReaderWriter::Options> options = makeOptionsFromPath(tex_path);
183 osg::Texture2D *tex = new osg::Texture2D;
184 tex->setWrap( osg::Texture2D::WRAP_S, osg::Texture2D::CLAMP );
185 tex->setWrap( osg::Texture2D::WRAP_T, osg::Texture2D::CLAMP );
186 tex->setImage(osgDB::readImageFile(texture, options.get()));
188 StateAttributeFactory* attribFactory = StateAttributeFactory::instance();
190 stateSet->setMode(GL_LIGHTING, osg::StateAttribute::ON);
191 stateSet->setMode(GL_CULL_FACE, osg::StateAttribute::OFF);
194 osg::Fog* fog = new osg::Fog;
195 fog->setUpdateCallback(new SGCloudFogUpdateCallback);
196 stateSet->setAttributeAndModes(fog);
197 stateSet->setDataVariance(osg::Object::DYNAMIC);
199 stateSet->setAttributeAndModes(attribFactory->getSmoothShadeModel());
200 stateSet->setAttributeAndModes(attribFactory->getStandardBlendFunc());
202 stateSet->setTextureAttributeAndModes(0, tex, osg::StateAttribute::ON );
203 stateSet->setRenderBinDetails(osg::StateSet::TRANSPARENT_BIN, "DepthSortedBin");
205 static ref_ptr<AlphaFunc> alphaFunc;
206 static ref_ptr<Program> program;
207 static ref_ptr<Uniform> baseTextureSampler;
208 static ref_ptr<Material> material;
210 // Generate the shader etc, if we don't already have one.
211 if (!program.valid()) {
212 alphaFunc = new AlphaFunc;
213 alphaFunc->setFunction(AlphaFunc::GREATER,0.001f);
214 program = new Program;
215 baseTextureSampler = new osg::Uniform("baseTexture", 0);
216 Shader* vertex_shader = new Shader(Shader::VERTEX, vertexShaderSource);
217 program->addShader(vertex_shader);
218 program->addBindAttribLocation("usrAttr1", CloudShaderGeometry::USR_ATTR_1);
219 program->addBindAttribLocation("usrAttr2", CloudShaderGeometry::USR_ATTR_2);
220 Shader* fragment_shader = new Shader(Shader::FRAGMENT, fragmentShaderSource);
221 program->addShader(fragment_shader);
222 material = new Material;
223 // DonĀ“t track vertex color
224 material->setColorMode(Material::OFF);
226 // We don't actually use the material information either - see shader.
227 material->setAmbient(Material::FRONT_AND_BACK,
228 Vec4(0.5f, 0.5f, 0.5f, 1.0f));
229 material->setDiffuse(Material::FRONT_AND_BACK,
230 Vec4(0.5f, 0.5f, 0.5f, 1.0f));
233 stateSet->setAttributeAndModes(alphaFunc.get());
234 stateSet->setAttribute(program.get());
235 stateSet->addUniform(baseTextureSampler.get());
236 stateSet->setMode(GL_VERTEX_PROGRAM_TWO_SIDE, StateAttribute::ON);
237 stateSet->setAttribute(material.get());
239 // Add the newly created texture to the map for use later.
240 SGCloudField::cloudTextureMap.insert(StateSetMap::value_type(texture, stateSet));
242 stateSet = iter->second.get();
245 quad = createOrthQuad(min_sprite_width, min_sprite_height, num_textures_x, num_textures_y);
248 SGNewCloud::~SGNewCloud() {
251 osg::Geometry* SGNewCloud::createOrthQuad(float w, float h, int varieties_x, int varieties_y)
253 // Create front and back polygons so we don't need to screw around
254 // with two-sided lighting in the shader.
255 osg::Vec3Array& v = *(new osg::Vec3Array(4));
256 osg::Vec3Array& n = *(new osg::Vec3Array(4));
257 osg::Vec2Array& t = *(new osg::Vec2Array(4));
261 v[0].set(0.0f, -cw, 0.0f);
262 v[1].set(0.0f, cw, 0.0f);
263 v[2].set(0.0f, cw, h);
264 v[3].set(0.0f, -cw, h);
266 // The texture coordinate range is not the
267 // entire coordinate space - as the texture
268 // has a number of different clouds on it.
269 float tx = 1.0f/varieties_x;
270 float ty = 1.0f/varieties_y;
272 t[0].set(0.0f, 0.0f);
277 // The normal isn't actually use in lighting.
278 n[0].set(1.0f, -1.0f, -1.0f);
279 n[1].set(1.0f, 1.0f, -1.0f);
280 n[2].set(1.0f, 1.0f, 1.0f);
281 n[3].set(1.0f, -1.0f, 1.0f);
283 osg::Geometry *geom = new osg::Geometry;
285 geom->setVertexArray(&v);
286 geom->setTexCoordArray(0, &t);
287 geom->setNormalArray(&n);
288 geom->setNormalBinding(Geometry::BIND_PER_VERTEX);
289 // No color for now; that's used to pass the position.
290 geom->addPrimitiveSet(new osg::DrawArrays(osg::PrimitiveSet::QUADS,0,4));
295 // return a random number between -n/2 and n/2, tending to 0
296 static float Rnd(float n) {
297 return n * (-0.5f + (sg_random() + sg_random()) / 2.0f);
300 osg::ref_ptr<Geode> SGNewCloud::genCloud() {
302 CloudMap::iterator iter = cloudMap.find(name);
303 osg::ref_ptr<osg::Geode> geode;
305 // We generate up to num_flavours of different versions
306 // of the same cloud before we start re-using them. This
307 // allows us to strike a balance between performance and
308 // visual complexity.
310 if (iter == cloudMap.end() || (*iter).second->size() < num_flavours)
315 CloudShaderGeometry* sg = new CloudShaderGeometry(num_textures_x, num_textures_y, max_width, max_height);
317 // Determine how big this specific cloud instance is. Note that we subtract
318 // the sprite size because the width/height is used to define the limits of
319 // the center of the sprites, not their edges.
320 float width = min_width + sg_random() * (max_width - min_width) - min_sprite_width;
321 float height = min_height + sg_random() * (max_height - min_height) - min_sprite_height;
323 // Determine the cull distance. This is used to remove sprites that are too close together.
324 // The value is squared as we use vector calculations.
325 float cull_distance_squared = min_sprite_height * min_sprite_height * 0.1f;
327 // The number of sprites we actually used is a function of the (user-controlled) density
328 int n_sprites = num_sprites * sprite_density;
330 for (int i = 0; i < n_sprites; i++)
332 // Determine the position of the sprite. Rather than being completely random,
333 // we place them on the surface of a distorted sphere. However, we place
334 // the first and second sprites on the top and bottom, and the third in the
335 // center of the sphere (and at maximum size) to ensure good coverage and
336 // reduce the chance of there being "holes" in our cloud.
352 double theta = sg_random() * SGD_2PI;
353 double elev = sg_random() * SGD_PI;
354 x = width * cos(theta) * 0.5f * sin(elev);
355 y = width * sin(theta) * 0.5f * sin(elev);
356 z = height * cos(elev) * 0.5f;
359 SGVec3f *pos = new SGVec3f(x, y, z);
361 // Determine the height and width as scaling factors on the minimum size (used to create the quad)
362 float sprite_width = 1.0f + sg_random() * (max_sprite_width - min_sprite_width) / min_sprite_width;
363 float sprite_height = 1.0f + sg_random() * (max_sprite_height - min_sprite_height) / min_sprite_height;
366 // The center sprite is always maximum size to fill up any holes.
367 sprite_width = 1.0f + (max_sprite_width - min_sprite_width) / min_sprite_width;
368 sprite_height = 1.0f + (max_sprite_height - min_sprite_height) / min_sprite_height;
371 // Determine the sprite texture indexes;
372 int index_x = (int) floor(sg_random() * num_textures_x);
373 if (index_x == num_textures_x) { index_x--; }
375 int index_y = (int) floor(sg_random() * num_textures_y);
376 if (index_y == num_textures_y) { index_y--; }
384 cull_distance_squared,
389 sg->setGeometry(quad);
390 geode->addDrawable(sg);
391 geode->setName("3D cloud");
392 geode->setStateSet(stateSet.get());
394 if (iter == cloudMap.end())
396 // This is the first of this cloud to be generated.
397 GeodeList* geodelist = new GeodeList;
398 geodelist->push_back(geode);
399 cloudMap.insert(CloudMap::value_type(name, geodelist));
403 // Add the new cloud to the list of geodes
404 (*iter).second->push_back(geode);
409 int index = sg_random() * num_flavours;
410 if (index == num_flavours) index--;
412 geode = iter->second->at(index);