simgear/scene/tgdb/TreeBin.cxx

   1 /* -*-c++-*-
   2  *
   3  * Copyright (C) 2008 Stuart Buchanan
   4  *
   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.
   9  *
  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.
  14  *
  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,
  18  * MA 02110-1301, USA.
  19  *
  20  */
  21
  22 #ifdef HAVE_CONFIG_H
  23 #  include <simgear_config.h>
  24 #endif
  25
  26 #include <algorithm>
  27 #include <vector>
  28 #include <string>
  29 #include <map>
  30
  31 #include <boost/tuple/tuple_comparison.hpp>
  32
  33 #include <osg/Geode>
  34 #include <osg/Geometry>
  35 #include <osg/Math>
  36 #include <osg/MatrixTransform>
  37 #include <osg/Matrix>
  38 #include <osg/NodeVisitor>
  39
  40 #include <osgDB/ReadFile>
  41 #include <osgDB/FileUtils>
  42
  43 #include <simgear/debug/logstream.hxx>
  44 #include <simgear/math/sg_random.h>
  45 #include <simgear/misc/sg_path.hxx>
  46 #include <simgear/scene/material/Effect.hxx>
  47 #include <simgear/scene/material/EffectGeode.hxx>
  48 #include <simgear/props/props.hxx>
  49 #include <simgear/scene/util/QuadTreeBuilder.hxx>
  50 #include <simgear/scene/util/RenderConstants.hxx>
  51 #include <simgear/scene/util/StateAttributeFactory.hxx>
  52 #include <simgear/structure/OSGUtils.hxx>
  53
  54 #include "ShaderGeometry.hxx"
  55 #include "TreeBin.hxx"
  56
  57 #define SG_TREE_QUAD_TREE_DEPTH 3
  58 #define SG_TREE_FADE_OUT_LEVELS 10
  59
  60 using namespace osg;
  61
  62 namespace simgear
  63 {
  64
  65 // Tree instance scheme:
  66 // vertex - local position of quad vertex.
  67 // normal - x y scaling, z number of varieties
  68 // fog coord - rotation
  69 // color - xyz of tree quad origin, replicated 4 times.
  70 //
  71 // The tree quad is rendered twice, with different rotations, to
  72 // create the crossed tree geometry.
  73
  74 struct TreesBoundingBoxCallback : public Drawable::ComputeBoundingBoxCallback
  75 {
  76     TreesBoundingBoxCallback() {}
  77     TreesBoundingBoxCallback(const TreesBoundingBoxCallback&, const CopyOp&) {}
  78     META_Object(simgear, TreesBoundingBoxCallback);
  79     virtual BoundingBox computeBound(const Drawable&) const;
  80 };
  81
  82 BoundingBox
  83 TreesBoundingBoxCallback::computeBound(const Drawable& drawable) const
  84 {
  85     BoundingBox bb;
  86     const Geometry* geom = static_cast<const Geometry*>(&drawable);
  87     const Vec3Array* v = static_cast<const Vec3Array*>(geom->getVertexArray());
  88     const Vec3Array* pos = static_cast<const Vec3Array*>(geom->getColorArray());
  89     const Vec3Array* params
  90         = static_cast<const Vec3Array*>(geom->getNormalArray());
  91     const FloatArray* rot
  92         = static_cast<const FloatArray*>(geom->getFogCoordArray());
  93     float w = (*params)[0].x();
  94     float h = (*params)[0].y();
  95     Geometry::PrimitiveSetList primSets = geom->getPrimitiveSetList();
  96     FloatArray::const_iterator rotitr = rot->begin();
  97     for (Geometry::PrimitiveSetList::const_iterator psitr = primSets.begin(),
  98              psend = primSets.end();
  99          psitr != psend;
 100          ++psitr, ++rotitr) {
 101         Matrixd trnsfrm = (Matrixd::scale(w, w, h)
 102                            * Matrixd::rotate(*rotitr, Vec3(0.0f, 0.0f, 1.0f)));
 103         DrawArrays* da = static_cast<DrawArrays*>(psitr->get());
 104         GLint psFirst = da->getFirst();
 105         GLint psEndVert = psFirst + da->getCount();
 106         for (GLint i = psFirst;i < psEndVert; ++i) {
 107             Vec3 pt = (*v)[i];
 108             pt = pt * trnsfrm;
 109             pt += (*pos)[i];
 110             bb.expandBy(pt);
 111         }
 112     }
 113     return bb;
 114 }
 115
 116 Geometry* makeSharedTreeGeometry(int numQuads)
 117 {
 118     // generate a repeatable random seed
 119     mt seed;
 120     mt_init(&seed, unsigned(123));
 121     // set up the coords
 122     osg::Vec3Array* v = new osg::Vec3Array;
 123     osg::Vec2Array* t = new osg::Vec2Array;
 124     v->reserve(numQuads * 4);
 125     t->reserve(numQuads * 4);
 126     for (int i = 0; i < numQuads; ++i) {
 127         // Apply a random scaling factor and texture index.
 128         float h = (mt_rand(&seed) + mt_rand(&seed)) / 2.0f + 0.5f;
 129         float cw = h * .5;
 130         v->push_back(Vec3(0.0f, -cw, 0.0f));
 131         v->push_back(Vec3(0.0f, cw, 0.0f));
 132         v->push_back(Vec3(0.0f, cw, h));
 133         v->push_back(Vec3(0.0f,-cw, h));
 134         // The texture coordinate range is not the entire coordinate
 135         // space, as the texture has a number of different trees on
 136         // it. Here we assign random coordinates and let the shader
 137         // choose the variety.
 138         float variety = mt_rand(&seed);
 139         t->push_back(Vec2(variety, 0.0f));
 140         t->push_back(Vec2(variety + 1.0f, 0.0f));
 141         t->push_back(Vec2(variety + 1.0f, 1.0f));
 142         t->push_back(Vec2(variety, 1.0f));
 143     }
 144     Geometry* result = new Geometry;
 145     result->setVertexArray(v);
 146     result->setTexCoordArray(0, t);
 147     result->setComputeBoundingBoxCallback(new TreesBoundingBoxCallback);
 148     result->setUseDisplayList(false);
 149     return result;
 150 }
 151
 152 ref_ptr<Geometry> sharedTreeGeometry;
 153
 154 Geometry* createTreeGeometry(float width, float height, int varieties)
 155 {
 156     if (!sharedTreeGeometry)
 157         sharedTreeGeometry = makeSharedTreeGeometry(1600);
 158     Geometry* quadGeom = simgear::clone(sharedTreeGeometry.get(),
 159                                         CopyOp::SHALLOW_COPY);
 160     Vec3Array* params = new Vec3Array;
 161     params->push_back(Vec3(width, height, (float)varieties));
 162     quadGeom->setNormalArray(params);
 163     quadGeom->setNormalBinding(Geometry::BIND_OVERALL);
 164     // Positions
 165     quadGeom->setColorArray(new Vec3Array);
 166     quadGeom->setColorBinding(Geometry::BIND_PER_VERTEX);
 167     FloatArray* rotation = new FloatArray(2);
 168     (*rotation)[0] = 0.0;
 169     (*rotation)[1] = PI_2;
 170     quadGeom->setFogCoordArray(rotation);
 171     quadGeom->setFogCoordBinding(Geometry::BIND_PER_PRIMITIVE_SET);
 172     // The primitive sets render the same geometry, but the second
 173     // will rotated 90 degrees by the vertex shader, which uses the
 174     // fog coordinate as a rotation.
 175     for (int i = 0; i < 2; ++i)
 176         quadGeom->addPrimitiveSet(new DrawArrays(PrimitiveSet::QUADS));
 177     return quadGeom;
 178 }
 179
 180 EffectGeode* createTreeGeode(float width, float height, int varieties)
 181 {
 182     EffectGeode* result = new EffectGeode;
 183     result->addDrawable(createTreeGeometry(width, height, varieties));
 184     return result;
 185 }
 186
 187 void addTreeToLeafGeode(Geode* geode, const SGVec3f& p)
 188 {
 189     Vec3 pos = toOsg(p);
 190     unsigned int numDrawables = geode->getNumDrawables();
 191     Geometry* geom
 192         = static_cast<Geometry*>(geode->getDrawable(numDrawables - 1));
 193     Vec3Array* posArray = static_cast<Vec3Array*>(geom->getColorArray());
 194     if (posArray->size()
 195         >= static_cast<Vec3Array*>(geom->getVertexArray())->size()) {
 196         Vec3Array* paramsArray
 197             = static_cast<Vec3Array*>(geom->getNormalArray());
 198         Vec3 params = (*paramsArray)[0];
 199         geom = createTreeGeometry(params.x(), params.y(), params.z());
 200         posArray = static_cast<Vec3Array*>(geom->getColorArray());
 201         geode->addDrawable(geom);
 202     }
 203     posArray->insert(posArray->end(), 4, pos);
 204     size_t numVerts = posArray->size();
 205     for (int i = 0; i < 2; ++i) {
 206         DrawArrays* primSet
 207             = static_cast<DrawArrays*>(geom->getPrimitiveSet(i));
 208         primSet->setCount(numVerts);
 209     }
 210 }
 211
 212 typedef std::map<std::string, osg::observer_ptr<Effect> > EffectMap;
 213
 214 static EffectMap treeEffectMap;
 215
 216 // Helper classes for creating the quad tree
 217 namespace
 218 {
 219 struct MakeTreesLeaf
 220 {
 221     MakeTreesLeaf(float range, int varieties, float width, float height,
 222         Effect* effect) :
 223         _range(range),  _varieties(varieties),
 224         _width(width), _height(height), _effect(effect) {}
 225
 226     MakeTreesLeaf(const MakeTreesLeaf& rhs) :
 227         _range(rhs._range),
 228         _varieties(rhs._varieties), _width(rhs._width), _height(rhs._height),
 229         _effect(rhs._effect)
 230     {}
 231
 232     LOD* operator() () const
 233     {
 234         LOD* result = new LOD;
 235
 236         // Create a series of LOD nodes so trees cover decreases slightly
 237         // gradually with distance from _range to 2*_range
 238         for (float i = 0.0; i < SG_TREE_FADE_OUT_LEVELS; i++)
 239         {
 240             EffectGeode* geode = createTreeGeode(_width, _height, _varieties);
 241             geode->setEffect(_effect.get());
 242             result->addChild(geode, 0, _range * (1.0 + i / (SG_TREE_FADE_OUT_LEVELS - 1.0)));
 243         }
 244         return result;
 245     }
 246     float _range;
 247     int _varieties;
 248     float _width;
 249     float _height;
 250     ref_ptr<Effect> _effect;
 251 };
 252
 253 struct AddTreesLeafObject
 254 {
 255     void operator() (LOD* lod, const TreeBin::Tree& tree) const
 256     {
 257         Geode* geode = static_cast<Geode*>(lod->getChild(int(tree.position.x() * 10.0f) % lod->getNumChildren()));
 258         addTreeToLeafGeode(geode, tree.position);
 259     }
 260 };
 261
 262 struct GetTreeCoord
 263 {
 264     Vec3 operator() (const TreeBin::Tree& tree) const
 265     {
 266         return toOsg(tree.position);
 267     }
 268 };
 269
 270 typedef QuadTreeBuilder<LOD*, TreeBin::Tree, MakeTreesLeaf, AddTreesLeafObject,
 271                         GetTreeCoord> ShaderGeometryQuadtree;
 272 }
 273
 274 struct TreeTransformer
 275 {
 276     TreeTransformer(Matrix& mat_) : mat(mat_) {}
 277     TreeBin::Tree operator()(const TreeBin::Tree& tree) const
 278     {
 279         Vec3 pos = toOsg(tree.position);
 280         return TreeBin::Tree(toSG(pos * mat));
 281     }
 282     Matrix mat;
 283 };
 284
 285 // We may end up with a quadtree with many empty leaves. One might say
 286 // that we should avoid constructing the leaves in the first place,
 287 // but this node visitor tries to clean up after the fact.
 288
 289 struct QuadTreeCleaner : public osg::NodeVisitor
 290 {
 291     QuadTreeCleaner() : NodeVisitor(NodeVisitor::TRAVERSE_ALL_CHILDREN)
 292     {
 293     }
 294     void apply(LOD& lod)
 295     {
 296         for (int i  = lod.getNumChildren() - 1; i >= 0; --i) {
 297             EffectGeode* geode = dynamic_cast<EffectGeode*>(lod.getChild(i));
 298             if (!geode)
 299                 continue;
 300             bool geodeEmpty = true;
 301             for (unsigned j = 0; j < geode->getNumDrawables(); ++j) {
 302                 const Geometry* geom = dynamic_cast<Geometry*>(geode->getDrawable(j));
 303                 if (!geom) {
 304                     geodeEmpty = false;
 305                     break;
 306                 }
 307                 for (unsigned k = 0; k < geom->getNumPrimitiveSets(); k++) {
 308                     const PrimitiveSet* ps = geom->getPrimitiveSet(k);
 309                     if (ps->getNumIndices() > 0) {
 310                         geodeEmpty = false;
 311                         break;
 312                     }
 313                 }
 314             }
 315             if (geodeEmpty)
 316                 lod.removeChildren(i, 1);
 317         }
 318     }
 319 };
 320
 321 // This actually returns a MatrixTransform node. If we rotate the whole
 322 // forest into the local Z-up coordinate system we can reuse the
 323 // primitive tree geometry for all the forests of the same type.
 324
 325 osg::Group* createForest(SGTreeBinList& forestList, const osg::Matrix& transform,
 326                          const SGReaderWriterOptions* options)
 327 {
 328     Matrix transInv = Matrix::inverse(transform);
 329     static Matrix ident;
 330     // Set up some shared structures.
 331     ref_ptr<Group> group;
 332     MatrixTransform* mt = new MatrixTransform(transform);
 333
 334     SGTreeBinList::iterator i;
 335
 336     for (i = forestList.begin(); i != forestList.end(); ++i) {
 337         TreeBin* forest = *i;
 338
 339         ref_ptr<Effect> effect;
 340         EffectMap::iterator iter = treeEffectMap.find(forest->texture);
 341
 342         if ((iter == treeEffectMap.end())||
 343             (!iter->second.lock(effect)))
 344         {
 345             SGPropertyNode_ptr effectProp = new SGPropertyNode;
 346             makeChild(effectProp, "inherits-from")->setStringValue("Effects/tree");
 347             SGPropertyNode* params = makeChild(effectProp, "parameters");
 348             // emphasize n = 0
 349             params->getChild("texture", 0, true)->getChild("image", 0, true)
 350                 ->setStringValue(forest->texture);
 351             effect = makeEffect(effectProp, true, options);
 352             if (iter == treeEffectMap.end())
 353                 treeEffectMap.insert(EffectMap::value_type(forest->texture, effect));
 354             else
 355                 iter->second = effect; // update existing, but empty observer
 356         }
 357
 358         // Now, create a quadtree for the forest.
 359         ShaderGeometryQuadtree
 360             quadtree(GetTreeCoord(), AddTreesLeafObject(),
 361                      SG_TREE_QUAD_TREE_DEPTH,
 362                      MakeTreesLeaf(forest->range, forest->texture_varieties,
 363                                    forest->width, forest->height, effect));
 364         // Transform tree positions from the "geocentric" positions we
 365         // get from the scenery polys into the local Z-up coordinate
 366         // system.
 367         std::vector<TreeBin::Tree> rotatedTrees;
 368         rotatedTrees.reserve(forest->_trees.size());
 369         std::transform(forest->_trees.begin(), forest->_trees.end(),
 370                        std::back_inserter(rotatedTrees),
 371                        TreeTransformer(transInv));
 372         quadtree.buildQuadTree(rotatedTrees.begin(), rotatedTrees.end());
 373         group = quadtree.getRoot();
 374
 375         for (size_t i = 0; i < group->getNumChildren(); ++i)
 376             mt->addChild(group->getChild(i));
 377
 378         delete forest;
 379     }
 380
 381     forestList.clear();
 382     QuadTreeCleaner cleaner;
 383     mt->accept(cleaner);
 384     return mt;
 385 }
 386
 387
 388 }