StateSet.h

Go to the documentation of this file.

/* -*-c++-*- OpenSceneGraph - Copyright (C) 1998-2008 Robert Osfield
 *
 * This library is open source and may be redistributed and/or modified under
 * the terms of the OpenSceneGraph Public License (OSGPL) version 0.0 or
 * (at your option) any later version.  The full license is in LICENSE file
 * included with this distribution, and on the openscenegraph.org website.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * OpenSceneGraph Public License for more details.
*/

#ifndef OSG_STATESET
#define OSG_STATESET 1

#include <osg/Object>
#include <osg/StateAttribute>
#include <osg/ref_ptr>
#include <osg/Uniform>

#include <map>
#include <vector>
#include <string>

#ifndef GL_RESCALE_NORMAL
// allow compilation against GL1.1 headers.
#define GL_RESCALE_NORMAL                 0x803A
#endif

namespace osg {

// forward declare for the purposes of the UpdateCallback.
class NodeVisitor;

class OSG_EXPORT StateSet : public Object
{
    public :


        StateSet();
        StateSet(const StateSet&,const CopyOp& copyop=CopyOp::SHALLOW_COPY);

        virtual Object* cloneType() const { return new StateSet(); }
        virtual Object* clone(const CopyOp& copyop) const { return new StateSet(*this,copyop); }
        virtual bool isSameKindAs(const Object* obj) const { return dynamic_cast<const StateSet*>(obj)!=NULL; }
        virtual const char* libraryName() const { return "osg"; }
        virtual const char* className() const { return "StateSet"; }

        int compare(const StateSet& rhs,bool compareAttributeContents=false) const;

        bool operator <  (const StateSet& rhs) const { return compare(rhs)<0; }
        bool operator == (const StateSet& rhs) const { return compare(rhs)==0; }
        bool operator != (const StateSet& rhs) const { return compare(rhs)!=0; }


        typedef std::vector<Node*> ParentList;

        inline const ParentList& getParents() const { return _parents; }

        inline ParentList getParents() { return _parents; }

        inline Node* getParent(unsigned int i)  { return _parents[i]; }
        inline const Node* getParent(unsigned int i) const  { return _parents[i]; }

        inline unsigned int getNumParents() const { return static_cast<unsigned int>(_parents.size()); }


        virtual void computeDataVariance();


        void setGlobalDefaults();

        void clear();

        void merge(const StateSet& rhs);

        typedef std::map<StateAttribute::GLMode,StateAttribute::GLModeValue>  ModeList;

        void setMode(StateAttribute::GLMode mode, StateAttribute::GLModeValue value);

        void removeMode(StateAttribute::GLMode mode);

        StateAttribute::GLModeValue getMode(StateAttribute::GLMode mode) const;

        inline void setModeList(ModeList& ml) { _modeList=ml; }

        inline ModeList& getModeList() { return _modeList; }

        inline const ModeList& getModeList() const { return _modeList; }



        typedef std::pair<ref_ptr<StateAttribute>,StateAttribute::OverrideValue>    RefAttributePair;

        typedef std::map<StateAttribute::TypeMemberPair,RefAttributePair>           AttributeList;

        void setAttribute(StateAttribute *attribute, StateAttribute::OverrideValue value=StateAttribute::OFF);

        void setAttributeAndModes(StateAttribute *attribute, StateAttribute::GLModeValue value=StateAttribute::ON);

        void removeAttribute(StateAttribute::Type type, unsigned int member=0);

        void removeAttribute(StateAttribute *attribute);

        StateAttribute* getAttribute(StateAttribute::Type type, unsigned int member = 0);

        const StateAttribute* getAttribute(StateAttribute::Type type, unsigned int member = 0) const;

        const RefAttributePair* getAttributePair(StateAttribute::Type type, unsigned int member = 0) const;

        inline void setAttributeList(AttributeList& al) { _attributeList=al; }

        inline AttributeList& getAttributeList() { return _attributeList; }

        inline const AttributeList& getAttributeList() const { return _attributeList; }



        typedef std::vector<ModeList>       TextureModeList;

        void setTextureMode(unsigned int unit,StateAttribute::GLMode mode, StateAttribute::GLModeValue value);

        void removeTextureMode(unsigned int unit,StateAttribute::GLMode mode);

        StateAttribute::GLModeValue getTextureMode(unsigned int unit,StateAttribute::GLMode mode) const;

        inline void setTextureModeList(TextureModeList& tml) { _textureModeList=tml; }

        inline TextureModeList& getTextureModeList() { return _textureModeList; }

        inline const TextureModeList& getTextureModeList() const  { return _textureModeList; }

        inline unsigned int getNumTextureModeLists() const { return static_cast<unsigned int>(_textureModeList.size()); }

