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 <osg/observer_ptr>
28 #include <osgDB/ReaderWriter>
30 #include <simgear/props/props.hxx>
31 #include <simgear/scene/util/UpdateOnceCallback.hxx>
49 class SGReaderWriterOptions;
52 * Object to be initialized at some point after an effect -- and its
53 * containing effect geode -- are hooked into the scene graph. Some
54 * things, like manipulations of the global property tree, are are
55 * only safe in the update process.
58 class InitializeWhenAdded
61 InitializeWhenAdded() : _initialized(false) {};
62 virtual ~InitializeWhenAdded() {};
63 void initOnAdd(Effect* effect, SGPropertyNode* propRoot)
66 initOnAddImpl(effect, propRoot);
70 bool getInitialized() const { return _initialized; }
72 virtual void initOnAddImpl(Effect* effect, SGPropertyNode* propRoot) = 0;
76 class Effect : public osg::Object
79 META_Object(simgear,Effect)
81 Effect(const Effect& rhs,
82 const osg::CopyOp& copyop = osg::CopyOp::SHALLOW_COPY);
83 osg::StateSet* getDefaultStateSet();
85 // Define what needs to be generated for this effect
92 void setGenerator(Generator what, int where) { generator[what] = where; }
93 int getGenerator(Generator what) const; // Returns -1 if generator should not be used
94 std::map<Generator, int> generator; // What is generated into which attribute location
96 std::vector<osg::ref_ptr<Technique> > techniques;
97 SGPropertyNode_ptr root;
98 // Pointer to the parameters node, if it exists
99 SGPropertyNode_ptr parametersProp;
100 Technique* chooseTechnique(osg::RenderInfo* renderInfo);
101 virtual void resizeGLObjectBuffers(unsigned int maxSize);
102 virtual void releaseGLObjects(osg::State* state = 0) const;
104 * Build the techniques from the effect properties.
106 bool realizeTechniques(const SGReaderWriterOptions* options = 0);
108 * Updaters that should be derefed when the effect is
109 * deleted. Updaters arrange to be run by listening on properties
112 struct Updater : public virtual SGReferenced
114 virtual ~Updater() {}
116 void addUpdater(Updater* data) { _extraData.push_back(data); }
117 // Callback that is added to the effect geode to initialize the
119 friend struct InitializeCallback;
120 struct InitializeCallback : public UpdateOnceCallback
122 void doUpdate(osg::Node* node, osg::NodeVisitor* nv);
125 std::vector<SGSharedPtr<Updater> > _extraData;
127 // Support for a cache of effects that inherit from this one, so
128 // Effect objects with the same parameters and techniques can be
133 Key(SGPropertyNode* unmerged_, const osgDB::FilePathList& paths_)
134 : unmerged(unmerged_), paths(paths_)
137 Key& operator=(const Key& rhs)
139 unmerged = rhs.unmerged;
143 SGPropertyNode_ptr unmerged;
144 osgDB::FilePathList paths;
147 bool operator()(const Key& lhs, const Key& rhs) const;
150 typedef std::tr1::unordered_map<Key, osg::observer_ptr<Effect>,
151 boost::hash<Key>, Key::EqualTo> Cache;
159 friend size_t hash_value(const Key& key);
160 friend Effect* makeEffect(SGPropertyNode* prop, bool realizeTechniques,
161 const SGReaderWriterOptions* options);
164 // Automatic support for boost hash function
165 size_t hash_value(const Effect::Key&);
168 Effect* makeEffect(const std::string& name,
169 bool realizeTechniques,
170 const SGReaderWriterOptions* options);
172 Effect* makeEffect(SGPropertyNode* prop,
173 bool realizeTechniques,
174 const SGReaderWriterOptions* options);
176 bool makeParametersFromStateSet(SGPropertyNode* paramRoot,
177 const osg::StateSet* ss);
179 void clearEffectCache();
184 * The function that implements effect property tree inheritance.
186 void mergePropertyTrees(SGPropertyNode* resultNode,
187 const SGPropertyNode* left,
188 const SGPropertyNode* right);