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/Texture>
  44 #include <osg/Texture2D>
  45 #include <osgDB/ReaderWriter>
  46 #include <osgDB/ReadFile>
  47 #include <osgDB/Registry>
  48 #include <osgDB/FileUtils>
  49
  50 #include <simgear/debug/logstream.hxx>
  51 #include <simgear/misc/sg_path.hxx>
  52 #include <simgear/misc/sgstream.hxx>
  53 #include <simgear/scene/util/SGReaderWriterOptions.hxx>
  54 #include <simgear/props/props_io.hxx>
  55 #include <simgear/scene/model/model.hxx>
  56 #include <simgear/scene/util/RenderConstants.hxx>
  57 #include <simgear/scene/util/StateAttributeFactory.hxx>
  58
  59 #include "Effect.hxx"
  60 #include "Technique.hxx"
  61 #include "Pass.hxx"
  62
  63 using std::map;
  64 using std::string;
  65 using namespace simgear;
  66
  67 \f
  68 ////////////////////////////////////////////////////////////////////////
  69 // Constructors and destructor.
  70 ////////////////////////////////////////////////////////////////////////
  71
  72 SGMaterial::_internal_state::_internal_state(Effect *e, bool l,
  73                                              const SGReaderWriterOptions* o)
  74     : effect(e), effect_realized(l), options(o)
  75 {
  76 }
  77
  78 SGMaterial::_internal_state::_internal_state(Effect *e, const string &t, bool l,
  79                                              const SGReaderWriterOptions* o)
  80     : effect(e), effect_realized(l), options(o)
  81 {
  82     texture_paths.push_back(std::make_pair(t,0));
  83 }
  84
  85 void SGMaterial::_internal_state::add_texture(const std::string &t, int i)
  86 {
  87     texture_paths.push_back(std::make_pair(t,i));
  88 }
  89
  90 SGMaterial::SGMaterial( const SGReaderWriterOptions* options,
  91                         const SGPropertyNode *props,
  92                         SGPropertyNode *prop_root )
  93 {
  94     init();
  95     read_properties( options, props, prop_root );
  96     buildEffectProperties(options);
  97 }
  98
  99 SGMaterial::SGMaterial( const osgDB::Options* options,
 100                         const SGPropertyNode *props,
 101                         SGPropertyNode *prop_root)
 102 {
 103     osg::ref_ptr<SGReaderWriterOptions> opt;
 104     opt = SGReaderWriterOptions::copyOrCreate(options);
 105     init();
 106     read_properties(opt.get(), props, prop_root);
 107     buildEffectProperties(opt.get());
 108 }
 109
 110 SGMaterial::~SGMaterial (void)
 111 {
 112 }
 113
 114 \f
 115 ////////////////////////////////////////////////////////////////////////
 116 // Public methods.
 117 ////////////////////////////////////////////////////////////////////////
 118
 119 void
 120 SGMaterial::read_properties(const SGReaderWriterOptions* options,
 121                             const SGPropertyNode *props,
 122                             SGPropertyNode *prop_root)
 123 {
 124     std::vector<bool> dds;
 125     std::vector<SGPropertyNode_ptr> textures = props->getChildren("texture");
 126     for (unsigned int i = 0; i < textures.size(); i++)
 127     {
 128         string tname = textures[i]->getStringValue();
 129
 130         if (tname.empty()) {
 131             tname = "unknown.rgb";
 132         }
 133
 134         SGPath tpath("Textures.high");
 135         tpath.append(tname);
 136         string fullTexPath = SGModelLib::findDataFile(tpath.str(), options);
 137         if (fullTexPath.empty()) {
 138             tpath = SGPath("Textures");
 139             tpath.append(tname);
 140             fullTexPath = SGModelLib::findDataFile(tpath.str(), options);
 141             if (fullTexPath.empty()) {
 142                 SG_LOG(SG_GENERAL, SG_ALERT, "Cannot find texture \""
 143                         << tname << "\" in Textures or Textures.high folders.");
 144             }
 145         }
 146
 147         if (tpath.lower_extension() == "dds") {
 148             dds.push_back(true);
 149         } else {
 150             dds.push_back(false);
 151         }
 152
 153         if (!fullTexPath.empty() ) {
 154             _internal_state st( NULL, fullTexPath, false, options );
 155             _status.push_back( st );
 156         }
 157     }
 158
 159     std::vector<SGPropertyNode_ptr> texturesets = props->getChildren("texture-set");
 160     for (unsigned int i = 0; i < texturesets.size(); i++)
 161     {
 162         _internal_state st( NULL, false, options );
 163         std::vector<SGPropertyNode_ptr> textures = texturesets[i]->getChildren("texture");
 164         for (unsigned int j = 0; j < textures.size(); j++)
 165         {
 166             string tname = textures[j]->getStringValue();
 167             if (tname.empty()) {
 168                 tname = "unknown.rgb";
 169             }
 170
 171             SGPath tpath("Textures.high");
 172             tpath.append(tname);
 173             string fullTexPath = SGModelLib::findDataFile(tpath.str(), options);
 174             if (fullTexPath.empty()) {
 175                 tpath = SGPath("Textures");
 176                 tpath.append(tname);
 177                 fullTexPath = SGModelLib::findDataFile(tpath.str(), options);
 178                 if (fullTexPath.empty() ) {
 179                     SG_LOG(SG_GENERAL, SG_ALERT, "Cannot find texture \""
 180                             << tname << "\" in Textures or Textures.high folders.");
 181                 }
 182             }
 183
 184             if (j == 0) {
 185                 if (tpath.lower_extension() == "dds") {
 186                     dds.push_back(true);
 187                 } else {
 188                     dds.push_back(false);
 189                 }
 190             }
 191
 192             st.add_texture(fullTexPath, textures[j]->getIndex());
 193         }
 194
 195         if (!st.texture_paths.empty() ) {
 196             _status.push_back( st );
 197         }
 198     }
 199
 200     if (textures.size() == 0 && texturesets.size() == 0) {
 201         SGPath tpath("Textures");
 202         tpath.append("Terrain");
 203         tpath.append("unknown.rgb");
 204         _internal_state st( NULL, tpath.str(), true, options );
 205         _status.push_back( st );
 206     }
 207
 208     std::vector<SGPropertyNode_ptr> masks = props->getChildren("object-mask");
 209     for (unsigned int i = 0; i < masks.size(); i++)
 210     {
 211         string omname = masks[i]->getStringValue();
 212
 213         if (! omname.empty()) {
 214             SGPath ompath("Textures.high");
 215             ompath.append(omname);
 216             string fullMaskPath = SGModelLib::findDataFile(ompath.str(), options);
 217
 218             if (fullMaskPath.empty()) {
 219                 ompath = SGPath("Textures");
 220                 ompath.append(omname);
 221                 fullMaskPath = SGModelLib::findDataFile(ompath.str(), options);
 222             }
 223
 224             if (fullMaskPath.empty()) {
 225                 SG_LOG(SG_GENERAL, SG_ALERT, "Cannot find texture \""
 226                         << omname << "\" in Textures or Textures.high folders.");
 227             }
 228             else
 229             {
 230                 osg::Image* image = osgDB::readImageFile(fullMaskPath, options);
 231                 if (image && image->valid())
 232                 {
 233                     osg::Texture2D* object_mask = new osg::Texture2D;
 234
 235                     bool dds_mask = (ompath.lower_extension() == "dds");
 236
 237                     if (dds[i] != dds_mask) {
 238                         // Texture format does not match mask format. This is relevant for
 239                         // the object mask, as DDS textures have an origin at the bottom
 240                         // left rather than top left, therefore we flip the object mask
 241                         // vertically.
 242                         image->flipVertical();
 243                     }
 244
 245                     object_mask->setImage(image);
 246
 247                     // We force the filtering to be nearest, as the red channel (rotation)
 248                     // in particular, doesn't make sense to be interpolated between pixels.
 249                     object_mask->setFilter(osg::Texture::MIN_FILTER, osg::Texture::NEAREST);
 250                     object_mask->setFilter(osg::Texture::MAG_FILTER, osg::Texture::NEAREST);
 251
 252                     object_mask->setDataVariance(osg::Object::STATIC);
 253                     object_mask->setWrap(osg::Texture::WRAP_S, osg::Texture::REPEAT);
 254                     object_mask->setWrap(osg::Texture::WRAP_T, osg::Texture::REPEAT);
 255                     _masks.push_back(object_mask);
 256                 }
 257             }
 258         }
 259     }
 260
 261     xsize = props->getDoubleValue("xsize", 0.0);
 262     ysize = props->getDoubleValue("ysize", 0.0);
 263     wrapu = props->getBoolValue("wrapu", true);
 264     wrapv = props->getBoolValue("wrapv", true);
 265     mipmap = props->getBoolValue("mipmap", true);
 266     light_coverage = props->getDoubleValue("light-coverage", 0.0);
 267
 268     // Building properties
 269     building_coverage = props->getDoubleValue("building-coverage", 0.0);
 270     building_spacing = props->getDoubleValue("building-spacing-m", 5.0);
 271
 272     string bt = props->getStringValue("building-texture", "Textures/buildings.png");
 273     building_texture = SGModelLib::findDataFile(bt, options);
 274
 275     if (building_texture.empty()) {
 276         SG_LOG(SG_GENERAL, SG_ALERT, "Cannot find texture \"" << bt);
 277     }
 278
 279     bt = props->getStringValue("building-lightmap", "Textures/buildings-lightmap.png");
 280     building_lightmap = SGModelLib::findDataFile(bt, options);
 281
 282     if (building_lightmap.empty()) {
 283         SG_LOG(SG_GENERAL, SG_ALERT, "Cannot find texture \"" << bt);
 284     }
 285
 286     building_small_ratio = props->getDoubleValue("building-small-ratio", 0.8);
 287     building_medium_ratio = props->getDoubleValue("building-medium-ratio", 0.15);
 288     building_large_ratio =  props->getDoubleValue("building-large-ratio", 0.05);
 289
 290     building_small_pitch =  props->getDoubleValue("building-small-pitch", 0.8);
 291     building_medium_pitch =  props->getDoubleValue("building-medium-pitch", 0.2);
 292     building_large_pitch =  props->getDoubleValue("building-large-pitch", 0.1);
 293
 294     building_small_min_floors = props->getIntValue("building-small-min-floors", 1);
 295     building_small_max_floors = props->getIntValue("building-small-max-floors", 3);
 296     building_medium_min_floors = props->getIntValue("building-medium-min-floors", 3);
 297     building_medium_max_floors = props->getIntValue("building-medium-max-floors", 8);
 298     building_large_min_floors = props->getIntValue("building-large-min-floors", 5);
 299     building_large_max_floors = props->getIntValue("building-large-max-floors", 20);
 300
 301     building_small_min_width = props->getFloatValue("building-small-min-width-m", 15.0);
 302     building_small_max_width = props->getFloatValue("building-small-max-width-m", 60.0);
 303     building_small_min_depth = props->getFloatValue("building-small-min-depth-m", 10.0);
 304     building_small_max_depth = props->getFloatValue("building-small-max-depth-m", 20.0);
 305
 306     building_medium_min_width = props->getFloatValue("building-medium-min-width-m", 25.0);
 307     building_medium_max_width = props->getFloatValue("building-medium-max-width-m", 50.0);
 308     building_medium_min_depth = props->getFloatValue("building-medium-min-depth-m", 20.0);
 309     building_medium_max_depth = props->getFloatValue("building-medium-max-depth-m", 50.0);
 310
 311     building_large_min_width = props->getFloatValue("building-large-min-width-m", 50.0);
 312     building_large_max_width = props->getFloatValue("building-large-max-width-m", 75.0);
 313     building_large_min_depth = props->getFloatValue("building-large-min-depth-m", 50.0);
 314     building_large_max_depth = props->getFloatValue("building-large-max-depth-m", 75.0);
 315
 316     // Random vegetation properties
 317     wood_coverage = props->getDoubleValue("wood-coverage", 0.0);
 318     tree_height = props->getDoubleValue("tree-height-m", 0.0);
 319     tree_width = props->getDoubleValue("tree-width-m", 0.0);
 320     tree_range = props->getDoubleValue("tree-range-m", 0.0);
 321     tree_varieties = props->getIntValue("tree-varieties", 1);
 322
 323     const SGPropertyNode* treeTexNode = props->getChild("tree-texture");
 324
 325     if (treeTexNode) {
 326         string treeTexPath = props->getStringValue("tree-texture");
 327
 328         if (! treeTexPath.empty()) {
 329             SGPath treePath("Textures.high");
 330             treePath.append(treeTexPath);
 331             tree_texture = SGModelLib::findDataFile(treePath.str(), options);
 332
 333             if (tree_texture.empty()) {
 334                 treePath = SGPath("Textures");
 335                 treePath.append(treeTexPath);
 336                 tree_texture = SGModelLib::findDataFile(treePath.str(), options);
 337             }
 338         }
 339     }
 340
 341     // surface values for use with ground reactions
 342     solid = props->getBoolValue("solid", true);
 343     friction_factor = props->getDoubleValue("friction-factor", 1.0);
 344     rolling_friction = props->getDoubleValue("rolling-friction", 0.02);
 345     bumpiness = props->getDoubleValue("bumpiness", 0.0);
 346     load_resistance = props->getDoubleValue("load-resistance", 1e30);
 347
 348     // Taken from default values as used in ac3d
 349     ambient[0] = props->getDoubleValue("ambient/r", 0.2);
 350     ambient[1] = props->getDoubleValue("ambient/g", 0.2);
 351     ambient[2] = props->getDoubleValue("ambient/b", 0.2);
 352     ambient[3] = props->getDoubleValue("ambient/a", 1.0);
 353
 354     diffuse[0] = props->getDoubleValue("diffuse/r", 0.8);
 355     diffuse[1] = props->getDoubleValue("diffuse/g", 0.8);
 356     diffuse[2] = props->getDoubleValue("diffuse/b", 0.8);
 357     diffuse[3] = props->getDoubleValue("diffuse/a", 1.0);
 358
 359     specular[0] = props->getDoubleValue("specular/r", 0.0);
 360     specular[1] = props->getDoubleValue("specular/g", 0.0);
 361     specular[2] = props->getDoubleValue("specular/b", 0.0);
 362     specular[3] = props->getDoubleValue("specular/a", 1.0);
 363
 364     emission[0] = props->getDoubleValue("emissive/r", 0.0);
 365     emission[1] = props->getDoubleValue("emissive/g", 0.0);
 366     emission[2] = props->getDoubleValue("emissive/b", 0.0);
 367     emission[3] = props->getDoubleValue("emissive/a", 1.0);
 368
 369     shininess = props->getDoubleValue("shininess", 1.0);
 370
 371     if (props->hasChild("effect"))
 372         effect = props->getStringValue("effect");
 373
 374     std::vector<SGPropertyNode_ptr> object_group_nodes =
 375             ((SGPropertyNode *)props)->getChildren("object-group");
 376     for (unsigned int i = 0; i < object_group_nodes.size(); i++)
 377         object_groups.push_back(new SGMatModelGroup(object_group_nodes[i]));
 378
 379     // read glyph table for taxi-/runway-signs
 380     std::vector<SGPropertyNode_ptr> glyph_nodes = props->getChildren("glyph");
 381     for (unsigned int i = 0; i < glyph_nodes.size(); i++) {
 382         const char *name = glyph_nodes[i]->getStringValue("name");
 383         if (name)
 384             glyphs[name] = new SGMaterialGlyph(glyph_nodes[i]);
 385     }
 386
 387     // Read conditions node
 388     const SGPropertyNode *conditionNode = props->getChild("condition");
 389     if (conditionNode) {
 390         condition = sgReadCondition(prop_root, conditionNode);
 391     }
 392 }
 393
 394
 395 \f
 396 ////////////////////////////////////////////////////////////////////////
 397 // Private methods.
 398 ////////////////////////////////////////////////////////////////////////
 399
 400 void
 401 SGMaterial::init ()
 402 {
 403     _status.clear();
 404     xsize = 0;
 405     ysize = 0;
 406     wrapu = true;
 407     wrapv = true;
 408
 409     mipmap = true;
 410     light_coverage = 0.0;
 411     building_coverage = 0.0;
 412
 413     solid = true;
 414     friction_factor = 1;
 415     rolling_friction = 0.02;
 416     bumpiness = 0;
 417     load_resistance = 1e30;
 418
 419     shininess = 1.0;
 420     for (int i = 0; i < 4; i++) {
 421         ambient[i]  = (i < 3) ? 0.2 : 1.0;
 422         specular[i] = (i < 3) ? 0.0 : 1.0;
 423         diffuse[i]  = (i < 3) ? 0.8 : 1.0;
 424         emission[i] = (i < 3) ? 0.0 : 1.0;
 425     }
 426     effect = "Effects/terrain-default";
 427 }
 428
 429 Effect* SGMaterial::get_effect(int i)
 430 {
 431     if(!_status[i].effect_realized) {
 432         if (!_status[i].effect.valid())
 433             return 0;
 434         _status[i].effect->realizeTechniques(_status[i].options.get());
 435         _status[i].effect_realized = true;
 436     }
 437     return _status[i].effect.get();
 438 }
 439
 440 Effect* SGMaterial::get_effect(SGTexturedTriangleBin triangleBin)
 441 {
 442     if (_status.size() == 0) {
 443         SG_LOG( SG_GENERAL, SG_WARN, "No effect available.");
 444         return 0;
 445     }
 446
 447     int i = triangleBin.getTextureIndex() % _status.size();
 448     return get_effect(i);
 449 }
 450
 451 Effect* SGMaterial::get_effect()
 452 {
 453     return get_effect(0);
 454 }
 455
 456
 457 osg::Texture2D* SGMaterial::get_object_mask(SGTexturedTriangleBin triangleBin)
 458 {
 459     if (_status.size() == 0) {
 460         SG_LOG( SG_GENERAL, SG_WARN, "No mask available.");
 461         return 0;
 462     }
 463
 464     // Note that the object mask is closely linked to the texture/effect
 465     // so we index based on the texture index,
 466     unsigned int i = triangleBin.getTextureIndex() % _status.size();
 467     if (i < _masks.size()) {
 468         return _masks[i];
 469     } else {
 470         return 0;
 471     }
 472 }
 473
 474 void SGMaterial::buildEffectProperties(const SGReaderWriterOptions* options)
 475 {
 476     using namespace osg;
 477     ref_ptr<SGMaterialUserData> user = new SGMaterialUserData(this);
 478     SGPropertyNode_ptr propRoot = new SGPropertyNode();
 479     makeChild(propRoot, "inherits-from")->setStringValue(effect);
 480     SGPropertyNode* paramProp = makeChild(propRoot, "parameters");
 481     SGPropertyNode* materialProp = makeChild(paramProp, "material");
 482     makeChild(materialProp, "ambient")->setValue(SGVec4d(ambient));
 483     makeChild(materialProp, "diffuse")->setValue(SGVec4d(diffuse));
 484     makeChild(materialProp, "specular")->setValue(SGVec4d(specular));
 485     makeChild(materialProp, "emissive")->setValue(SGVec4d(emission));
 486     makeChild(materialProp, "shininess")->setFloatValue(shininess);
 487     if (ambient[3] < 1 || diffuse[3] < 1 ||
 488         specular[3] < 1 || emission[3] < 1) {
 489         makeChild(paramProp, "transparent")->setBoolValue(true);
 490         SGPropertyNode* binProp = makeChild(paramProp, "render-bin");
 491         makeChild(binProp, "bin-number")->setIntValue(TRANSPARENT_BIN);
 492         makeChild(binProp, "bin-name")->setStringValue("DepthSortedBin");
 493     }
 494     BOOST_FOREACH(_internal_state& matState, _status)
 495     {
 496         SGPropertyNode_ptr effectProp = new SGPropertyNode();
 497         copyProperties(propRoot, effectProp);
 498         SGPropertyNode* effectParamProp = effectProp->getChild("parameters", 0);
 499         for (unsigned int i = 0; i < matState.texture_paths.size(); i++) {
 500             SGPropertyNode* texProp = makeChild(effectParamProp, "texture", matState.texture_paths[i].second);
 501             makeChild(texProp, "image")->setStringValue(matState.texture_paths[i].first);
 502             makeChild(texProp, "filter")
 503                 ->setStringValue(mipmap ? "linear-mipmap-linear" : "nearest");
 504             makeChild(texProp, "wrap-s")
 505                 ->setStringValue(wrapu ? "repeat" : "clamp");
 506             makeChild(texProp, "wrap-t")
 507                 ->setStringValue(wrapv ? "repeat" : "clamp");
 508         }
 509         makeChild(effectParamProp, "xsize")->setDoubleValue(xsize);
 510         makeChild(effectParamProp, "ysize")->setDoubleValue(ysize);
 511         makeChild(effectParamProp, "scale")->setValue(SGVec3d(xsize,ysize,0.0));
 512         makeChild(effectParamProp, "light-coverage")->setDoubleValue(light_coverage);
 513
 514         matState.effect = makeEffect(effectProp, false, options);
 515         if (matState.effect.valid())
 516             matState.effect->setUserData(user.get());
 517     }
 518 }
 519
 520 SGMaterialGlyph* SGMaterial::get_glyph (const string& name) const
 521 {
 522     map<string, SGSharedPtr<SGMaterialGlyph> >::const_iterator it;
 523     it = glyphs.find(name);
 524     if (it == glyphs.end())
 525         return 0;
 526
 527     return it->second;
 528 }
 529
 530 \f
 531 ////////////////////////////////////////////////////////////////////////
 532 // SGMaterialGlyph.
 533 ////////////////////////////////////////////////////////////////////////
 534
 535 SGMaterialGlyph::SGMaterialGlyph(SGPropertyNode *p) :
 536     _left(p->getDoubleValue("left", 0.0)),
 537     _right(p->getDoubleValue("right", 1.0))
 538 {
 539 }
 540
 541 void
 542 SGSetTextureFilter( int max) {
 543     SGSceneFeatures::instance()->setTextureFilter( max);
 544 }
 545
 546 int
 547 SGGetTextureFilter() {
 548     return SGSceneFeatures::instance()->getTextureFilter();
 549 }