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
  84     // Define what needs to be generated for this effect
  85     enum Generator
  86     {
  87         NORMAL,
  88         TANGENT,
  89         BINORMAL
  90     };
  91     void setGenerator(Generator what, int where) { generator[what] = where; }
  92     int getGenerator(Generator what) const;  // Returns -1 if generator should not be used
  93     std::map<Generator, int> generator;  // What is generated into which attribute location
  94
  95     std::vector<osg::ref_ptr<Technique> > techniques;
  96     SGPropertyNode_ptr root;
  97     // Pointer to the parameters node, if it exists
  98     SGPropertyNode_ptr parametersProp;
  99     Technique* chooseTechnique(osg::RenderInfo* renderInfo);
 100     virtual void resizeGLObjectBuffers(unsigned int maxSize);
 101     virtual void releaseGLObjects(osg::State* state = 0) const;
 102     /**
 103      * Build the techniques from the effect properties.
 104      */
 105     bool realizeTechniques(const SGReaderWriterXMLOptions* options = 0);
 106     /**
 107      * Updaters that should be derefed when the effect is
 108      * deleted. Updaters arrange to be run by listening on properties
 109      * or something.
 110      */
 111     struct Updater : public virtual SGReferenced
 112     {
 113         virtual ~Updater() {}
 114     };
 115     void addUpdater(Updater* data) { _extraData.push_back(data); }
 116     // Callback that is added to the effect geode to initialize the
 117     // effect.
 118     friend struct InitializeCallback;
 119     struct InitializeCallback : public UpdateOnceCallback
 120     {
 121         void doUpdate(osg::Node* node, osg::NodeVisitor* nv);
 122     };
 123 protected:
 124     std::vector<SGSharedPtr<Updater> > _extraData;
 125     ~Effect();
 126     // Support for a cache of effects that inherit from this one, so
 127     // Effect objects with the same parameters and techniques can be
 128     // shared.
 129     struct Key
 130     {
 131         Key() {}
 132         Key(SGPropertyNode* unmerged_, const osgDB::FilePathList& paths_)
 133             : unmerged(unmerged_), paths(paths_)
 134         {
 135         }
 136         Key& operator=(const Key& rhs)
 137         {
 138             unmerged = rhs.unmerged;
 139             paths = rhs.paths;
 140             return *this;
 141         }
 142         SGPropertyNode_ptr unmerged;
 143         osgDB::FilePathList paths;
 144         struct EqualTo
 145         {
 146             bool operator()(const Key& lhs, const Key& rhs) const;
 147         };
 148     };
 149     typedef std::tr1::unordered_map<Key, osg::ref_ptr<Effect>,
 150                                     boost::hash<Key>, Key::EqualTo> Cache;
 151     Cache* getCache()
 152     {
 153         if (!_cache)
 154             _cache = new Cache;
 155         return _cache;
 156     }
 157     Cache* _cache;
 158     friend size_t hash_value(const Key& key);
 159     friend Effect* makeEffect(SGPropertyNode* prop, bool realizeTechniques,
 160                               const SGReaderWriterXMLOptions* options);
 161     bool _isRealized;
 162 };
 163 // Automatic support for boost hash function
 164 size_t hash_value(const Effect::Key&);
 165
 166
 167 Effect* makeEffect(const std::string& name,
 168                    bool realizeTechniques,
 169                    const SGReaderWriterXMLOptions* options = 0);
 170
 171 Effect* makeEffect(SGPropertyNode* prop,
 172                    bool realizeTechniques,
 173                    const SGReaderWriterXMLOptions* options = 0);
 174
 175 bool makeParametersFromStateSet(SGPropertyNode* paramRoot,
 176                                 const osg::StateSet* ss);
 177
 178 namespace effect
 179 {
 180 /**
 181  * The function that implements effect property tree inheritance.
 182  */
 183 void mergePropertyTrees(SGPropertyNode* resultNode,
 184                         const SGPropertyNode* left,
 185                         const SGPropertyNode* right);
 186 }
 187 }
 188 #endif