1 // Copyright (C) 2008 - 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_EFFECT_HXX
18 #define SIMGEAR_EFFECT_HXX 1
22 #include <boost/tr1/unordered_map.hpp>
24 #include <boost/functional/hash.hpp>
27 #include <osgDB/ReaderWriter>
29 #include <simgear/props/props.hxx>
30 #include <simgear/scene/util/UpdateOnceCallback.hxx>
48 class SGReaderWriterOptions;
51 * Object to be initialized at some point after an effect -- and its
52 * containing effect geode -- are hooked into the scene graph. Some
53 * things, like manipulations of the global property tree, are are
54 * only safe in the update process.
57 class InitializeWhenAdded
60 InitializeWhenAdded() : _initialized(false) {};
61 virtual ~InitializeWhenAdded() {};
62 void initOnAdd(Effect* effect, SGPropertyNode* propRoot)
65 initOnAddImpl(effect, propRoot);
69 bool getInitialized() const { return _initialized; }
71 virtual void initOnAddImpl(Effect* effect, SGPropertyNode* propRoot) = 0;
75 class Effect : public osg::Object
78 META_Object(simgear,Effect)
80 Effect(const Effect& rhs,
81 const osg::CopyOp& copyop = osg::CopyOp::SHALLOW_COPY);
82 osg::StateSet* getDefaultStateSet();
97 // Define what needs to be generated for this effect
104 void setGenerator(Generator what, int where) { generator[what] = where; }
105 int getGenerator(Generator what) const; // Returns -1 if generator should not be used
106 std::map<Generator, int> generator; // What is generated into which attribute location
108 std::vector<osg::ref_ptr<Technique> > techniques;
109 SGPropertyNode_ptr root;
110 // Pointer to the parameters node, if it exists
111 SGPropertyNode_ptr parametersProp;
112 Technique* chooseTechnique(osg::RenderInfo* renderInfo);
113 virtual void resizeGLObjectBuffers(unsigned int maxSize);
114 virtual void releaseGLObjects(osg::State* state = 0) const;
116 * Build the techniques from the effect properties.
118 bool realizeTechniques(const SGReaderWriterOptions* options = 0);
120 * Updaters that should be derefed when the effect is
121 * deleted. Updaters arrange to be run by listening on properties
124 struct Updater : public virtual SGReferenced
126 virtual ~Updater() {}
128 void addUpdater(Updater* data) { _extraData.push_back(data); }
129 // Callback that is added to the effect geode to initialize the
131 friend struct InitializeCallback;
132 struct InitializeCallback : public UpdateOnceCallback
134 void doUpdate(osg::Node* node, osg::NodeVisitor* nv);
137 std::vector<SGSharedPtr<Updater> > _extraData;
139 // Support for a cache of effects that inherit from this one, so
140 // Effect objects with the same parameters and techniques can be
145 Key(SGPropertyNode* unmerged_, const osgDB::FilePathList& paths_)
146 : unmerged(unmerged_), paths(paths_)
149 Key& operator=(const Key& rhs)
151 unmerged = rhs.unmerged;
155 SGPropertyNode_ptr unmerged;
156 osgDB::FilePathList paths;
159 bool operator()(const Key& lhs, const Key& rhs) const;
162 typedef std::tr1::unordered_map<Key, osg::ref_ptr<Effect>,
163 boost::hash<Key>, Key::EqualTo> Cache;
171 friend size_t hash_value(const Key& key);
172 friend Effect* makeEffect(SGPropertyNode* prop, bool realizeTechniques,
173 const SGReaderWriterOptions* options);
176 // Automatic support for boost hash function
177 size_t hash_value(const Effect::Key&);
180 Effect* makeEffect(const std::string& name,
181 bool realizeTechniques,
182 const SGReaderWriterOptions* options = 0);
184 Effect* makeEffect(SGPropertyNode* prop,
185 bool realizeTechniques,
186 const SGReaderWriterOptions* options = 0);
188 bool makeParametersFromStateSet(SGPropertyNode* paramRoot,
189 const osg::StateSet* ss);
194 * The function that implements effect property tree inheritance.
196 void mergePropertyTrees(SGPropertyNode* resultNode,
197 const SGPropertyNode* left,
198 const SGPropertyNode* right);