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/scene/util/SGReaderWriterOptions.hxx>
54 #include <simgear/props/props_io.hxx>
55 #include <simgear/props/vectorPropTemplates.hxx>
56 #include <simgear/scene/model/model.hxx>
57 #include <simgear/scene/material/matmodel.hxx>
58 #include <simgear/scene/util/RenderConstants.hxx>
59 #include <simgear/scene/util/StateAttributeFactory.hxx>
60 #include <simgear/props/condition.hxx>
61 #include <simgear/scene/util/SGSceneFeatures.hxx>
62 #include <simgear/scene/tgdb/SGTexturedTriangleBin.hxx>
65 #include "Technique.hxx"
70 using namespace simgear;
73 ////////////////////////////////////////////////////////////////////////
74 // Constructors and destructor.
75 ////////////////////////////////////////////////////////////////////////
77 SGMaterial::_internal_state::_internal_state(Effect *e, bool l,
78 const SGReaderWriterOptions* o)
79 : effect(e), effect_realized(l), options(o)
83 SGMaterial::_internal_state::_internal_state(Effect *e, const string &t, bool l,
84 const SGReaderWriterOptions* o)
85 : effect(e), effect_realized(l), options(o)
87 texture_paths.push_back(std::make_pair(t,0));
90 void SGMaterial::_internal_state::add_texture(const std::string &t, int i)
92 texture_paths.push_back(std::make_pair(t,i));
95 SGMaterial::SGMaterial( const SGReaderWriterOptions* options,
96 const SGPropertyNode *props,
97 SGPropertyNode *prop_root )
100 read_properties( options, props, prop_root );
101 buildEffectProperties(options);
104 SGMaterial::SGMaterial( const osgDB::Options* options,
105 const SGPropertyNode *props,
106 SGPropertyNode *prop_root)
108 osg::ref_ptr<SGReaderWriterOptions> opt;
109 opt = SGReaderWriterOptions::copyOrCreate(options);
111 read_properties(opt.get(), props, prop_root);
112 buildEffectProperties(opt.get());
115 SGMaterial::~SGMaterial (void)
120 ////////////////////////////////////////////////////////////////////////
122 ////////////////////////////////////////////////////////////////////////
125 SGMaterial::read_properties(const SGReaderWriterOptions* options,
126 const SGPropertyNode *props,
127 SGPropertyNode *prop_root)
129 std::vector<bool> dds;
130 std::vector<SGPropertyNode_ptr> textures = props->getChildren("texture");
131 for (unsigned int i = 0; i < textures.size(); i++)
133 string tname = textures[i]->getStringValue();
136 tname = "unknown.rgb";
139 SGPath tpath("Textures.high");
141 string fullTexPath = SGModelLib::findDataFile(tpath.str(), options);
142 if (fullTexPath.empty()) {
143 tpath.set("Textures");
145 fullTexPath = SGModelLib::findDataFile(tpath.str(), options);
146 if (fullTexPath.empty()) {
147 SG_LOG(SG_GENERAL, SG_ALERT, "Cannot find texture \""
148 << tname << "\" in Textures or Textures.high folders.");
152 if (tpath.lower_extension() == "dds") {
155 dds.push_back(false);
158 if (!fullTexPath.empty() ) {
159 _internal_state st( NULL, fullTexPath, false, options );
160 _status.push_back( st );
164 std::vector<SGPropertyNode_ptr> texturesets = props->getChildren("texture-set");
165 for (unsigned int i = 0; i < texturesets.size(); i++)
167 _internal_state st( NULL, false, options );
168 std::vector<SGPropertyNode_ptr> textures = texturesets[i]->getChildren("texture");
169 for (unsigned int j = 0; j < textures.size(); j++)
171 string tname = textures[j]->getStringValue();
173 tname = "unknown.rgb";
176 SGPath tpath("Textures.high");
178 string fullTexPath = SGModelLib::findDataFile(tpath.str(), options);
179 if (fullTexPath.empty()) {
180 tpath.set("Textures");
182 fullTexPath = SGModelLib::findDataFile(tpath.str(), options);
183 if (fullTexPath.empty() ) {
184 SG_LOG(SG_GENERAL, SG_ALERT, "Cannot find texture \""
185 << tname << "\" in Textures or Textures.high folders.");
190 if (tpath.lower_extension() == "dds") {
193 dds.push_back(false);
197 st.add_texture(fullTexPath, textures[j]->getIndex());
200 if (!st.texture_paths.empty() ) {
201 _status.push_back( st );
205 if (textures.size() == 0 && texturesets.size() == 0) {
206 SGPath tpath("Textures");
207 tpath.append("Terrain");
208 tpath.append("unknown.rgb");
209 _internal_state st( NULL, tpath.str(), true, options );
210 _status.push_back( st );
213 std::vector<SGPropertyNode_ptr> masks = props->getChildren("object-mask");
214 for (unsigned int i = 0; i < masks.size(); i++)
216 string omname = masks[i]->getStringValue();
218 if (! omname.empty()) {
219 SGPath ompath("Textures.high");
220 ompath.append(omname);
221 string fullMaskPath = SGModelLib::findDataFile(ompath.str(), options);
223 if (fullMaskPath.empty()) {
224 ompath.set("Textures");
225 ompath.append(omname);
226 fullMaskPath = SGModelLib::findDataFile(ompath.str(), options);
229 if (fullMaskPath.empty()) {
230 SG_LOG(SG_GENERAL, SG_ALERT, "Cannot find texture \""
231 << omname << "\" in Textures or Textures.high folders.");
235 osg::Image* image = osgDB::readImageFile(fullMaskPath, options);
236 if (image && image->valid())
238 osg::Texture2D* object_mask = new osg::Texture2D;
240 bool dds_mask = (ompath.lower_extension() == "dds");
242 if (dds[i] != dds_mask) {
243 // Texture format does not match mask format. This is relevant for
244 // the object mask, as DDS textures have an origin at the bottom
245 // left rather than top left. Therefore we flip a copy of the image
246 // (otherwise a second reference to the object mask would flip it
248 SG_LOG(SG_GENERAL, SG_DEBUG, "Flipping object mask" << omname);
249 image = (osg::Image* ) image->clone(osg::CopyOp::SHALLOW_COPY);
250 image->flipVertical();
253 object_mask->setImage(image);
255 // We force the filtering to be nearest, as the red channel (rotation)
256 // in particular, doesn't make sense to be interpolated between pixels.
257 object_mask->setFilter(osg::Texture::MIN_FILTER, osg::Texture::NEAREST);
258 object_mask->setFilter(osg::Texture::MAG_FILTER, osg::Texture::NEAREST);
260 object_mask->setDataVariance(osg::Object::STATIC);
261 object_mask->setWrap(osg::Texture::WRAP_S, osg::Texture::REPEAT);
262 object_mask->setWrap(osg::Texture::WRAP_T, osg::Texture::REPEAT);
263 _masks.push_back(object_mask);
269 xsize = props->getDoubleValue("xsize", 0.0);
270 ysize = props->getDoubleValue("ysize", 0.0);
271 wrapu = props->getBoolValue("wrapu", true);
272 wrapv = props->getBoolValue("wrapv", true);
273 mipmap = props->getBoolValue("mipmap", true);
274 light_coverage = props->getDoubleValue("light-coverage", 0.0);
276 // Building properties
277 building_coverage = props->getDoubleValue("building-coverage", 0.0);
278 building_spacing = props->getDoubleValue("building-spacing-m", 5.0);
280 string bt = props->getStringValue("building-texture", "Textures/buildings.png");
281 building_texture = SGModelLib::findDataFile(bt, options);
283 if (building_texture.empty()) {
284 SG_LOG(SG_GENERAL, SG_ALERT, "Cannot find texture \"" << bt);
287 bt = props->getStringValue("building-lightmap", "Textures/buildings-lightmap.png");
288 building_lightmap = SGModelLib::findDataFile(bt, options);
290 if (building_lightmap.empty()) {
291 SG_LOG(SG_GENERAL, SG_ALERT, "Cannot find texture \"" << bt);
294 building_small_ratio = props->getDoubleValue("building-small-ratio", 0.8);
295 building_medium_ratio = props->getDoubleValue("building-medium-ratio", 0.15);
296 building_large_ratio = props->getDoubleValue("building-large-ratio", 0.05);
298 building_small_pitch = props->getDoubleValue("building-small-pitch", 0.8);
299 building_medium_pitch = props->getDoubleValue("building-medium-pitch", 0.2);
300 building_large_pitch = props->getDoubleValue("building-large-pitch", 0.1);
302 building_small_min_floors = props->getIntValue("building-small-min-floors", 1);
303 building_small_max_floors = props->getIntValue("building-small-max-floors", 3);
304 building_medium_min_floors = props->getIntValue("building-medium-min-floors", 3);
305 building_medium_max_floors = props->getIntValue("building-medium-max-floors", 8);
306 building_large_min_floors = props->getIntValue("building-large-min-floors", 5);
307 building_large_max_floors = props->getIntValue("building-large-max-floors", 20);
309 building_small_min_width = props->getFloatValue("building-small-min-width-m", 15.0);
310 building_small_max_width = props->getFloatValue("building-small-max-width-m", 60.0);
311 building_small_min_depth = props->getFloatValue("building-small-min-depth-m", 10.0);
312 building_small_max_depth = props->getFloatValue("building-small-max-depth-m", 20.0);
314 building_medium_min_width = props->getFloatValue("building-medium-min-width-m", 25.0);
315 building_medium_max_width = props->getFloatValue("building-medium-max-width-m", 50.0);
316 building_medium_min_depth = props->getFloatValue("building-medium-min-depth-m", 20.0);
317 building_medium_max_depth = props->getFloatValue("building-medium-max-depth-m", 50.0);
319 building_large_min_width = props->getFloatValue("building-large-min-width-m", 50.0);
320 building_large_max_width = props->getFloatValue("building-large-max-width-m", 75.0);
321 building_large_min_depth = props->getFloatValue("building-large-min-depth-m", 50.0);
322 building_large_max_depth = props->getFloatValue("building-large-max-depth-m", 75.0);
324 // Random vegetation properties
325 wood_coverage = props->getDoubleValue("wood-coverage", 0.0);
326 tree_height = props->getDoubleValue("tree-height-m", 0.0);
327 tree_width = props->getDoubleValue("tree-width-m", 0.0);
328 tree_range = props->getDoubleValue("tree-range-m", 0.0);
329 tree_varieties = props->getIntValue("tree-varieties", 1);
331 const SGPropertyNode* treeTexNode = props->getChild("tree-texture");
334 string treeTexPath = props->getStringValue("tree-texture");
336 if (! treeTexPath.empty()) {
337 SGPath treePath("Textures.high");
338 treePath.append(treeTexPath);
339 tree_texture = SGModelLib::findDataFile(treePath.str(), options);
341 if (tree_texture.empty()) {
342 treePath.set("Textures");
343 treePath.append(treeTexPath);
344 tree_texture = SGModelLib::findDataFile(treePath.str(), options);
349 // surface values for use with ground reactions
350 _solid = props->getBoolValue("solid", _solid);
351 _friction_factor = props->getDoubleValue("friction-factor", _friction_factor);
352 _rolling_friction = props->getDoubleValue("rolling-friction", _rolling_friction);
353 _bumpiness = props->getDoubleValue("bumpiness", _bumpiness);
354 _load_resistance = props->getDoubleValue("load-resistance", _load_resistance);
356 // Taken from default values as used in ac3d
357 ambient[0] = props->getDoubleValue("ambient/r", 0.2);
358 ambient[1] = props->getDoubleValue("ambient/g", 0.2);
359 ambient[2] = props->getDoubleValue("ambient/b", 0.2);
360 ambient[3] = props->getDoubleValue("ambient/a", 1.0);
362 diffuse[0] = props->getDoubleValue("diffuse/r", 0.8);
363 diffuse[1] = props->getDoubleValue("diffuse/g", 0.8);
364 diffuse[2] = props->getDoubleValue("diffuse/b", 0.8);
365 diffuse[3] = props->getDoubleValue("diffuse/a", 1.0);
367 specular[0] = props->getDoubleValue("specular/r", 0.0);
368 specular[1] = props->getDoubleValue("specular/g", 0.0);
369 specular[2] = props->getDoubleValue("specular/b", 0.0);
370 specular[3] = props->getDoubleValue("specular/a", 1.0);
372 emission[0] = props->getDoubleValue("emissive/r", 0.0);
373 emission[1] = props->getDoubleValue("emissive/g", 0.0);
374 emission[2] = props->getDoubleValue("emissive/b", 0.0);
375 emission[3] = props->getDoubleValue("emissive/a", 1.0);
377 shininess = props->getDoubleValue("shininess", 1.0);
379 if (props->hasChild("effect"))
380 effect = props->getStringValue("effect");
382 std::vector<SGPropertyNode_ptr> object_group_nodes =
383 ((SGPropertyNode *)props)->getChildren("object-group");
384 for (unsigned int i = 0; i < object_group_nodes.size(); i++)
385 object_groups.push_back(new SGMatModelGroup(object_group_nodes[i]));
387 // read glyph table for taxi-/runway-signs
388 std::vector<SGPropertyNode_ptr> glyph_nodes = props->getChildren("glyph");
389 for (unsigned int i = 0; i < glyph_nodes.size(); i++) {
390 const char *name = glyph_nodes[i]->getStringValue("name");
392 glyphs[name] = new SGMaterialGlyph(glyph_nodes[i]);
395 // Read parameters entry, which is passed into the effect
396 if (props->hasChild("parameters")) {
397 parameters = props->getChild("parameters");
399 parameters = new SGPropertyNode();
402 // Read conditions node
403 const SGPropertyNode *conditionNode = props->getChild("condition");
405 condition = sgReadCondition(prop_root, conditionNode);
411 ////////////////////////////////////////////////////////////////////////
413 ////////////////////////////////////////////////////////////////////////
425 light_coverage = 0.0;
426 building_coverage = 0.0;
429 for (int i = 0; i < 4; i++) {
430 ambient[i] = (i < 3) ? 0.2 : 1.0;
431 specular[i] = (i < 3) ? 0.0 : 1.0;
432 diffuse[i] = (i < 3) ? 0.8 : 1.0;
433 emission[i] = (i < 3) ? 0.0 : 1.0;
435 effect = "Effects/terrain-default";
438 Effect* SGMaterial::get_effect(int i)
440 if(!_status[i].effect_realized) {
441 if (!_status[i].effect.valid())
443 _status[i].effect->realizeTechniques(_status[i].options.get());
444 _status[i].effect_realized = true;
446 return _status[i].effect.get();
449 Effect* SGMaterial::get_effect(const SGTexturedTriangleBin& triangleBin)
451 if (_status.size() == 0) {
452 SG_LOG( SG_GENERAL, SG_WARN, "No effect available.");
456 int i = triangleBin.getTextureIndex() % _status.size();
457 return get_effect(i);
460 Effect* SGMaterial::get_effect()
462 return get_effect(0);
466 osg::Texture2D* SGMaterial::get_object_mask(const SGTexturedTriangleBin& triangleBin)
468 if (_status.size() == 0) {
469 SG_LOG( SG_GENERAL, SG_WARN, "No mask available.");
473 // Note that the object mask is closely linked to the texture/effect
474 // so we index based on the texture index,
475 unsigned int i = triangleBin.getTextureIndex() % _status.size();
476 if (i < _masks.size()) {
483 void SGMaterial::buildEffectProperties(const SGReaderWriterOptions* options)
486 ref_ptr<SGMaterialUserData> user = new SGMaterialUserData(this);
487 SGPropertyNode_ptr propRoot = new SGPropertyNode();
488 makeChild(propRoot, "inherits-from")->setStringValue(effect);
490 SGPropertyNode* paramProp = makeChild(propRoot, "parameters");
491 copyProperties(parameters, paramProp);
493 SGPropertyNode* materialProp = makeChild(paramProp, "material");
494 makeChild(materialProp, "ambient")->setValue(SGVec4d(ambient));
495 makeChild(materialProp, "diffuse")->setValue(SGVec4d(diffuse));
496 makeChild(materialProp, "specular")->setValue(SGVec4d(specular));
497 makeChild(materialProp, "emissive")->setValue(SGVec4d(emission));
498 makeChild(materialProp, "shininess")->setFloatValue(shininess);
499 if (ambient[3] < 1 || diffuse[3] < 1 ||
500 specular[3] < 1 || emission[3] < 1) {
501 makeChild(paramProp, "transparent")->setBoolValue(true);
502 SGPropertyNode* binProp = makeChild(paramProp, "render-bin");
503 makeChild(binProp, "bin-number")->setIntValue(TRANSPARENT_BIN);
504 makeChild(binProp, "bin-name")->setStringValue("DepthSortedBin");
506 BOOST_FOREACH(_internal_state& matState, _status)
508 SGPropertyNode_ptr effectProp = new SGPropertyNode();
509 copyProperties(propRoot, effectProp);
510 SGPropertyNode* effectParamProp = effectProp->getChild("parameters", 0);
511 for (unsigned int i = 0; i < matState.texture_paths.size(); i++) {
512 SGPropertyNode* texProp = makeChild(effectParamProp, "texture", matState.texture_paths[i].second);
513 makeChild(texProp, "image")->setStringValue(matState.texture_paths[i].first);
514 makeChild(texProp, "filter")
515 ->setStringValue(mipmap ? "linear-mipmap-linear" : "nearest");
516 makeChild(texProp, "wrap-s")
517 ->setStringValue(wrapu ? "repeat" : "clamp-to-edge");
518 makeChild(texProp, "wrap-t")
519 ->setStringValue(wrapv ? "repeat" : "clamp-to-edge");
521 makeChild(effectParamProp, "xsize")->setDoubleValue(xsize);
522 makeChild(effectParamProp, "ysize")->setDoubleValue(ysize);
523 makeChild(effectParamProp, "scale")->setValue(SGVec3d(xsize,ysize,0.0));
524 makeChild(effectParamProp, "light-coverage")->setDoubleValue(light_coverage);
526 matState.effect = makeEffect(effectProp, false, options);
527 if (matState.effect.valid())
528 matState.effect->setUserData(user.get());
532 SGMaterialGlyph* SGMaterial::get_glyph (const string& name) const
534 map<string, SGSharedPtr<SGMaterialGlyph> >::const_iterator it;
535 it = glyphs.find(name);
536 if (it == glyphs.end())
542 bool SGMaterial::valid() const
545 return condition->test();
552 ////////////////////////////////////////////////////////////////////////
554 ////////////////////////////////////////////////////////////////////////
556 SGMaterialGlyph::SGMaterialGlyph(SGPropertyNode *p) :
557 _left(p->getDoubleValue("left", 0.0)),
558 _right(p->getDoubleValue("right", 1.0))
563 SGSetTextureFilter( int max) {
564 SGSceneFeatures::instance()->setTextureFilter( max);
568 SGGetTextureFilter() {
569 return SGSceneFeatures::instance()->getTextureFilter();