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 #include <vector>
  33 #include <string>
  34
  35 #include <boost/foreach.hpp>
  36 #include "mat.hxx"
  37
  38 #include <osg/CullFace>
  39 #include <osg/Material>
  40 #include <osg/ShadeModel>
  41 #include <osg/StateSet>
  42 #include <osg/TexEnv>
  43 #include <osg/Texture2D>
  44 #include <osgDB/ReaderWriter>
  45 #include <osgDB/ReadFile>
  46 #include <osgDB/Registry>
  47 #include <osgDB/FileUtils>
  48
  49 #include <simgear/debug/logstream.hxx>
  50 #include <simgear/misc/sg_path.hxx>
  51 #include <simgear/misc/sgstream.hxx>
  52 #include <simgear/scene/util/SGReaderWriterOptions.hxx>
  53 #include <simgear/props/props_io.hxx>
  54 #include <simgear/scene/model/model.hxx>
  55 #include <simgear/scene/util/RenderConstants.hxx>
  56 #include <simgear/scene/util/StateAttributeFactory.hxx>
  57
  58 #include "Effect.hxx"
  59 #include "Technique.hxx"
  60 #include "Pass.hxx"
  61
  62 using std::map;
  63 using std::string;
  64 using namespace simgear;
  65
  66 \f
  67 ////////////////////////////////////////////////////////////////////////
  68 // Constructors and destructor.
  69 ////////////////////////////////////////////////////////////////////////
  70
  71 SGMaterial::_internal_state::_internal_state(Effect *e, bool l,
  72                                              const SGReaderWriterOptions* o)
  73     : effect(e), effect_realized(l), options(o)
  74 {
  75 }
  76
  77 SGMaterial::_internal_state::_internal_state(Effect *e, const string &t, bool l,
  78                                              const SGReaderWriterOptions* o)
  79     : effect(e), effect_realized(l), options(o)
  80 {
  81     texture_paths.push_back(std::make_pair(t,0));
  82 }
  83
  84 void SGMaterial::_internal_state::add_texture(const std::string &t, int i)
  85 {
  86     texture_paths.push_back(std::make_pair(t,i));
  87 }
  88
  89 SGMaterial::SGMaterial( const SGReaderWriterOptions* options,
  90                         const SGPropertyNode *props )
  91 {
  92     init();
  93     read_properties( options, props );
  94     buildEffectProperties(options);
  95 }
  96
  97 SGMaterial::SGMaterial( const osgDB::ReaderWriter::Options* options,
  98                         const SGPropertyNode *props )
  99 {
 100     osg::ref_ptr<const SGReaderWriterOptions> sgOptions;
 101     if (options)
 102         sgOptions = new SGReaderWriterOptions(*options);
 103     init();
 104     read_properties( sgOptions.get(), props );
 105     buildEffectProperties(sgOptions.get());
 106 }
 107
 108 SGMaterial::~SGMaterial (void)
 109 {
 110 }
 111
 112 \f
 113 ////////////////////////////////////////////////////////////////////////
 114 // Public methods.
 115 ////////////////////////////////////////////////////////////////////////
 116
 117 void
 118 SGMaterial::read_properties(const SGReaderWriterOptions* options,
 119                             const SGPropertyNode *props)
 120 {
 121   std::vector<bool> dds;
 122   std::vector<SGPropertyNode_ptr> textures = props->getChildren("texture");
 123   for (unsigned int i = 0; i < textures.size(); i++)
 124   {
 125     string tname = textures[i]->getStringValue();
 126
 127     if (tname.empty()) {
 128         tname = "unknown.rgb";
 129     }
 130
 131     SGPath tpath("Textures.high");
 132     tpath.append(tname);
 133     string fullTexPath = SGModelLib::findDataFile(tpath.str(), options);
 134     if (fullTexPath.empty()) {
 135       tpath = SGPath("Textures");
 136       tpath.append(tname);
 137       fullTexPath = SGModelLib::findDataFile(tpath.str(), options);
 138     }
 139
 140     if (tpath.lower_extension() == "dds") {
 141       dds.push_back(true);
 142     } else {
 143       dds.push_back(false);
 144     }
 145
 146     if (!fullTexPath.empty() ) {
 147       _internal_state st( NULL, fullTexPath, false, options );
 148       _status.push_back( st );
 149     }
 150   }
 151
 152   std::vector<SGPropertyNode_ptr> texturesets = props->getChildren("texture-set");
 153   for (unsigned int i = 0; i < texturesets.size(); i++)
 154   {
 155     _internal_state st( NULL, false, options );
 156     std::vector<SGPropertyNode_ptr> textures = texturesets[i]->getChildren("texture");
 157     for (unsigned int j = 0; j < textures.size(); j++)
 158     {
 159       string tname = textures[j]->getStringValue();
 160       if (tname.empty()) {
 161           tname = "unknown.rgb";
 162       }
 163
 164       SGPath tpath("Textures.high");
 165       tpath.append(tname);
 166       string fullTexPath = SGModelLib::findDataFile(tpath.str(), options);
 167       if (fullTexPath.empty()) {
 168         tpath = SGPath("Textures");
 169         tpath.append(tname);
 170         fullTexPath = SGModelLib::findDataFile(tpath.str(), options);
 171       }
 172
 173       if (j == 0) {
 174         if (tpath.lower_extension() == "dds") {
 175           dds.push_back(true);
 176         } else {
 177           dds.push_back(false);
 178         }
 179       }
 180
 181       st.add_texture(fullTexPath, textures[j]->getIndex());
 182     }
 183
 184     if (!st.texture_paths.empty() ) {
 185       _status.push_back( st );
 186     }
 187   }
 188
 189   if (textures.size() == 0 && texturesets.size() == 0) {
 190     SGPath tpath("Textures");
 191     tpath.append("Terrain");
 192     tpath.append("unknown.rgb");
 193     _internal_state st( NULL, tpath.str(), true, options );
 194     _status.push_back( st );
 195   }
 196
 197   std::vector<SGPropertyNode_ptr> masks = props->getChildren("object-mask");
 198   for (unsigned int i = 0; i < masks.size(); i++)
 199   {
 200     string omname = masks[i]->getStringValue();
 201
 202     if (! omname.empty()) {
 203       SGPath ompath("Textures.high");
 204       ompath.append(omname);
 205       string fullMaskPath = SGModelLib::findDataFile(ompath.str(), options);
 206
 207       if (fullMaskPath.empty()) {
 208         ompath = SGPath("Textures");
 209         ompath.append(omname);
 210         fullMaskPath = SGModelLib::findDataFile(ompath.str(), options);
 211       }
 212
 213       osg::Image* image = osgDB::readImageFile(fullMaskPath, options);
 214       if (image->valid())
 215       {
 216         osg::Texture2D* object_mask = new osg::Texture2D;
 217
 218         bool dds_mask = (ompath.lower_extension() == "dds");
 219
 220         if (dds[i] != dds_mask) {
 221           // Texture format does not match mask format. This is relevant for
 222           // the object mask, as DDS textures have an origin at the bottom
 223           // left rather than top left, therefore we flip the object mask
 224           // vertically.
 225           image->flipVertical();
 226         }
 227
 228         object_mask->setImage(image);
 229         object_mask->setDataVariance(osg::Object::STATIC);
 230         object_mask->setWrap(osg::Texture::WRAP_S, osg::Texture::REPEAT);
 231         object_mask->setWrap(osg::Texture::WRAP_T, osg::Texture::REPEAT);
 232         _masks.push_back(object_mask);
 233       }
 234     }
 235   }
 236
 237   xsize = props->getDoubleValue("xsize", 0.0);
 238   ysize = props->getDoubleValue("ysize", 0.0);
 239   wrapu = props->getBoolValue("wrapu", true);
 240   wrapv = props->getBoolValue("wrapv", true);
 241   mipmap = props->getBoolValue("mipmap", true);
 242   light_coverage = props->getDoubleValue("light-coverage", 0.0);
 243   wood_coverage = props->getDoubleValue("wood-coverage", 0.0);
 244   tree_height = props->getDoubleValue("tree-height-m", 0.0);
 245   tree_width = props->getDoubleValue("tree-width-m", 0.0);
 246   tree_range = props->getDoubleValue("tree-range-m", 0.0);
 247   tree_varieties = props->getIntValue("tree-varieties", 1);
 248
 249   const SGPropertyNode* treeTexNode = props->getChild("tree-texture");
 250
 251   if (treeTexNode) {
 252     string treeTexPath = props->getStringValue("tree-texture");
 253
 254     if (! treeTexPath.empty()) {
 255       SGPath treePath("Textures.high");
 256       treePath.append(treeTexPath);
 257       tree_texture = SGModelLib::findDataFile(treePath.str(), options);
 258
 259       if (tree_texture.empty()) {
 260         treePath = SGPath("Textures");
 261         treePath.append(treeTexPath);
 262         tree_texture = SGModelLib::findDataFile(treePath.str(), options);
 263       }
 264     }
 265   }
 266
 267   // surface values for use with ground reactions
 268   solid = props->getBoolValue("solid", true);
 269   friction_factor = props->getDoubleValue("friction-factor", 1.0);
 270   rolling_friction = props->getDoubleValue("rolling-friction", 0.02);
 271   bumpiness = props->getDoubleValue("bumpiness", 0.0);
 272   load_resistance = props->getDoubleValue("load-resistance", 1e30);
 273
 274   // Taken from default values as used in ac3d
 275   ambient[0] = props->getDoubleValue("ambient/r", 0.2);
 276   ambient[1] = props->getDoubleValue("ambient/g", 0.2);
 277   ambient[2] = props->getDoubleValue("ambient/b", 0.2);
 278   ambient[3] = props->getDoubleValue("ambient/a", 1.0);
 279
 280   diffuse[0] = props->getDoubleValue("diffuse/r", 0.8);
 281   diffuse[1] = props->getDoubleValue("diffuse/g", 0.8);
 282   diffuse[2] = props->getDoubleValue("diffuse/b", 0.8);
 283   diffuse[3] = props->getDoubleValue("diffuse/a", 1.0);
 284
 285   specular[0] = props->getDoubleValue("specular/r", 0.0);
 286   specular[1] = props->getDoubleValue("specular/g", 0.0);
 287   specular[2] = props->getDoubleValue("specular/b", 0.0);
 288   specular[3] = props->getDoubleValue("specular/a", 1.0);
 289
 290   emission[0] = props->getDoubleValue("emissive/r", 0.0);
 291   emission[1] = props->getDoubleValue("emissive/g", 0.0);
 292   emission[2] = props->getDoubleValue("emissive/b", 0.0);
 293   emission[3] = props->getDoubleValue("emissive/a", 1.0);
 294
 295   shininess = props->getDoubleValue("shininess", 1.0);
 296
 297   if (props->hasChild("effect"))
 298       effect = props->getStringValue("effect");
 299
 300   std::vector<SGPropertyNode_ptr> object_group_nodes =
 301     ((SGPropertyNode *)props)->getChildren("object-group");
 302   for (unsigned int i = 0; i < object_group_nodes.size(); i++)
 303     object_groups.push_back(new SGMatModelGroup(object_group_nodes[i]));
 304
 305   // read glyph table for taxi-/runway-signs
 306   std::vector<SGPropertyNode_ptr> glyph_nodes = props->getChildren("glyph");
 307   for (unsigned int i = 0; i < glyph_nodes.size(); i++) {
 308     const char *name = glyph_nodes[i]->getStringValue("name");
 309     if (name)
 310       glyphs[name] = new SGMaterialGlyph(glyph_nodes[i]);
 311   }
 312 }
 313
 314
 315 \f
 316 ////////////////////////////////////////////////////////////////////////
 317 // Private methods.
 318 ////////////////////////////////////////////////////////////////////////
 319
 320 void
 321 SGMaterial::init ()
 322 {
 323     _status.clear();
 324     xsize = 0;
 325     ysize = 0;
 326     wrapu = true;
 327     wrapv = true;
 328
 329     mipmap = true;
 330     light_coverage = 0.0;
 331
 332     solid = true;
 333     friction_factor = 1;
 334     rolling_friction = 0.02;
 335     bumpiness = 0;
 336     load_resistance = 1e30;
 337
 338     shininess = 1.0;
 339     for (int i = 0; i < 4; i++) {
 340         ambient[i]  = (i < 3) ? 0.2 : 1.0;
 341         specular[i] = (i < 3) ? 0.0 : 1.0;
 342         diffuse[i]  = (i < 3) ? 0.8 : 1.0;
 343         emission[i] = (i < 3) ? 0.0 : 1.0;
 344     }
 345     effect = "Effects/terrain-default";
 346 }
 347
 348 Effect* SGMaterial::get_effect(int i)
 349 {
 350     if(!_status[i].effect_realized) {
 351         _status[i].effect->realizeTechniques(_status[i].options.get());
 352         _status[i].effect_realized = true;
 353     }
 354     return _status[i].effect.get();
 355 }
 356
 357 Effect* SGMaterial::get_effect(SGTexturedTriangleBin triangleBin)
 358 {
 359     if (_status.size() == 0) {
 360         SG_LOG( SG_GENERAL, SG_WARN, "No effect available.");
 361         return 0;
 362     }
 363
 364     int i = triangleBin.getTextureIndex() % _status.size();
 365     return get_effect(i);
 366 }
 367
 368 Effect* SGMaterial::get_effect()
 369 {
 370     return get_effect(0);
 371 }
 372
 373
 374 osg::Texture2D* SGMaterial::get_object_mask(SGTexturedTriangleBin triangleBin)
 375 {
 376     if (_status.size() == 0) {
 377         SG_LOG( SG_GENERAL, SG_WARN, "No mask available.");
 378         return 0;
 379     }
 380
 381     // Note that the object mask is closely linked to the texture/effect
 382     // so we index based on the texture index,
 383     unsigned int i = triangleBin.getTextureIndex() % _status.size();
 384     if (i < _masks.size()) {
 385         return _masks[i];
 386     } else {
 387         return 0;
 388     }
 389 }
 390
 391 void SGMaterial::buildEffectProperties(const SGReaderWriterOptions* options)
 392 {
 393     using namespace osg;
 394     ref_ptr<SGReaderWriterOptions> xmlOptions;
 395     if (options)
 396         xmlOptions = new SGReaderWriterOptions(*options);
 397     ref_ptr<SGMaterialUserData> user = new SGMaterialUserData(this);
 398     SGPropertyNode_ptr propRoot = new SGPropertyNode();
 399     makeChild(propRoot, "inherits-from")->setStringValue(effect);
 400     SGPropertyNode* paramProp = makeChild(propRoot, "parameters");
 401     SGPropertyNode* materialProp = makeChild(paramProp, "material");
 402     makeChild(materialProp, "ambient")->setValue(SGVec4d(ambient));
 403     makeChild(materialProp, "diffuse")->setValue(SGVec4d(diffuse));
 404     makeChild(materialProp, "specular")->setValue(SGVec4d(specular));
 405     makeChild(materialProp, "emissive")->setValue(SGVec4d(emission));
 406     makeChild(materialProp, "shininess")->setFloatValue(shininess);
 407     if (ambient[3] < 1 || diffuse[3] < 1 ||
 408         specular[3] < 1 || emission[3] < 1) {
 409         makeChild(paramProp, "transparent")->setBoolValue(true);
 410         SGPropertyNode* binProp = makeChild(paramProp, "render-bin");
 411         makeChild(binProp, "bin-number")->setIntValue(TRANSPARENT_BIN);
 412         makeChild(binProp, "bin-name")->setStringValue("DepthSortedBin");
 413     }
 414     BOOST_FOREACH(_internal_state& matState, _status)
 415     {
 416         SGPropertyNode_ptr effectProp = new SGPropertyNode();
 417         copyProperties(propRoot, effectProp);
 418         SGPropertyNode* effectParamProp = effectProp->getChild("parameters", 0);
 419         for (unsigned int i = 0; i < matState.texture_paths.size(); i++) {
 420             SGPropertyNode* texProp = makeChild(effectParamProp, "texture", matState.texture_paths[i].second);
 421             makeChild(texProp, "image")->setStringValue(matState.texture_paths[i].first);
 422             makeChild(texProp, "filter")
 423                 ->setStringValue(mipmap ? "linear-mipmap-linear" : "nearest");
 424             makeChild(texProp, "wrap-s")
 425                 ->setStringValue(wrapu ? "repeat" : "clamp");
 426             makeChild(texProp, "wrap-t")
 427                 ->setStringValue(wrapv ? "repeat" : "clamp");
 428         }
 429         makeChild(effectParamProp, "xsize")->setDoubleValue(xsize);
 430         makeChild(effectParamProp, "ysize")->setDoubleValue(ysize);
 431         makeChild(effectParamProp, "scale")->setValue(SGVec3d(xsize,ysize,0.0));
 432         makeChild(effectParamProp, "light-coverage")->setDoubleValue(light_coverage);
 433
 434         matState.effect = makeEffect(effectProp, false, xmlOptions.get());
 435         matState.effect->setUserData(user.get());
 436     }
 437 }
 438
 439 SGMaterialGlyph* SGMaterial::get_glyph (const string& name) const
 440 {
 441   map<string, SGSharedPtr<SGMaterialGlyph> >::const_iterator it;
 442   it = glyphs.find(name);
 443   if (it == glyphs.end())
 444     return 0;
 445
 446   return it->second;
 447 }
 448
 449 \f
 450 ////////////////////////////////////////////////////////////////////////
 451 // SGMaterialGlyph.
 452 ////////////////////////////////////////////////////////////////////////
 453
 454 SGMaterialGlyph::SGMaterialGlyph(SGPropertyNode *p) :
 455     _left(p->getDoubleValue("left", 0.0)),
 456     _right(p->getDoubleValue("right", 1.0))
 457 {
 458 }
 459
 460 void
 461 SGSetTextureFilter( int max) {
 462         SGSceneFeatures::instance()->setTextureFilter( max);
 463 }
 464
 465 int
 466 SGGetTextureFilter() {
 467         return SGSceneFeatures::instance()->getTextureFilter();
 468 }