Represents a section of the PagedWorld which uses a given PageStrategy, and which is made up of a generally localised set of Page instances. More...
#include <OgrePagedWorldSection.h>

Public Types | |
| typedef map< PageID, Page * >::type | PageMap |
Public Member Functions | |
| PagedWorldSection (const String &name, PagedWorld *parent, SceneManager *sm) | |
| Construct a new instance, specifying the parent and scene manager. | |
| virtual | ~PagedWorldSection () |
| PageManager * | getManager () const |
| virtual const String & | getName () const |
| Get the name of this section. | |
| virtual PageStrategy * | getStrategy () const |
| Get the page strategy which this section is using. | |
| virtual void | setStrategy (PageStrategy *strat) |
| Change the page strategy. | |
| virtual void | setStrategy (const String &stratName) |
| Change the page strategy. | |
| virtual void | setSceneManager (SceneManager *sm) |
| Change the SceneManager. | |
| virtual void | setSceneManager (const String &smName) |
| Change the SceneManager. | |
| virtual SceneManager * | getSceneManager () const |
| Get the current SceneManager. | |
| virtual PagedWorld * | getWorld () const |
| Get the parent world. | |
| virtual PageStrategyData * | getStrategyData () const |
| Get the data required by the PageStrategy which is specific to this world section. | |
| virtual void | setBoundingBox (const AxisAlignedBox &box) |
| Set the bounds of this section. | |
| virtual const AxisAlignedBox & | getBoundingBox () const |
| Get the bounds of this section. | |
| virtual bool | load (StreamSerialiser &stream) |
| Load this section from a stream (returns true if successful) | |
| virtual void | save (StreamSerialiser &stream) |
| Save this section to a stream. | |
| virtual void | frameStart (Real timeSinceLastFrame) |
| Called when the frame starts. | |
| virtual void | frameEnd (Real timeElapsed) |
| Called when the frame ends. | |
| virtual void | notifyCamera (Camera *cam) |
| Notify a section of the current camera. | |
| virtual Page * | loadOrCreatePage (const Vector3 &worldPos) |
| Load or create a page against this section covering the given world space position. | |
| virtual PageID | getPageID (const Vector3 &worldPos) |
| Get the page ID for a given world position. | |
| virtual void | loadPage (PageID pageID, bool forceSynchronous=false) |
| Ask for a page to be loaded with the given (section-relative) PageID. | |
| virtual void | unloadPage (PageID pageID, bool forceSynchronous=false) |
| Ask for a page to be unloaded with the given (section-relative) PageID. | |
| virtual void | unloadPage (Page *p, bool forceSynchronous=false) |
| Ask for a page to be unloaded with the given (section-relative) PageID. | |
| virtual bool | _prepareProceduralPage (Page *page) |
| Give a section the opportunity to prepare page content procedurally. | |
| virtual bool | _loadProceduralPage (Page *page) |
| Give a section the opportunity to prepare page content procedurally. | |
| virtual bool | _unloadProceduralPage (Page *page) |
| Give a section the opportunity to unload page content procedurally. | |
| virtual bool | _unprepareProceduralPage (Page *page) |
| Give a section the opportunity to unprepare page content procedurally. | |
| virtual void | holdPage (PageID pageID) |
| Ask for a page to be kept in memory if it's loaded. | |
| virtual Page * | getPage (PageID pageID) |
| Retrieves a Page. | |
| virtual void | removeAllPages () |
| Remove all pages immediately. | |
| virtual void | setPageProvider (PageProvider *provider) |
| Set the PageProvider which can provide streams Pages in this section. | |
| virtual PageProvider * | getPageProvider () const |
| Get the PageProvider which can provide streams for Pages in this section. | |
| virtual StreamSerialiser * | _readPageStream (PageID pageID) |
| Get a serialiser set up to read Page data for the given PageID. | |
| virtual StreamSerialiser * | _writePageStream (PageID pageID) |
| Get a serialiser set up to write Page data for the given PageID. | |
| virtual const String & | getType () |
| Get the type name of this section. | |
| void * | operator new (size_t sz, const char *file, int line, const char *func) |
| operator new, with debug line info | |
| void * | operator new (size_t sz) |
| void * | operator new (size_t sz, void *ptr) |
| placement operator new | |
| void * | operator new[] (size_t sz, const char *file, int line, const char *func) |
| array operator new, with debug line info | |
| void * | operator new[] (size_t sz) |
| 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 *) |
Static Public Attributes | |
| static const uint32 | CHUNK_ID |
| static const uint16 | CHUNK_VERSION |
Protected Member Functions | |
| virtual void | loadSubtypeData (StreamSerialiser &ser) |
| Load data specific to a subtype of this class (if any) | |
| virtual void | saveSubtypeData (StreamSerialiser &ser) |
Protected Attributes | |
| String | mName |
| AxisAlignedBox | mAABB |
| PagedWorld * | mParent |
| PageStrategy * | mStrategy |
| PageStrategyData * | mStrategyData |
| PageMap | mPages |
| PageProvider * | mPageProvider |
| SceneManager * | mSceneMgr |
Friends | |
| _OgrePagingExport friend std::ostream & | operator<< (std::ostream &o, const PagedWorldSection &p) |
| Function for writing to a stream. | |
Represents a section of the PagedWorld which uses a given PageStrategy, and which is made up of a generally localised set of Page instances.
Definition at line 69 of file OgrePagedWorldSection.h.
| typedef map<PageID, Page*>::type Ogre::PagedWorldSection::PageMap |
Definition at line 72 of file OgrePagedWorldSection.h.
| Ogre::PagedWorldSection::PagedWorldSection | ( | const String & | name, |
| PagedWorld * | parent, | ||
| SceneManager * | sm | ||
| ) |
Construct a new instance, specifying the parent and scene manager.
| virtual Ogre::PagedWorldSection::~PagedWorldSection | ( | ) | [virtual] |
| virtual bool Ogre::PagedWorldSection::_loadProceduralPage | ( | Page * | page | ) | [virtual] |
Give a section the opportunity to prepare page content procedurally.
| virtual bool Ogre::PagedWorldSection::_prepareProceduralPage | ( | Page * | page | ) | [virtual] |
Give a section the opportunity to prepare page content procedurally.
| virtual StreamSerialiser* Ogre::PagedWorldSection::_readPageStream | ( | PageID | pageID | ) | [virtual] |
Get a serialiser set up to read Page data for the given PageID.
| pageID | The ID of the page being requested |
| virtual bool Ogre::PagedWorldSection::_unloadProceduralPage | ( | Page * | page | ) | [virtual] |
Give a section the opportunity to unload page content procedurally.
| virtual bool Ogre::PagedWorldSection::_unprepareProceduralPage | ( | Page * | page | ) | [virtual] |
Give a section the opportunity to unprepare page content procedurally.
| virtual StreamSerialiser* Ogre::PagedWorldSection::_writePageStream | ( | PageID | pageID | ) | [virtual] |
Get a serialiser set up to write Page data for the given PageID.
| pageID | The ID of the page being requested |
| virtual void Ogre::PagedWorldSection::frameEnd | ( | Real | timeElapsed | ) | [virtual] |
Called when the frame ends.
| virtual void Ogre::PagedWorldSection::frameStart | ( | Real | timeSinceLastFrame | ) | [virtual] |
Called when the frame starts.
| virtual const AxisAlignedBox& Ogre::PagedWorldSection::getBoundingBox | ( | ) | const [virtual] |
Get the bounds of this section.
| PageManager* Ogre::PagedWorldSection::getManager | ( | ) | const |
| virtual const String& Ogre::PagedWorldSection::getName | ( | void | ) | const [virtual] |
Get the name of this section.
Definition at line 99 of file OgrePagedWorldSection.h.
| virtual Page* Ogre::PagedWorldSection::getPage | ( | PageID | pageID | ) | [virtual] |
| virtual PageID Ogre::PagedWorldSection::getPageID | ( | const Vector3 & | worldPos | ) | [virtual] |
Get the page ID for a given world position.
| virtual PageProvider* Ogre::PagedWorldSection::getPageProvider | ( | ) | const [virtual] |
Get the PageProvider which can provide streams for Pages in this section.
Definition at line 271 of file OgrePagedWorldSection.h.
| virtual SceneManager* Ogre::PagedWorldSection::getSceneManager | ( | ) | const [virtual] |
Get the current SceneManager.
Definition at line 130 of file OgrePagedWorldSection.h.
| virtual PageStrategy* Ogre::PagedWorldSection::getStrategy | ( | ) | const [virtual] |
Get the page strategy which this section is using.
Definition at line 101 of file OgrePagedWorldSection.h.
| virtual PageStrategyData* Ogre::PagedWorldSection::getStrategyData | ( | ) | const [virtual] |
Get the data required by the PageStrategy which is specific to this world section.
Definition at line 135 of file OgrePagedWorldSection.h.
| virtual const String& Ogre::PagedWorldSection::getType | ( | ) | [virtual] |
Get the type name of this section.
| virtual PagedWorld* Ogre::PagedWorldSection::getWorld | ( | ) | const [virtual] |
Get the parent world.
Definition at line 133 of file OgrePagedWorldSection.h.
| virtual void Ogre::PagedWorldSection::holdPage | ( | PageID | pageID | ) | [virtual] |
Ask for a page to be kept in memory if it's loaded.
| virtual bool Ogre::PagedWorldSection::load | ( | StreamSerialiser & | stream | ) | [virtual] |
Load this section from a stream (returns true if successful)
| virtual Page* Ogre::PagedWorldSection::loadOrCreatePage | ( | const Vector3 & | worldPos | ) | [virtual] |
Load or create a page against this section covering the given world space position.
| virtual void Ogre::PagedWorldSection::loadPage | ( | PageID | pageID, |
| bool | forceSynchronous = false |
||
| ) | [virtual] |
Ask for a page to be loaded with the given (section-relative) PageID.
| pageID | The page ID to load |
| forceSynchronous | If true, the page will always be loaded synchronously |
Reimplemented in Ogre::TerrainPagedWorldSection.
| virtual void Ogre::PagedWorldSection::loadSubtypeData | ( | StreamSerialiser & | ser | ) | [protected, virtual] |
Load data specific to a subtype of this class (if any)
Reimplemented in Ogre::TerrainPagedWorldSection.
Definition at line 84 of file OgrePagedWorldSection.h.
| virtual void Ogre::PagedWorldSection::notifyCamera | ( | Camera * | cam | ) | [virtual] |
Notify a section of the current camera.
| void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr | ) | [inherited] |
Definition at line 95 of file OgreMemoryAllocatedObject.h.
| void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr, |
| void * | |||
| ) | [inherited] |
Definition at line 101 of file OgreMemoryAllocatedObject.h.
| void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr, |
| const char * | , | ||
| int | , | ||
| const char * | |||
| ) | [inherited] |
Definition at line 107 of file OgreMemoryAllocatedObject.h.
| void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr | ) | [inherited] |
Definition at line 112 of file OgreMemoryAllocatedObject.h.
| void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr, |
| const char * | , | ||
| int | , | ||
| const char * | |||
| ) | [inherited] |
Definition at line 118 of file OgreMemoryAllocatedObject.h.
| 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 67 of file OgreMemoryAllocatedObject.h.
| void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz | ) | [inherited] |
Definition at line 72 of file OgreMemoryAllocatedObject.h.
| void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz, |
| void * | ptr | ||
| ) | [inherited] |
placement operator new
Definition at line 78 of file OgreMemoryAllocatedObject.h.
| 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 85 of file OgreMemoryAllocatedObject.h.
| void* Ogre::AllocatedObject< Alloc >::operator new[] | ( | size_t | sz | ) | [inherited] |
Definition at line 90 of file OgreMemoryAllocatedObject.h.
| virtual void Ogre::PagedWorldSection::removeAllPages | ( | ) | [virtual] |
Remove all pages immediately.
| virtual void Ogre::PagedWorldSection::save | ( | StreamSerialiser & | stream | ) | [virtual] |
Save this section to a stream.
| virtual void Ogre::PagedWorldSection::saveSubtypeData | ( | StreamSerialiser & | ser | ) | [protected, virtual] |
Reimplemented in Ogre::TerrainPagedWorldSection.
Definition at line 85 of file OgrePagedWorldSection.h.
| virtual void Ogre::PagedWorldSection::setBoundingBox | ( | const AxisAlignedBox & | box | ) | [virtual] |
Set the bounds of this section.
| virtual void Ogre::PagedWorldSection::setPageProvider | ( | PageProvider * | provider | ) | [virtual] |
Set the PageProvider which can provide streams Pages in this section.
Definition at line 268 of file OgrePagedWorldSection.h.
| virtual void Ogre::PagedWorldSection::setSceneManager | ( | SceneManager * | sm | ) | [virtual] |
Change the SceneManager.
| virtual void Ogre::PagedWorldSection::setSceneManager | ( | const String & | smName | ) | [virtual] |
Change the SceneManager.
| smName | The instance name of the SceneManager |
| virtual void Ogre::PagedWorldSection::setStrategy | ( | PageStrategy * | strat | ) | [virtual] |
Change the page strategy.
| virtual void Ogre::PagedWorldSection::setStrategy | ( | const String & | stratName | ) | [virtual] |
Change the page strategy.
| virtual void Ogre::PagedWorldSection::unloadPage | ( | PageID | pageID, |
| bool | forceSynchronous = false |
||
| ) | [virtual] |
Ask for a page to be unloaded with the given (section-relative) PageID.
| pageID | The page ID to unload |
| forceSynchronous | If true, the page will always be unloaded synchronously |
Reimplemented in Ogre::TerrainPagedWorldSection.
| virtual void Ogre::PagedWorldSection::unloadPage | ( | Page * | p, |
| bool | forceSynchronous = false |
||
| ) | [virtual] |
Ask for a page to be unloaded with the given (section-relative) PageID.
| p | The Page to unload |
| forceSynchronous | If true, the page will always be unloaded synchronously |
| _OgrePagingExport friend std::ostream& operator<< | ( | std::ostream & | o, |
| const PagedWorldSection & | p | ||
| ) | [friend] |
Function for writing to a stream.
const uint32 Ogre::PagedWorldSection::CHUNK_ID [static] |
Definition at line 89 of file OgrePagedWorldSection.h.
const uint16 Ogre::PagedWorldSection::CHUNK_VERSION [static] |
Definition at line 90 of file OgrePagedWorldSection.h.
AxisAlignedBox Ogre::PagedWorldSection::mAABB [protected] |
Definition at line 75 of file OgrePagedWorldSection.h.
String Ogre::PagedWorldSection::mName [protected] |
Definition at line 74 of file OgrePagedWorldSection.h.
PageProvider* Ogre::PagedWorldSection::mPageProvider [protected] |
Definition at line 80 of file OgrePagedWorldSection.h.
PageMap Ogre::PagedWorldSection::mPages [protected] |
Definition at line 79 of file OgrePagedWorldSection.h.
PagedWorld* Ogre::PagedWorldSection::mParent [protected] |
Definition at line 76 of file OgrePagedWorldSection.h.
SceneManager* Ogre::PagedWorldSection::mSceneMgr [protected] |
Definition at line 81 of file OgrePagedWorldSection.h.
PageStrategy* Ogre::PagedWorldSection::mStrategy [protected] |
Definition at line 77 of file OgrePagedWorldSection.h.
PageStrategyData* Ogre::PagedWorldSection::mStrategyData [protected] |
Definition at line 78 of file OgrePagedWorldSection.h.
Copyright © 2012 Torus Knot Software Ltd

This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
Last modified Sun Sep 2 2012 07:27:43