OgrePage.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 __Ogre_Page_H__
#define __Ogre_Page_H__

#include "OgrePagingPrerequisites.h"
#include "OgreWorkQueue.h"


namespace Ogre
{
    class _OgrePagingExport Page : public WorkQueue::RequestHandler, 
        public WorkQueue::ResponseHandler, public PageAlloc
    {
    public:
        typedef vector<PageContentCollection*>::type ContentCollectionList;
    protected:
        PageID mID;
        PagedWorldSection* mParent;
        unsigned long mFrameLastHeld;
        ContentCollectionList mContentCollections;
        uint16 mWorkQueueChannel;
        bool mDeferredProcessInProgress;
        bool mModified;

        SceneNode* mDebugNode;
        void updateDebugDisplay();

        struct PageData : public PageAlloc
        {
            ContentCollectionList collectionsToAdd;
        };
        struct PageRequest
        {
            Page* srcPage;
            _OgrePagingExport friend std::ostream& operator<<(std::ostream& o, const PageRequest& r)
            { return o; }       

            PageRequest(Page* p): srcPage(p) {}
        };
        struct PageResponse
        {
            PageData* pageData;

            _OgrePagingExport friend std::ostream& operator<<(std::ostream& o, const PageResponse& r)
            { return o; }       

            PageResponse() : pageData(0) {}
        };



        virtual bool prepareImpl(PageData* dataToPopulate);
        virtual bool prepareImpl(StreamSerialiser& str, PageData* dataToPopulate);
        virtual void loadImpl();

        String generateFilename() const;

    public:
        static const uint32 CHUNK_ID;
        static const uint16 CHUNK_VERSION;

        static const uint32 CHUNK_CONTENTCOLLECTION_DECLARATION_ID;

        Page(PageID pageID, PagedWorldSection* parent);
        virtual ~Page();

        PageManager* getManager() const;
        SceneManager* getSceneManager() const;

        bool isDeferredProcessInProgress() const { return mDeferredProcessInProgress; }

        virtual PageID getID() const { return mID; }
        virtual PagedWorldSection* getParentSection() const { return mParent; }
        virtual unsigned long getFrameLastHeld() { return mFrameLastHeld; }
        virtual void touch();

        virtual void load(bool synchronous);
        virtual void unload();


        virtual bool isHeld() const;

        virtual void save();
        virtual void save(const String& filename);
        virtual void save(StreamSerialiser& stream);

        virtual void frameStart(Real timeSinceLastFrame);
        virtual void frameEnd(Real timeElapsed);
        virtual void notifyCamera(Camera* cam);

        virtual PageContentCollection* createContentCollection(const String& typeName);

        virtual void destroyContentCollection(PageContentCollection* coll);
        virtual void destroyAllContentCollections();
        virtual size_t getContentCollectionCount() const;
        virtual PageContentCollection* getContentCollection(size_t index);
        const ContentCollectionList& getContentCollectionList() const;

        bool canHandleRequest(const WorkQueue::Request* req, const WorkQueue* srcQ);
        WorkQueue::Response* handleRequest(const WorkQueue::Request* req, const WorkQueue* srcQ);
        bool canHandleResponse(const WorkQueue::Response* res, const WorkQueue* srcQ);
        void handleResponse(const WorkQueue::Response* res, const WorkQueue* srcQ);


        void _notifyModified() { mModified = true; }
        bool isModified() const { return mModified; }

        static const uint16 WORKQUEUE_PREPARE_REQUEST;
        static const uint16 WORKQUEUE_CHANGECOLLECTION_REQUEST;

        _OgrePagingExport friend std::ostream& operator <<( std::ostream& o, const Page& p );



    };

}

#endif