1 // Copyright (C) 2009 Tim Moore timoore@redhat.com
3 // This library is free software; you can redistribute it and/or
4 // modify it under the terms of the GNU Library General Public
5 // License as published by the Free Software Foundation; either
6 // version 2 of the License, or (at your option) any later version.
8 // This library is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 // Library General Public License for more details.
13 // You should have received a copy of the GNU General Public License
14 // along with this program; if not, write to the Free Software
15 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17 #ifndef SIMGEAR_EFFECTBUILDER_HXX
18 #define SIMGEAR_EFFECTBUILDER_HXX 1
27 #include <osgDB/Registry>
29 #include <boost/bind.hpp>
30 #include <boost/multi_index_container.hpp>
31 #include <boost/multi_index/member.hpp>
32 #include <boost/multi_index/ordered_index.hpp>
34 #include <simgear/props/AtomicChangeListener.hxx>
35 #include <simgear/props/props.hxx>
36 #include <simgear/scene/util/SGReaderWriterOptions.hxx>
37 #include <simgear/structure/exception.hxx>
38 #include <simgear/structure/SGSharedPtr.hxx>
39 #include <simgear/structure/Singleton.hxx>
43 * Support classes for parsing effects.
50 class SGReaderWriterOptions;
53 * Builder that returns an object, probably an OSG object.
56 class EffectBuilder : public SGReferenced
59 virtual ~EffectBuilder() {}
60 virtual T* build(Effect* effect, Pass* pass, const SGPropertyNode*,
61 const SGReaderWriterOptions* options) = 0;
62 static T* buildFromType(Effect* effect, Pass* pass, const std::string& type,
63 const SGPropertyNode*props,
64 const SGReaderWriterOptions* options)
66 BuilderMap& builderMap = getMap();
67 typename BuilderMap::iterator iter = builderMap.find(type);
68 if (iter != builderMap.end())
69 return iter->second->build(effect, pass, props, options);
74 friend struct Registrar;
77 Registrar(const std::string& type, EffectBuilder* builder)
79 getMap().insert(std::make_pair(type, builder));
83 typedef std::map<std::string, SGSharedPtr<EffectBuilder> > BuilderMap;
84 struct BuilderMapSingleton : public simgear::Singleton<BuilderMapSingleton>
88 static BuilderMap& getMap()
90 return BuilderMapSingleton::instance()->_map;
94 // Tables of strings and constants. We want to reconstruct the effect
95 // property tree from OSG state sets, so the tables should be bi-directional.
97 // two-way map for building StateSets from property descriptions, and
98 // vice versa. Mostly copied from the boost documentation.
102 using boost::multi_index_container;
103 using namespace boost::multi_index;
105 // tags for accessing both sides of a bidirectional map
110 template <typename T>
111 struct EffectNameValue
113 // Don't use std::pair because we want to use aggregate intialization.
118 // The class template bidirectional_map wraps the specification
119 // of a bidirectional map based on multi_index_container.
121 template<typename FromType,typename ToType>
122 struct bidirectional_map
128 value_type(FromType f, ToType s) : first(f),second(s){}
131 typedef std::pair<FromType,ToType> value_type;
134 /* A bidirectional map can be simulated as a multi_index_container
135 * of pairs of (FromType,ToType) with two unique indices, one
136 * for each member of the pair.
138 typedef multi_index_container<
142 tag<from>, member<value_type, FromType, &value_type::first> >,
144 tag<to>, member<value_type, ToType, &value_type::second> >
150 struct EffectPropertyMap
152 typedef typename bidirectional_map<std::string, T>::type BMap;
155 EffectPropertyMap(const EffectNameValue<T> (&attrs)[N]);
160 EffectPropertyMap<T>::EffectPropertyMap(const EffectNameValue<T> (&attrs)[N])
162 for (int i = 0; i < N; ++i)
163 _map.insert(typename BMap::value_type(attrs[i].first, attrs[i].second));
166 // A one-way map that can be initialized using an array
168 struct SimplePropertyMap
170 typedef std::map<string, T> map_type;
173 SimplePropertyMap(const EffectNameValue<T> (&attrs)[N])
175 for (int i = 0; i < N; ++i)
176 _map.insert(typename map_type::value_type(attrs[i].first,
181 class BuilderException : public sg_exception
185 BuilderException(const char* message, const char* origin = 0);
186 BuilderException(const std::string& message, const std::string& = "");
187 virtual ~BuilderException() throw();
192 void findAttr(const effect::EffectPropertyMap<T>& pMap,
196 using namespace effect;
197 typename EffectPropertyMap<T>::BMap::iterator itr
198 = pMap._map.template get<from>().find(name);
199 if (itr == pMap._map.end()) {
200 throw effect::BuilderException(string("findAttr: could not find attribute ")
203 result = itr->second;
208 inline void findAttr(const effect::EffectPropertyMap<T>& pMap,
209 const std::string& name,
212 findAttr(pMap, name.c_str(), result);
216 void findAttr(const effect::EffectPropertyMap<T>& pMap,
217 const SGPropertyNode* prop,
221 throw effect::BuilderException("findAttr: empty property");
222 const char* name = prop->getStringValue();
224 throw effect::BuilderException("findAttr: no name for lookup");
225 findAttr(pMap, name, result);
228 // Versions that don't throw an error
231 const T* findAttr(const effect::EffectPropertyMap<T>& pMap,
234 using namespace effect;
235 typename EffectPropertyMap<T>::BMap::iterator itr
236 = pMap._map.template get<from>().find(name);
237 if (itr == pMap._map.end())
244 const T* findAttr(const effect::SimplePropertyMap<T>& pMap,
247 using namespace effect;
248 typename SimplePropertyMap<T>::map_type::const_iterator itr
249 = pMap._map.find(name);
250 if (itr == pMap._map.end())
256 template<typename T, template<class> class Map>
257 const T* findAttr(const Map<T>& pMap,
258 const std::string& name)
260 return findAttr(pMap, name.c_str());
265 std::string findName(const effect::EffectPropertyMap<T>& pMap, T value)
267 using namespace effect;
269 typename EffectPropertyMap<T>::BMap::template index_iterator<to>::type itr
270 = pMap._map.template get<to>().find(value);
271 if (itr != pMap._map.template get<to>().end())
277 std::string findName(const effect::EffectPropertyMap<T>& pMap, GLenum value)
279 return findName(pMap, static_cast<T>(value));
283 * Given a property node from a pass, get its value either from it or
284 * from the effect parameters.
287 const SGPropertyNode* getEffectPropertyNode(Effect* effect,
288 const SGPropertyNode* prop);
290 * Get a named child property from pass parameters or effect
293 const SGPropertyNode* getEffectPropertyChild(Effect* effect,
294 const SGPropertyNode* prop,
298 * Get the name of a node mentioned in a <use> clause from the global property
300 * @return empty if prop doesn't contain a <use> clause; otherwise the
301 * mentioned node name.
303 std::string getGlobalProperty(const SGPropertyNode* prop,
304 const SGReaderWriterOptions *);
306 template<typename NameItr>
307 std::vector<std::string>
308 getVectorProperties(const SGPropertyNode* prop,
309 const SGReaderWriterOptions *options, size_t vecSize,
310 NameItr defaultNames)
313 vector<string> result;
316 PropertyList useProps = prop->getChildren("use");
317 if (useProps.size() == 1) {
318 string parentName = useProps[0]->getStringValue();
319 if (parentName.size() == 0 || parentName[0] != '/')
320 parentName = options->getPropertyNode()->getPath() + "/" + parentName;
321 if (parentName[parentName.size() - 1] != '/')
322 parentName.append("/");
323 NameItr itr = defaultNames;
324 for (size_t i = 0; i < vecSize; ++i, ++itr)
325 result.push_back(parentName + *itr);
326 } else if (useProps.size() == vecSize) {
327 string parentName = useProps[0]->getStringValue();
329 for (PropertyList::const_iterator itr = useProps.begin(),
330 end = useProps.end();
333 string childName = (*itr)->getStringValue();
334 if (childName.size() == 0 || childName[0] != '/')
335 result.push_back(parentName + childName);
337 result.push_back(childName);
343 class PassAttributeBuilder : public SGReferenced
346 typedef std::map<const std::string, SGSharedPtr<PassAttributeBuilder> >
349 struct PassAttrMapSingleton : public simgear::Singleton<PassAttrMapSingleton>
351 PassAttrMap passAttrMap;
355 virtual ~PassAttributeBuilder(); // anchor into the compilation unit.
357 virtual void buildAttribute(Effect* effect, Pass* pass,
358 const SGPropertyNode* prop,
359 const SGReaderWriterOptions* options)
361 static PassAttributeBuilder* find(const std::string& str)
363 PassAttrMap::iterator itr
364 = PassAttrMapSingleton::instance()->passAttrMap.find(str);
365 if (itr == PassAttrMapSingleton::instance()->passAttrMap.end())
368 return itr->second.ptr();
370 template<typename T> friend struct InstallAttributeBuilder;
374 struct InstallAttributeBuilder
376 InstallAttributeBuilder(const string& name)
378 PassAttributeBuilder::PassAttrMapSingleton::instance()
379 ->passAttrMap.insert(make_pair(name, new T));
383 // The description of an attribute may exist in a pass' XML, but a
384 // derived effect might want to disable the attribute altogether. So,
385 // some attributes have an "active" property; if it exists and is
386 // false, the OSG attribute is not built at all. This is different
387 // from any OSG mode settings that might be around.
388 bool isAttributeActive(Effect* effect, const SGPropertyNode* prop);
393 * Bridge between types stored in properties and what OSG or the
396 template<typename T> struct Bridge;
399 * Default just passes on the same type.
406 static T get(const T& val) { return val; }
410 struct Bridge<const T> : public Bridge<T>
414 // Save some typing...
415 template<typename InType, typename OutType>
418 typedef InType sg_type;
419 static OutType get(const InType& val) { return toOsg(val); }
422 struct Bridge<osg::Vec3f> : public BridgeOSGVec<SGVec3d, osg::Vec3f>
427 struct Bridge<osg::Vec3d> : public BridgeOSGVec<SGVec3d, osg::Vec3d>
432 struct Bridge<osg::Vec4f> : public BridgeOSGVec<SGVec4d, osg::Vec4f>
437 struct Bridge<osg::Vec4d> : public BridgeOSGVec<SGVec4d, osg::Vec4d>
442 * Functor for calling a function on an osg::Referenced object and a
443 * value (e.g., an SGVec4d from a property) which will be converted to
444 * the equivalent OSG type.
446 * General version, function takes obj, val
448 template<typename OSGParam, typename Obj, typename Func>
449 struct OSGFunctor : public Bridge<OSGParam>
451 OSGFunctor(Obj* obj, const Func& func)
452 : _obj(obj), _func(func) {}
453 void operator()(const typename Bridge<OSGParam>::sg_type& val) const
455 _func(_obj, this->get(val));
457 osg::ref_ptr<Obj>_obj;
462 * Version which uses a pointer to member function instead.
464 template<typename OSGParam, typename Obj>
465 struct OSGFunctor<OSGParam, Obj, void (Obj::* const)(const OSGParam&)>
466 : public Bridge<OSGParam>
468 typedef void (Obj::*const MemFunc)(const OSGParam&);
469 OSGFunctor(Obj* obj, MemFunc func)
470 : _obj(obj), _func(func) {}
471 void operator()(const typename Bridge<OSGParam>::sg_type& val) const
473 (_obj->*_func)(this->get(val));
475 osg::ref_ptr<Obj>_obj;
480 * Typical convenience constructors
482 template<typename OSGParam, typename Obj, typename Func>
483 OSGFunctor<OSGParam, Obj, Func> make_OSGFunctor(Obj* obj, const Func& func)
485 return OSGFunctor<OSGParam, Obj, Func>(obj, func);
488 template<typename OSGParam, typename Obj>
489 OSGFunctor<OSGParam, Obj, void (Obj::*const)(const OSGParam&)>
490 make_OSGFunctor(Obj* obj, void (Obj::*const func)(const OSGParam&))
492 return OSGFunctor<OSGParam, Obj,
493 void (Obj::* const)(const OSGParam&)>(obj, func);
496 template<typename OSGParamType, typename ObjType, typename F>
497 class ScalarChangeListener
498 : public SGPropertyChangeListener, public InitializeWhenAdded,
499 public Effect::Updater
502 ScalarChangeListener(ObjType* obj, const F& setter,
503 const std::string& propName)
504 : _obj(obj), _setter(setter)
506 _propName = new std::string(propName);
508 virtual ~ScalarChangeListener()
513 void valueChanged(SGPropertyNode* node)
515 _setter(_obj.get(), node->getValue<OSGParamType>());
517 void initOnAddImpl(Effect* effect, SGPropertyNode* propRoot)
519 SGPropertyNode* listenProp = makeNode(propRoot, *_propName);
523 listenProp->addChangeListener(this, true);
526 osg::ref_ptr<ObjType> _obj;
528 std::string* _propName;
531 template<typename T, typename Func>
532 class EffectExtendedPropListener : public InitializeWhenAdded,
533 public Effect::Updater
536 template<typename Itr>
537 EffectExtendedPropListener(const Func& func,
538 const std::string* propName, Itr childNamesBegin,
540 : _propName(0), _func(func)
543 _propName = new std::string(*propName);
544 _childNames = new std::vector<std::string>(childNamesBegin,
547 virtual ~EffectExtendedPropListener()
552 void initOnAddImpl(Effect* effect, SGPropertyNode* propRoot)
554 SGPropertyNode* parent = 0;
556 parent = propRoot->getNode(*_propName, true);
560 = new ExtendedPropListener<T, Func>(parent, _childNames->begin(),
569 std::string* _propName;
570 std::vector<std::string>* _childNames;
571 SGSharedPtr<ExtendedPropListener<T, Func> > _propListener;
575 template<typename T, typename Func, typename Itr>
577 new_EEPropListener(const Func& func, const std::string* propName,
578 const Itr& namesBegin, const Itr& namesEnd)
580 return new EffectExtendedPropListener<T, Func>
581 (func, 0, namesBegin, namesEnd);
585 * Set DYNAMIC data variance on an osg::Object.
588 inline void setDynamicVariance(void* obj)
592 inline void setDynamicVariance(osg::Object* obj)
594 obj->setDataVariance(osg::Object::DYNAMIC);
598 * Initialize the value and the possible updating of an effect
599 * attribute. If the value is specified directly, set it. Otherwise,
600 * use the <use> tag to look at the parameters. Again, if there is a
601 * value there set it directly. Otherwise, the parameter contains its
602 * own <use> tag referring to a property in the global property tree;
603 * install a change listener that will set the attribute when the
606 * For relative property names, the property root found in options is
609 template<typename OSGParamType, typename ObjType, typename F>
611 initFromParameters(Effect* effect, const SGPropertyNode* prop, ObjType* obj,
612 const F& setter, const SGReaderWriterOptions* options)
614 const SGPropertyNode* valProp = getEffectPropertyNode(effect, prop);
617 setDynamicVariance(obj);
618 if (valProp->nChildren() == 0) {
619 setter(obj, valProp->getValue<OSGParamType>());
621 std::string propName = getGlobalProperty(valProp, options);
622 ScalarChangeListener<OSGParamType, ObjType, F>* listener
623 = new ScalarChangeListener<OSGParamType, ObjType, F>(obj, setter,
625 effect->addUpdater(listener);
629 template<typename OSGParamType, typename ObjType, typename SetterReturn>
631 initFromParameters(Effect* effect, const SGPropertyNode* prop, ObjType* obj,
632 SetterReturn (ObjType::*setter)(const OSGParamType),
633 const SGReaderWriterOptions* options)
635 initFromParameters<OSGParamType>(effect, prop, obj,
636 boost::bind(setter, _1, _2), options);
640 * Initialize vector parameters from individual properties.
641 * The parameter may be updated at runtime.
643 * If the value is specified directly, set it. Otherwise, use the
644 * <use> tag to look at the parameters. Again, if there is a value
645 * there set it directly. Otherwise, the parameter contains one or several
646 * <use> tags. If there is one tag, it is a property that is the root
647 * for the values needed to update the parameter; nameIter holds the
648 * names of the properties relative to the root. If there are several
649 * <use> tags, they each hold the name of the property holding the
650 * value for the corresponding vector member.
652 * Install a change listener that will set the attribute when the
655 * For relative property names, the property root found in options is
658 template<typename OSGParamType, typename ObjType, typename NameItrType,
661 initFromParameters(Effect* effect, const SGPropertyNode* prop, ObjType* obj,
663 NameItrType nameItr, const SGReaderWriterOptions* options)
665 typedef typename Bridge<OSGParamType>::sg_type sg_type;
666 const int numComponents = props::NumComponents<sg_type>::num_components;
667 const SGPropertyNode* valProp = getEffectPropertyNode(effect, prop);
670 setDynamicVariance(obj);
671 if (valProp->nChildren() == 0) { // Has <use>?
672 setter(obj, Bridge<OSGParamType>::get(valProp->getValue<sg_type>()));
674 std::vector<std::string> paramNames
675 = getVectorProperties(valProp, options,numComponents, nameItr);
676 if (paramNames.empty())
677 throw BuilderException();
678 std::vector<std::string>::const_iterator pitr = paramNames.begin();
679 Effect::Updater* listener
680 = new_EEPropListener<sg_type>(make_OSGFunctor<OSGParamType>
682 0, pitr, pitr + numComponents);
683 effect->addUpdater(listener);
687 template<typename OSGParamType, typename ObjType, typename NameItrType,
688 typename SetterReturn>
690 initFromParameters(Effect* effect, const SGPropertyNode* prop, ObjType* obj,
691 SetterReturn (ObjType::*setter)(const OSGParamType&),
692 NameItrType nameItr, const SGReaderWriterOptions* options)
694 initFromParameters<OSGParamType>(effect, prop, obj,
695 boost::bind(setter, _1, _2), nameItr,
698 extern const char* colorFields[];