        typedef std::vector<AttributeList>  TextureAttributeList;

        void setTextureAttribute(unsigned int unit,StateAttribute *attribute, StateAttribute::OverrideValue value=StateAttribute::OFF);
        void setTextureAttributeAndModes(unsigned int unit,StateAttribute *attribute, StateAttribute::GLModeValue value=StateAttribute::ON);

        void removeTextureAttribute(unsigned int unit, StateAttribute::Type type);

        void removeTextureAttribute(unsigned int unit, StateAttribute *attribute);

        StateAttribute* getTextureAttribute(unsigned int unit,StateAttribute::Type type);

        const StateAttribute* getTextureAttribute(unsigned int unit,StateAttribute::Type type) const;

        const RefAttributePair* getTextureAttributePair(unsigned int unit,StateAttribute::Type type) const;

        inline void setTextureAttributeList(TextureAttributeList& tal) { _textureAttributeList=tal; }

        inline TextureAttributeList& getTextureAttributeList() { return _textureAttributeList; }

        inline const TextureAttributeList& getTextureAttributeList() const { return _textureAttributeList; }

        inline unsigned int getNumTextureAttributeLists() const { return static_cast<unsigned int>(_textureAttributeList.size()); }


        void setAssociatedModes(const StateAttribute* attribute, StateAttribute::GLModeValue value);
        void removeAssociatedModes(const StateAttribute* attribute);

        void setAssociatedTextureModes(unsigned int unit,const StateAttribute* attribute, StateAttribute::GLModeValue value);
        void removeAssociatedTextureModes(unsigned int unit,const StateAttribute* attribute);




        typedef std::pair<ref_ptr<Uniform>,StateAttribute::OverrideValue>  RefUniformPair;

        typedef std::map<std::string,RefUniformPair> UniformList;

        void addUniform(Uniform* uniform, StateAttribute::OverrideValue value=StateAttribute::ON);

        void removeUniform(const std::string& name);

        void removeUniform(Uniform* uniform);

        Uniform* getUniform(const std::string& name);

        Uniform* getOrCreateUniform(const std::string& name, Uniform::Type type, unsigned int numElements=1);

        const Uniform* getUniform(const std::string& name) const;

        const RefUniformPair* getUniformPair(const std::string& name) const;

        inline void setUniformList(UniformList& al) { _uniformList=al; }

        inline UniformList& getUniformList() { return _uniformList; }

        inline const UniformList& getUniformList() const { return _uniformList; }


        typedef std::pair<std::string, StateAttribute::OverrideValue> DefinePair;
        typedef std::map<std::string, DefinePair> DefineList;

        void setDefine(const std::string& defineName, StateAttribute::OverrideValue value=StateAttribute::ON);

        void setDefine(const std::string& defineName, const std::string& defineValue, StateAttribute::OverrideValue value=StateAttribute::ON);

        DefinePair* getDefinePair(const std::string& defineName) { DefineList::iterator itr = _defineList.find(defineName); return (itr!=_defineList.end()) ? &(itr->second) : 0; }
        const DefinePair* getDefinePair(const std::string& defineName) const { DefineList::const_iterator itr = _defineList.find(defineName); return (itr!=_defineList.end()) ? &(itr->second) : 0; }


        void removeDefine(const std::string& defineName);


        void setDefineList(const DefineList& dl) { _defineList = dl; }

        DefineList& getDefineList() { return _defineList; }

        const DefineList& getDefineList() const { return _defineList; }



        enum RenderingHint
        {
            DEFAULT_BIN = 0,
            OPAQUE_BIN = 1,
            TRANSPARENT_BIN = 2
        };

        void setRenderingHint(int hint);

        inline int getRenderingHint() const      { return _renderingHint; }

        enum RenderBinMode
        {
            INHERIT_RENDERBIN_DETAILS   =0,
            USE_RENDERBIN_DETAILS       =1,
            OVERRIDE_RENDERBIN_DETAILS  =2,
            PROTECTED_RENDERBIN_DETAILS =4,
            OVERRIDE_PROTECTED_RENDERBIN_DETAILS = OVERRIDE_RENDERBIN_DETAILS|PROTECTED_RENDERBIN_DETAILS
        };

        void setRenderBinDetails(int binNum,const std::string& binName,RenderBinMode mode=USE_RENDERBIN_DETAILS);

        void setRenderBinToInherit();

        inline bool useRenderBinDetails() const { return _binMode!=INHERIT_RENDERBIN_DETAILS; }

        inline void setRenderBinMode(RenderBinMode mode) { _binMode=mode; }

        inline RenderBinMode getRenderBinMode() const { return _binMode; }

        inline void setBinNumber(int num) { _binNum=num; }

