#include <OgrePage.h>
Classes | |
struct | PageData |
struct | PageRequest |
Structure for holding background page requests. More... | |
struct | PageResponse |
Public Types | |
typedef vector < PageContentCollection * > ::type | ContentCollectionList |
Public Member Functions | |
Page (PageID pageID, PagedWorldSection *parent) | |
virtual | ~Page () |
void | _notifyModified () |
Tell the page that it is modified. More... | |
bool | canHandleRequest (const WorkQueue::Request *req, const WorkQueue *srcQ) |
WorkQueue::RequestHandler override. More... | |
bool | canHandleResponse (const WorkQueue::Response *res, const WorkQueue *srcQ) |
WorkQueue::ResponseHandler override. More... | |
virtual PageContentCollection * | createContentCollection (const String &typeName) |
Create a new PageContentCollection within this page. More... | |
virtual void | destroyAllContentCollections () |
Destroy all PageContentCollections within this page. More... | |
virtual void | destroyContentCollection (PageContentCollection *coll) |
Destroy a PageContentCollection within this page. More... | |
virtual void | frameEnd (Real timeElapsed) |
Called when the frame ends. More... | |
virtual void | frameStart (Real timeSinceLastFrame) |
Called when the frame starts. More... | |
virtual PageContentCollection * | getContentCollection (size_t index) |
Get a content collection. More... | |
virtual size_t | getContentCollectionCount () const |
Get the number of content collections. More... | |
const ContentCollectionList & | getContentCollectionList () const |
Get the list of content collections. More... | |
virtual unsigned long | getFrameLastHeld () |
Get the frame number in which this Page was last loaded or held. More... | |
virtual PageID | getID () const |
Get the ID of this page, unique within the parent. More... | |
PageManager * | getManager () const |
virtual PagedWorldSection * | getParentSection () const |
Get the PagedWorldSection this page belongs to. More... | |
SceneManager * | getSceneManager () const |
WorkQueue::Response * | handleRequest (const WorkQueue::Request *req, const WorkQueue *srcQ) |
WorkQueue::RequestHandler override. More... | |
void | handleResponse (const WorkQueue::Response *res, const WorkQueue *srcQ) |
WorkQueue::ResponseHandler override. More... | |
bool | isDeferredProcessInProgress () const |
If true, it's not safe to access this Page at this time, contents may be changing. More... | |
virtual bool | isHeld () const |
Returns whether this page was 'held' in the last frame, that is was it either directly needed, or requested to stay in memory (held - as in a buffer region for example). More... | |
bool | isModified () const |
virtual void | load (bool synchronous) |
Load this page. More... | |
virtual void | notifyCamera (Camera *cam) |
Notify a section of the current camera. More... | |
void | operator delete (void *ptr) |
void | operator delete (void *ptr, void *) |
void | operator delete (void *ptr, const char *, int, const char *) |
void | operator delete[] (void *ptr) |
void | operator delete[] (void *ptr, const char *, int, const char *) |
void * | operator new (size_t sz, const char *file, int line, const char *func) |
operator new, with debug line info More... | |
void * | operator new (size_t sz) |
void * | operator new (size_t sz, void *ptr) |
placement operator new More... | |
void * | operator new[] (size_t sz, const char *file, int line, const char *func) |
array operator new, with debug line info More... | |
void * | operator new[] (size_t sz) |
virtual void | save () |
Save page data to an automatically generated file name. More... | |
virtual void | save (const String &filename) |
Save page data to a file. More... | |
virtual void | save (StreamSerialiser &stream) |
Save page data to a serialiser. More... | |
virtual void | touch () |
'Touch' the page to let it know it's being used More... | |
virtual void | unload () |
Unload this page. More... | |
Static Public Attributes | |
static const uint32 | CHUNK_CONTENTCOLLECTION_DECLARATION_ID |
static const uint32 | CHUNK_ID |
static const uint16 | CHUNK_VERSION |
static const uint16 | WORKQUEUE_CHANGECOLLECTION_REQUEST |
static const uint16 | WORKQUEUE_PREPARE_REQUEST |
Protected Member Functions | |
String | generateFilename () const |
virtual void | loadImpl () |
virtual bool | prepareImpl (PageData *dataToPopulate) |
virtual bool | prepareImpl (StreamSerialiser &str, PageData *dataToPopulate) |
void | updateDebugDisplay () |
Protected Attributes | |
ContentCollectionList | mContentCollections |
SceneNode * | mDebugNode |
bool | mDeferredProcessInProgress |
unsigned long | mFrameLastHeld |
PageID | mID |
bool | mModified |
PagedWorldSection * | mParent |
uint16 | mWorkQueueChannel |
Friends | |
_OgrePagingExport friend std::ostream & | operator<< (std::ostream &o, const Page &p) |
Function for writing to a stream. More... | |
Page class.
Definition at line 49 of file OgrePage.h.
typedef vector<PageContentCollection*>::type Ogre::Page::ContentCollectionList |
Definition at line 53 of file OgrePage.h.
Ogre::Page::Page | ( | PageID | pageID, |
PagedWorldSection * | parent | ||
) |
|
virtual |
|
inline |
Tell the page that it is modified.
Definition at line 188 of file OgrePage.h.
|
virtual |
WorkQueue::RequestHandler override.
Reimplemented from Ogre::WorkQueue::RequestHandler.
|
virtual |
WorkQueue::ResponseHandler override.
Reimplemented from Ogre::WorkQueue::ResponseHandler.
|
virtual |
Create a new PageContentCollection within this page.
This is equivalent to calling PageManager::createContentCollection and then attachContentCollection.
typeName | The name of the type of content collection (see PageManager::getContentCollectionFactories) |
|
virtual |
Destroy all PageContentCollections within this page.
|
virtual |
Destroy a PageContentCollection within this page.
This is equivalent to calling detachContentCollection and PageManager::destroyContentCollection.
|
virtual |
Called when the frame ends.
|
virtual |
Called when the frame starts.
|
protected |
|
virtual |
Get a content collection.
|
virtual |
Get the number of content collections.
const ContentCollectionList& Ogre::Page::getContentCollectionList | ( | ) | const |
Get the list of content collections.
|
inlinevirtual |
Get the frame number in which this Page was last loaded or held.
Definition at line 121 of file OgrePage.h.
|
inlinevirtual |
Get the ID of this page, unique within the parent.
Definition at line 113 of file OgrePage.h.
PageManager* Ogre::Page::getManager | ( | ) | const |
|
inlinevirtual |
Get the PagedWorldSection this page belongs to.
Definition at line 115 of file OgrePage.h.
SceneManager* Ogre::Page::getSceneManager | ( | ) | const |
|
virtual |
WorkQueue::RequestHandler override.
Implements Ogre::WorkQueue::RequestHandler.
|
virtual |
WorkQueue::ResponseHandler override.
Implements Ogre::WorkQueue::ResponseHandler.
|
inline |
If true, it's not safe to access this Page at this time, contents may be changing.
Definition at line 110 of file OgrePage.h.
|
virtual |
Returns whether this page was 'held' in the last frame, that is was it either directly needed, or requested to stay in memory (held - as in a buffer region for example).
If not, this page is eligible for removal.
|
inline |
Definition at line 189 of file OgrePage.h.
|
virtual |
Load this page.
synchronous | Whether to force this to happen synchronously. |
|
protectedvirtual |
|
virtual |
Notify a section of the current camera.
|
inlineinherited |
Definition at line 96 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 102 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 108 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 113 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 119 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
operator new, with debug line info
Definition at line 68 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 73 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
placement operator new
Definition at line 79 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
array operator new, with debug line info
Definition at line 86 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 91 of file OgreMemoryAllocatedObject.h.
|
protectedvirtual |
|
protectedvirtual |
|
virtual |
Save page data to an automatically generated file name.
|
virtual |
Save page data to a file.
|
virtual |
Save page data to a serialiser.
|
virtual |
'Touch' the page to let it know it's being used
|
virtual |
Unload this page.
|
protected |
|
friend |
Function for writing to a stream.
|
static |
Definition at line 101 of file OgrePage.h.
|
static |
Definition at line 98 of file OgrePage.h.
|
static |
Definition at line 99 of file OgrePage.h.
|
protected |
Definition at line 58 of file OgrePage.h.
|
protected |
Definition at line 63 of file OgrePage.h.
|
protected |
Definition at line 60 of file OgrePage.h.
|
protected |
Definition at line 57 of file OgrePage.h.
|
protected |
Definition at line 55 of file OgrePage.h.
|
protected |
Definition at line 61 of file OgrePage.h.
|
protected |
Definition at line 56 of file OgrePage.h.
|
protected |
Definition at line 59 of file OgrePage.h.
|
static |
Definition at line 192 of file OgrePage.h.
|
static |
Definition at line 191 of file OgrePage.h.