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