1 // mat.cxx -- class to handle material properties
3 // Written by Curtis Olson, started May 1998.
5 // Copyright (C) 1998 - 2000 Curtis L. Olson - http://www.flightgear.org/~curt
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.
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.
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.
25 # include <simgear_config.h>
28 #include <simgear/compiler.h>
35 #include <boost/foreach.hpp>
38 #include <osg/CullFace>
39 #include <osg/Material>
40 #include <osg/ShadeModel>
41 #include <osg/StateSet>
43 #include <osg/Texture>
44 #include <osg/Texture2D>
45 #include <osgDB/ReaderWriter>
46 #include <osgDB/ReadFile>
47 #include <osgDB/Registry>
48 #include <osgDB/FileUtils>
50 #include <simgear/debug/logstream.hxx>
51 #include <simgear/misc/sg_path.hxx>
52 #include <simgear/misc/sgstream.hxx>
53 #include <simgear/threads/SGGuard.hxx>
55 #include <simgear/scene/util/SGReaderWriterOptions.hxx>
56 #include <simgear/props/props_io.hxx>
57 #include <simgear/props/vectorPropTemplates.hxx>
58 #include <simgear/scene/model/model.hxx>
59 #include <simgear/scene/material/matmodel.hxx>
60 #include <simgear/scene/util/RenderConstants.hxx>
61 #include <simgear/scene/util/StateAttributeFactory.hxx>
62 #include <simgear/props/condition.hxx>
63 #include <simgear/scene/util/SGSceneFeatures.hxx>
64 #include <simgear/scene/tgdb/SGTexturedTriangleBin.hxx>
67 #include "Technique.hxx"
72 using namespace simgear;
75 ////////////////////////////////////////////////////////////////////////
76 // Constructors and destructor.
77 ////////////////////////////////////////////////////////////////////////
79 SGMaterial::_internal_state::_internal_state(Effect *e, bool l,
80 const SGReaderWriterOptions* o)
81 : effect(e), effect_realized(l), options(o)
85 SGMaterial::_internal_state::_internal_state(Effect *e, const string &t, bool l,
86 const SGReaderWriterOptions* o)
87 : effect(e), effect_realized(l), options(o)
89 texture_paths.push_back(std::make_pair(t,0));
92 void SGMaterial::_internal_state::add_texture(const std::string &t, int i)
94 texture_paths.push_back(std::make_pair(t,i));
97 SGMaterial::SGMaterial( const SGReaderWriterOptions* options,
98 const SGPropertyNode *props,
99 SGPropertyNode *prop_root )
102 read_properties( options, props, prop_root );
103 buildEffectProperties(options);
106 SGMaterial::SGMaterial( const osgDB::Options* options,
107 const SGPropertyNode *props,
108 SGPropertyNode *prop_root)
110 osg::ref_ptr<SGReaderWriterOptions> opt;
111 opt = SGReaderWriterOptions::copyOrCreate(options);
113 read_properties(opt.get(), props, prop_root);
114 buildEffectProperties(opt.get());
117 SGMaterial::~SGMaterial (void)
122 ////////////////////////////////////////////////////////////////////////
124 ////////////////////////////////////////////////////////////////////////
127 SGMaterial::read_properties(const SGReaderWriterOptions* options,
128 const SGPropertyNode *props,
129 SGPropertyNode *prop_root)
131 std::vector<bool> dds;
132 std::vector<SGPropertyNode_ptr> textures = props->getChildren("texture");
133 for (unsigned int i = 0; i < textures.size(); i++)
135 string tname = textures[i]->getStringValue();
138 tname = "unknown.rgb";
141 SGPath tpath("Textures.high");
143 string fullTexPath = SGModelLib::findDataFile(tpath.str(), options);
144 if (fullTexPath.empty()) {
145 tpath.set("Textures");
147 fullTexPath = SGModelLib::findDataFile(tpath.str(), options);
148 if (fullTexPath.empty()) {
149 SG_LOG(SG_GENERAL, SG_ALERT, "Cannot find texture \""
150 << tname << "\" in Textures or Textures.high folders.");
154 if (tpath.lower_extension() == "dds") {
157 dds.push_back(false);
160 if (!fullTexPath.empty() ) {
161 _internal_state st( NULL, fullTexPath, false, options );
162 _status.push_back( st );
166 std::vector<SGPropertyNode_ptr> texturesets = props->getChildren("texture-set");
167 for (unsigned int i = 0; i < texturesets.size(); i++)
169 _internal_state st( NULL, false, options );
170 std::vector<SGPropertyNode_ptr> textures = texturesets[i]->getChildren("texture");
171 for (unsigned int j = 0; j < textures.size(); j++)
173 string tname = textures[j]->getStringValue();
175 tname = "unknown.rgb";
178 SGPath tpath("Textures.high");
180 string fullTexPath = SGModelLib::findDataFile(tpath.str(), options);
181 if (fullTexPath.empty()) {
182 tpath.set("Textures");
184 fullTexPath = SGModelLib::findDataFile(tpath.str(), options);
185 if (fullTexPath.empty() ) {
186 SG_LOG(SG_GENERAL, SG_ALERT, "Cannot find texture \""
187 << tname << "\" in Textures or Textures.high folders.");
192 if (tpath.lower_extension() == "dds") {
195 dds.push_back(false);
199 st.add_texture(fullTexPath, textures[j]->getIndex());
202 if (!st.texture_paths.empty() ) {
203 _status.push_back( st );
207 if (textures.empty() && texturesets.empty()) {
208 SGPath tpath("Textures");
209 tpath.append("Terrain");
210 tpath.append("unknown.rgb");
211 _internal_state st( NULL, tpath.str(), true, options );
212 _status.push_back( st );
215 std::vector<SGPropertyNode_ptr> masks = props->getChildren("object-mask");
216 for (unsigned int i = 0; i < masks.size(); i++)
218 string omname = masks[i]->getStringValue();
220 if (! omname.empty()) {
221 SGPath ompath("Textures.high");
222 ompath.append(omname);
223 string fullMaskPath = SGModelLib::findDataFile(ompath.str(), options);
225 if (fullMaskPath.empty()) {
226 ompath.set("Textures");
227 ompath.append(omname);
228 fullMaskPath = SGModelLib::findDataFile(ompath.str(), options);
231 if (fullMaskPath.empty()) {
232 SG_LOG(SG_GENERAL, SG_ALERT, "Cannot find texture \""
233 << omname << "\" in Textures or Textures.high folders.");
237 osg::Image* image = osgDB::readImageFile(fullMaskPath, options);
238 if (image && image->valid())
240 osg::Texture2D* object_mask = new osg::Texture2D;
242 bool dds_mask = (ompath.lower_extension() == "dds");
244 if (i < dds.size() && dds[i] != dds_mask) {
245 // Texture format does not match mask format. This is relevant for
246 // the object mask, as DDS textures have an origin at the bottom
247 // left rather than top left. Therefore we flip a copy of the image
248 // (otherwise a second reference to the object mask would flip it
250 SG_LOG(SG_GENERAL, SG_DEBUG, "Flipping object mask" << omname);
251 image = (osg::Image* ) image->clone(osg::CopyOp::SHALLOW_COPY);
252 image->flipVertical();
255 object_mask->setImage(image);
257 // We force the filtering to be nearest, as the red channel (rotation)
258 // in particular, doesn't make sense to be interpolated between pixels.
259 object_mask->setFilter(osg::Texture::MIN_FILTER, osg::Texture::NEAREST);
260 object_mask->setFilter(osg::Texture::MAG_FILTER, osg::Texture::NEAREST);
262 object_mask->setDataVariance(osg::Object::STATIC);
263 object_mask->setWrap(osg::Texture::WRAP_S, osg::Texture::REPEAT);
264 object_mask->setWrap(osg::Texture::WRAP_T, osg::Texture::REPEAT);
265 _masks.push_back(object_mask);
271 xsize = props->getDoubleValue("xsize", 0.0);
272 ysize = props->getDoubleValue("ysize", 0.0);
273 wrapu = props->getBoolValue("wrapu", true);
274 wrapv = props->getBoolValue("wrapv", true);
275 mipmap = props->getBoolValue("mipmap", true);
276 light_coverage = props->getDoubleValue("light-coverage", 0.0);
278 // Building properties
279 building_coverage = props->getDoubleValue("building-coverage", 0.0);
280 building_spacing = props->getDoubleValue("building-spacing-m", 5.0);
282 string bt = props->getStringValue("building-texture", "Textures/buildings.png");
283 building_texture = SGModelLib::findDataFile(bt, options);
285 if (building_texture.empty()) {
286 SG_LOG(SG_GENERAL, SG_ALERT, "Cannot find texture \"" << bt);
289 bt = props->getStringValue("building-lightmap", "Textures/buildings-lightmap.png");
290 building_lightmap = SGModelLib::findDataFile(bt, options);
292 if (building_lightmap.empty()) {
293 SG_LOG(SG_GENERAL, SG_ALERT, "Cannot find texture \"" << bt);
296 building_small_ratio = props->getDoubleValue("building-small-ratio", 0.8);
297 building_medium_ratio = props->getDoubleValue("building-medium-ratio", 0.15);
298 building_large_ratio = props->getDoubleValue("building-large-ratio", 0.05);
300 building_small_pitch = props->getDoubleValue("building-small-pitch", 0.8);
301 building_medium_pitch = props->getDoubleValue("building-medium-pitch", 0.2);
302 building_large_pitch = props->getDoubleValue("building-large-pitch", 0.1);
304 building_small_min_floors = props->getIntValue("building-small-min-floors", 1);
305 building_small_max_floors = props->getIntValue("building-small-max-floors", 3);
306 building_medium_min_floors = props->getIntValue("building-medium-min-floors", 3);
307 building_medium_max_floors = props->getIntValue("building-medium-max-floors", 8);
308 building_large_min_floors = props->getIntValue("building-large-min-floors", 5);
309 building_large_max_floors = props->getIntValue("building-large-max-floors", 20);
311 building_small_min_width = props->getFloatValue("building-small-min-width-m", 15.0);
312 building_small_max_width = props->getFloatValue("building-small-max-width-m", 60.0);
313 building_small_min_depth = props->getFloatValue("building-small-min-depth-m", 10.0);
314 building_small_max_depth = props->getFloatValue("building-small-max-depth-m", 20.0);
316 building_medium_min_width = props->getFloatValue("building-medium-min-width-m", 25.0);
317 building_medium_max_width = props->getFloatValue("building-medium-max-width-m", 50.0);
318 building_medium_min_depth = props->getFloatValue("building-medium-min-depth-m", 20.0);
319 building_medium_max_depth = props->getFloatValue("building-medium-max-depth-m", 50.0);
321 building_large_min_width = props->getFloatValue("building-large-min-width-m", 50.0);
322 building_large_max_width = props->getFloatValue("building-large-max-width-m", 75.0);
323 building_large_min_depth = props->getFloatValue("building-large-min-depth-m", 50.0);
324 building_large_max_depth = props->getFloatValue("building-large-max-depth-m", 75.0);
326 building_range = props->getDoubleValue("building-range-m", 10000.0);
328 cos_object_max_density_slope_angle = cos(props->getFloatValue("object-max-density-angle-deg", 20.0) * osg::PI/180.0);
329 cos_object_zero_density_slope_angle = cos(props->getFloatValue("object-zero-density-angle-deg", 30.0) * osg::PI/180.0);
331 // Random vegetation properties
332 wood_coverage = props->getDoubleValue("wood-coverage", 0.0);
333 tree_height = props->getDoubleValue("tree-height-m", 0.0);
334 tree_width = props->getDoubleValue("tree-width-m", 0.0);
335 tree_range = props->getDoubleValue("tree-range-m", 0.0);
336 tree_varieties = props->getIntValue("tree-varieties", 1);
337 cos_tree_max_density_slope_angle = cos(props->getFloatValue("tree-max-density-angle-deg", 30.0) * osg::PI/180.0);
338 cos_tree_zero_density_slope_angle = cos(props->getFloatValue("tree-zero-density-angle-deg", 45.0) * osg::PI/180.0);
340 const SGPropertyNode* treeTexNode = props->getChild("tree-texture");
343 string treeTexPath = props->getStringValue("tree-texture");
345 if (! treeTexPath.empty()) {
346 SGPath treePath("Textures.high");
347 treePath.append(treeTexPath);
348 tree_texture = SGModelLib::findDataFile(treePath.str(), options);
350 if (tree_texture.empty()) {
351 treePath.set("Textures");
352 treePath.append(treeTexPath);
353 tree_texture = SGModelLib::findDataFile(treePath.str(), options);
358 // surface values for use with ground reactions
359 _solid = props->getBoolValue("solid", _solid);
360 _friction_factor = props->getDoubleValue("friction-factor", _friction_factor);
361 _rolling_friction = props->getDoubleValue("rolling-friction", _rolling_friction);
362 _bumpiness = props->getDoubleValue("bumpiness", _bumpiness);
363 _load_resistance = props->getDoubleValue("load-resistance", _load_resistance);
365 // Taken from default values as used in ac3d
366 ambient[0] = props->getDoubleValue("ambient/r", 0.2);
367 ambient[1] = props->getDoubleValue("ambient/g", 0.2);
368 ambient[2] = props->getDoubleValue("ambient/b", 0.2);
369 ambient[3] = props->getDoubleValue("ambient/a", 1.0);
371 diffuse[0] = props->getDoubleValue("diffuse/r", 0.8);
372 diffuse[1] = props->getDoubleValue("diffuse/g", 0.8);
373 diffuse[2] = props->getDoubleValue("diffuse/b", 0.8);
374 diffuse[3] = props->getDoubleValue("diffuse/a", 1.0);
376 specular[0] = props->getDoubleValue("specular/r", 0.0);
377 specular[1] = props->getDoubleValue("specular/g", 0.0);
378 specular[2] = props->getDoubleValue("specular/b", 0.0);
379 specular[3] = props->getDoubleValue("specular/a", 1.0);
381 emission[0] = props->getDoubleValue("emissive/r", 0.0);
382 emission[1] = props->getDoubleValue("emissive/g", 0.0);
383 emission[2] = props->getDoubleValue("emissive/b", 0.0);
384 emission[3] = props->getDoubleValue("emissive/a", 1.0);
386 shininess = props->getDoubleValue("shininess", 1.0);
388 if (props->hasChild("effect"))
389 effect = props->getStringValue("effect");
391 std::vector<SGPropertyNode_ptr> object_group_nodes =
392 ((SGPropertyNode *)props)->getChildren("object-group");
393 for (unsigned int i = 0; i < object_group_nodes.size(); i++)
394 object_groups.push_back(new SGMatModelGroup(object_group_nodes[i]));
396 // read glyph table for taxi-/runway-signs
397 std::vector<SGPropertyNode_ptr> glyph_nodes = props->getChildren("glyph");
398 for (unsigned int i = 0; i < glyph_nodes.size(); i++) {
399 const char *name = glyph_nodes[i]->getStringValue("name");
401 glyphs[name] = new SGMaterialGlyph(glyph_nodes[i]);
404 // Read parameters entry, which is passed into the effect
405 if (props->hasChild("parameters")) {
406 parameters = props->getChild("parameters");
408 parameters = new SGPropertyNode();
411 // Read conditions node
412 const SGPropertyNode *conditionNode = props->getChild("condition");
414 condition = sgReadCondition(prop_root, conditionNode);
420 ////////////////////////////////////////////////////////////////////////
422 ////////////////////////////////////////////////////////////////////////
434 light_coverage = 0.0;
435 building_coverage = 0.0;
438 for (int i = 0; i < 4; i++) {
439 ambient[i] = (i < 3) ? 0.2 : 1.0;
440 specular[i] = (i < 3) ? 0.0 : 1.0;
441 diffuse[i] = (i < 3) ? 0.8 : 1.0;
442 emission[i] = (i < 3) ? 0.0 : 1.0;
444 effect = "Effects/terrain-default";
447 Effect* SGMaterial::get_effect(int i)
449 if(!_status[i].effect_realized) {
450 if (!_status[i].effect.valid())
452 _status[i].effect->realizeTechniques(_status[i].options.get());
453 _status[i].effect_realized = true;
455 return _status[i].effect.get();
458 Effect* SGMaterial::get_effect(const SGTexturedTriangleBin& triangleBin)
460 SGGuard<SGMutex> g(_lock);
461 if (_status.empty()) {
462 SG_LOG( SG_GENERAL, SG_WARN, "No effect available.");
466 int i = triangleBin.getTextureIndex() % _status.size();
467 return get_effect(i);
470 Effect* SGMaterial::get_effect()
472 SGGuard<SGMutex> g(_lock);
473 return get_effect(0);
477 osg::Texture2D* SGMaterial::get_object_mask(const SGTexturedTriangleBin& triangleBin)
479 if (_status.empty()) {
480 SG_LOG( SG_GENERAL, SG_WARN, "No mask available.");
484 // Note that the object mask is closely linked to the texture/effect
485 // so we index based on the texture index,
486 unsigned int i = triangleBin.getTextureIndex() % _status.size();
487 if (i < _masks.size()) {
494 void SGMaterial::buildEffectProperties(const SGReaderWriterOptions* options)
497 ref_ptr<SGMaterialUserData> user = new SGMaterialUserData(this);
498 SGPropertyNode_ptr propRoot = new SGPropertyNode();
499 makeChild(propRoot, "inherits-from")->setStringValue(effect);
501 SGPropertyNode* paramProp = makeChild(propRoot, "parameters");
502 copyProperties(parameters, paramProp);
504 SGPropertyNode* materialProp = makeChild(paramProp, "material");
505 makeChild(materialProp, "ambient")->setValue(SGVec4d(ambient));
506 makeChild(materialProp, "diffuse")->setValue(SGVec4d(diffuse));
507 makeChild(materialProp, "specular")->setValue(SGVec4d(specular));
508 makeChild(materialProp, "emissive")->setValue(SGVec4d(emission));
509 makeChild(materialProp, "shininess")->setFloatValue(shininess);
510 if (ambient[3] < 1 || diffuse[3] < 1 ||
511 specular[3] < 1 || emission[3] < 1) {
512 makeChild(paramProp, "transparent")->setBoolValue(true);
513 SGPropertyNode* binProp = makeChild(paramProp, "render-bin");
514 makeChild(binProp, "bin-number")->setIntValue(TRANSPARENT_BIN);
515 makeChild(binProp, "bin-name")->setStringValue("DepthSortedBin");
517 BOOST_FOREACH(_internal_state& matState, _status)
519 SGPropertyNode_ptr effectProp = new SGPropertyNode();
520 copyProperties(propRoot, effectProp);
521 SGPropertyNode* effectParamProp = effectProp->getChild("parameters", 0);
522 for (unsigned int i = 0; i < matState.texture_paths.size(); i++) {
523 SGPropertyNode* texProp = makeChild(effectParamProp, "texture", matState.texture_paths[i].second);
524 makeChild(texProp, "image")->setStringValue(matState.texture_paths[i].first);
525 makeChild(texProp, "filter")
526 ->setStringValue(mipmap ? "linear-mipmap-linear" : "nearest");
527 makeChild(texProp, "wrap-s")
528 ->setStringValue(wrapu ? "repeat" : "clamp-to-edge");
529 makeChild(texProp, "wrap-t")
530 ->setStringValue(wrapv ? "repeat" : "clamp-to-edge");
532 makeChild(effectParamProp, "xsize")->setDoubleValue(xsize);
533 makeChild(effectParamProp, "ysize")->setDoubleValue(ysize);
534 makeChild(effectParamProp, "scale")->setValue(SGVec3d(xsize,ysize,0.0));
535 makeChild(effectParamProp, "light-coverage")->setDoubleValue(light_coverage);
537 matState.effect = makeEffect(effectProp, false, options);
538 if (matState.effect.valid())
539 matState.effect->setUserData(user.get());
543 SGMaterialGlyph* SGMaterial::get_glyph (const string& name) const
545 map<string, SGSharedPtr<SGMaterialGlyph> >::const_iterator it;
546 it = glyphs.find(name);
547 if (it == glyphs.end())
553 bool SGMaterial::valid() const
556 return condition->test();
563 ////////////////////////////////////////////////////////////////////////
565 ////////////////////////////////////////////////////////////////////////
567 SGMaterialGlyph::SGMaterialGlyph(SGPropertyNode *p) :
568 _left(p->getDoubleValue("left", 0.0)),
569 _right(p->getDoubleValue("right", 1.0))
574 SGSetTextureFilter( int max) {
575 SGSceneFeatures::instance()->setTextureFilter( max);
579 SGGetTextureFilter() {
580 return SGSceneFeatures::instance()->getTextureFilter();