simgear/scene/model/SGReaderWriterXML.cxx

   1 // Copyright (C) 2007 Tim Moore timoore@redhat.com
   2 // Copyright (C) 2008 Till Busch buti@bux.at
   3 //
   4 // This program is free software; you can redistribute it and/or
   5 // modify it under the terms of the GNU General Public License as
   6 // published by the Free Software Foundation; either version 2 of the
   7 // License, or (at your option) any later version.
   8 //
   9 // This program is distributed in the hope that it will be useful, but
  10 // WITHOUT ANY WARRANTY; without even the implied warranty of
  11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12 // General Public License for more details.
  13 //
  14 // You should have received a copy of the GNU General Public License
  15 // along with this program; if not, write to the Free Software
  16 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  17 //
  18
  19 #ifdef HAVE_CONFIG_H
  20 #  include <simgear_config.h>
  21 #endif
  22
  23 #include <algorithm>
  24 //yuck
  25 #include <cstring>
  26
  27 #include <boost/bind.hpp>
  28
  29 #include <osg/Geode>
  30 #include <osg/MatrixTransform>
  31 #include <osgDB/WriteFile>
  32 #include <osgDB/Registry>
  33 #include <osg/Switch>
  34 #include <osgDB/FileNameUtils>
  35
  36 #include <simgear/compiler.h>
  37 #include <simgear/structure/exception.hxx>
  38 #include <simgear/props/props.hxx>
  39 #include <simgear/props/props_io.hxx>
  40 #include <simgear/props/condition.hxx>
  41 #include <simgear/scene/util/SGNodeMasks.hxx>
  42
  43 #include "modellib.hxx"
  44 #include "SGPagedLOD.hxx"
  45 #include "SGReaderWriterXML.hxx"
  46 #include "SGReaderWriterXMLOptions.hxx"
  47
  48 #include "animation.hxx"
  49 #include "particles.hxx"
  50 #include "model.hxx"
  51 #include "SGText.hxx"
  52 #include "SGMaterialAnimation.hxx"
  53
  54 using namespace std;
  55 using namespace simgear;
  56 using namespace osg;
  57
  58 static osg::Node *
  59 sgLoad3DModel_internal(const std::string& path,
  60                        const osgDB::ReaderWriter::Options* options,
  61                        SGPropertyNode *overlay = 0);
  62
  63
  64 SGReaderWriterXML::SGReaderWriterXML()
  65 {
  66     supportsExtension("xml", "SimGear xml database format");
  67 }
  68
  69 SGReaderWriterXML::~SGReaderWriterXML()
  70 {
  71 }
  72
  73 const char* SGReaderWriterXML::className() const
  74 {
  75     return "XML database reader";
  76 }
  77
  78 osgDB::ReaderWriter::ReadResult
  79 SGReaderWriterXML::readNode(const std::string& fileName,
  80                             const osgDB::ReaderWriter::Options* options) const
  81 {
  82     osg::Node *result=0;
  83     try {
  84         result=sgLoad3DModel_internal(fileName, options);
  85     } catch (const sg_throwable &t) {
  86         SG_LOG(SG_INPUT, SG_ALERT, "Failed to load model: " << t.getFormattedMessage());
  87         result=new osg::Node;
  88     }
  89     if (result)
  90         return result;
  91     else
  92         return ReadResult::FILE_NOT_HANDLED;
  93 }
  94
  95 class SGSwitchUpdateCallback : public osg::NodeCallback
  96 {
  97 public:
  98     SGSwitchUpdateCallback(SGCondition* condition) :
  99             mCondition(condition) {}
 100     virtual void operator()(osg::Node* node, osg::NodeVisitor* nv) {
 101         assert(dynamic_cast<osg::Switch*>(node));
 102         osg::Switch* s = static_cast<osg::Switch*>(node);
 103
 104         if (mCondition && mCondition->test()) {
 105             s->setAllChildrenOn();
 106             // note, callback is responsible for scenegraph traversal so
 107             // should always include call traverse(node,nv) to ensure
 108             // that the rest of cullbacks and the scene graph are traversed.
 109             traverse(node, nv);
 110         } else
 111             s->setAllChildrenOff();
 112     }
 113
 114 private:
 115     SGSharedPtr<SGCondition> mCondition;
 116 };
 117
 118
 119 // Little helper class that holds an extra reference to a
 120 // loaded 3d model.
 121 // Since we clone all structural nodes from our 3d models,
 122 // the database pager will only see one single reference to
 123 // top node of the model and expire it relatively fast.
 124 // We attach that extra reference to every model cloned from
 125 // a base model in the pager. When that cloned model is deleted
 126 // this extra reference is deleted too. So if there are no
 127 // cloned models left the model will expire.
 128 namespace {
 129 class SGDatabaseReference : public osg::Observer
 130 {
 131 public:
 132     SGDatabaseReference(osg::Referenced* referenced) :
 133         mReferenced(referenced)
 134     { }
 135     virtual void objectDeleted(void*)
 136     {
 137         mReferenced = 0;
 138     }
 139 private:
 140     osg::ref_ptr<osg::Referenced> mReferenced;
 141 };
 142
 143 void makeEffectAnimations(PropertyList& animation_nodes,
 144                           PropertyList& effect_nodes)
 145 {
 146     for (PropertyList::iterator itr = animation_nodes.begin();
 147          itr != animation_nodes.end();
 148          ++itr) {
 149         SGPropertyNode_ptr effectProp;
 150         SGPropertyNode* animProp = itr->ptr();
 151         SGPropertyNode* typeProp = animProp->getChild("type");
 152         if (!typeProp)
 153             continue;
 154         const char* typeString = typeProp->getStringValue();
 155         if (!strcmp(typeString, "material")) {
 156             effectProp
 157                 = SGMaterialAnimation::makeEffectProperties(animProp);
 158         } else if (!strcmp(typeString, "shader")) {
 159
 160             SGPropertyNode* shaderProp = animProp->getChild("shader");
 161             if (!shaderProp || strcmp(shaderProp->getStringValue(), "chrome"))
 162                 continue;
 163             *itr = 0;           // effect replaces animation
 164             SGPropertyNode* textureProp = animProp->getChild("texture");
 165             if (!textureProp)
 166                 continue;
 167             effectProp = new SGPropertyNode();
 168             makeChild(effectProp.ptr(), "inherits-from")
 169                 ->setValue("Effects/chrome");
 170             SGPropertyNode* paramsProp = makeChild(effectProp.get(), "parameters");
 171             makeChild(paramsProp, "chrome-texture")
 172                 ->setValue(textureProp->getStringValue());
 173         }
 174         if (effectProp.valid()) {
 175             PropertyList objectNameNodes = animProp->getChildren("object-name");
 176             for (PropertyList::iterator objItr = objectNameNodes.begin(),
 177                      end = objectNameNodes.end();
 178                  objItr != end;
 179                  ++objItr)
 180                 effectProp->addChild("object-name")
 181                     ->setStringValue((*objItr)->getStringValue());
 182             effect_nodes.push_back(effectProp);
 183
 184         }
 185     }
 186     animation_nodes.erase(remove_if(animation_nodes.begin(),
 187                                     animation_nodes.end(),
 188                                     !boost::bind(&SGPropertyNode_ptr::valid,
 189                                                  _1)),
 190                           animation_nodes.end());
 191 }
 192 }
 193
 194 static osg::Node *
 195 sgLoad3DModel_internal(const string &path,
 196                        const osgDB::ReaderWriter::Options* options_,
 197                        SGPropertyNode *overlay)
 198 {
 199     const SGReaderWriterXMLOptions* xmlOptions;
 200     xmlOptions = dynamic_cast<const SGReaderWriterXMLOptions*>(options_);
 201
 202     SGSharedPtr<SGPropertyNode> prop_root;
 203     osg::Node *(*load_panel)(SGPropertyNode *)=0;
 204     osg::ref_ptr<SGModelData> data;
 205
 206     if (xmlOptions) {
 207         prop_root = xmlOptions->getPropRoot();
 208         load_panel = xmlOptions->getLoadPanel();
 209         data = xmlOptions->getModelData();
 210     }
 211     if (!prop_root) {
 212         prop_root = new SGPropertyNode;
 213     }
 214
 215     osgDB::FilePathList filePathList;
 216     filePathList = osgDB::Registry::instance()->getDataFilePathList();
 217     filePathList.push_front(std::string());
 218
 219     SGPath modelpath = osgDB::findFileInPath(path, filePathList);
 220     if (modelpath.str().empty()) {
 221         SG_LOG(SG_INPUT, SG_ALERT, "Failed to load file: \"" << path << "\"");
 222         return 0;
 223     }
 224     SGPath texturepath = modelpath;
 225
 226     osg::ref_ptr<osg::Node> model;
 227     osg::ref_ptr<osg::Group> group;
 228     SGPropertyNode_ptr props = new SGPropertyNode;
 229
 230     // Check for an XML wrapper
 231     if (modelpath.extension() == "xml") {
 232        try {
 233             readProperties(modelpath.str(), props);
 234         } catch (const sg_throwable &t) {
 235             SG_LOG(SG_INPUT, SG_ALERT, "Failed to load xml: "
 236                    << t.getFormattedMessage());
 237             throw;
 238         }
 239         if (overlay)
 240             copyProperties(overlay, props);
 241
 242         if (props->hasValue("/path")) {
 243             modelpath = modelpath.dir();
 244             modelpath.append(props->getStringValue("/path"));
 245             if (props->hasValue("/texture-path")) {
 246                 texturepath = texturepath.dir();
 247                 texturepath.append(props->getStringValue("/texture-path"));
 248             }
 249         } else {
 250             model = new osg::Node;
 251         }
 252
 253         SGPropertyNode *mp = props->getNode("multiplay");
 254         if (mp && prop_root && prop_root->getParent())
 255             copyProperties(mp, prop_root);
 256     } else {
 257         SG_LOG(SG_INPUT, SG_DEBUG, "model without wrapper: "
 258                << modelpath.str());
 259     }
 260
 261     osg::ref_ptr<SGReaderWriterXMLOptions> options
 262     = new SGReaderWriterXMLOptions(*options_);
 263     options->setPropRoot(prop_root);
 264     options->setLoadPanel(load_panel);
 265
 266     // Assume that textures are in
 267     // the same location as the XML file.
 268     if (!model) {
 269         if (!texturepath.extension().empty())
 270             texturepath = texturepath.dir();
 271
 272         options->setDatabasePath(texturepath.str());
 273         osgDB::ReaderWriter::ReadResult modelResult
 274             = osgDB::Registry::instance()->readNode(modelpath.str(),
 275                                                     options.get());
 276         if (!modelResult.validNode())
 277             throw sg_io_exception("Failed to load 3D model",
 278                                   sg_location(modelpath.str()));
 279         model = copyModel(modelResult.getNode());
 280         // Add an extra reference to the model stored in the database.
 281         // That is to avoid expiring the object from the cache even if
 282         // it is still in use. Note that the object cache will think
 283         // that a model is unused if the reference count is 1. If we
 284         // clone all structural nodes here we need that extra
 285         // reference to the original object
 286         SGDatabaseReference* databaseReference;
 287         databaseReference = new SGDatabaseReference(modelResult.getNode());
 288         model->addObserver(databaseReference);
 289
 290         // Update liveries
 291         TextureUpdateVisitor liveryUpdate(options->getDatabasePathList());
 292         model->accept(liveryUpdate);
 293
 294         // Copy the userdata fields, still sharing the boundingvolumes,
 295         // but introducing new data for velocities.
 296         UserDataCopyVisitor userDataCopyVisitor;
 297         model->accept(userDataCopyVisitor);
 298     }
 299     model->setName(modelpath.str());
 300
 301     bool needTransform=false;
 302     // Set up the alignment node if needed
 303     SGPropertyNode *offsets = props->getNode("offsets", false);
 304     if (offsets) {
 305         needTransform=true;
 306         osg::MatrixTransform *alignmainmodel = new osg::MatrixTransform;
 307         alignmainmodel->setDataVariance(osg::Object::STATIC);
 308         osg::Matrix res_matrix;
 309         res_matrix.makeRotate(
 310             offsets->getFloatValue("pitch-deg", 0.0)*SG_DEGREES_TO_RADIANS,
 311             osg::Vec3(0, 1, 0),
 312             offsets->getFloatValue("roll-deg", 0.0)*SG_DEGREES_TO_RADIANS,
 313             osg::Vec3(1, 0, 0),
 314             offsets->getFloatValue("heading-deg", 0.0)*SG_DEGREES_TO_RADIANS,
 315             osg::Vec3(0, 0, 1));
 316
 317         osg::Matrix tmat;
 318         tmat.makeTranslate(offsets->getFloatValue("x-m", 0.0),
 319                            offsets->getFloatValue("y-m", 0.0),
 320                            offsets->getFloatValue("z-m", 0.0));
 321         alignmainmodel->setMatrix(res_matrix*tmat);
 322         group = alignmainmodel;
 323     }
 324     if (!group) {
 325         group = new osg::Group;
 326     }
 327     group->addChild(model.get());
 328
 329     // Load sub-models
 330     vector<SGPropertyNode_ptr> model_nodes = props->getChildren("model");
 331     for (unsigned i = 0; i < model_nodes.size(); i++) {
 332         SGPropertyNode_ptr sub_props = model_nodes[i];
 333
 334         SGPath submodelpath;
 335         osg::ref_ptr<osg::Node> submodel;
 336         string submodelFileName = sub_props->getStringValue("path");
 337         if (submodelFileName.size() > 2
 338             && !submodelFileName.compare(0, 2, "./" )) {
 339             submodelpath = modelpath.dir();
 340             submodelpath.append( submodelFileName.substr( 2 ) );
 341         } else {
 342             submodelpath = submodelFileName;
 343         }
 344         osg::ref_ptr<SGReaderWriterXMLOptions> options;
 345         options = new SGReaderWriterXMLOptions(*options_);
 346         options->setPropRoot(prop_root);
 347         options->setLoadPanel(load_panel);
 348         try {
 349             submodel = sgLoad3DModel_internal(submodelpath.str(), options.get(),
 350                                               sub_props->getNode("overlay"));
 351         } catch (const sg_throwable &t) {
 352             SG_LOG(SG_INPUT, SG_ALERT, "Failed to load submodel: " << t.getFormattedMessage());
 353             throw;
 354         }
 355
 356         osg::ref_ptr<osg::Node> submodel_final = submodel;
 357         SGPropertyNode *offs = sub_props->getNode("offsets", false);
 358         if (offs) {
 359             osg::Matrix res_matrix;
 360             osg::ref_ptr<osg::MatrixTransform> align = new osg::MatrixTransform;
 361             align->setDataVariance(osg::Object::STATIC);
 362             res_matrix.makeIdentity();
 363             res_matrix.makeRotate(
 364                 offs->getDoubleValue("pitch-deg", 0.0)*SG_DEGREES_TO_RADIANS,
 365                 osg::Vec3(0, 1, 0),
 366                 offs->getDoubleValue("roll-deg", 0.0)*SG_DEGREES_TO_RADIANS,
 367                 osg::Vec3(1, 0, 0),
 368                 offs->getDoubleValue("heading-deg", 0.0)*SG_DEGREES_TO_RADIANS,
 369                 osg::Vec3(0, 0, 1));
 370
 371             osg::Matrix tmat;
 372             tmat.makeIdentity();
 373             tmat.makeTranslate(offs->getDoubleValue("x-m", 0),
 374                                offs->getDoubleValue("y-m", 0),
 375                                offs->getDoubleValue("z-m", 0));
 376             align->setMatrix(res_matrix*tmat);
 377             align->addChild(submodel.get());
 378             submodel_final = align;
 379         }
 380         submodel_final->setName(sub_props->getStringValue("name", ""));
 381
 382         SGPropertyNode *cond = sub_props->getNode("condition", false);
 383         if (cond) {
 384             osg::ref_ptr<osg::Switch> sw = new osg::Switch;
 385             sw->setUpdateCallback(new SGSwitchUpdateCallback(sgReadCondition(prop_root, cond)));
 386             group->addChild(sw.get());
 387             sw->addChild(submodel_final.get());
 388             sw->setName("submodel condition switch");
 389         } else {
 390             group->addChild(submodel_final.get());
 391         }
 392     } // end of submodel loading
 393
 394     if ( load_panel ) {
 395         // Load panels
 396         vector<SGPropertyNode_ptr> panel_nodes = props->getChildren("panel");
 397         for (unsigned i = 0; i < panel_nodes.size(); i++) {
 398             SG_LOG(SG_INPUT, SG_DEBUG, "Loading a panel");
 399             osg::ref_ptr<osg::Node> panel = load_panel(panel_nodes[i]);
 400             if (panel_nodes[i]->hasValue("name"))
 401                 panel->setName(panel_nodes[i]->getStringValue("name"));
 402             group->addChild(panel.get());
 403         }
 404     }
 405
 406     std::vector<SGPropertyNode_ptr> particle_nodes;
 407     particle_nodes = props->getChildren("particlesystem");
 408     for (unsigned i = 0; i < particle_nodes.size(); ++i) {
 409         if (i==0) {
 410             if (!texturepath.extension().empty())
 411                 texturepath = texturepath.dir();
 412
 413             options->setDatabasePath(texturepath.str());
 414         }
 415         group->addChild(Particles::appendParticles(particle_nodes[i],
 416                         prop_root,
 417                         options.get()));
 418     }
 419
 420     std::vector<SGPropertyNode_ptr> text_nodes;
 421     text_nodes = props->getChildren("text");
 422     for (unsigned i = 0; i < text_nodes.size(); ++i) {
 423         group->addChild(SGText::appendText(text_nodes[i],
 424                         prop_root,
 425                         options.get()));
 426     }
 427     PropertyList effect_nodes = props->getChildren("effect");
 428     PropertyList animation_nodes = props->getChildren("animation");
 429     // Some material animations (eventually all) are actually effects.
 430     makeEffectAnimations(animation_nodes, effect_nodes);
 431     {
 432         ref_ptr<Node> modelWithEffects
 433             = instantiateEffects(group.get(), effect_nodes, options.get());
 434         group = static_cast<Group*>(modelWithEffects.get());
 435     }
 436     for (unsigned i = 0; i < animation_nodes.size(); ++i)
 437         /// OSGFIXME: duh, why not only model?????
 438         SGAnimation::animate(group.get(), animation_nodes[i], prop_root,
 439                              options.get());
 440
 441     if (!needTransform && group->getNumChildren() < 2) {
 442         model = group->getChild(0);
 443         group->removeChild(model.get());
 444         if (data.valid())
 445             data->modelLoaded(modelpath.str(), props, model.get());
 446         return model.release();
 447     }
 448     if (data.valid())
 449         data->modelLoaded(modelpath.str(), props, group.get());
 450     if (props->hasChild("debug-outfile")) {
 451         std::string outputfile = props->getStringValue("debug-outfile",
 452                                  "debug-model.osg");
 453         osgDB::writeNodeFile(*group, outputfile);
 454     }
 455
 456     return group.release();
 457 }
 458