Ogre::Page Class Reference
Components » Paging

Page class. More...

`#include <OgrePage.h>`

Inheritance diagram for Ogre::Page:
[legend]

## 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...

## Detailed Description

Page class.

Definition at line 49 of file OgrePage.h.

## Member Typedef Documentation

## ContentCollectionList

typedef vector<PageContentCollection*>::type Ogre::Page::ContentCollectionList

Definition at line 53 of file OgrePage.h.

## Constructor & Destructor Documentation

## Page()

Ogre::Page::Page | ( | PageID | pageID,
|  | PagedWorldSection * | parent
| ) |  |

## ~Page()

virtual Ogre::Page::~Page | ( |  | ) |

virtual

## Member Function Documentation

## _notifyModified()

void Ogre::Page::_notifyModified | ( |  | ) |

Tell the page that it is modified.

Definition at line 188 of file OgrePage.h.

## canHandleRequest()

bool Ogre::Page::canHandleRequest | ( | const WorkQueue::Request * | req,
|  | const WorkQueue * | srcQ
| ) |  |

virtual

WorkQueue::RequestHandler override.

Reimplemented from Ogre::WorkQueue::RequestHandler.

## canHandleResponse()

bool Ogre::Page::canHandleResponse | ( | const WorkQueue::Response * | res,
|  | const WorkQueue * | srcQ
| ) |  |

virtual

WorkQueue::ResponseHandler override.

Reimplemented from Ogre::WorkQueue::ResponseHandler.

## createContentCollection()

virtual PageContentCollection* Ogre::Page::createContentCollection | ( | const String & | typeName | ) |

virtual

Create a new PageContentCollection within this page.

This is equivalent to calling PageManager::createContentCollection and then attachContentCollection.

Parameters

  typeName | The name of the type of content collection (see PageManager::getContentCollectionFactories)

## destroyAllContentCollections()

virtual void Ogre::Page::destroyAllContentCollections | ( |  | ) |

virtual

Destroy all PageContentCollections within this page.

## destroyContentCollection()

virtual void Ogre::Page::destroyContentCollection | ( | PageContentCollection * | coll | ) |

virtual

Destroy a PageContentCollection within this page.

This is equivalent to calling detachContentCollection and PageManager::destroyContentCollection.

## frameEnd()

virtual void Ogre::Page::frameEnd | ( | Real | timeElapsed | ) |

virtual

Called when the frame ends.

## frameStart()

virtual void Ogre::Page::frameStart | ( | Real | timeSinceLastFrame | ) |

virtual

Called when the frame starts.

## generateFilename()

String Ogre::Page::generateFilename | ( |  | ) | const

protected

## getContentCollection()

virtual PageContentCollection* Ogre::Page::getContentCollection | ( | size_t | index | ) |

virtual

Get a content collection.

## getContentCollectionCount()

virtual size_t Ogre::Page::getContentCollectionCount | ( |  | ) | const

virtual

Get the number of content collections.

## getContentCollectionList()

const ContentCollectionList& Ogre::Page::getContentCollectionList | ( |  | ) | const

Get the list of content collections.

## getFrameLastHeld()

virtual unsigned long Ogre::Page::getFrameLastHeld | ( |  | ) |

virtual

Get the frame number in which this Page was last loaded or held.

Remarks
  A Page that has not been requested to be loaded or held in the recent past will be a candidate for removal.

Definition at line 121 of file OgrePage.h.

## getID()

virtual PageID Ogre::Page::getID | ( |  | ) | const

virtual

Get the ID of this page, unique within the parent.

Definition at line 113 of file OgrePage.h.

## getManager()

PageManager* Ogre::Page::getManager | ( |  | ) | const

## getParentSection()

virtual PagedWorldSection* Ogre::Page::getParentSection | ( |  | ) | const

virtual

Get the PagedWorldSection this page belongs to.

Definition at line 115 of file OgrePage.h.

## getSceneManager()

SceneManager* Ogre::Page::getSceneManager | ( |  | ) | const

## handleRequest()

WorkQueue::Response* Ogre::Page::handleRequest | ( | const WorkQueue::Request * | req,
|  | const WorkQueue * | srcQ
| ) |  |

virtual

WorkQueue::RequestHandler override.

Implements Ogre::WorkQueue::RequestHandler.

## handleResponse()

void Ogre::Page::handleResponse | ( | const WorkQueue::Response * | res,
|  | const WorkQueue * | srcQ
| ) |  |

virtual

WorkQueue::ResponseHandler override.

Implements Ogre::WorkQueue::ResponseHandler.

## isDeferredProcessInProgress()

bool Ogre::Page::isDeferredProcessInProgress | ( |  | ) | const

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.

## isHeld()

virtual bool Ogre::Page::isHeld | ( |  | ) | const

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.

