OGRE  1.9.0
OgrePage.h
Go to the documentation of this file.
1/*
2-----------------------------------------------------------------------------
3This source file is part of OGRE
4(Object-oriented Graphics Rendering Engine)
5For the latest info, see http://www.ogre3d.org/
6
7Copyright (c) 2000-2014 Torus Knot Software Ltd
8
9Permission is hereby granted, free of charge, to any person obtaining a copy
10of this software and associated documentation files (the "Software"), to deal
11in the Software without restriction, including without limitation the rights
12to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13copies of the Software, and to permit persons to whom the Software is
14furnished to do so, subject to the following conditions:
15
16The above copyright notice and this permission notice shall be included in
17all copies or substantial portions of the Software.
18
19THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25THE SOFTWARE.
26-----------------------------------------------------------------------------
27*/
28
29#ifndef __Ogre_Page_H__
30#define __Ogre_Page_H__
31
34#include "OgreWorkQueue.h"
35
36
37namespace Ogre
38{
51 {
52 public:
54 protected:
57 unsigned long mFrameLastHeld;
62
65
72 {
74 _OgrePagingExport friend std::ostream& operator<<(std::ostream& o, const PageRequest& r)
75 { return o; }
76
77 PageRequest(Page* p): srcPage(p) {}
78 };
80 {
82
83 _OgrePagingExport friend std::ostream& operator<<(std::ostream& o, const PageResponse& r)
84 { return o; }
85
86 PageResponse() : pageData(0) {}
87 };
88
89
90
91 virtual bool prepareImpl(PageData* dataToPopulate);
92 virtual bool prepareImpl(StreamSerialiser& str, PageData* dataToPopulate);
93 virtual void loadImpl();
94
96
97 public:
98 static const uint32 CHUNK_ID;
99 static const uint16 CHUNK_VERSION;
100
102
103 Page(PageID pageID, PagedWorldSection* parent);
104 virtual ~Page();
105
108
110 bool isDeferredProcessInProgress() const { return mDeferredProcessInProgress; }
111
113 virtual PageID getID() const { return mID; }
115 virtual PagedWorldSection* getParentSection() const { return mParent; }
121 virtual unsigned long getFrameLastHeld() { return mFrameLastHeld; }
123 virtual void touch();
124
128 virtual void load(bool synchronous);
131 virtual void unload();
132
133
139 virtual bool isHeld() const;
140
142 virtual void save();
144 virtual void save(const String& filename);
146 virtual void save(StreamSerialiser& stream);
147
149 virtual void frameStart(Real timeSinceLastFrame);
151 virtual void frameEnd(Real timeElapsed);
153 virtual void notifyCamera(Camera* cam);
154
161
171 virtual size_t getContentCollectionCount() const;
176
178 bool canHandleRequest(const WorkQueue::Request* req, const WorkQueue* srcQ);
182 bool canHandleResponse(const WorkQueue::Response* res, const WorkQueue* srcQ);
184 void handleResponse(const WorkQueue::Response* res, const WorkQueue* srcQ);
185
186
188 void _notifyModified() { mModified = true; }
189 bool isModified() const { return mModified; }
190
193
196 _OgrePagingExport friend std::ostream& operator <<( std::ostream& o, const Page& p );
197
198
199
200 };
201
204}
205
206#endif
#define _OgrePagingExport
Superclass for all objects that wish to use custom memory allocators when their new / delete operator...
A viewpoint from which the scene will be rendered.
Definition OgreCamera.h:87
Definition of the interface for a collection of PageContent instances.
The PageManager is the entry point through which you load all PagedWorld instances,...
Page class.
Definition OgrePage.h:51
virtual size_t getContentCollectionCount() const
Get the number of content collections.
virtual bool prepareImpl(PageData *dataToPopulate)
Page(PageID pageID, PagedWorldSection *parent)
virtual bool isHeld() const
Returns whether this page was 'held' in the last frame, that is was it either directly needed,...
virtual PagedWorldSection * getParentSection() const
Get the PagedWorldSection this page belongs to.
Definition OgrePage.h:115
bool mModified
Definition OgrePage.h:61
PageID mID
Definition OgrePage.h:55
virtual void loadImpl()
virtual void unload()
Unload this page.
virtual bool prepareImpl(StreamSerialiser &str, PageData *dataToPopulate)
bool canHandleResponse(const WorkQueue::Response *res, const WorkQueue *srcQ)
WorkQueue::ResponseHandler override.
SceneNode * mDebugNode
Definition OgrePage.h:63
virtual void touch()
'Touch' the page to let it know it's being used
virtual void save()
Save page data to an automatically generated file name.
bool mDeferredProcessInProgress
Definition OgrePage.h:60
const ContentCollectionList & getContentCollectionList() const
Get the list of content collections.
ContentCollectionList mContentCollections
Definition OgrePage.h:58
vector< PageContentCollection * >::type ContentCollectionList
Definition OgrePage.h:53
static const uint16 CHUNK_VERSION
Definition OgrePage.h:99
virtual PageID getID() const
Get the ID of this page, unique within the parent.
Definition OgrePage.h:113
static const uint32 CHUNK_CONTENTCOLLECTION_DECLARATION_ID
Definition OgrePage.h:101
PageManager * getManager() const
SceneManager * getSceneManager() const
virtual PageContentCollection * getContentCollection(size_t index)
Get a content collection.
virtual void destroyAllContentCollections()
Destroy all PageContentCollections within this page.
virtual unsigned long getFrameLastHeld()
Get the frame number in which this Page was last loaded or held.
Definition OgrePage.h:121
bool canHandleRequest(const WorkQueue::Request *req, const WorkQueue *srcQ)
WorkQueue::RequestHandler override.
PagedWorldSection * mParent
Definition OgrePage.h:56
virtual void destroyContentCollection(PageContentCollection *coll)
Destroy a PageContentCollection within this page.
void handleResponse(const WorkQueue::Response *res, const WorkQueue *srcQ)
WorkQueue::ResponseHandler override.
static const uint32 CHUNK_ID
Definition OgrePage.h:98
bool isDeferredProcessInProgress() const
If true, it's not safe to access this Page at this time, contents may be changing.
Definition OgrePage.h:110
uint16 mWorkQueueChannel
Definition OgrePage.h:59
virtual void load(bool synchronous)
Load this page.
virtual void notifyCamera(Camera *cam)
Notify a section of the current camera.
virtual void save(StreamSerialiser &stream)
Save page data to a serialiser.
virtual void frameEnd(Real timeElapsed)
Called when the frame ends.
bool isModified() const
Definition OgrePage.h:189
void updateDebugDisplay()
void _notifyModified()
Tell the page that it is modified.
Definition OgrePage.h:188
WorkQueue::Response * handleRequest(const WorkQueue::Request *req, const WorkQueue *srcQ)
WorkQueue::RequestHandler override.
static const uint16 WORKQUEUE_PREPARE_REQUEST
Definition OgrePage.h:191
unsigned long mFrameLastHeld
Definition OgrePage.h:57
virtual ~Page()
virtual void save(const String &filename)
Save page data to a file.
virtual void frameStart(Real timeSinceLastFrame)
Called when the frame starts.
String generateFilename() const
virtual PageContentCollection * createContentCollection(const String &typeName)
Create a new PageContentCollection within this page.
static const uint16 WORKQUEUE_CHANGECOLLECTION_REQUEST
Definition OgrePage.h:192
Represents a section of the PagedWorld which uses a given PageStrategy, and which is made up of a gen...
Manages the organisation and rendering of a 'scene' i.e.
Class representing a node in the scene graph.
Utility class providing helper methods for reading / writing structured data held in a DataStream.
Interface definition for a handler of requests.
General purpose request structure.
Interface definition for a handler of responses.
Interface to a general purpose request / response style background work queue.
uint32 PageID
Identifier for a page.
float Real
Software floating point type.
unsigned short uint16
unsigned int uint32
_StringBase String
ContentCollectionList collectionsToAdd
Definition OgrePage.h:68
Structure for holding background page requests.
Definition OgrePage.h:72
_OgrePagingExport friend std::ostream & operator<<(std::ostream &o, const PageRequest &r)
Definition OgrePage.h:74
_OgrePagingExport friend std::ostream & operator<<(std::ostream &o, const PageResponse &r)
Definition OgrePage.h:83
General purpose response structure.
std::vector< T, A > type