simgear/scene/material/mat.cxx

   1 // mat.cxx -- class to handle material properties
   2 //
   3 // Written by Curtis Olson, started May 1998.
   4 //
   5 // Copyright (C) 1998 - 2000  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 <string.h>
  31 #include <map>
  32 SG_USING_STD(map);
  33
  34 #include <plib/ul.h>
  35
  36 #ifdef SG_MATH_EXCEPTION_CLASH
  37 #  include <math.h>
  38 #endif
  39
  40 #include <osg/CullFace>
  41 #include <osg/Material>
  42 #include <osg/ShadeModel>
  43 #include <osg/TexEnv>
  44 #include <osg/Texture2D>
  45 #include <osgDB/ReadFile>
  46
  47 #include <simgear/debug/logstream.hxx>
  48 #include <simgear/misc/sg_path.hxx>
  49 #include <simgear/misc/sgstream.hxx>
  50
  51 #include <simgear/scene/model/model.hxx>
  52
  53 #include "mat.hxx"
  54
  55 \f
  56 ////////////////////////////////////////////////////////////////////////
  57 // Constructors and destructor.
  58 ////////////////////////////////////////////////////////////////////////
  59
  60
  61 SGMaterial::SGMaterial( const string &fg_root, const SGPropertyNode *props, const char *season )
  62 {
  63     init();
  64     read_properties( fg_root, props, season );
  65     build_state( false );
  66 }
  67
  68 SGMaterial::SGMaterial( const string &texpath )
  69 {
  70     init();
  71
  72     _internal_state st( NULL, texpath, false );
  73     _status.push_back( st );
  74
  75     build_state( true );
  76 }
  77
  78 SGMaterial::SGMaterial( osg::StateSet *s )
  79 {
  80     init();
  81     set_state( s );
  82 }
  83
  84 SGMaterial::~SGMaterial (void)
  85 {
  86 }
  87
  88
  89 \f
  90 ////////////////////////////////////////////////////////////////////////
  91 // Public methods.
  92 ////////////////////////////////////////////////////////////////////////
  93
  94 void
  95 SGMaterial::read_properties( const string &fg_root, const SGPropertyNode * props, const char *season )
  96 {
  97                                 // Gather the path(s) to the texture(s)
  98   vector<SGPropertyNode_ptr> textures = props->getChildren("texture");
  99   for (unsigned int i = 0; i < textures.size(); i++)
 100   {
 101     string tname = textures[i]->getStringValue();
 102     string otname = tname;
 103     if (season && strncmp(season, "summer", 6))
 104     {
 105         if (tname.substr(0,7) == "Terrain")
 106             tname.insert(7,"."+string(season));
 107     }
 108
 109     if (tname == "") {
 110         tname = "unknown.rgb";
 111     }
 112
 113     SGPath tpath( fg_root );
 114     tpath.append("Textures.high");
 115     tpath.append(tname);
 116     if ( !ulFileExists(tpath.c_str()) ) {
 117       tpath = SGPath( fg_root );
 118       tpath.append("Textures");
 119       tpath.append(tname);
 120     }
 121
 122     if ( ulFileExists(tpath.c_str()) ) {
 123       _internal_state st( NULL, tpath.str(), false );
 124       _status.push_back( st );
 125     }
 126   }
 127
 128   if (textures.size() == 0) {
 129     string tname = "unknown.rgb";
 130     SGPath tpath( fg_root );
 131     tpath.append("Textures");
 132     tpath.append("Terrain");
 133     tpath.append(tname);
 134     _internal_state st( NULL, tpath.str(), true );
 135     _status.push_back( st );
 136   }
 137
 138   xsize = props->getDoubleValue("xsize", 0.0);
 139   ysize = props->getDoubleValue("ysize", 0.0);
 140   wrapu = props->getBoolValue("wrapu", true);
 141   wrapv = props->getBoolValue("wrapv", true);
 142   mipmap = props->getBoolValue("mipmap", true);
 143   light_coverage = props->getDoubleValue("light-coverage", 0.0);
 144   tree_coverage = props->getDoubleValue("tree-coverage", 0.0);
 145   tree_height = props->getDoubleValue("tree-height-m", 0.0);
 146   tree_width = props->getDoubleValue("tree-width-m", 0.0);
 147   tree_range = props->getDoubleValue("tree-range-m", 0.0);
 148
 149   // surface values for use with ground reactions
 150   solid = props->getBoolValue("solid", true);
 151   friction_factor = props->getDoubleValue("friction-factor", 1.0);
 152   rolling_friction = props->getDoubleValue("rolling-friction", 0.02);
 153   bumpiness = props->getDoubleValue("bumpiness", 0.0);
 154   load_resistance = props->getDoubleValue("load-resistance", 1e30);
 155
 156   // Taken from default values as used in ac3d
 157   ambient[0] = props->getDoubleValue("ambient/r", 0.2);
 158   ambient[1] = props->getDoubleValue("ambient/g", 0.2);
 159   ambient[2] = props->getDoubleValue("ambient/b", 0.2);
 160   ambient[3] = props->getDoubleValue("ambient/a", 1.0);
 161
 162   diffuse[0] = props->getDoubleValue("diffuse/r", 0.8);
 163   diffuse[1] = props->getDoubleValue("diffuse/g", 0.8);
 164   diffuse[2] = props->getDoubleValue("diffuse/b", 0.8);
 165   diffuse[3] = props->getDoubleValue("diffuse/a", 1.0);
 166
 167   specular[0] = props->getDoubleValue("specular/r", 0.0);
 168   specular[1] = props->getDoubleValue("specular/g", 0.0);
 169   specular[2] = props->getDoubleValue("specular/b", 0.0);
 170   specular[3] = props->getDoubleValue("specular/a", 1.0);
 171
 172   emission[0] = props->getDoubleValue("emissive/r", 0.0);
 173   emission[1] = props->getDoubleValue("emissive/g", 0.0);
 174   emission[2] = props->getDoubleValue("emissive/b", 0.0);
 175   emission[3] = props->getDoubleValue("emissive/a", 1.0);
 176
 177   shininess = props->getDoubleValue("shininess", 1.0);
 178
 179   vector<SGPropertyNode_ptr> object_group_nodes =
 180     ((SGPropertyNode *)props)->getChildren("object-group");
 181   for (unsigned int i = 0; i < object_group_nodes.size(); i++)
 182     object_groups.push_back(new SGMatModelGroup(object_group_nodes[i]));
 183
 184   vector<SGPropertyNode_ptr> tree_texture_nodes =
 185     ((SGPropertyNode *)props)->getChildren("tree-texture");
 186   for (unsigned int i = 0; i < tree_texture_nodes.size(); i++) {
 187     SGPath tpath( fg_root );
 188     tpath.append(tree_texture_nodes[i]->getStringValue());
 189     tree_textures.push_back(tpath.str());
 190   }
 191
 192   // read glyph table for taxi-/runway-signs
 193   vector<SGPropertyNode_ptr> glyph_nodes = props->getChildren("glyph");
 194   for (unsigned int i = 0; i < glyph_nodes.size(); i++) {
 195     const char *name = glyph_nodes[i]->getStringValue("name");
 196     if (name)
 197       glyphs[name] = new SGMaterialGlyph(glyph_nodes[i]);
 198   }
 199 }
 200
 201
 202 \f
 203 ////////////////////////////////////////////////////////////////////////
 204 // Private methods.
 205 ////////////////////////////////////////////////////////////////////////
 206
 207 void
 208 SGMaterial::init ()
 209 {
 210     _status.clear();
 211     _current_ptr = 0;
 212     xsize = 0;
 213     ysize = 0;
 214     wrapu = true;
 215     wrapv = true;
 216
 217     mipmap = true;
 218     light_coverage = 0.0;
 219
 220     solid = true;
 221     friction_factor = 1;
 222     rolling_friction = 0.02;
 223     bumpiness = 0;
 224     load_resistance = 1e30;
 225
 226     shininess = 1.0;
 227     for (int i = 0; i < 4; i++) {
 228         ambient[i]  = (i < 3) ? 0.2 : 1.0;
 229         specular[i] = (i < 3) ? 0.0 : 1.0;
 230         diffuse[i]  = (i < 3) ? 0.8 : 1.0;
 231         emission[i] = (i < 3) ? 0.0 : 1.0;
 232     }
 233 }
 234
 235 osg::StateSet *
 236 SGMaterial::get_state (int n)
 237 {
 238     if (_status.size() == 0) {
 239         SG_LOG( SG_GENERAL, SG_WARN, "No state available.");
 240         return NULL;
 241     }
 242
 243     int i = n >= 0 ? n : _current_ptr;
 244
 245     if(!_status[i].texture_loaded)
 246     {
 247         assignTexture(_status[i].state.get(), _status[i].texture_path,
 248                       wrapu, wrapv, mipmap);
 249         _status[i].texture_loaded = true;
 250     }
 251     osg::StateSet *st = _status[i].state.get();
 252
 253     _current_ptr += 1;
 254     if (_current_ptr >= _status.size())
 255         _current_ptr = 0;
 256
 257     return st;
 258 }
 259
 260
 261 void
 262 SGMaterial::build_state( bool defer_tex_load )
 263 {
 264     for (unsigned int i = 0; i < _status.size(); i++)
 265     {
 266         osg::StateSet *stateSet = new osg::StateSet;
 267         stateSet->setUserData(new SGMaterialUserData(this));
 268
 269         // Set up the textured state
 270         osg::ShadeModel* shadeModel = new osg::ShadeModel;
 271         shadeModel->setMode(osg::ShadeModel::SMOOTH);
 272         stateSet->setAttribute(shadeModel);
 273
 274         osg::CullFace* cullFace = new osg::CullFace;
 275         cullFace->setMode(osg::CullFace::BACK);
 276         stateSet->setMode(GL_CULL_FACE, osg::StateAttribute::ON);
 277         stateSet->setAttribute(cullFace);
 278
 279         stateSet->setMode(GL_LIGHTING, osg::StateAttribute::ON);
 280
 281         _status[i].texture_loaded = false;
 282
 283         osg::Material* material = new osg::Material;
 284         material->setColorMode(osg::Material::AMBIENT_AND_DIFFUSE);
 285         material->setAmbient(osg::Material::FRONT_AND_BACK, ambient.osg());
 286         material->setDiffuse(osg::Material::FRONT_AND_BACK, diffuse.osg());
 287         material->setSpecular(osg::Material::FRONT_AND_BACK, specular.osg());
 288         material->setEmission(osg::Material::FRONT_AND_BACK, emission.osg());
 289         material->setShininess(osg::Material::FRONT_AND_BACK, shininess );
 290         stateSet->setAttribute(material);
 291
 292         if (ambient[3] < 1 || diffuse[3] < 1 ||
 293             specular[3] < 1 || emission[3] < 1) {
 294           stateSet->setRenderingHint(osg::StateSet::TRANSPARENT_BIN);
 295           stateSet->setMode(GL_BLEND, osg::StateAttribute::ON);
 296           stateSet->setMode(GL_ALPHA_TEST, osg::StateAttribute::ON);
 297         } else {
 298           stateSet->setRenderingHint(osg::StateSet::OPAQUE_BIN);
 299           stateSet->setMode(GL_BLEND, osg::StateAttribute::OFF);
 300           stateSet->setMode(GL_ALPHA_TEST, osg::StateAttribute::OFF);
 301         }
 302
 303         _status[i].state = stateSet;
 304     }
 305 }
 306
 307
 308 void SGMaterial::set_state( osg::StateSet *s )
 309 {
 310     _status.push_back( _internal_state( s, "", true ) );
 311 }
 312
 313 void SGMaterial::assignTexture( osg::StateSet *state, const std::string &fname,
 314                  int _wrapu, int _wrapv, int _mipmap )
 315 {
 316    osg::Texture2D* texture = SGLoadTexture2D(fname, 0, _wrapu, _wrapv,
 317                                              mipmap ? -1 : 0);
 318    texture->setMaxAnisotropy( SGGetTextureFilter());
 319    state->setTextureAttributeAndModes(0, texture);
 320
 321    osg::TexEnv* texEnv = new osg::TexEnv;
 322    texEnv->setMode(osg::TexEnv::MODULATE);
 323    state->setTextureAttributeAndModes(0, texEnv);
 324 }
 325
 326 SGMaterialGlyph* SGMaterial::get_glyph (const string& name) const
 327 {
 328   map<string, SGSharedPtr<SGMaterialGlyph> >::const_iterator it;
 329   it = glyphs.find(name);
 330   if (it == glyphs.end())
 331     return 0;
 332
 333   return it->second;
 334 }
 335
 336 \f
 337 ////////////////////////////////////////////////////////////////////////
 338 // SGMaterialGlyph.
 339 ////////////////////////////////////////////////////////////////////////
 340
 341 SGMaterialGlyph::SGMaterialGlyph(SGPropertyNode *p) :
 342     _left(p->getDoubleValue("left", 0.0)),
 343     _right(p->getDoubleValue("right", 1.0))
 344 {
 345 }
 346
 347 void
 348 SGSetTextureFilter( int max) {
 349         SGSceneFeatures::instance()->setTextureFilter( max);
 350 }
 351
 352 int
 353 SGGetTextureFilter() {
 354         return SGSceneFeatures::instance()->getTextureFilter();
 355 }