#define SIMGEAR_EFFECTBUILDER_HXX 1
#include <algorithm>
+#include <iterator>
#include <map>
#include <string>
#include <cstring>
#include <osgDB/Registry>
+#include <boost/bind.hpp>
#include <boost/multi_index_container.hpp>
#include <boost/multi_index/member.hpp>
#include <boost/multi_index/ordered_index.hpp>
+#include <simgear/math/SGMath.hxx>
+#include <simgear/props/AtomicChangeListener.hxx>
#include <simgear/props/props.hxx>
#include <simgear/structure/exception.hxx>
#include <simgear/structure/SGSharedPtr.hxx>
#include <simgear/structure/Singleton.hxx>
+#include "Effect.hxx"
/**
* Support classes for parsing effects.
*/
namespace simgear
{
class Effect;
+class Pass;
/**
* Builder that returns an object, probably an OSG object.
_map.insert(typename BMap::value_type(attrs[i].first, attrs[i].second));
}
+class BuilderException : public sg_exception
+{
+public:
+ BuilderException();
+ BuilderException(const char* message, const char* origin = 0);
+ BuilderException(const std::string& message, const std::string& = "");
+ virtual ~BuilderException() throw();
+};
}
template<typename T>
-bool findAttr(const effect::EffectPropertyMap<T>& pMap,
- const SGPropertyNode* prop,
+void findAttr(const effect::EffectPropertyMap<T>& pMap,
+ const char* name,
T& result)
{
using namespace effect;
- if (!prop)
- return false;
- const char* name = prop->getStringValue();
- if (!name)
- return false;
typename EffectPropertyMap<T>::BMap::iterator itr
= pMap._map.get<from>().find(name);
if (itr == pMap._map.end()) {
- return false;
+ throw effect::BuilderException(string("findAttr: could not find attribute ")
+ + string(name));
} else {
result = itr->second;
- return true;
}
}
+template<typename T>
+inline void findAttr(const effect::EffectPropertyMap<T>& pMap,
+ const std::string& name,
+ T& result)
+{
+ findAttr(pMap, name.c_str(), result);
+}
+
+template<typename T>
+void findAttr(const effect::EffectPropertyMap<T>& pMap,
+ const SGPropertyNode* prop,
+ T& result)
+{
+ if (!prop)
+ throw effect::BuilderException("findAttr: empty property");
+ const char* name = prop->getStringValue();
+ if (!name)
+ throw effect::BuilderException("findAttr: no name for lookup");
+ findAttr(pMap, name, result);
+}
+
template<typename T>
std::string findName(const effect::EffectPropertyMap<T>& pMap, T value)
{
const SGPropertyNode* prop,
const char* name);
-class BuilderException : public sg_exception
+/**
+ * Get the name of a node mentioned in a <use> clause from the global property
+ * tree.
+ * @return empty if prop doesn't contain a <use> clause; otherwise the
+ * mentioned node name.
+ */
+std::string getGlobalProperty(const SGPropertyNode* prop);
+
+class PassAttributeBuilder : public SGReferenced
{
+protected:
+ typedef std::map<const std::string, SGSharedPtr<PassAttributeBuilder> >
+ PassAttrMap;
+
+ struct PassAttrMapSingleton : public simgear::Singleton<PassAttrMapSingleton>
+ {
+ PassAttrMap passAttrMap;
+ };
public:
- BuilderException();
- BuilderException(const char* message, const char* origin = 0);
- BuilderException(const std::string& message, const std::string& = "");
- virtual ~BuilderException() throw();
+ virtual void buildAttribute(Effect* effect, Pass* pass,
+ const SGPropertyNode* prop,
+ const osgDB::ReaderWriter::Options* options)
+ = 0;
+ static PassAttributeBuilder* find(const std::string& str)
+ {
+ PassAttrMap::iterator itr
+ = PassAttrMapSingleton::instance()->passAttrMap.find(str);
+ if (itr == PassAttrMapSingleton::instance()->passAttrMap.end())
+ return 0;
+ else
+ return itr->second.ptr();
+ }
+ template<typename T> friend struct InstallAttributeBuilder;
+};
+
+template<typename T>
+struct InstallAttributeBuilder
+{
+ InstallAttributeBuilder(const string& name)
+ {
+ PassAttributeBuilder::PassAttrMapSingleton::instance()
+ ->passAttrMap.insert(make_pair(name, new T));
+ }
+};
+
+// The description of an attribute may exist in a pass' XML, but a
+// derived effect might want to disable the attribute altogether. So,
+// some attributes have an "active" property; if it exists and is
+// false, the OSG attribute is not built at all. This is different
+// from any OSG mode settings that might be around.
+bool isAttributeActive(Effect* effect, const SGPropertyNode* prop);
+
+namespace effect
+{
+/**
+ * Bridge between types stored in properties and what OSG wants.
+ */
+template<typename T> struct OSGBridge;
+
+template<typename T>
+struct OSGBridge<const T> : public OSGBridge<T>
+{
+};
+
+template<>
+struct OSGBridge<osg::Vec3f>
+{
+ typedef SGVec3d sg_type;
+ static osg::Vec3f getOsgType(const SGVec3d& val) { return toOsg(val); }
+};
+
+template<>
+struct OSGBridge<osg::Vec3d>
+{
+ typedef SGVec3d sg_type;
+ static osg::Vec3d getOsgType(const SGVec3d& val) { return toOsg(val); }
+};
+
+template<>
+struct OSGBridge<osg::Vec4f>
+{
+ typedef SGVec4d sg_type;
+ static osg::Vec4f getOsgType(const SGVec4d& val) { return toOsg(val); }
+};
+
+template<>
+struct OSGBridge<osg::Vec4d>
+{
+ typedef SGVec4d sg_type;
+ static osg::Vec4d getOsgType(const SGVec4d& val) { return toOsg(val); }
};
+
+template<typename Obj, typename OSGParam>
+struct OSGFunctor : public OSGBridge<OSGParam>
+{
+ OSGFunctor(Obj* obj, void (Obj::*func)(const OSGParam&))
+ : _obj(obj), _func(func) {}
+ void operator()(const typename OSGBridge<OSGParam>::sg_type& val) const
+ {
+ ((_obj.get())->*_func)(this->getOsgType(val));
+ }
+ osg::ref_ptr<Obj>_obj;
+ void (Obj::*_func)(const OSGParam&);
+};
+
+template<typename ObjType, typename OSGParamType>
+class ScalarChangeListener
+ : public SGPropertyChangeListener, public InitializeWhenAdded,
+ public Effect::Updater
+{
+public:
+ typedef void (ObjType::*setter_type)(const OSGParamType);
+ ScalarChangeListener(ObjType* obj, setter_type setter,
+ const std::string& propName)
+ : _obj(obj), _setter(setter)
+ {
+ _propName = new std::string(propName);
+ }
+ virtual ~ScalarChangeListener()
+ {
+ delete _propName;
+ _propName = 0;
+ }
+ void valueChanged(SGPropertyNode* node)
+ {
+ _obj->*setter(node->getValue<OSGParamType>());
+ }
+ void initOnAddImpl(Effect* effect, SGPropertyNode* propRoot)
+ {
+ SGPropertyNode* listenProp = makeNode(propRoot, *_propName);
+ delete _propName;
+ _propName = 0;
+ if (listenProp)
+ listenProp->addChangeListener(this, true);
+ }
+private:
+ osg::ref_ptr<ObjType> _obj;
+ setter_type _setter;
+ std::string* _propName;
+};
+
+template<typename T, typename Func>
+class EffectExtendedPropListener : public InitializeWhenAdded,
+ public Effect::Updater
+{
+public:
+ template<typename Itr>
+ EffectExtendedPropListener(const Func& func,
+ const std::string& propName, Itr childNamesBegin,
+ Itr childNamesEnd)
+ : _func(func)
+ {
+ _propName = new std::string(propName);
+ _childNames = new std::vector<std::string>(childNamesBegin,
+ childNamesEnd);
+ }
+ virtual ~EffectExtendedPropListener()
+ {
+ delete _propName;
+ delete _childNames;
+ }
+ void initOnAddImpl(Effect* effect, SGPropertyNode* propRoot)
+ {
+ SGPropertyNode* parent = propRoot->getNode(*_propName, true);
+ _propListener
+ = new ExtendedPropListener<T, Func>(parent, _childNames->begin(),
+ _childNames->end(),
+ _func, true);
+ delete _propName;
+ _propName = 0;
+ delete _childNames;
+ _childNames = 0;
+ }
+private:
+ std::string* _propName;
+ std::vector<std::string>* _childNames;
+ SGSharedPtr<ExtendedPropListener<T, Func> > _propListener;
+ Func _func;
+};
+
+/**
+ * Initialize the value and the possible updating of an effect
+ * attribute. If the value is specified directly, set it. Otherwise,
+ * use the <use> tag to look at the parameters. Again, if there is a
+ * value there set it directly. Otherwise, the parameter contains its
+ * own <use> tag referring to a property in the global property tree;
+ * install a change listener that will set the attribute when the
+ * property changes.
+ */
+template<typename ObjType, typename OSGParamType>
+void
+initFromParameters(Effect* effect, const SGPropertyNode* prop, ObjType* obj,
+ void (ObjType::*setter)(const OSGParamType))
+{
+ const SGPropertyNode* valProp = getEffectPropertyNode(effect, prop);
+ if (!valProp)
+ return;
+ if (valProp->nChildren() == 0) {
+ obj->*setter(valProp->getValue<OSGParamType>());
+ } else {
+ std::string propName = getGlobalProperty(prop);
+ ScalarChangeListener<ObjType, OSGParamType>* listener
+ = new ScalarChangeListener<ObjType, OSGParamType>(obj, setter,
+ propName);
+ effect->addUpdater(listener);
+ }
+}
+
+template<typename ObjType, typename OSGParamType, typename NameItrType>
+void
+initFromParameters(Effect* effect, const SGPropertyNode* prop, ObjType* obj,
+ void (ObjType::*setter)(const OSGParamType&),
+ NameItrType nameItr)
+{
+ typedef typename OSGBridge<OSGParamType>::sg_type sg_type;
+ const SGPropertyNode* valProp = getEffectPropertyNode(effect, prop);
+ if (!valProp)
+ return;
+ if (valProp->nChildren() == 0) {
+ (obj->*setter)(OSGBridge<OSGParamType>
+ ::getOsgType(valProp->getValue<sg_type>()));
+ } else {
+ string listenPropName = getGlobalProperty(valProp);
+ if (listenPropName.empty())
+ return;
+ typedef OSGFunctor<ObjType, OSGParamType> Functor;
+ Effect::Updater* listener
+ = new EffectExtendedPropListener<sg_type, Functor>
+ (Functor(obj, setter), listenPropName, nameItr,
+ nameItr + props::NumComponents<sg_type>::num_components);
+ effect->addUpdater(listener);
+ }
+}
+
+extern const char* colorFields[];
+}
}
#endif
projects / simgear.git / blobdiff