## isModified()

bool Ogre::Page::isModified | ( |  | ) | const

Definition at line 189 of file OgrePage.h.

## load()

virtual void Ogre::Page::load | ( | bool | synchronous | ) |

virtual

Load this page.

Parameters

  synchronous | Whether to force this to happen synchronously.

## loadImpl()

virtual void Ogre::Page::loadImpl | ( |  | ) |

protected virtual

## notifyCamera()

virtual void Ogre::Page::notifyCamera | ( | Camera * | cam | ) |

virtual

Notify a section of the current camera.

## operator delete() [1/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr | ) |

inherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

## operator delete() [2/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr,
|  | void * |
| ) |  |

inherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

## operator delete() [3/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr,
|  | const char * | ,
|  | int | ,
|  | const char * |
| ) |  |

inherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

## operator delete[]() [1/2]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr | ) |

inherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

## operator delete[]() [2/2]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr,
|  | const char * | ,
|  | int | ,
|  | const char * |
| ) |  |

inherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

## operator new() [1/3]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz,
|  | const char * | file,
|  | int | line,
|  | const char * | func
| ) |  |

inherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

## operator new() [2/3]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz | ) |

inherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

## operator new() [3/3]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz,
|  | void * | ptr
| ) |  |

inherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

## operator new[]() [1/2]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[] | ( | size_t | sz,
|  | const char * | file,
|  | int | line,
|  | const char * | func
| ) |  |

inherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

## operator new[]() [2/2]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[] | ( | size_t | sz | ) |

inherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

## prepareImpl() [1/2]

virtual bool Ogre::Page::prepareImpl | ( | PageData * | dataToPopulate | ) |

protected virtual

## prepareImpl() [2/2]

virtual bool Ogre::Page::prepareImpl | ( | StreamSerialiser & | str,
|  | PageData * | dataToPopulate
| ) |  |

protected virtual

## save() [1/3]

virtual void Ogre::Page::save | ( |  | ) |

virtual

Save page data to an automatically generated file name.

## save() [2/3]

virtual void Ogre::Page::save | ( | const String & | filename | ) |

virtual

Save page data to a file.

## save() [3/3]

virtual void Ogre::Page::save | ( | StreamSerialiser & | stream | ) |

virtual

Save page data to a serialiser.

## touch()

virtual void Ogre::Page::touch | ( |  | ) |

virtual

'Touch' the page to let it know it's being used

## unload()

virtual void Ogre::Page::unload | ( |  | ) |

virtual

Unload this page.

## updateDebugDisplay()

void Ogre::Page::updateDebugDisplay | ( |  | ) |

protected

## Friends And Related Function Documentation

## operator<<

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

friend

Function for writing to a stream.

## Member Data Documentation

## CHUNK_CONTENTCOLLECTION_DECLARATION_ID

const uint32 Ogre::Page::CHUNK_CONTENTCOLLECTION_DECLARATION_ID

static

Definition at line 101 of file OgrePage.h.

## CHUNK_ID

const uint32 Ogre::Page::CHUNK_ID

static

Definition at line 98 of file OgrePage.h.

## CHUNK_VERSION

const uint16 Ogre::Page::CHUNK_VERSION

static

Definition at line 99 of file OgrePage.h.

## mContentCollections

ContentCollectionList Ogre::Page::mContentCollections

protected

Definition at line 58 of file OgrePage.h.

## mDebugNode

SceneNode* Ogre::Page::mDebugNode

protected

Definition at line 63 of file OgrePage.h.

## mDeferredProcessInProgress

bool Ogre::Page::mDeferredProcessInProgress

protected

Definition at line 60 of file OgrePage.h.

## mFrameLastHeld

unsigned long Ogre::Page::mFrameLastHeld

protected

Definition at line 57 of file OgrePage.h.

## mID

PageID Ogre::Page::mID

protected

Definition at line 55 of file OgrePage.h.

## mModified

bool Ogre::Page::mModified

protected

Definition at line 61 of file OgrePage.h.

## mParent

PagedWorldSection* Ogre::Page::mParent

protected

Definition at line 56 of file OgrePage.h.

## mWorkQueueChannel

uint16 Ogre::Page::mWorkQueueChannel

protected

Definition at line 59 of file OgrePage.h.

## WORKQUEUE_CHANGECOLLECTION_REQUEST

const uint16 Ogre::Page::WORKQUEUE_CHANGECOLLECTION_REQUEST

static

Definition at line 192 of file OgrePage.h.

## WORKQUEUE_PREPARE_REQUEST

const uint16 Ogre::Page::WORKQUEUE_PREPARE_REQUEST

static

Definition at line 191 of file OgrePage.h.

The documentation for this class was generated from the following file:

- OgrePage.h

Copyright © 2012 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.