Go to the documentation of this file.
29 #ifndef __Ogre_Page_H__
30 #define __Ogre_Page_H__
128 virtual void load(
bool synchronous);
bool isDeferredProcessInProgress() const
If true, it's not safe to access this Page at this time, contents may be changing.
virtual PagedWorldSection * getParentSection() const
Get the PagedWorldSection this page belongs to.
PageManager * getManager() const
virtual void destroyAllContentCollections()
Destroy all PageContentCollections within this page.
Interface to a general purpose request / response style background work queue.
Superclass for all objects that wish to use custom memory allocators when their new / delete operator...
General purpose request structure.
WorkQueue::Response * handleRequest(const WorkQueue::Request *req, const WorkQueue *srcQ)
WorkQueue::RequestHandler override.
A viewpoint from which the scene will be rendered.
virtual bool prepareImpl(PageData *dataToPopulate)
virtual unsigned long getFrameLastHeld()
Get the frame number in which this Page was last loaded or held.
virtual PageID getID() const
Get the ID of this page, unique within the parent.
virtual void touch()
'Touch' the page to let it know it's being used
bool canHandleRequest(const WorkQueue::Request *req, const WorkQueue *srcQ)
WorkQueue::RequestHandler override.
String generateFilename() const
static const uint16 WORKQUEUE_PREPARE_REQUEST
virtual size_t getContentCollectionCount() const
Get the number of content collections.
unsigned long mFrameLastHeld
The PageManager is the entry point through which you load all PagedWorld instances,...
General purpose response structure.
virtual bool prepareImpl(StreamSerialiser &str, PageData *dataToPopulate)
virtual void load(bool synchronous)
Load this page.
ContentCollectionList collectionsToAdd
Class representing a node in the scene graph.
uint32 PageID
Identifier for a page.
std::ostream & operator<<(std::ostream &o, const TRect< T > &r)
SceneManager * getSceneManager() const
virtual void save(const String &filename)
Save page data to a file.
Manages the organisation and rendering of a 'scene' i.e.
virtual PageContentCollection * getContentCollection(size_t index)
Get a content collection.
Definition of the interface for a collection of PageContent instances.
Interface definition for a handler of responses.
virtual void save()
Save page data to an automatically generated file name.
virtual PageContentCollection * createContentCollection(const String &typeName)
Create a new PageContentCollection within this page.
void _notifyModified()
Tell the page that it is modified.
static const uint32 CHUNK_ID
static const uint32 CHUNK_CONTENTCOLLECTION_DECLARATION_ID
bool canHandleResponse(const WorkQueue::Response *res, const WorkQueue *srcQ)
WorkQueue::ResponseHandler override.
Represents a section of the PagedWorld which uses a given PageStrategy, and which is made up of a gen...
virtual void notifyCamera(Camera *cam)
Notify a section of the current camera.
bool mDeferredProcessInProgress
void handleResponse(const WorkQueue::Response *res, const WorkQueue *srcQ)
WorkQueue::ResponseHandler override.
Utility class providing helper methods for reading / writing structured data held in a DataStream.
void updateDebugDisplay()
Page(PageID pageID, PagedWorldSection *parent)
virtual void unload()
Unload this page.
virtual bool isHeld() const
Returns whether this page was 'held' in the last frame, that is was it either directly needed,...
static const uint16 CHUNK_VERSION
Interface definition for a handler of requests.
float Real
Software floating point type.
virtual void destroyContentCollection(PageContentCollection *coll)
Destroy a PageContentCollection within this page.
vector< PageContentCollection * >::type ContentCollectionList
PagedWorldSection * mParent
virtual void frameEnd(Real timeElapsed)
Called when the frame ends.
virtual void save(StreamSerialiser &stream)
Save page data to a serialiser.
virtual void frameStart(Real timeSinceLastFrame)
Called when the frame starts.
const ContentCollectionList & getContentCollectionList() const
Get the list of content collections.
static const uint16 WORKQUEUE_CHANGECOLLECTION_REQUEST
ContentCollectionList mContentCollections
#define _OgrePagingExport
Copyright © 2012 Torus Knot Software Ltd

This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.