        inline int getBinNumber() const { return _binNum; }

        inline void setBinName(const std::string& name) { _binName=name; }

        inline const std::string& getBinName() const { return _binName; }

        inline void setNestRenderBins(bool val) { _nestRenderBins = val; }

        inline bool getNestRenderBins() const { return _nestRenderBins; }


        struct OSG_EXPORT Callback : public virtual osg::Callback
        {
            Callback() {}

            Callback(const Callback&,const CopyOp&) {}

            META_Object(osg,Callback);

            virtual bool run(osg::Object* object, osg::Object* data);

            virtual void operator() (StateSet*, NodeVisitor*) {}
        };

        void setUpdateCallback(Callback* ac);

        Callback* getUpdateCallback() { return _updateCallback.get(); }

        const Callback* getUpdateCallback() const { return _updateCallback.get(); }

        bool requiresUpdateTraversal() const { return _updateCallback.valid() || getNumChildrenRequiringUpdateTraversal()!=0; }

        inline unsigned int getNumChildrenRequiringUpdateTraversal() const { return _numChildrenRequiringUpdateTraversal; }

        void runUpdateCallbacks(osg::NodeVisitor* nv);


        void setEventCallback(Callback* ac);

        Callback* getEventCallback() { return _eventCallback.get(); }

        const Callback* getEventCallback() const { return _eventCallback.get(); }

        bool requiresEventTraversal() const { return _eventCallback.valid() || getNumChildrenRequiringEventTraversal()!=0; }

        inline unsigned int getNumChildrenRequiringEventTraversal() const { return _numChildrenRequiringEventTraversal; }

        void runEventCallbacks(osg::NodeVisitor* nv);

        bool checkValidityOfAssociatedModes(State& state) const;

        virtual void setThreadSafeRefUnref(bool threadSafe);

        void compileGLObjects(State& state) const;

        virtual void resizeGLObjectBuffers(unsigned int maxSize);

        virtual void releaseGLObjects(State* state=0) const;

    protected :


        virtual ~StateSet();

        StateSet& operator = (const StateSet&) { return *this; }

        void addParent(osg::Node* object);
        void removeParent(osg::Node* object);

        ParentList _parents;
        friend class osg::Node;
        friend class osg::Drawable;
        friend class osg::Uniform;
        friend class osg::StateAttribute;

        ModeList                            _modeList;
        AttributeList                       _attributeList;

        TextureModeList                     _textureModeList;
        TextureAttributeList                _textureAttributeList;

        UniformList                         _uniformList;
        DefineList                          _defineList;

        inline ModeList& getOrCreateTextureModeList(unsigned int unit)
        {
            if (unit>=_textureModeList.size()) _textureModeList.resize(unit+1);
            return _textureModeList[unit];
        }

        inline AttributeList& getOrCreateTextureAttributeList(unsigned int unit)
        {
            if (unit>=_textureAttributeList.size()) _textureAttributeList.resize(unit+1);
            return _textureAttributeList[unit];
        }

        int compareModes(const ModeList& lhs,const ModeList& rhs);
        int compareAttributePtrs(const AttributeList& lhs,const AttributeList& rhs);
        int compareAttributeContents(const AttributeList& lhs,const AttributeList& rhs);

        void setMode(ModeList& modeList,StateAttribute::GLMode mode, StateAttribute::GLModeValue value);
        void setModeToInherit(ModeList& modeList,StateAttribute::GLMode mode);
        StateAttribute::GLModeValue getMode(const ModeList& modeList,StateAttribute::GLMode mode) const;

        void setAttribute(AttributeList& attributeList,StateAttribute *attribute, const StateAttribute::OverrideValue value=StateAttribute::OFF);

        StateAttribute* getAttribute(AttributeList& attributeList,const StateAttribute::Type type, unsigned int member);
        const StateAttribute* getAttribute(const AttributeList& attributeList,const StateAttribute::Type type, unsigned int member) const;
        const RefAttributePair* getAttributePair(const AttributeList& attributeList,const StateAttribute::Type type, unsigned int member) const;

        int                                 _renderingHint;

        RenderBinMode                       _binMode;
        int                                 _binNum;
        std::string                         _binName;
        bool                                _nestRenderBins;

        ref_ptr<Callback> _updateCallback;
        unsigned int _numChildrenRequiringUpdateTraversal;
        void setNumChildrenRequiringUpdateTraversal(unsigned int num);

        ref_ptr<Callback> _eventCallback;
        unsigned int _numChildrenRequiringEventTraversal;
        void setNumChildrenRequiringEventTraversal(unsigned int num);

};

extern OSG_EXPORT bool isTextureMode(StateAttribute::GLMode mode);

}

#endif