OgreRenderToVertexBuffer.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 __RenderToVertexBuffer_H__
#define __RenderToVertexBuffer_H__

#include "OgrePrerequisites.h"
#include "OgreMaterial.h"
#include "OgreRenderOperation.h"

namespace Ogre {
    class _OgreExport RenderToVertexBuffer
    {    
    public:
        RenderToVertexBuffer();
        virtual ~RenderToVertexBuffer();

        VertexDeclaration* getVertexDeclaration();
        
        unsigned int getMaxVertexCount() const { return mMaxVertexCount; }
        
        void setMaxVertexCount(unsigned int maxVertexCount) { mMaxVertexCount = maxVertexCount; }

        RenderOperation::OperationType getOperationType() const { return mOperationType; }

        void setOperationType(RenderOperation::OperationType operationType) { mOperationType = operationType; }

        void setResetsEveryUpdate(bool resetsEveryUpdate) { mResetsEveryUpdate = resetsEveryUpdate; }

        bool getResetsEveryUpdate() const { return mResetsEveryUpdate; }

        virtual void getRenderOperation(RenderOperation& op) = 0;

        virtual void update(SceneManager* sceneMgr) = 0;

        virtual void reset() { mResetRequested = true; }
        
        void setSourceRenderable(Renderable* source) { mSourceRenderable = source; }

        const Renderable* getSourceRenderable() const { return mSourceRenderable; }

        const MaterialPtr& getRenderToBufferMaterial() { return mMaterial; }

        void setRenderToBufferMaterialName(const String& materialName);
    protected:
        RenderOperation::OperationType mOperationType;
        bool mResetsEveryUpdate;
        bool mResetRequested;
        MaterialPtr mMaterial;
        Renderable* mSourceRenderable;
        VertexData* mVertexData;
        unsigned int mMaxVertexCount;
    };

    typedef SharedPtr<RenderToVertexBuffer> RenderToVertexBufferSharedPtr;
}

#endif