OgreShaderSubRenderState.h

Go to the documentation of this file.

/*
-----------------------------------------------------------------------------
This source file is part of OGRE
(Object-oriented Graphics Rendering Engine)
For the latest info, see http://www.ogre3d.org

Copyright (c) 2000-2012 Torus Knot Software Ltd
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
-----------------------------------------------------------------------------
*/
#ifndef _ShaderSubRenderState_
#define _ShaderSubRenderState_

#include "OgreShaderPrerequisites.h"
#include "OgreGpuProgram.h"
#include "OgreSceneManager.h"
#include "OgreMaterialSerializer.h"
#include "OgreScriptCompiler.h"
#include "OgreShaderScriptTranslator.h"


namespace Ogre {
namespace RTShader {

typedef SharedPtr<SubRenderStateAccessor>   SubRenderStateAccessorPtr; 


class _OgreRTSSExport SubRenderState : public RTShaderSystemAlloc
{

// Interface.
public:

    SubRenderState          ();

    virtual ~SubRenderState ();


    virtual const String&   getType                 () const = 0;


    virtual int             getExecutionOrder       () const = 0;


    virtual void            copyFrom                (const SubRenderState& rhs) = 0;

    SubRenderState& operator=   (const SubRenderState& rhs);

    virtual bool            createCpuSubPrograms    (ProgramSet* programSet);

    virtual void            updateGpuProgramsParams (Renderable* rend, Pass* pass,  const AutoParamDataSource* source,  const LightList* pLightList) { }

    virtual bool            preAddToRenderState     (const RenderState* renderState, Pass* srcPass, Pass* dstPass) { return true; }

    SubRenderStateAccessorPtr   getAccessor             ();

    SubRenderStateAccessorPtr   getAccessor             () const;

// Protected methods
protected:

    virtual bool            resolveParameters       (ProgramSet* programSet);   

    virtual bool            resolveDependencies     (ProgramSet* programSet);

    virtual bool            addFunctionInvocations  (ProgramSet* programSet);

// Attributes.
private:    
    mutable SubRenderStateAccessorPtr   mThisAccessor;          // The accessor of this instance.
    SubRenderStateAccessorPtr           mOtherAccessor;         // The accessor of the source instance which used as base to create this instance.
    
};

typedef vector<SubRenderState*>::type               SubRenderStateList;
typedef SubRenderStateList::iterator                SubRenderStateListIterator;
typedef SubRenderStateList::const_iterator          SubRenderStateListConstIterator;

typedef set<SubRenderState*>::type                  SubRenderStateSet;
typedef SubRenderStateSet::iterator                 SubRenderStateSetIterator;
typedef SubRenderStateSet::const_iterator           SubRenderStateSetConstIterator;


class _OgreRTSSExport SubRenderStateAccessor
{
public:
    void addSubRenderStateInstance(SubRenderState* subRenderState) const 
    {
        mSubRenderStateInstancesSet.insert(subRenderState);
    }

    void removeSubRenderStateInstance(SubRenderState* subRenderState) const
    {
        SubRenderStateSetIterator itFind = mSubRenderStateInstancesSet.find(subRenderState);

        if (itFind != mSubRenderStateInstancesSet.end())
        {
            mSubRenderStateInstancesSet.erase(itFind);
        }
    }

    SubRenderStateSet&  getSubRenderStateInstanceSet() { return mSubRenderStateInstancesSet; }

    const SubRenderStateSet&    getSubRenderStateInstanceSet() const { return mSubRenderStateInstancesSet; }

protected:
    SubRenderStateAccessor(const SubRenderState* templateSubRenderState) : mTemplateSubRenderState(templateSubRenderState) {}


protected:
    const SubRenderState*       mTemplateSubRenderState;
    mutable SubRenderStateSet   mSubRenderStateInstancesSet;

private:
    friend class SubRenderState;

};


class _OgreRTSSExport SubRenderStateFactory : public RTShaderSystemAlloc
{

public:
    SubRenderStateFactory           () {}
    virtual ~SubRenderStateFactory  ();

    virtual const String&   getType             () const = 0;
    
    virtual SubRenderState* createInstance      ();

    virtual SubRenderState* createInstance      (ScriptCompiler* compiler, PropertyAbstractNode* prop, Pass* pass, SGScriptTranslator* translator) { return NULL; }

    virtual SubRenderState* createInstance      (ScriptCompiler* compiler, PropertyAbstractNode* prop, TextureUnitState* texState, SGScriptTranslator* translator) { return NULL; }

    virtual SubRenderState* createOrRetrieveInstance(SGScriptTranslator* translator);

    virtual void            destroyInstance     (SubRenderState* subRenderState);

    virtual void            destroyAllInstances ();

    virtual void            writeInstance       (MaterialSerializer* ser, SubRenderState* subRenderState, Pass* srcPass, Pass* dstPass) {}

    virtual void            writeInstance       (MaterialSerializer* ser, SubRenderState* subRenderState, const TextureUnitState* srcTextureUnit, const TextureUnitState* dstTextureUnit) {}
protected:
    virtual SubRenderState* createInstanceImpl  () = 0;

// Attributes.
protected:
    SubRenderStateSet       mSubRenderStateList;        // List of all sub render states instances this factory created.
};

}
}

#endif