// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+
+#ifdef HAVE_CONFIG_H
+# include <simgear_config.h>
+#endif
+
#include "ModelRegistry.hxx"
+#include <algorithm>
+#include <utility>
+#include <vector>
+
#include <OpenThreads/ScopedLock>
-#include <osg/observer_ptr>
#include <osg/ref_ptr>
#include <osg/Group>
#include <osg/NodeCallback>
#include <simgear/scene/util/SGSceneFeatures.hxx>
#include <simgear/scene/util/SGStateAttributeVisitor.hxx>
#include <simgear/scene/util/SGTextureStateAttributeVisitor.hxx>
+#include <simgear/scene/util/NodeAndDrawableVisitor.hxx>
#include <simgear/structure/exception.hxx>
#include <simgear/props/props.hxx>
#include <simgear/props/props_io.hxx>
#include <simgear/props/condition.hxx>
+#include "BoundingVolumeBuildVisitor.hxx"
+#include "model.hxx"
+#include "SGReaderWriterXMLOptions.hxx"
+
using namespace std;
using namespace osg;
using namespace osgUtil;
ref_ptr<Referenced> mReferenced;
};
-// Visitor for
-class SGTextureUpdateVisitor : public SGTextureStateAttributeVisitor {
+// Set the name of a Texture to the simple name of its image
+// file. This can be used to do livery substitution after the image
+// has been deallocated.
+class TextureNameVisitor : public NodeAndDrawableVisitor {
public:
- SGTextureUpdateVisitor(const FilePathList& pathList) :
- mPathList(pathList)
- { }
- Texture2D* textureReplace(int unit,
- StateSet::RefAttributePair& refAttr)
- {
- Texture2D* texture;
- texture = dynamic_cast<Texture2D*>(refAttr.first.get());
- if (!texture)
- return 0;
-
- ref_ptr<Image> image = texture->getImage(0);
- if (!image)
- return 0;
-
- // The currently loaded file name
- string fullFilePath = image->getFileName();
- // The short name
- string fileName = getSimpleFileName(fullFilePath);
- // The name that should be found with the current database path
- string fullLiveryFile = findFileInPath(fileName, mPathList);
- // If they are identical then there is nothing to do
- if (fullLiveryFile == fullFilePath)
- return 0;
-
- image = readImageFile(fullLiveryFile);
- if (!image)
- return 0;
+ TextureNameVisitor(NodeVisitor::TraversalMode tm = NodeVisitor::TRAVERSE_ALL_CHILDREN) :
+ NodeAndDrawableVisitor(tm)
+ {
+ }
- CopyOp copyOp(CopyOp::DEEP_COPY_ALL & ~CopyOp::DEEP_COPY_IMAGES);
- texture = static_cast<Texture2D*>(copyOp(texture));
- if (!texture)
- return 0;
- texture->setImage(image.get());
- return texture;
- }
- virtual void apply(StateSet* stateSet)
- {
- if (!stateSet)
- return;
+ virtual void apply(Node& node)
+ {
+ nameTextures(node.getStateSet());
+ traverse(node);
+ }
- // get a copy that we can safely modify the statesets values.
- StateSet::TextureAttributeList attrList;
- attrList = stateSet->getTextureAttributeList();
- for (unsigned unit = 0; unit < attrList.size(); ++unit) {
- StateSet::AttributeList::iterator i = attrList[unit].begin();
- while (i != attrList[unit].end()) {
- Texture2D* texture = textureReplace(unit, i->second);
- if (texture) {
- stateSet->removeTextureAttribute(unit, i->second.first.get());
- stateSet->setTextureAttribute(unit, texture, i->second.second);
- stateSet->setTextureMode(unit, GL_TEXTURE_2D, StateAttribute::ON);
+ virtual void apply(Drawable& drawable)
+ {
+ nameTextures(drawable.getStateSet());
+ }
+protected:
+ void nameTextures(StateSet* stateSet)
+ {
+ if (!stateSet)
+ return;
+ int numUnits = stateSet->getTextureAttributeList().size();
+ for (int i = 0; i < numUnits; ++i) {
+ StateAttribute* attr
+ = stateSet->getTextureAttribute(i, StateAttribute::TEXTURE);
+ Texture2D* texture = dynamic_cast<Texture2D*>(attr);
+ if (!texture || !texture->getName().empty())
+ continue;
+ const Image *image = texture->getImage();
+ if (!image)
+ continue;
+ texture->setName(image->getFileName());
}
- ++i;
- }
}
- }
-
-private:
- FilePathList mPathList;
};
+
class SGTexCompressionVisitor : public SGTextureStateAttributeVisitor {
public:
virtual void apply(int, StateSet::RefAttributePair& refAttr)
if (!texture)
return;
- // Hmm, true??
- texture->setDataVariance(osg::Object::STATIC);
+ // Do not touch dynamically generated textures.
+ if (texture->getReadPBuffer())
+ return;
+ if (texture->getDataVariance() == osg::Object::DYNAMIC)
+ return;
+ // If no image attached, we assume this one is dynamically generated
Image* image = texture->getImage(0);
if (!image)
return;
texture = dynamic_cast<Texture*>(refAttr.first.get());
if (!texture)
return;
+
+ // Cannot be static if this is a render to texture thing
+ if (texture->getReadPBuffer())
+ return;
+ if (texture->getDataVariance() == osg::Object::DYNAMIC)
+ return;
+ // If no image attached, we assume this one is dynamically generated
+ Image* image = texture->getImage(0);
+ if (!image)
+ return;
texture->setDataVariance(Object::STATIC);
}
{
if (!stateSet)
return;
- SGTextureStateAttributeVisitor::apply(stateSet);
stateSet->setDataVariance(Object::STATIC);
+ SGTextureStateAttributeVisitor::apply(stateSet);
}
};
-class SGAcMaterialCrippleVisitor : public SGStateAttributeVisitor {
-public:
- virtual void apply(StateSet::RefAttributePair& refAttr)
- {
- Material* material;
- material = dynamic_cast<Material*>(refAttr.first.get());
- if (!material)
- return;
- material->setColorMode(Material::AMBIENT_AND_DIFFUSE);
- }
-};
-
-// Work around an OSG bug - the file loaders don't use the file path
-// in options while the file is being loaded.
-
-struct OptionsPusher {
- FilePathList localPathList;
- bool validOptions;
- OptionsPusher(const ReaderWriter::Options* options):
- validOptions(false)
- {
- if (!options)
- return;
- Registry* registry = Registry::instance();
- localPathList = registry->getDataFilePathList();
- const FilePathList& regPathList = registry->getDataFilePathList();
- const FilePathList& optionsPathList = options->getDatabasePathList();
- for (FilePathList::const_iterator iter = optionsPathList.begin();
- iter != optionsPathList.end();
- ++iter) {
- if (find(regPathList.begin(), regPathList.end(), *iter)
- == regPathList.end())
- localPathList.push_front(*iter);
- }
- // Save the current Registry path list and install the augmented one.
- localPathList.swap(registry->getDataFilePathList());
- validOptions = true;
- }
- ~OptionsPusher()
- {
- // Restore the old path list
- if (validOptions)
- localPathList.swap(Registry::instance()->getDataFilePathList());
- }
-};
} // namespace
+Node* DefaultProcessPolicy::process(Node* node, const string& filename,
+ const ReaderWriter::Options* opt)
+{
+ TextureNameVisitor nameVisitor;
+ node->accept(nameVisitor);
+ return node;
+}
+
ReaderWriter::ReadResult
ModelRegistry::readImage(const string& fileName,
const ReaderWriter::Options* opt)
{
- OpenThreads::ScopedLock<OpenThreads::ReentrantMutex> lock(readerMutex);
CallbackMap::iterator iter
= imageCallbackMap.find(getFileExtension(fileName));
- // XXX Workaround for OSG plugin bug
- OptionsPusher pusher(opt);
- if (iter != imageCallbackMap.end() && iter->second.valid())
- return iter->second->readImage(fileName, opt);
- string absFileName = findDataFile(fileName);
- if (!fileExists(absFileName)) {
- SG_LOG(SG_IO, SG_ALERT, "Cannot find image file \""
- << fileName << "\"");
- return ReaderWriter::ReadResult::FILE_NOT_FOUND;
- }
-
- Registry* registry = Registry::instance();
- ReaderWriter::ReadResult res;
- res = registry->readImageImplementation(absFileName, opt);
- if (res.loadedFromCache())
- SG_LOG(SG_IO, SG_INFO, "Returning cached image \""
- << res.getImage()->getFileName() << "\"");
- else
- SG_LOG(SG_IO, SG_INFO, "Reading image \""
- << res.getImage()->getFileName() << "\"");
+ {
+ if (iter != imageCallbackMap.end() && iter->second.valid())
+ return iter->second->readImage(fileName, opt);
+ string absFileName = SGModelLib::findDataFile(fileName, opt);
+ if (!fileExists(absFileName)) {
+ SG_LOG(SG_IO, SG_ALERT, "Cannot find image file \""
+ << fileName << "\"");
+ return ReaderWriter::ReadResult::FILE_NOT_FOUND;
+ }
- return res;
+ Registry* registry = Registry::instance();
+ ReaderWriter::ReadResult res;
+ res = registry->readImageImplementation(absFileName, opt);
+ if (!res.success()) {
+ SG_LOG(SG_IO, SG_WARN, "Image loading failed:" << res.message());
+ return res;
+ }
+
+ if (res.loadedFromCache())
+ SG_LOG(SG_IO, SG_BULK, "Returning cached image \""
+ << res.getImage()->getFileName() << "\"");
+ else
+ SG_LOG(SG_IO, SG_BULK, "Reading image \""
+ << res.getImage()->getFileName() << "\"");
+
+ return res;
+ }
}
osg::Node* cached
= dynamic_cast<Node*>(registry->getFromObjectCache(fileName));
if (cached)
- SG_LOG(SG_IO, SG_INFO, "Got cached model \""
+ SG_LOG(SG_IO, SG_BULK, "Got cached model \""
<< fileName << "\"");
else
- SG_LOG(SG_IO, SG_INFO, "Reading model \""
+ SG_LOG(SG_IO, SG_BULK, "Reading model \""
<< fileName << "\"");
return cached;
}
// STATIC so that textures will be globally shared.
SGTexDataVarianceVisitor dataVarianceVisitor;
node->accept(dataVarianceVisitor);
-
+
SGTexCompressionVisitor texComp;
node->accept(texComp);
return node;
}
-osg::Node* DefaultCopyPolicy::copy(osg::Node* model, const string& fileName,
- const osgDB::ReaderWriter::Options* opt)
-{
- // Add an extra reference to the model stored in the database.
- // That it to avoid expiring the object from the cache even if it is still
- // in use. Note that the object cache will think that a model is unused
- // if the reference count is 1. If we clone all structural nodes here
- // we need that extra reference to the original object
- SGDatabaseReference* databaseReference;
- databaseReference = new SGDatabaseReference(model);
- CopyOp::CopyFlags flags = CopyOp::DEEP_COPY_ALL;
- flags &= ~CopyOp::DEEP_COPY_TEXTURES;
- flags &= ~CopyOp::DEEP_COPY_IMAGES;
- flags &= ~CopyOp::DEEP_COPY_STATESETS;
- flags &= ~CopyOp::DEEP_COPY_STATEATTRIBUTES;
- flags &= ~CopyOp::DEEP_COPY_ARRAYS;
- flags &= ~CopyOp::DEEP_COPY_PRIMITIVES;
- // This will safe display lists ...
- flags &= ~CopyOp::DEEP_COPY_DRAWABLES;
- flags &= ~CopyOp::DEEP_COPY_SHAPES;
- osg::Node* res = CopyOp(flags)(model);
- res->addObserver(databaseReference);
-
- // Update liveries
- SGTextureUpdateVisitor liveryUpdate(opt->getDatabasePathList());
- res->accept(liveryUpdate);
- return res;
-}
-
string OSGSubstitutePolicy::substitute(const string& name,
const ReaderWriter::Options* opt)
{
string fileSansExtension = getNameLessExtension(name);
string osgFileName = fileSansExtension + ".osg";
- string absFileName = findDataFile(osgFileName, opt);
+ string absFileName = SGModelLib::findDataFile(osgFileName, opt);
return absFileName;
}
+
+void
+BuildLeafBVHPolicy::buildBVH(const std::string& fileName, osg::Node* node)
+{
+ SG_LOG(SG_IO, SG_BULK, "Building leaf attached boundingvolume tree for \""
+ << fileName << "\".");
+ BoundingVolumeBuildVisitor bvBuilder(true);
+ node->accept(bvBuilder);
+}
+
+void
+BuildGroupBVHPolicy::buildBVH(const std::string& fileName, osg::Node* node)
+{
+ SG_LOG(SG_IO, SG_BULK, "Building group attached boundingvolume tree for \""
+ << fileName << "\".");
+ BoundingVolumeBuildVisitor bvBuilder(false);
+ node->accept(bvBuilder);
+}
+
+void
+NoBuildBVHPolicy::buildBVH(const std::string& fileName, osg::Node*)
+{
+ SG_LOG(SG_IO, SG_BULK, "Omitting boundingvolume tree for \""
+ << fileName << "\".");
+}
+
ModelRegistry::ModelRegistry() :
_defaultCallback(new DefaultCallback(""))
{
nodeCallbackMap.insert(CallbackMap::value_type(extension, callback));
}
-ref_ptr<ModelRegistry> ModelRegistry::instance;
-
-ModelRegistry* ModelRegistry::getInstance()
-
-{
- if (!instance.valid())
- instance = new ModelRegistry;
- return instance.get();
-}
-
ReaderWriter::ReadResult
ModelRegistry::readNode(const string& fileName,
const ReaderWriter::Options* opt)
{
- OpenThreads::ScopedLock<OpenThreads::ReentrantMutex> lock(readerMutex);
- // XXX Workaround for OSG plugin bug.
- OptionsPusher pusher(opt);
- Registry* registry = Registry::instance();
ReaderWriter::ReadResult res;
- Node* cached = 0;
CallbackMap::iterator iter
= nodeCallbackMap.find(getFileExtension(fileName));
+ ReaderWriter::ReadResult result;
if (iter != nodeCallbackMap.end() && iter->second.valid())
- return iter->second->readNode(fileName, opt);
- return _defaultCallback->readNode(fileName, opt);
+ result = iter->second->readNode(fileName, opt);
+ else
+ result = _defaultCallback->readNode(fileName, opt);
+
+ return result;
}
class SGReadCallbackInstaller {
registry->setOptions(options);
registry->getOrCreateSharedStateManager()->
setShareMode(SharedStateManager::SHARE_STATESETS);
- registry->setReadFileCallback(ModelRegistry::getInstance());
+ registry->setReadFileCallback(ModelRegistry::instance());
}
};
static SGReadCallbackInstaller readCallbackInstaller;
-// we get optimal geometry from the loader.
+// we get optimal geometry from the loader (Hah!).
struct ACOptimizePolicy : public OptimizeModelPolicy {
ACOptimizePolicy(const string& extension) :
OptimizeModelPolicy(extension)
{
_osgOptions &= ~Optimizer::TRISTRIP_GEOMETRY;
}
+ Node* optimize(Node* node, const string& fileName,
+ const ReaderWriter::Options* opt)
+ {
+ ref_ptr<Node> optimized
+ = OptimizeModelPolicy::optimize(node, fileName, opt);
+ Group* group = dynamic_cast<Group*>(optimized.get());
+ MatrixTransform* transform
+ = dynamic_cast<MatrixTransform*>(optimized.get());
+ if (((transform && transform->getMatrix().isIdentity()) || group)
+ && group->getName().empty()
+ && group->getNumChildren() == 1) {
+ optimized = static_cast<Node*>(group->getChild(0));
+ group = dynamic_cast<Group*>(optimized.get());
+ if (group && group->getName().empty()
+ && group->getNumChildren() == 1)
+ optimized = static_cast<Node*>(group->getChild(0));
+ }
+ const SGReaderWriterXMLOptions* sgopt
+ = dynamic_cast<const SGReaderWriterXMLOptions*>(opt);
+ if (sgopt && sgopt->getInstantiateEffects())
+ optimized = instantiateEffects(optimized.get(), sgopt);
+ return optimized.release();
+ }
};
struct ACProcessPolicy {
transform->setDataVariance(Object::STATIC);
transform->setMatrix(m);
transform->addChild(node);
- // Ok, this step is questionable.
- // It is there to have the same visual appearance of ac objects for the
- // first cut. Osg's ac3d loader will correctly set materials from the
- // ac file. But the old plib loader used GL_AMBIENT_AND_DIFFUSE for the
- // materials that in effect igored the ambient part specified in the
- // file. We emulate that for the first cut here by changing all
- // ac models here. But in the long term we should use the
- // unchanged model and fix the input files instead ...
- SGAcMaterialCrippleVisitor matCriple;
- root->accept(matCriple);
+
return root;
}
};
typedef ModelRegistryCallback<ACProcessPolicy, DefaultCachePolicy,
- ACOptimizePolicy, DefaultCopyPolicy,
- OSGSubstitutePolicy> ACCallback;
+ ACOptimizePolicy,
+ OSGSubstitutePolicy, BuildLeafBVHPolicy>
+ACCallback;
namespace
{
ModelRegistryCallbackProxy<ACCallback> g_acRegister("ac");
-}
+}