simgear/scene/material/Effect.hxx

   1 // Copyright (C) 2008 - 2009  Tim Moore timoore@redhat.com
   2 //
   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.
   7 //
   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.
  12 //
  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.
  16
  17 #ifndef SIMGEAR_EFFECT_HXX
  18 #define SIMGEAR_EFFECT_HXX 1
  19
  20 #include <vector>
  21 #include <string>
  22 #include <boost/tr1/unordered_map.hpp>
  23
  24 #include <boost/functional/hash.hpp>
  25
  26 #include <osg/Object>
  27 #include <osgDB/ReaderWriter>
  28
  29 #include <simgear/props/props.hxx>
  30 #include <simgear/scene/util/UpdateOnceCallback.hxx>
  31
  32 namespace osg
  33 {
  34 class Drawable;
  35 class StateSet;
  36 class RenderInfo;
  37 }
  38
  39 namespace osgUtil
  40 {
  41 class CullVisitor;
  42 }
  43
  44 namespace simgear
  45 {
  46 class Technique;
  47 class Effect;
  48 class SGReaderWriterXMLOptions;
  49
  50 /**
  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.
  55  */
  56
  57 class InitializeWhenAdded
  58 {
  59 public:
  60     InitializeWhenAdded() : _initialized(false) {};
  61     virtual ~InitializeWhenAdded() {};
  62     void initOnAdd(Effect* effect, SGPropertyNode* propRoot)
  63     {
  64         if (!_initialized) {
  65             initOnAddImpl(effect, propRoot);
  66             _initialized = true;
  67         }
  68     }
  69     bool getInitialized() const { return _initialized; }
  70 private:
  71     virtual void initOnAddImpl(Effect* effect, SGPropertyNode* propRoot) = 0;
  72     bool _initialized;
  73 };
  74
  75 class Effect : public osg::Object
  76 {
  77 public:
  78     META_Object(simgear,Effect)
  79     Effect();
  80     Effect(const Effect& rhs,
  81            const osg::CopyOp& copyop = osg::CopyOp::SHALLOW_COPY);
  82     osg::StateSet* getDefaultStateSet();
  83     std::vector<osg::ref_ptr<Technique> > techniques;
  84     SGPropertyNode_ptr root;
  85     // Pointer to the parameters node, if it exists
  86     SGPropertyNode_ptr parametersProp;
  87     Technique* chooseTechnique(osg::RenderInfo* renderInfo);
  88     virtual void resizeGLObjectBuffers(unsigned int maxSize);
  89     virtual void releaseGLObjects(osg::State* state = 0) const;
  90     /**
  91      * Build the techniques from the effect properties.
  92      */
  93     bool realizeTechniques(const SGReaderWriterXMLOptions* options = 0);
  94     /**
  95      * Updaters that should be derefed when the effect is
  96      * deleted. Updaters arrange to be run by listening on properties
  97      * or something.
  98      */
  99     struct Updater : public virtual SGReferenced
 100     {
 101         virtual ~Updater() {}
 102     };
 103     void addUpdater(Updater* data) { _extraData.push_back(data); }
 104     // Callback that is added to the effect geode to initialize the
 105     // effect.
 106     friend struct InitializeCallback;
 107     struct InitializeCallback : public UpdateOnceCallback
 108     {
 109         void doUpdate(osg::Node* node, osg::NodeVisitor* nv);
 110     };
 111 protected:
 112     std::vector<SGSharedPtr<Updater> > _extraData;
 113     ~Effect();
 114     // Support for a cache of effects that inherit from this one, so
 115     // Effect objects with the same parameters and techniques can be
 116     // shared.
 117     struct Key
 118     {
 119         Key() {}
 120         Key(SGPropertyNode* unmerged_, const osgDB::FilePathList& paths_)
 121             : unmerged(unmerged_), paths(paths_)
 122         {
 123         }
 124         Key& operator=(const Key& rhs)
 125         {
 126             unmerged = rhs.unmerged;
 127             paths = rhs.paths;
 128             return *this;
 129         }
 130         SGPropertyNode_ptr unmerged;
 131         osgDB::FilePathList paths;
 132         struct EqualTo
 133         {
 134             bool operator()(const Key& lhs, const Key& rhs) const;
 135         };
 136     };
 137     typedef std::tr1::unordered_map<Key, osg::ref_ptr<Effect>,
 138                                     boost::hash<Key>, Key::EqualTo> Cache;
 139     Cache* getCache()
 140     {
 141         if (!_cache)
 142             _cache = new Cache;
 143         return _cache;
 144     }
 145     Cache* _cache;
 146     friend size_t hash_value(const Key& key);
 147     friend Effect* makeEffect(SGPropertyNode* prop, bool realizeTechniques,
 148                               const SGReaderWriterXMLOptions* options);
 149     bool _isRealized;
 150 };
 151 // Automatic support for boost hash function
 152 size_t hash_value(const Effect::Key&);
 153
 154
 155 Effect* makeEffect(const std::string& name,
 156                    bool realizeTechniques,
 157                    const SGReaderWriterXMLOptions* options = 0);
 158
 159 Effect* makeEffect(SGPropertyNode* prop,
 160                    bool realizeTechniques,
 161                    const SGReaderWriterXMLOptions* options = 0);
 162
 163 bool makeParametersFromStateSet(SGPropertyNode* paramRoot,
 164                                 const osg::StateSet* ss);
 165
 166 namespace effect
 167 {
 168 /**
 169  * The function that implements effect property tree inheritance.
 170  */
 171 void mergePropertyTrees(SGPropertyNode* resultNode,
 172                         const SGPropertyNode* left,
 173                         const SGPropertyNode* right);
 174 }
 175 }
 176 #endif