]> git.mxchange.org Git - simgear.git/blobdiff - simgear/scene/model/model.cxx
pass SGReaderWriterXMLOptions to effects
[simgear.git] / simgear / scene / model / model.cxx
index becc88c6d824cd128eeb64eb21ecf61feae617dc..1ea486f0d13afc5b1dae4353c449539f77df3d85 100644 (file)
@@ -7,34 +7,36 @@
 #include <simgear_config.h>
 #endif
 
-#include <osg/observer_ptr>
+#include <utility>
+
+#include <boost/foreach.hpp>
+
 #include <osg/ref_ptr>
-#include <osg/Group>
-#include <osg/NodeCallback>
-#include <osg/Switch>
-#include <osg/MatrixTransform>
-#include <osgDB/Archive>
 #include <osgDB/FileNameUtils>
 #include <osgDB/FileUtils>
+#include <osgDB/ReaderWriter>
 #include <osgDB/ReadFile>
-#include <osgDB/WriteFile>
-#include <osgDB/Registry>
 #include <osgDB/SharedStateManager>
-#include <osgUtil/Optimizer>
 
+#include <simgear/math/SGMath.hxx>
+#include <simgear/scene/material/Effect.hxx>
+#include <simgear/scene/material/EffectGeode.hxx>
 #include <simgear/scene/util/SGSceneFeatures.hxx>
-#include <simgear/scene/util/SGStateAttributeVisitor.hxx>
-#include <simgear/scene/util/SGTextureStateAttributeVisitor.hxx>
+#include <simgear/scene/util/SGSceneUserData.hxx>
+#include <simgear/scene/util/CopyOp.hxx>
+#include <simgear/scene/util/SplicingVisitor.hxx>
+
 
 #include <simgear/structure/exception.hxx>
+#include <simgear/structure/Singleton.hxx>
 #include <simgear/props/props.hxx>
 #include <simgear/props/props_io.hxx>
 #include <simgear/props/condition.hxx>
 
-#include "animation.hxx"
+#include "SGReaderWriterXMLOptions.hxx"
 #include "model.hxx"
 
-SG_USING_STD(vector);
+using std::vector;
 
 osg::Texture2D*
 SGLoadTexture2D(bool staticTexture, const std::string& path,
@@ -70,205 +72,265 @@ SGLoadTexture2D(bool staticTexture, const std::string& path,
     }
   }
 
-  // Make sure the texture is shared if we already have the same texture
-  // somewhere ...
-  {
-    osg::ref_ptr<osg::Node> tmpNode = new osg::Node;
-    osg::StateSet* stateSet = tmpNode->getOrCreateStateSet();
-    stateSet->setTextureAttribute(0, texture.get());
-
-    // OSGFIXME: don't forget that mutex here
-    osgDB::Registry* registry = osgDB::Registry::instance();
-    registry->getSharedStateManager()->share(tmpNode.get(), 0);
-
-    // should be the same, but be paranoid ...
-    stateSet = tmpNode->getStateSet();
-    osg::StateAttribute* stateAttr;
-    stateAttr = stateSet->getTextureAttribute(0, osg::StateAttribute::TEXTURE);
-    osg::Texture2D* texture2D = dynamic_cast<osg::Texture2D*>(stateAttr);
-    if (texture2D)
-      texture = texture2D;
-  }
-
   return texture.release();
 }
 
