simgear/scene/material/matmodel.cxx

   1 // matmodel.cxx -- class to handle models tied to a material property
   2 //
   3 // Written by David Megginson, started May 1998.
   4 //
   5 // Copyright (C) 1998 - 2003  Curtis L. Olson  - http://www.flightgear.org/~curt
   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 // $Id$
  22
  23
  24 #ifdef HAVE_CONFIG_H
  25 #  include <simgear_config.h>
  26 #endif
  27
  28 #include <simgear/compiler.h>
  29
  30 #include <map>
  31 using std::map;
  32
  33 #include <osg/AlphaFunc>
  34 #include <osg/Group>
  35 #include <osg/LOD>
  36 #include <osg/StateSet>
  37 #include <osg/Transform>
  38
  39 #include <simgear/debug/logstream.hxx>
  40 #include <simgear/math/SGMath.hxx>
  41 #include <simgear/math/sg_random.h>
  42 #include <simgear/misc/sg_path.hxx>
  43 #include <simgear/misc/sgstream.hxx>
  44 #include <simgear/scene/model/modellib.hxx>
  45
  46 #include "matmodel.hxx"
  47
  48 using namespace simgear;
  49
  50 \f
  51 ////////////////////////////////////////////////////////////////////////
  52 // Implementation of SGMatModel.
  53 ////////////////////////////////////////////////////////////////////////
  54
  55 SGMatModel::SGMatModel (const SGPropertyNode * node, double range_m)
  56   : _models_loaded(false),
  57     _coverage_m2(node->getDoubleValue("coverage-m2", 1000000)),
  58     _range_m(range_m)
  59 {
  60                                 // Sanity check
  61   if (_coverage_m2 < 1000) {
  62     SG_LOG(SG_INPUT, SG_ALERT, "Random object coverage " << _coverage_m2
  63            << " is too small, forcing, to 1000");
  64     _coverage_m2 = 1000;
  65   }
  66
  67                                 // Note all the model paths
  68   vector <SGPropertyNode_ptr> path_nodes = node->getChildren("path");
  69   for (unsigned int i = 0; i < path_nodes.size(); i++)
  70     _paths.push_back(path_nodes[i]->getStringValue());
  71
  72                                 // Note the heading type
  73   string hdg = node->getStringValue("heading-type", "fixed");
  74   if (hdg == "fixed") {
  75     _heading_type = HEADING_FIXED;
  76   } else if (hdg == "billboard") {
  77     _heading_type = HEADING_BILLBOARD;
  78   } else if (hdg == "random") {
  79     _heading_type = HEADING_RANDOM;
  80   } else {
  81     _heading_type = HEADING_FIXED;
  82     SG_LOG(SG_INPUT, SG_ALERT, "Unknown heading type: " << hdg
  83            << "; using 'fixed' instead.");
  84   }
  85
  86   // uncomment to preload models
  87   // load_models();
  88 }
  89
  90 SGMatModel::~SGMatModel ()
  91 {
  92 }
  93
  94 int
  95 SGMatModel::get_model_count( SGPropertyNode *prop_root )
  96 {
  97   load_models( prop_root );
  98   return _models.size();
  99 }
 100
 101 inline void
 102 SGMatModel::load_models( SGPropertyNode *prop_root )
 103 {
 104                                 // Load model only on demand
 105   if (!_models_loaded) {
 106     for (unsigned int i = 0; i < _paths.size(); i++) {
 107       osg::Node *entity = SGModelLib::loadModel(_paths[i], prop_root);
 108       if (entity != 0) {
 109         // FIXME: this stuff can be handled
 110         // in the XML wrapper as well (at least,
 111         // the billboarding should be handled
 112         // there).
 113
 114         if (_heading_type == HEADING_BILLBOARD) {
 115           // if the model is a billboard, it is likely :
 116           // 1. a branch with only leaves,
 117           // 2. a tree or a non rectangular shape faked by transparency
 118           // We add alpha clamp then
 119           osg::StateSet* stateSet = entity->getOrCreateStateSet();
 120           osg::AlphaFunc* alphaFunc =
 121             new osg::AlphaFunc(osg::AlphaFunc::GREATER, 0.01f);
 122           stateSet->setAttributeAndModes(alphaFunc,
 123                                          osg::StateAttribute::OVERRIDE);
 124           stateSet->setRenderingHint(osg::StateSet::TRANSPARENT_BIN);
 125         }
 126
 127         _models.push_back(entity);
 128
 129       } else {
 130         SG_LOG(SG_INPUT, SG_ALERT, "Failed to load object " << _paths[i]);
 131       }
 132     }
 133   }
 134   _models_loaded = true;
 135 }
 136
 137 osg::Node*
 138 SGMatModel::get_random_model( SGPropertyNode *prop_root )
 139 {
 140   load_models( prop_root ); // comment this out if preloading models
 141   int nModels = _models.size();
 142   // int index = int(sg_random() * nModels);
 143   static int index = -1;
 144   if (++index >= nModels)
 145     index = 0;
 146   return _models[index].get();
 147 }
 148
 149 double
 150 SGMatModel::get_coverage_m2 () const
 151 {
 152   return _coverage_m2;
 153 }
 154
 155 double SGMatModel::get_range_m() const
 156 {
 157   return _range_m;
 158 }
 159
 160 double SGMatModel::get_randomized_range_m(mt* seed) const
 161 {
 162   double lrand = mt_rand(seed);
 163
 164   // Note that the LoD is not completely randomized.
 165   // 10% at 2   * range_m
 166   // 30% at 1.5 * range_m
 167   // 60% at 1   * range_m
 168   if (lrand < 0.1) return 2   * _range_m;
 169   if (lrand < 0.4) return 1.5 * _range_m;
 170   else return _range_m;
 171 }
 172
 173 SGMatModel::HeadingType
 174 SGMatModel::get_heading_type () const
 175 {
 176   return _heading_type;
 177 }
 178
 179
 180 \f
 181 ////////////////////////////////////////////////////////////////////////
 182 // Implementation of SGMatModelGroup.
 183 ////////////////////////////////////////////////////////////////////////
 184
 185 SGMatModelGroup::SGMatModelGroup (SGPropertyNode * node)
 186   : _range_m(node->getDoubleValue("range-m", 2000))
 187 {
 188                                 // Load the object subnodes
 189   vector<SGPropertyNode_ptr> object_nodes =
 190     ((SGPropertyNode *)node)->getChildren("object");
 191   for (unsigned int i = 0; i < object_nodes.size(); i++) {
 192     const SGPropertyNode * object_node = object_nodes[i];
 193     if (object_node->hasChild("path"))
 194       _objects.push_back(new SGMatModel(object_node, _range_m));
 195     else
 196       SG_LOG(SG_INPUT, SG_ALERT, "No path supplied for object");
 197   }
 198 }
 199
 200 SGMatModelGroup::~SGMatModelGroup ()
 201 {
 202 }
 203
 204 double
 205 SGMatModelGroup::get_range_m () const
 206 {
 207   return _range_m;
 208 }
 209
 210 int
 211 SGMatModelGroup::get_object_count () const
 212 {
 213   return _objects.size();
 214 }
 215
 216 SGMatModel *
 217 SGMatModelGroup::get_object (int index) const
 218 {
 219   return _objects[index];
 220 }
 221
 222 // end of matmodel.cxx