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/Texture2D>
44 #include <osgDB/ReaderWriter>
45 #include <osgDB/ReadFile>
46 #include <osgDB/Registry>
47 #include <osgDB/FileUtils>
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>
59 #include "Technique.hxx"
64 using namespace simgear;
67 ////////////////////////////////////////////////////////////////////////
68 // Constructors and destructor.
69 ////////////////////////////////////////////////////////////////////////
71 SGMaterial::_internal_state::_internal_state(Effect *e, bool l,
72 const SGReaderWriterOptions* o)
73 : effect(e), effect_realized(l), options(o)
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)
81 texture_paths.push_back(std::make_pair(t,0));
84 void SGMaterial::_internal_state::add_texture(const std::string &t, int i)
86 texture_paths.push_back(std::make_pair(t,i));
89 SGMaterial::SGMaterial( const SGReaderWriterOptions* options,
90 const SGPropertyNode *props )
93 read_properties( options, props );
94 buildEffectProperties(options);
97 SGMaterial::SGMaterial( const osgDB::ReaderWriter::Options* options,
98 const SGPropertyNode *props )
100 osg::ref_ptr<const SGReaderWriterOptions> sgOptions;
102 sgOptions = new SGReaderWriterOptions(*options);
104 read_properties( sgOptions.get(), props );
105 buildEffectProperties(sgOptions.get());
108 SGMaterial::~SGMaterial (void)
113 ////////////////////////////////////////////////////////////////////////
115 ////////////////////////////////////////////////////////////////////////
118 SGMaterial::read_properties(const SGReaderWriterOptions* options,
119 const SGPropertyNode *props)
121 std::vector<bool> dds;
122 std::vector<SGPropertyNode_ptr> textures = props->getChildren("texture");
123 for (unsigned int i = 0; i < textures.size(); i++)
125 string tname = textures[i]->getStringValue();
128 tname = "unknown.rgb";
131 if (tname.rfind(".dds") == (tname.length() - 4)) {
134 dds.push_back(false);
137 SGPath tpath("Textures.high");
139 string fullTexPath = SGModelLib::findDataFile(tpath.str(), options);
140 if (fullTexPath.empty()) {
141 tpath = SGPath("Textures");
143 fullTexPath = SGModelLib::findDataFile(tpath.str(), options);
146 if (!fullTexPath.empty() ) {
147 _internal_state st( NULL, fullTexPath, false, options );
148 _status.push_back( st );
152 std::vector<SGPropertyNode_ptr> texturesets = props->getChildren("texture-set");
153 for (unsigned int i = 0; i < texturesets.size(); i++)
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++)
159 string tname = textures[j]->getStringValue();
161 tname = "unknown.rgb";
165 if (tname.rfind(".dds") == (tname.length() - 4)) {
168 dds.push_back(false);
172 SGPath tpath("Textures.high");
174 string fullTexPath = SGModelLib::findDataFile(tpath.str(), options);
175 if (fullTexPath.empty()) {
176 tpath = SGPath("Textures");
178 fullTexPath = SGModelLib::findDataFile(tpath.str(), options);
181 st.add_texture(fullTexPath, textures[j]->getIndex());
184 if (!st.texture_paths.empty() ) {
185 _status.push_back( st );
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 );
197 std::vector<SGPropertyNode_ptr> masks = props->getChildren("object-mask");
198 for (unsigned int i = 0; i < masks.size(); i++)
200 string omname = masks[i]->getStringValue();
202 if (! omname.empty()) {
203 SGPath ompath("Textures.high");
204 ompath.append(omname);
205 string fullMaskPath = SGModelLib::findDataFile(ompath.str(), options);
207 if (fullMaskPath.empty()) {
208 ompath = SGPath("Textures");
209 ompath.append(omname);
210 fullMaskPath = SGModelLib::findDataFile(ompath.str(), options);
213 osg::Image* image = osgDB::readImageFile(fullMaskPath, options);
216 osg::Texture2D* object_mask = new osg::Texture2D;
219 // Texture is a DDS. This is relevant for the object mask, as DDS
220 // textures have an origin at the bottom left rather than top
221 // left, therefore we flip the object mask vertically.
222 image->flipVertical();
225 object_mask->setImage(image);
226 object_mask->setDataVariance(osg::Object::STATIC);
227 object_mask->setWrap(osg::Texture::WRAP_S, osg::Texture::REPEAT);
228 object_mask->setWrap(osg::Texture::WRAP_T, osg::Texture::REPEAT);
229 _masks.push_back(object_mask);
234 xsize = props->getDoubleValue("xsize", 0.0);
235 ysize = props->getDoubleValue("ysize", 0.0);
236 wrapu = props->getBoolValue("wrapu", true);
237 wrapv = props->getBoolValue("wrapv", true);
238 mipmap = props->getBoolValue("mipmap", true);
239 light_coverage = props->getDoubleValue("light-coverage", 0.0);
240 wood_coverage = props->getDoubleValue("wood-coverage", 0.0);
241 tree_height = props->getDoubleValue("tree-height-m", 0.0);
242 tree_width = props->getDoubleValue("tree-width-m", 0.0);
243 tree_range = props->getDoubleValue("tree-range-m", 0.0);
244 tree_varieties = props->getIntValue("tree-varieties", 1);
246 const SGPropertyNode* treeTexNode = props->getChild("tree-texture");
248 string treeTexPath = props->getStringValue("tree-texture");
249 tree_texture = SGModelLib::findDataFile(treeTexPath, options);
252 // surface values for use with ground reactions
253 solid = props->getBoolValue("solid", true);
254 friction_factor = props->getDoubleValue("friction-factor", 1.0);
255 rolling_friction = props->getDoubleValue("rolling-friction", 0.02);
256 bumpiness = props->getDoubleValue("bumpiness", 0.0);
257 load_resistance = props->getDoubleValue("load-resistance", 1e30);
259 // Taken from default values as used in ac3d
260 ambient[0] = props->getDoubleValue("ambient/r", 0.2);
261 ambient[1] = props->getDoubleValue("ambient/g", 0.2);
262 ambient[2] = props->getDoubleValue("ambient/b", 0.2);
263 ambient[3] = props->getDoubleValue("ambient/a", 1.0);
265 diffuse[0] = props->getDoubleValue("diffuse/r", 0.8);
266 diffuse[1] = props->getDoubleValue("diffuse/g", 0.8);
267 diffuse[2] = props->getDoubleValue("diffuse/b", 0.8);
268 diffuse[3] = props->getDoubleValue("diffuse/a", 1.0);
270 specular[0] = props->getDoubleValue("specular/r", 0.0);
271 specular[1] = props->getDoubleValue("specular/g", 0.0);
272 specular[2] = props->getDoubleValue("specular/b", 0.0);
273 specular[3] = props->getDoubleValue("specular/a", 1.0);
275 emission[0] = props->getDoubleValue("emissive/r", 0.0);
276 emission[1] = props->getDoubleValue("emissive/g", 0.0);
277 emission[2] = props->getDoubleValue("emissive/b", 0.0);
278 emission[3] = props->getDoubleValue("emissive/a", 1.0);
280 shininess = props->getDoubleValue("shininess", 1.0);
282 if (props->hasChild("effect"))
283 effect = props->getStringValue("effect");
285 std::vector<SGPropertyNode_ptr> object_group_nodes =
286 ((SGPropertyNode *)props)->getChildren("object-group");
287 for (unsigned int i = 0; i < object_group_nodes.size(); i++)
288 object_groups.push_back(new SGMatModelGroup(object_group_nodes[i]));
290 // read glyph table for taxi-/runway-signs
291 std::vector<SGPropertyNode_ptr> glyph_nodes = props->getChildren("glyph");
292 for (unsigned int i = 0; i < glyph_nodes.size(); i++) {
293 const char *name = glyph_nodes[i]->getStringValue("name");
295 glyphs[name] = new SGMaterialGlyph(glyph_nodes[i]);
301 ////////////////////////////////////////////////////////////////////////
303 ////////////////////////////////////////////////////////////////////////
315 light_coverage = 0.0;
319 rolling_friction = 0.02;
321 load_resistance = 1e30;
324 for (int i = 0; i < 4; i++) {
325 ambient[i] = (i < 3) ? 0.2 : 1.0;
326 specular[i] = (i < 3) ? 0.0 : 1.0;
327 diffuse[i] = (i < 3) ? 0.8 : 1.0;
328 emission[i] = (i < 3) ? 0.0 : 1.0;
330 effect = "Effects/terrain-default";
333 Effect* SGMaterial::get_effect(int i)
335 if(!_status[i].effect_realized) {
336 _status[i].effect->realizeTechniques(_status[i].options.get());
337 _status[i].effect_realized = true;
339 return _status[i].effect.get();
342 Effect* SGMaterial::get_effect(SGTexturedTriangleBin triangleBin)
344 if (_status.size() == 0) {
345 SG_LOG( SG_GENERAL, SG_WARN, "No effect available.");
349 int i = triangleBin.getTextureIndex() % _status.size();
350 return get_effect(i);
353 Effect* SGMaterial::get_effect()
355 return get_effect(0);
359 osg::Texture2D* SGMaterial::get_object_mask(SGTexturedTriangleBin triangleBin)
361 if (_status.size() == 0) {
362 SG_LOG( SG_GENERAL, SG_WARN, "No mask available.");
366 // Note that the object mask is closely linked to the texture/effect
367 // so we index based on the texture index,
368 unsigned int i = triangleBin.getTextureIndex() % _status.size();
369 if (i < _masks.size()) {
376 void SGMaterial::buildEffectProperties(const SGReaderWriterOptions* options)
379 ref_ptr<SGReaderWriterOptions> xmlOptions;
381 xmlOptions = new SGReaderWriterOptions(*options);
382 ref_ptr<SGMaterialUserData> user = new SGMaterialUserData(this);
383 SGPropertyNode_ptr propRoot = new SGPropertyNode();
384 makeChild(propRoot, "inherits-from")->setStringValue(effect);
385 SGPropertyNode* paramProp = makeChild(propRoot, "parameters");
386 SGPropertyNode* materialProp = makeChild(paramProp, "material");
387 makeChild(materialProp, "ambient")->setValue(SGVec4d(ambient));
388 makeChild(materialProp, "diffuse")->setValue(SGVec4d(diffuse));
389 makeChild(materialProp, "specular")->setValue(SGVec4d(specular));
390 makeChild(materialProp, "emissive")->setValue(SGVec4d(emission));
391 makeChild(materialProp, "shininess")->setFloatValue(shininess);
392 if (ambient[3] < 1 || diffuse[3] < 1 ||
393 specular[3] < 1 || emission[3] < 1) {
394 makeChild(paramProp, "transparent")->setBoolValue(true);
395 SGPropertyNode* binProp = makeChild(paramProp, "render-bin");
396 makeChild(binProp, "bin-number")->setIntValue(TRANSPARENT_BIN);
397 makeChild(binProp, "bin-name")->setStringValue("DepthSortedBin");
399 BOOST_FOREACH(_internal_state& matState, _status)
401 SGPropertyNode_ptr effectProp = new SGPropertyNode();
402 copyProperties(propRoot, effectProp);
403 SGPropertyNode* effectParamProp = effectProp->getChild("parameters", 0);
404 for (unsigned int i = 0; i < matState.texture_paths.size(); i++) {
405 SGPropertyNode* texProp = makeChild(effectParamProp, "texture", matState.texture_paths[i].second);
406 makeChild(texProp, "image")->setStringValue(matState.texture_paths[i].first);
407 makeChild(texProp, "filter")
408 ->setStringValue(mipmap ? "linear-mipmap-linear" : "nearest");
409 makeChild(texProp, "wrap-s")
410 ->setStringValue(wrapu ? "repeat" : "clamp");
411 makeChild(texProp, "wrap-t")
412 ->setStringValue(wrapv ? "repeat" : "clamp");
414 makeChild(effectParamProp, "xsize")->setDoubleValue(xsize);
415 makeChild(effectParamProp, "ysize")->setDoubleValue(ysize);
416 makeChild(effectParamProp, "scale")->setValue(SGVec3d(xsize,ysize,0.0));
417 makeChild(effectParamProp, "light-coverage")->setDoubleValue(light_coverage);
419 matState.effect = makeEffect(effectProp, false, xmlOptions.get());
420 matState.effect->setUserData(user.get());
424 SGMaterialGlyph* SGMaterial::get_glyph (const string& name) const
426 map<string, SGSharedPtr<SGMaterialGlyph> >::const_iterator it;
427 it = glyphs.find(name);
428 if (it == glyphs.end())
435 ////////////////////////////////////////////////////////////////////////
437 ////////////////////////////////////////////////////////////////////////
439 SGMaterialGlyph::SGMaterialGlyph(SGPropertyNode *p) :
440 _left(p->getDoubleValue("left", 0.0)),
441 _right(p->getDoubleValue("right", 1.0))
446 SGSetTextureFilter( int max) {
447 SGSceneFeatures::instance()->setTextureFilter( max);
451 SGGetTextureFilter() {
452 return SGSceneFeatures::instance()->getTextureFilter();