-class SGSwitchUpdateCallback : public osg::NodeCallback {
-public:
-  SGSwitchUpdateCallback(SGCondition* condition) :
-    mCondition(condition) {}
-  virtual void operator()(osg::Node* node, osg::NodeVisitor* nv)
-  { 
-    assert(dynamic_cast<osg::Switch*>(node));
-    osg::Switch* s = static_cast<osg::Switch*>(node);
-
-    if (mCondition && mCondition->test()) {
-      s->setAllChildrenOn();
-      // note, callback is responsible for scenegraph traversal so
-      // should always include call traverse(node,nv) to ensure 
-      // that the rest of cullbacks and the scene graph are traversed.
-      traverse(node, nv);
-    } else
-      s->setAllChildrenOff();
-  }
+namespace simgear
+{
+using namespace std;
+using namespace osg;
+using simgear::CopyOp;
 
-private:
-  SGSharedPtr<SGCondition> mCondition;
-};
+Node* copyModel(Node* model)
+{
+    const CopyOp::CopyFlags flags = (CopyOp::DEEP_COPY_ALL
+                                     & ~CopyOp::DEEP_COPY_TEXTURES
+                                     & ~CopyOp::DEEP_COPY_IMAGES
+                                     & ~CopyOp::DEEP_COPY_STATESETS
+                                     & ~CopyOp::DEEP_COPY_STATEATTRIBUTES
+                                     & ~CopyOp::DEEP_COPY_ARRAYS
+                                     & ~CopyOp::DEEP_COPY_PRIMITIVES
+                                     // This will preserve display lists ...
+                                     & ~CopyOp::DEEP_COPY_DRAWABLES
+                                     & ~CopyOp::DEEP_COPY_SHAPES);
+    return (CopyOp(flags))(model);
+}
 
-\f
-////////////////////////////////////////////////////////////////////////
-// Global functions.
-////////////////////////////////////////////////////////////////////////
-
-osg::Node *
-sgLoad3DModel( const string &fg_root, const string &path,
-               SGPropertyNode *prop_root,
-               double sim_time_sec, osg::Node *(*load_panel)(SGPropertyNode *),
-               SGModelData *data,
-               const SGPath& externalTexturePath )
+TextureUpdateVisitor::TextureUpdateVisitor(const osgDB::FilePathList& pathList) :
+    NodeAndDrawableVisitor(NodeVisitor::TRAVERSE_ALL_CHILDREN),
+    _pathList(pathList)
 {
-  osg::ref_ptr<osg::Node> model;
-  SGPropertyNode props;
-
-  // Load the 3D aircraft object itself
-  SGPath modelpath = path, texturepath = path;
-  if ( !ulIsAbsolutePathName( path.c_str() ) ) {
-    SGPath tmp = fg_root;
-    tmp.append(modelpath.str());
-    modelpath = texturepath = tmp;
-  }
+}
 
-  // Check for an XML wrapper
-  if (modelpath.str().substr(modelpath.str().size() - 4, 4) == ".xml") {
-    readProperties(modelpath.str(), &props);
-    if (props.hasValue("/path")) {
-      modelpath = modelpath.dir();
-      modelpath.append(props.getStringValue("/path"));
-      if (props.hasValue("/texture-path")) {
-        texturepath = texturepath.dir();
-        texturepath.append(props.getStringValue("/texture-path"));
-      }
-    } else {
-      if (!model)
-        model = new osg::Switch;
-    }
-  }
+void TextureUpdateVisitor::apply(Node& node)
+{
+    StateSet* stateSet = cloneStateSet(node.getStateSet());
+    if (stateSet)
+        node.setStateSet(stateSet);
+    traverse(node);
+}
 
-  osg::ref_ptr<osgDB::ReaderWriter::Options> options
-      = new osgDB::ReaderWriter::Options(*osgDB::Registry::instance()
-                                         ->getOptions());
+void TextureUpdateVisitor::apply(Drawable& drawable)
+{
+    StateSet* stateSet = cloneStateSet(drawable.getStateSet());
+    if (stateSet)
+        drawable.setStateSet(stateSet);
+}
 
-  // Assume that textures are in
-  // the same location as the XML file.
-  if (!model) {
-      if (texturepath.extension() != "")
-          texturepath = texturepath.dir();
+Texture2D* TextureUpdateVisitor::textureReplace(int unit, const StateAttribute* attr)
+{
+    using namespace osgDB;
+    const Texture2D* texture = dynamic_cast<const Texture2D*>(attr);
 
-      options->setDatabasePath(texturepath.str());
-      if (!externalTexturePath.str().empty())
-          options->getDatabasePathList().push_back(externalTexturePath.str());
+    if (!texture)
+        return 0;
 
-      model = osgDB::readNodeFile(modelpath.str(), options.get());
-      if (model == 0)
-          throw sg_io_exception("Failed to load 3D model", 
-                                sg_location(modelpath.str()));
-  }
+    const Image* image = texture->getImage();
+    const string* fullFilePath = 0;
+    if (image) {
+        // The currently loaded file name
+        fullFilePath = &image->getFileName();
 
-  // Set up the alignment node
-  osg::ref_ptr<osg::MatrixTransform> alignmainmodel = new osg::MatrixTransform;
-  alignmainmodel->addChild(model.get());
-  osg::Matrix res_matrix;
-  res_matrix.makeRotate(
-    props.getFloatValue("/offsets/pitch-deg", 0.0)*SG_DEGREES_TO_RADIANS,
-    osg::Vec3(0, 1, 0),
-    props.getFloatValue("/offsets/roll-deg", 0.0)*SG_DEGREES_TO_RADIANS,
-    osg::Vec3(1, 0, 0),
-    props.getFloatValue("/offsets/heading-deg", 0.0)*SG_DEGREES_TO_RADIANS,
-    osg::Vec3(0, 0, 1));
-
-  osg::Matrix tmat;
-  tmat.makeTranslate(props.getFloatValue("/offsets/x-m", 0.0),
-                     props.getFloatValue("/offsets/y-m", 0.0),
-                     props.getFloatValue("/offsets/z-m", 0.0));
-  alignmainmodel->setMatrix(res_matrix*tmat);
-
-  // Load sub-models
-  vector<SGPropertyNode_ptr> model_nodes = props.getChildren("model");
-  for (unsigned i = 0; i < model_nodes.size(); i++) {
-    SGPropertyNode_ptr node = model_nodes[i];
-    osg::ref_ptr<osg::MatrixTransform> align = new osg::MatrixTransform;
-    res_matrix.makeIdentity();
-    res_matrix.makeRotate(
-      node->getDoubleValue("offsets/pitch-deg", 0.0)*SG_DEGREES_TO_RADIANS,
-      osg::Vec3(0, 1, 0),
-      node->getDoubleValue("offsets/roll-deg", 0.0)*SG_DEGREES_TO_RADIANS,
-      osg::Vec3(1, 0, 0),
-      node->getDoubleValue("offsets/heading-deg", 0.0)*SG_DEGREES_TO_RADIANS,
-      osg::Vec3(0, 0, 1));
-    
-    tmat.makeIdentity();
-    tmat.makeTranslate(node->getDoubleValue("offsets/x-m", 0),
-                       node->getDoubleValue("offsets/y-m", 0),
-                       node->getDoubleValue("offsets/z-m", 0));
-    align->setMatrix(res_matrix*tmat);
-
-    osg::ref_ptr<osg::Node> kid;
-    const char* submodel = node->getStringValue("path");
-    try {
-      kid = sgLoad3DModel( fg_root, submodel, prop_root, sim_time_sec, load_panel );
-
-    } catch (const sg_throwable &t) {
-      SG_LOG(SG_INPUT, SG_ALERT, "Failed to load submodel: " << t.getFormattedMessage());
-      throw;
+    } else {
+        fullFilePath = &texture->getName();
+    }
+    // The short name
+    string fileName = getSimpleFileName(*fullFilePath);
+    if (fileName.empty())
+        return 0;
+    // The name that should be found with the current database path
+    string fullLiveryFile = findFileInPath(fileName, _pathList);
+    // If it is empty or they are identical then there is nothing to do
+    if (fullLiveryFile.empty() || fullLiveryFile == *fullFilePath)
+        return 0;
+    Image* newImage = readImageFile(fullLiveryFile);
+    if (!newImage)
+        return 0;
+    CopyOp copyOp(CopyOp::DEEP_COPY_ALL & ~CopyOp::DEEP_COPY_IMAGES);
+    Texture2D* newTexture = static_cast<Texture2D*>(copyOp(texture));
+    if (!newTexture) {
+        return 0;
+    } else {
+        newTexture->setImage(newImage);
+        return newTexture;
     }
-    align->addChild(kid.get());
+}
 
-    align->setName(node->getStringValue("name", ""));
+StateSet* TextureUpdateVisitor::cloneStateSet(const StateSet* stateSet)
+{
+    typedef std::pair<int, Texture2D*> Tex2D;
+    vector<Tex2D> newTextures;
+    StateSet* result = 0;
+
+    if (!stateSet)
+        return 0;
+    int numUnits = stateSet->getTextureAttributeList().size();
+    if (numUnits > 0) {
+        for (int i = 0; i < numUnits; ++i) {
+            const StateAttribute* attr
+                = stateSet->getTextureAttribute(i, StateAttribute::TEXTURE);
+            Texture2D* newTexture = textureReplace(i, attr);
+            if (newTexture)
+                newTextures.push_back(Tex2D(i, newTexture));
+        }
+        if (!newTextures.empty()) {
+            result = static_cast<StateSet*>(stateSet->clone(CopyOp()));
+            for (vector<Tex2D>::iterator i = newTextures.begin();
+                 i != newTextures.end();
+                 ++i) {
+                result->setTextureAttribute(i->first, i->second);
+            }
+        }
+    }
+    return result;
+}
 
-    SGPropertyNode *cond = node->getNode("condition", false);
-    if (cond) {
-      osg::ref_ptr<osg::Switch> sw = new osg::Switch;
-      sw->setUpdateCallback(new SGSwitchUpdateCallback(sgReadCondition(prop_root, cond)));
-      alignmainmodel->addChild(sw.get());
-      sw->addChild(align.get());
-      sw->setName("submodel condition switch");
-    } else {
-      alignmainmodel->addChild(align.get());
+UserDataCopyVisitor::UserDataCopyVisitor() :
+    NodeVisitor(NodeVisitor::NODE_VISITOR,
+                NodeVisitor::TRAVERSE_ALL_CHILDREN)
+{
+}
+
+void UserDataCopyVisitor::apply(Node& node)
+{
+    ref_ptr<SGSceneUserData> userData;
+    userData = SGSceneUserData::getSceneUserData(&node);
+    if (userData.valid()) {
+        SGSceneUserData* newUserData  = new SGSceneUserData(*userData);
+        newUserData->setVelocity(0);
+        node.setUserData(newUserData);
     }
-  }
+    node.traverse(*this);
+}
 
-  if ( load_panel ) {
-    // Load panels
-    vector<SGPropertyNode_ptr> panel_nodes = props.getChildren("panel");
-    for (unsigned i = 0; i < panel_nodes.size(); i++) {
-        SG_LOG(SG_INPUT, SG_DEBUG, "Loading a panel");
-        osg::ref_ptr<osg::Node> panel = load_panel(panel_nodes[i]);
-        if (panel_nodes[i]->hasValue("name"))
-            panel->setName((char *)panel_nodes[i]->getStringValue("name"));
-        alignmainmodel->addChild(panel.get());
+namespace
+{
+class MakeEffectVisitor : public SplicingVisitor
+{
+public:
+    typedef std::map<string, SGPropertyNode_ptr> EffectMap;
+    using SplicingVisitor::apply;
+    MakeEffectVisitor(const SGReaderWriterXMLOptions* options = 0)
+        : _options(options)
+    {
     }
-  }
+    virtual void apply(osg::Group& node);
+    virtual void apply(osg::Geode& geode);
+    EffectMap& getEffectMap() { return _effectMap; }
+    const EffectMap& getEffectMap() const { return _effectMap; }
+    void setDefaultEffect(SGPropertyNode* effect)
+    {
+        _currentEffectParent = effect;
+    }
+    SGPropertyNode* getDefaultEffect() { return _currentEffectParent; }
+protected:
+    EffectMap _effectMap;
+    SGPropertyNode_ptr _currentEffectParent;
+    osg::ref_ptr<const SGReaderWriterXMLOptions> _options;
+};
 
-  if (data) {
-    alignmainmodel->setUserData(data);
-    data->modelLoaded(path, &props, alignmainmodel.get());
-  }
+void MakeEffectVisitor::apply(osg::Group& node)
+{
+    SGPropertyNode_ptr savedEffectRoot;
+    const string& nodeName = node.getName();
+    bool restoreEffect = false;
+    if (!nodeName.empty()) {
+        EffectMap::iterator eitr = _effectMap.find(nodeName);
+        if (eitr != _effectMap.end()) {
+            savedEffectRoot = _currentEffectParent;
+            _currentEffectParent = eitr->second;
+            restoreEffect = true;
+        }
+    }
+    SplicingVisitor::apply(node);
+    // If a new node was created, copy the user data too.
+    ref_ptr<SGSceneUserData> userData = SGSceneUserData::getSceneUserData(&node);
+    if (userData.valid() && _childStack.back().back().get() != &node)
+        _childStack.back().back()->setUserData(new SGSceneUserData(*userData));
+    if (restoreEffect)
+        _currentEffectParent = savedEffectRoot;
+}
 
-  std::vector<SGPropertyNode_ptr> animation_nodes;
-  animation_nodes = props.getChildren("animation");
-  for (unsigned i = 0; i < animation_nodes.size(); ++i)
-    /// OSGFIXME: duh, why not only model?????
-    SGAnimation::animate(alignmainmodel.get(), animation_nodes[i], prop_root,
-                         options.get());
-
-  if (props.hasChild("debug-outfile")) {
-    std::string outputfile = props.getStringValue("debug-outfile",
-                                                  "debug-model.osg");
-    osgDB::writeNodeFile(*alignmainmodel, outputfile);
-  }
+void MakeEffectVisitor::apply(osg::Geode& geode)
+{
+    if (pushNode(getNewNode(geode)))
+        return;
+    osg::StateSet* ss = geode.getStateSet();
+    if (!ss) {
+        pushNode(&geode);
+        return;
+    }
+    SGPropertyNode_ptr ssRoot = new SGPropertyNode;
+    makeParametersFromStateSet(ssRoot, ss);
+    SGPropertyNode_ptr effectRoot = new SGPropertyNode;
+    effect::mergePropertyTrees(effectRoot, ssRoot, _currentEffectParent);
+    Effect* effect = makeEffect(effectRoot, true, _options);
+    EffectGeode* eg = dynamic_cast<EffectGeode*>(&geode);
+    if (eg) {
+        eg->setEffect(effect);
+    } else {
+        eg = new EffectGeode;
+        eg->setEffect(effect);
+        ref_ptr<SGSceneUserData> userData = SGSceneUserData::getSceneUserData(&geode);
+        if (userData.valid())
+            eg->setUserData(new SGSceneUserData(*userData));
+        for (int i = 0; i < geode.getNumDrawables(); ++i)
+            eg->addDrawable(geode.getDrawable(i));
+    }
+    pushResultNode(&geode, eg);
+
+}
+
+}
 
-  return alignmainmodel.release();
+namespace
+{
+class DefaultEffect : public simgear::Singleton<DefaultEffect>
+{
+public:
+    DefaultEffect()
+    {
+        _effect = new SGPropertyNode;
+        makeChild(_effect.ptr(), "inherits-from")
+            ->setStringValue("Effects/model-default");
+    }
+    virtual ~DefaultEffect() {}
+    SGPropertyNode* getEffect() { return _effect.ptr(); }
+protected:
+    SGPropertyNode_ptr _effect;
+};
 }
 
+ref_ptr<Node> instantiateEffects(osg::Node* modelGroup,
+                                 PropertyList& effectProps,
+                                 const SGReaderWriterXMLOptions* options)
+{
+    SGPropertyNode_ptr defaultEffectPropRoot;
+    MakeEffectVisitor visitor(options);
+    MakeEffectVisitor::EffectMap& emap = visitor.getEffectMap();
+    for (PropertyList::iterator itr = effectProps.begin(),
+             end = effectProps.end();
+         itr != end;
+        ++itr)
+    {
+        SGPropertyNode_ptr configNode = *itr;
+        std::vector<SGPropertyNode_ptr> objectNames =
+            configNode->getChildren("object-name");
+        SGPropertyNode* defaultNode = configNode->getChild("default");
+        if (defaultNode && defaultNode->getValue<bool>())
+            defaultEffectPropRoot = configNode;
+        BOOST_FOREACH(SGPropertyNode_ptr objNameNode, objectNames) {
+            emap.insert(make_pair(objNameNode->getStringValue(), configNode));
+        }
+        configNode->removeChild("default");
+        configNode->removeChildren("object-name");
+    }
+    if (!defaultEffectPropRoot)
+        defaultEffectPropRoot = DefaultEffect::instance()->getEffect();
+    visitor.setDefaultEffect(defaultEffectPropRoot.ptr());
+    modelGroup->accept(visitor);
+    osg::NodeList& result = visitor.getResults();
+    return ref_ptr<Node>(result[0].get());
+}
+}
 // end of model.cxx