3 * Copyright (C) 2006-2007 Mathias Froehlich, Tim Moore
5 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU General Public License as
7 * published by the Free Software Foundation; either version 2 of the
8 * License, or (at your option) any later version.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
23 # include <simgear_config.h>
26 #include "SGOceanTile.hxx"
29 #include <simgear/compiler.h>
32 #include <osg/Geometry>
33 #include <osg/MatrixTransform>
34 #include <osg/StateSet>
36 #include <simgear/bucket/newbucket.hxx>
37 #include <simgear/math/sg_geodesy.hxx>
38 #include <simgear/math/sg_types.hxx>
39 #include <simgear/misc/texcoord.hxx>
40 #include <simgear/scene/material/Effect.hxx>
41 #include <simgear/scene/material/EffectGeode.hxx>
42 #include <simgear/scene/material/mat.hxx>
43 #include <simgear/scene/material/matlib.hxx>
44 #include <simgear/scene/util/OsgMath.hxx>
45 #include <simgear/scene/util/VectorArrayAdapter.hxx>
46 #include <simgear/scene/util/SGNodeMasks.hxx>
48 using namespace simgear;
49 // Ocean tile with curvature and apron to hide cracks. The cracks are
50 // mostly with adjoining coastal tiles that assume a flat ocean
51 // between corners of a tile; they also hide the micro cracks between
52 // adjoining ocean tiles. This is probably over-engineered, but it
53 // serves as a testbed for some things that will come later.
55 // Helper class for building and accessing the mesh. The layout of the
56 // points in the mesh is a little wacky. First is the bottom row of
57 // the points for the apron. Next is the left apron point, the points
58 // in the mesh, and the right apron point, for each of the rows of the
59 // mesh; the points for the top apron come last. This order should
60 // help with things like vertex caching in the OpenGL driver, though
61 // it may be superfluous for such a small mesh.
66 OceanMesh(int latP, int lonP):
69 geoPoints(latPoints * lonPoints + 2 * (lonPoints + latPoints)),
70 geod_nodes(latPoints * lonPoints),
71 vl(new osg::Vec3Array(geoPoints)),
72 nl(new osg::Vec3Array(geoPoints)),
73 tl(new osg::Vec2Array(geoPoints)),
74 vlArray(*vl, lonPoints + 2, lonPoints, 1),
75 nlArray(*nl, lonPoints + 2, lonPoints, 1),
76 tlArray(*tl, lonPoints + 2, lonPoints, 1)
78 int numPoints = latPoints * lonPoints;
79 geod = new SGGeod[numPoints];
80 normals = new SGVec3f[numPoints];
81 rel = new SGVec3d[numPoints];
91 const int latPoints, lonPoints;
97 std::vector<SGGeod> geod_nodes;
102 VectorArrayAdapter<osg::Vec3Array> vlArray;
103 VectorArrayAdapter<osg::Vec3Array> nlArray;
104 VectorArrayAdapter<osg::Vec2Array> tlArray;
106 void calcMesh(const SGVec3d& cartCenter, const SGQuatd& orient,
107 double clon, double clat,
108 double height, double width, double tex_width);
109 void calcApronPt(int latIdx, int lonIdx, int latInner, int lonInner,
110 int destIdx, double tex_width);
111 void calcApronPts(double tex_width);
116 void OceanMesh::calcMesh(const SGVec3d& cartCenter, const SGQuatd& orient,
117 double clon, double clat,
118 double height, double width, double tex_width)
120 // Calculate vertices. By splitting the tile up into 4 quads on a
121 // side we avoid curvature-of-the-earth problems; the error should
122 // be less than .5 meters.
123 double longInc = width * .25;
124 double latInc = height * .25;
125 double startLat = clat - height * .5;
126 double startLon = clon - width * .5;
127 for (int j = 0; j < latPoints; j++) {
128 double lat = startLat + j * latInc;
129 for (int i = 0; i < lonPoints; i++) {
130 int index = (j * lonPoints) + i;
131 geod[index] = SGGeod::fromDeg(startLon + i * longInc, lat);
132 SGVec3d cart = SGVec3d::fromGeod(geod[index]);
133 rel[index] = orient.transform(cart - cartCenter);
134 normals[index] = toVec3f(orient.transform(normalize(cart)));
138 // Calculate texture coordinates
139 typedef std::vector<SGGeod> GeodVector;
141 GeodVector geod_nodes(latPoints * lonPoints);
142 VectorArrayAdapter<GeodVector> geodNodesArray(geod_nodes, lonPoints);
143 int_list rectangle(latPoints * lonPoints);
144 VectorArrayAdapter<int_list> rectArray(rectangle, lonPoints);
145 for (int j = 0; j < latPoints; j++) {
146 for (int i = 0; i < lonPoints; i++) {
147 int index = (j * lonPoints) + i;
148 geodNodesArray(j, i) = geod[index];
149 rectArray(j, i) = index;
153 typedef std::vector<SGVec2f> Vec2Array;
154 Vec2Array texs = sgCalcTexCoords( clat, geod_nodes, rectangle,
155 1000.0 / tex_width );
158 VectorArrayAdapter<Vec2Array> texsArray(texs, lonPoints);
160 for (int j = 0; j < latPoints; j++) {
161 for (int i = 0; i < lonPoints; ++i) {
162 int index = (j * lonPoints) + i;
163 vlArray(j, i) = toOsg(rel[index]);
164 nlArray(j, i) = toOsg(normals[index]);
165 tlArray(j, i) = toOsg(texsArray(j, i));
171 // Apron points. For each point on the edge we'll go 150
172 // metres "down" and 40 metres "out" to create a nice overlap. The
173 // texture should be applied according to this dimension. The
174 // normals of the apron polygons will be the same as the those of
175 // the points on the edge to better disguise the apron.
176 void OceanMesh::calcApronPt(int latIdx, int lonIdx, int latInner, int lonInner,
177 int destIdx, double tex_width)
179 static const float downDist = 150.0f;
180 static const float outDist = 40.0f;
181 // Get vector along edge, in the right direction to make a cross
182 // product with the normal vector that will point out from the
184 osg::Vec3f edgePt = vlArray(latIdx, lonIdx);
186 if (lonIdx == lonInner) { // bottom or top edge
188 edgeVec = vlArray(latIdx, lonIdx - 1) - edgePt;
190 edgeVec = edgePt - vlArray(latIdx, lonIdx + 1);
191 if (latIdx > latInner)
192 edgeVec = -edgeVec; // Top edge
193 } else { // right or left edge
195 edgeVec = edgePt - vlArray(latIdx - 1, lonIdx);
197 edgeVec = vlArray(latIdx + 1, lonIdx) - edgePt;
198 if (lonIdx > lonInner) // right edge
202 osg::Vec3f outVec = nlArray(latIdx, lonIdx) ^ edgeVec;
204 = edgePt - nlArray(latIdx, lonIdx) * downDist + outVec * outDist;
205 (*nl)[destIdx] = nlArray(latIdx, lonIdx);
206 static const float apronDist
207 = sqrtf(downDist * downDist + outDist * outDist);
208 float texDelta = apronDist / tex_width;
209 if (lonIdx == lonInner) {
210 if (latIdx > latInner)
212 = tlArray(latIdx, lonIdx) + osg::Vec2f(0.0f, texDelta);
215 = tlArray(latIdx, lonIdx) - osg::Vec2f(0.0f, texDelta);
217 if (lonIdx > lonInner)
219 = tlArray(latIdx, lonIdx) + osg::Vec2f(texDelta, 0.0f);
222 = tlArray(latIdx, lonIdx) - osg::Vec2f(texDelta, 0.0f);
226 void OceanMesh::calcApronPts(double tex_width)
228 for (int i = 0; i < lonPoints; i++)
229 calcApronPt(0, i, 1, i, i, tex_width);
230 int topApronOffset = latPoints + (2 + lonPoints) * latPoints;
231 for (int i = 0; i < lonPoints; i++)
232 calcApronPt(latPoints - 1, i, latPoints - 2, i,
233 i + topApronOffset, tex_width);
234 for (int i = 0; i < latPoints; i++) {
235 calcApronPt(i, 0, i, 1, lonPoints + i * (lonPoints + 2), tex_width);
236 calcApronPt(i, lonPoints - 1, i, lonPoints - 2,
237 lonPoints + i * (lonPoints + 2) + 1 + lonPoints, tex_width);
243 // Enter the vertices of triangles that fill one row of the
244 // mesh. The vertices are entered in counter-clockwise order.
245 void fillDrawElementsRow(int width, short row0Start, short row1Start,
246 osg::DrawElementsUShort::vector_type::iterator&
249 short row0Idx = row0Start;
250 short row1Idx = row1Start;
251 for (int i = 0; i < width - 1; i++, row0Idx++, row1Idx++) {
252 *elements++ = row0Idx;
253 *elements++ = row0Idx + 1;
254 *elements++ = row1Idx;
255 *elements++ = row1Idx;
256 *elements++ = row0Idx + 1;
257 *elements++ = row1Idx + 1;
261 void fillDrawElementsWithApron(short height, short width,
262 osg::DrawElementsUShort::vector_type::iterator
266 fillDrawElementsRow(width, 0, width + 1, elements);
267 for (short i = 0; i < height - 1; i++)
268 fillDrawElementsRow(width + 2, width + i * (width + 2),
269 width + (i + 1) * (width + 2),
272 short topApronBottom = width + (height - 1) * (width + 2) + 1;
273 fillDrawElementsRow(width, topApronBottom, topApronBottom + width + 1,
278 osg::Node* SGOceanTile(const SGBucket& b, SGMaterialLib *matlib, int latPoints, int lonPoints)
282 double tex_width = 1000.0;
284 // find Ocean material in the properties list
285 SGMaterial *mat = matlib->find( "Ocean" );
287 // set the texture width and height values for this
289 tex_width = mat->get_xsize();
292 effect = mat->get_effect();
294 SG_LOG( SG_TERRAIN, SG_ALERT, "Ack! unknown use material name = Ocean");
296 OceanMesh grid(latPoints, lonPoints);
297 // Calculate center point
298 SGVec3d cartCenter = SGVec3d::fromGeod(b.get_center());
299 SGGeod geodPos = SGGeod::fromCart(cartCenter);
300 SGQuatd hlOr = SGQuatd::fromLonLat(geodPos)*SGQuatd::fromEulerDeg(0, 0, 180);
302 double clon = b.get_center_lon();
303 double clat = b.get_center_lat();
304 double height = b.get_height();
305 double width = b.get_width();
307 grid.calcMesh(cartCenter, hlOr, clon, clat, height, width, tex_width);
308 grid.calcApronPts(tex_width);
310 osg::Vec4Array* cl = new osg::Vec4Array;
311 cl->push_back(osg::Vec4(1, 1, 1, 1));
313 osg::Geometry* geometry = new osg::Geometry;
314 geometry->setDataVariance(osg::Object::STATIC);
315 geometry->setVertexArray(grid.vl);
316 geometry->setNormalArray(grid.nl);
317 geometry->setNormalBinding(osg::Geometry::BIND_PER_VERTEX);
318 geometry->setColorArray(cl);
319 geometry->setColorBinding(osg::Geometry::BIND_OVERALL);
320 geometry->setTexCoordArray(0, grid.tl);
322 // Allocate the indices for triangles in the mesh and the apron
323 osg::DrawElementsUShort* drawElements
324 = new osg::DrawElementsUShort(GL_TRIANGLES,
325 6 * ((latPoints - 1) * (lonPoints + 1)
326 + 2 * (latPoints - 1)));
327 fillDrawElementsWithApron(latPoints, lonPoints, drawElements->begin());
328 geometry->addPrimitiveSet(drawElements);
330 EffectGeode* geode = new EffectGeode;
331 geode->setName("Ocean tile");
332 geode->setEffect(effect);
333 geode->addDrawable(geometry);
334 geode->runGenerators(geometry);
336 osg::MatrixTransform* transform = new osg::MatrixTransform;
337 transform->setName("Ocean");
338 transform->setMatrix(osg::Matrix::rotate(toOsg(hlOr))*
339 osg::Matrix::translate(toOsg(cartCenter)));
340 transform->addChild(geode);
341 transform->setNodeMask( ~simgear::MODELLIGHT_BIT );