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
 145   // surface values for use with ground reactions
 146   solid = props->getBoolValue("solid", true);
 147   friction_factor = props->getDoubleValue("friction-factor", 1.0);
 148   rolling_friction = props->getDoubleValue("rolling-friction", 0.02);
 149   bumpiness = props->getDoubleValue("bumpiness", 0.0);
 150   load_resistance = props->getDoubleValue("load-resistance", 1e30);
 151
 152   // Taken from default values as used in ac3d
 153   ambient[0] = props->getDoubleValue("ambient/r", 0.2);
 154   ambient[1] = props->getDoubleValue("ambient/g", 0.2);
 155   ambient[2] = props->getDoubleValue("ambient/b", 0.2);
 156   ambient[3] = props->getDoubleValue("ambient/a", 1.0);
 157
 158   diffuse[0] = props->getDoubleValue("diffuse/r", 0.8);
 159   diffuse[1] = props->getDoubleValue("diffuse/g", 0.8);
 160   diffuse[2] = props->getDoubleValue("diffuse/b", 0.8);
 161   diffuse[3] = props->getDoubleValue("diffuse/a", 1.0);
 162
 163   specular[0] = props->getDoubleValue("specular/r", 0.0);
 164   specular[1] = props->getDoubleValue("specular/g", 0.0);
 165   specular[2] = props->getDoubleValue("specular/b", 0.0);
 166   specular[3] = props->getDoubleValue("specular/a", 1.0);
 167
 168   emission[0] = props->getDoubleValue("emissive/r", 0.0);
 169   emission[1] = props->getDoubleValue("emissive/g", 0.0);
 170   emission[2] = props->getDoubleValue("emissive/b", 0.0);
 171   emission[3] = props->getDoubleValue("emissive/a", 1.0);
 172
 173   shininess = props->getDoubleValue("shininess", 1.0);
 174
 175   vector<SGPropertyNode_ptr> object_group_nodes =
 176     ((SGPropertyNode *)props)->getChildren("object-group");
 177   for (unsigned int i = 0; i < object_group_nodes.size(); i++)
 178     object_groups.push_back(new SGMatModelGroup(object_group_nodes[i]));
 179
 180   // read glyph table for taxi-/runway-signs
 181   vector<SGPropertyNode_ptr> glyph_nodes = props->getChildren("glyph");
 182   for (unsigned int i = 0; i < glyph_nodes.size(); i++) {
 183     const char *name = glyph_nodes[i]->getStringValue("name");
 184     if (name)
 185       glyphs[name] = new SGMaterialGlyph(glyph_nodes[i]);
 186   }
 187 }
 188
 189
 190 \f
 191 ////////////////////////////////////////////////////////////////////////
 192 // Private methods.
 193 ////////////////////////////////////////////////////////////////////////
 194
 195 void
 196 SGMaterial::init ()
 197 {
 198     _status.clear();
 199     _current_ptr = 0;
 200     xsize = 0;
 201     ysize = 0;
 202     wrapu = true;
 203     wrapv = true;
 204
 205     mipmap = true;
 206     light_coverage = 0.0;
 207
 208     solid = true;
 209     friction_factor = 1;
 210     rolling_friction = 0.02;
 211     bumpiness = 0;
 212     load_resistance = 1e30;
 213
 214     shininess = 1.0;
 215     for (int i = 0; i < 4; i++) {
 216         ambient[i]  = (i < 3) ? 0.2 : 1.0;
 217         specular[i] = (i < 3) ? 0.0 : 1.0;
 218         diffuse[i]  = (i < 3) ? 0.8 : 1.0;
 219         emission[i] = (i < 3) ? 0.0 : 1.0;
 220     }
 221 }
 222
 223 osg::StateSet *
 224 SGMaterial::get_state (int n)
 225 {
 226     if (_status.size() == 0) {
 227         SG_LOG( SG_GENERAL, SG_WARN, "No state available.");
 228         return NULL;
 229     }
 230
 231     int i = n >= 0 ? n : _current_ptr;
 232
 233     if(!_status[i].texture_loaded)
 234     {
 235         assignTexture(_status[i].state.get(), _status[i].texture_path,
 236                       wrapu, wrapv, mipmap);
 237         _status[i].texture_loaded = true;
 238     }
 239     osg::StateSet *st = _status[i].state.get();
 240
 241     _current_ptr += 1;
 242     if (_current_ptr >= _status.size())
 243         _current_ptr = 0;
 244
 245     return st;
 246 }
 247
 248
 249 void
 250 SGMaterial::build_state( bool defer_tex_load )
 251 {
 252     for (unsigned int i = 0; i < _status.size(); i++)
 253     {
 254         osg::StateSet *stateSet = new osg::StateSet;
 255         stateSet->setUserData(new SGMaterialUserData(this));
 256
 257         // Set up the textured state
 258         osg::ShadeModel* shadeModel = new osg::ShadeModel;
 259         shadeModel->setMode(osg::ShadeModel::SMOOTH);
 260         stateSet->setAttribute(shadeModel);
 261
 262         osg::CullFace* cullFace = new osg::CullFace;
 263         cullFace->setMode(osg::CullFace::BACK);
 264         stateSet->setMode(GL_CULL_FACE, osg::StateAttribute::ON);
 265         stateSet->setAttribute(cullFace);
 266
 267         stateSet->setMode(GL_LIGHTING, osg::StateAttribute::ON);
 268
 269         _status[i].texture_loaded = false;
 270
 271         osg::Material* material = new osg::Material;
 272         material->setColorMode(osg::Material::AMBIENT_AND_DIFFUSE);
 273         material->setAmbient(osg::Material::FRONT_AND_BACK, ambient.osg());
 274         material->setDiffuse(osg::Material::FRONT_AND_BACK, diffuse.osg());
 275         material->setSpecular(osg::Material::FRONT_AND_BACK, specular.osg());
 276         material->setEmission(osg::Material::FRONT_AND_BACK, emission.osg());
 277         material->setShininess(osg::Material::FRONT_AND_BACK, shininess );
 278         stateSet->setAttribute(material);
 279
 280         if (ambient[3] < 1 || diffuse[3] < 1 ||
 281             specular[3] < 1 || emission[3] < 1) {
 282           stateSet->setRenderingHint(osg::StateSet::TRANSPARENT_BIN);
 283           stateSet->setMode(GL_BLEND, osg::StateAttribute::ON);
 284           stateSet->setMode(GL_ALPHA_TEST, osg::StateAttribute::ON);
 285         } else {
 286           stateSet->setRenderingHint(osg::StateSet::OPAQUE_BIN);
 287           stateSet->setMode(GL_BLEND, osg::StateAttribute::OFF);
 288           stateSet->setMode(GL_ALPHA_TEST, osg::StateAttribute::OFF);
 289         }
 290
 291         _status[i].state = stateSet;
 292     }
 293 }
 294
 295
 296 void SGMaterial::set_state( osg::StateSet *s )
 297 {
 298     _status.push_back( _internal_state( s, "", true ) );
 299 }
 300
 301 void SGMaterial::assignTexture( osg::StateSet *state, const std::string &fname,
 302                  int _wrapu, int _wrapv, int _mipmap )
 303 {
 304    osg::Texture2D* texture = SGLoadTexture2D(fname, 0, _wrapu, _wrapv,
 305                                              mipmap ? -1 : 0);
 306    texture->setMaxAnisotropy( SGGetTextureFilter());
 307    state->setTextureAttributeAndModes(0, texture);
 308
 309    osg::TexEnv* texEnv = new osg::TexEnv;
 310    texEnv->setMode(osg::TexEnv::MODULATE);
 311    state->setTextureAttributeAndModes(0, texEnv);
 312 }
 313
 314 SGMaterialGlyph* SGMaterial::get_glyph (const string& name) const
 315 {
 316   map<string, SGSharedPtr<SGMaterialGlyph> >::const_iterator it;
 317   it = glyphs.find(name);
 318   if (it == glyphs.end())
 319     return 0;
 320
 321   return it->second;
 322 }
 323
 324 \f
 325 ////////////////////////////////////////////////////////////////////////
 326 // SGMaterialGlyph.
 327 ////////////////////////////////////////////////////////////////////////
 328
 329 SGMaterialGlyph::SGMaterialGlyph(SGPropertyNode *p) :
 330     _left(p->getDoubleValue("left", 0.0)),
 331     _right(p->getDoubleValue("right", 1.0))
 332 {
 333 }
 334
 335 void
 336 SGSetTextureFilter( int max) {
 337         SGSceneFeatures::instance()->setTextureFilter( max);
 338 }
 339
 340 int
 341 SGGetTextureFilter() {
 342         return SGSceneFeatures::instance()->getTextureFilter();
 343 }