OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Ogre::PageManager Class Reference

The PageManager is the entry point through which you load all PagedWorld instances, and the place where PageStrategy instances and factory classes are registered to customise the paging behaviour. More...

#include <OgrePageManager.h>

+ Inheritance diagram for Ogre::PageManager:
+ Collaboration diagram for Ogre::PageManager:

Classes

class  EventRouter
 

Public Types

typedef vector< Camera * >::type CameraList
 
typedef map< String,
PageContentCollectionFactory * >
::type 
ContentCollectionFactoryMap
 
typedef map< String,
PageContentFactory * >::type 
ContentFactoryMap
 
typedef map< String,
PageStrategy * >::type 
StrategyMap
 
typedef map< String,
PagedWorld * >::type 
WorldMap
 
typedef map< String,
PagedWorldSectionFactory * >
::type 
WorldSectionFactoryMap
 

Public Member Functions

 PageManager ()
 
virtual ~PageManager ()
 
virtual bool _loadProceduralPage (Page *page, PagedWorldSection *section)
 Give a provider the opportunity to prepare page content procedurally. More...
 
virtual bool _prepareProceduralPage (Page *page, PagedWorldSection *section)
 Give a provider the opportunity to prepare page content procedurally. More...
 
StreamSerialiser_readPageStream (PageID pageID, PagedWorldSection *section)
 Get a serialiser set up to read Page data for the given PageID. More...
 
StreamSerialiser_readWorldStream (const String &filename)
 Get a serialiser set up to read PagedWorld data for the given world name. More...
 
virtual bool _unloadProceduralPage (Page *page, PagedWorldSection *section)
 Give a manager the opportunity to unload page content procedurally. More...
 
virtual bool _unprepareProceduralPage (Page *page, PagedWorldSection *section)
 Give a manager the opportunity to unprepare page content procedurally. More...
 
StreamSerialiser_writePageStream (PageID pageID, PagedWorldSection *section)
 Get a serialiser set up to write Page data for the given PageID. More...
 
StreamSerialiser_writeWorldStream (const String &filename)
 Get a serialiser set up to write PagedWorld data. More...
 
void addCamera (Camera *c)
 Tells the paging system to start tracking a given camera. More...
 
void addContentCollectionFactory (PageContentCollectionFactory *f)
 Add a new PageContentCollectionFactory implementation. More...
 
void addContentFactory (PageContentFactory *f)
 Add a new PageContentFactory implementation. More...
 
void addStrategy (PageStrategy *strategy)
 Add a new PageStrategy implementation. More...
 
void addWorldSectionFactory (PagedWorldSectionFactory *f)
 Add a new PagedWorldSectionFactory implementation. More...
 
PageContentcreateContent (const String &typeName)
 Create a new instance of PageContent using the registered factories. More...
 
PageContentCollectioncreateContentCollection (const String &typeName)
 Create a new instance of PageContentCollection using the registered factories. More...
 
PagedWorldcreateWorld (const String &name=BLANKSTRING)
 Create a new PagedWorld instance. More...
 
PagedWorldSectioncreateWorldSection (const String &typeName, const String &name, PagedWorld *parent, SceneManager *sm)
 Create a new instance of PagedWorldSection using the registered factories. More...
 
void destroyContent (PageContent *c)
 Destroy an instance of PageContent. More...
 
void destroyContentCollection (PageContentCollection *coll)
 Destroy an instance of PageContentCollection. More...
 
void destroyWorld (const String &name)
 Destroy a world. More...
 
void destroyWorld (PagedWorld *world)
 Destroy a world. More...
 
void destroyWorldSection (PagedWorldSection *s)
 Destroy an instance of PagedWorldSection. More...
 
const CameraListgetCameraList () const
 Returns a list of cameras being tracked. More...
 
const ContentCollectionFactoryMapgetContentCollectionFactories () const
 Get a reference to the registered strategies. More...
 
PageContentCollectionFactorygetContentCollectionFactory (const String &name)
 Get a PageContentCollectionFactory. More...
 
const ContentFactoryMapgetContentFactories () const
 Get a reference to the registered strategies. More...
 
PageContentFactorygetContentFactory (const String &name)
 Get a PageContentFactory. More...
 
uint8 getDebugDisplayLevel () const
 Get the debug display level. More...
 
PageProvidergetPageProvider () const
 Get the PageProvider which can provide streams for any Page. More...
 
const StringgetPageResourceGroup () const
 Get the resource group that will be used to read/write files when the default load routines are used. More...
 
bool getPagingOperationsEnabled () const
 Get whether paging operations are currently allowed to happen. More...
 
const StrategyMapgetStrategies () const
 Get a reference to the registered strategies. More...
 
PageStrategygetStrategy (const String &name)
 Get a PageStrategy. More...
 
PagedWorldgetWorld (const String &name)
 Get a named world. More...
 
const WorldMapgetWorlds () const
 Get a reference to the worlds that are currently loaded. More...
 
const WorldSectionFactoryMapgetWorldSectionFactories () const
 Get a reference to the registered strategies. More...
 
PagedWorldSectionFactorygetWorldSectionFactory (const String &name)
 Get a PagedWorldSectionFactory. More...
 
bool hasCamera (Camera *c) const
 Returns whether or not a given camera is being watched by the paging system. More...
 
PagedWorldloadWorld (const String &filename, const String &name=BLANKSTRING)
 Load a new PagedWorld from a file. More...
 
PagedWorldloadWorld (const DataStreamPtr &stream, const String &name=BLANKSTRING)
 Load a new PagedWorld from a stream. 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)
 
void removeCamera (Camera *c)
 Tells the paging system to stop tracking a given camera. More...
 
void removeContentCollectionFactory (PageContentCollectionFactory *f)
 Remove a PageContentCollectionFactory implementation. More...
 
void removeContentFactory (PageContentFactory *f)
 Remove a PageContentFactory implementation. More...
 
void removeStrategy (PageStrategy *strategy)
 Remove a PageStrategy implementation. More...
 
void removeWorldSectionFactory (PagedWorldSectionFactory *f)
 Remove a PagedWorldSectionFactory implementation. More...
 
void saveWorld (PagedWorld *world, const String &filename)
 Save a PagedWorld instance to a file. More...
 
void saveWorld (PagedWorld *world, const DataStreamPtr &stream)
 Save a PagedWorld instance to a file. More...
 
void setDebugDisplayLevel (uint8 lvl)
 Set the debug display level. More...
 
void setPageProvider (PageProvider *provider)
 Set the PageProvider which can provide streams for any Page. More...
 
void setPageResourceGroup (const String &g)
 Set the resource group that will be used to read/write files when the default load routines are used. More...
 
void setPagingOperationsEnabled (bool enabled)
 Pause or unpause all paging operations. More...
 

Protected Member Functions

void createStandardContentFactories ()
 
void createStandardStrategies ()
 

Protected Attributes

CameraList mCameraList
 
ContentCollectionFactoryMap mContentCollectionFactories
 
ContentFactoryMap mContentFactories
 
uint8 mDebugDisplayLvl
 
EventRouter mEventRouter
 
Grid2DPageStrategymGrid2DPageStrategy
 
Grid3DPageStrategymGrid3DPageStrategy
 
PageProvidermPageProvider
 
String mPageResourceGroup
 
bool mPagingEnabled
 
SimplePageContentCollectionFactorymSimpleCollectionFactory
 
StrategyMap mStrategies
 
NameGenerator mWorldNameGenerator
 
WorldMap mWorlds
 
WorldSectionFactoryMap mWorldSectionFactories
 

Detailed Description

The PageManager is the entry point through which you load all PagedWorld instances, and the place where PageStrategy instances and factory classes are registered to customise the paging behaviour.

Remarks
To get started, the minimum you need is a PagedWorld with at least one PagedWorldSection within it, and at least one Camera being tracked (see addCamera).

Definition at line 134 of file OgrePageManager.h.

Member Typedef Documentation

Definition at line 407 of file OgrePageManager.h.

Definition at line 184 of file OgrePageManager.h.

Definition at line 179 of file OgrePageManager.h.

Constructor & Destructor Documentation

Ogre::PageManager::PageManager ( )
virtual Ogre::PageManager::~PageManager ( )
virtual

Member Function Documentation

virtual bool Ogre::PageManager::_loadProceduralPage ( Page page,
PagedWorldSection section 
)
virtual

Give a provider the opportunity to prepare page content procedurally.

Remarks
You should not call this method directly. This call will happen in the main render thread so it can access GPU resources. Use _prepareProceduralPage for background preparation.
Returns
true if the page was populated, false otherwise
virtual bool Ogre::PageManager::_prepareProceduralPage ( Page page,
PagedWorldSection section 
)
virtual

Give a provider the opportunity to prepare page content procedurally.

Remarks
You should not call this method directly. This call may well happen in a separate thread so it should not access GPU resources, use _loadProceduralPage for that
Returns
true if the page was populated, false otherwise
StreamSerialiser* Ogre::PageManager::_readPageStream ( PageID  pageID,
PagedWorldSection section 
)

Get a serialiser set up to read Page data for the given PageID.

Parameters
pageIDThe ID of the page being requested
sectionThe parent section to which this page will belong
Remarks
The StreamSerialiser returned is the responsibility of the caller to delete.
StreamSerialiser* Ogre::PageManager::_readWorldStream ( const String filename)

Get a serialiser set up to read PagedWorld data for the given world name.

Remarks
The StreamSerialiser returned is the responsibility of the caller to delete.
virtual bool Ogre::PageManager::_unloadProceduralPage ( Page page,
PagedWorldSection section 
)
virtual

Give a manager the opportunity to unload page content procedurally.

Remarks
You should not call this method directly. This call will happen in the main render thread so it can access GPU resources. Use _unprepareProceduralPage for background preparation.
Returns
true if the page was populated, false otherwise
virtual bool Ogre::PageManager::_unprepareProceduralPage ( Page page,
PagedWorldSection section 
)
virtual

Give a manager the opportunity to unprepare page content procedurally.

Remarks
You should not call this method directly. This call may well happen in a separate thread so it should not access GPU resources, use _unloadProceduralPage for that
Returns
true if the page was unpopulated, false otherwise
StreamSerialiser* Ogre::PageManager::_writePageStream ( PageID  pageID,
PagedWorldSection section 
)

Get a serialiser set up to write Page data for the given PageID.

Parameters
pageIDThe ID of the page being requested
sectionThe parent section to which this page will belong
Remarks
The StreamSerialiser returned is the responsibility of the caller to delete.
StreamSerialiser* Ogre::PageManager::_writeWorldStream ( const String filename)

Get a serialiser set up to write PagedWorld data.

Remarks
The StreamSerialiser returned is the responsibility of the caller to delete.
void Ogre::PageManager::addCamera ( Camera c)

Tells the paging system to start tracking a given camera.

Remarks
In order for the paging system to function it needs to know which Cameras to track. You may not want to have all your cameras affect the paging system, so just add the cameras you want it to keep track of here.
void Ogre::PageManager::addContentCollectionFactory ( PageContentCollectionFactory f)

Add a new PageContentCollectionFactory implementation.

Remarks
The caller remains resonsible for destruction of this instance.
void Ogre::PageManager::addContentFactory ( PageContentFactory f)

Add a new PageContentFactory implementation.

Remarks
The caller remains resonsible for destruction of this instance.
void Ogre::PageManager::addStrategy ( PageStrategy strategy)

Add a new PageStrategy implementation.

Remarks
The caller remains resonsible for destruction of this instance.
void Ogre::PageManager::addWorldSectionFactory ( PagedWorldSectionFactory f)

Add a new PagedWorldSectionFactory implementation.

Remarks
The caller remains resonsible for destruction of this instance.
PageContent* Ogre::PageManager::createContent ( const String typeName)

Create a new instance of PageContent using the registered factories.

Parameters
typeNameThe name of the type of content to create
PageContentCollection* Ogre::PageManager::createContentCollection ( const String typeName)

Create a new instance of PageContentCollection using the registered factories.

Parameters
typeNameThe name of the type of collection to create
void Ogre::PageManager::createStandardContentFactories ( )
protected
void Ogre::PageManager::createStandardStrategies ( )
protected
PagedWorld* Ogre::PageManager::createWorld ( const String name = BLANKSTRING)

Create a new PagedWorld instance.

Parameters
nameOptionally give a name to the world (if no name is given, one will be generated).
PagedWorldSection* Ogre::PageManager::createWorldSection ( const String typeName,
const String name,
PagedWorld parent,
SceneManager sm 
)

Create a new instance of PagedWorldSection using the registered factories.

Parameters
typeNameThe name of the type of collection to create
nameThe instance name
parentThe parent world
smThe SceneManager to use (can be null if this is to be loaded)
void Ogre::PageManager::destroyContent ( PageContent c)

Destroy an instance of PageContent.

void Ogre::PageManager::destroyContentCollection ( PageContentCollection coll)

Destroy an instance of PageContentCollection.

void Ogre::PageManager::destroyWorld ( const String name)

Destroy a world.

void Ogre::PageManager::destroyWorld ( PagedWorld world)

Destroy a world.

void Ogre::PageManager::destroyWorldSection ( PagedWorldSection s)

Destroy an instance of PagedWorldSection.

const CameraList& Ogre::PageManager::getCameraList ( ) const

Returns a list of cameras being tracked.

const ContentCollectionFactoryMap& Ogre::PageManager::getContentCollectionFactories ( ) const

Get a reference to the registered strategies.

PageContentCollectionFactory* Ogre::PageManager::getContentCollectionFactory ( const String name)

Get a PageContentCollectionFactory.

Parameters
nameThe name of the factory to retrieve
Returns
Pointer to a PageContentCollectionFactory, or null if the ContentCollection was not found.
const ContentFactoryMap& Ogre::PageManager::getContentFactories ( ) const

Get a reference to the registered strategies.

PageContentFactory* Ogre::PageManager::getContentFactory ( const String name)

Get a PageContentFactory.

Parameters
nameThe name of the factory to retrieve
Returns
Pointer to a PageContentFactory, or null if the Content was not found.
uint8 Ogre::PageManager::getDebugDisplayLevel ( ) const
inline

Get the debug display level.

Definition at line 422 of file OgrePageManager.h.

PageProvider* Ogre::PageManager::getPageProvider ( ) const
inline

Get the PageProvider which can provide streams for any Page.

Definition at line 316 of file OgrePageManager.h.

const String& Ogre::PageManager::getPageResourceGroup ( ) const
inline

Get the resource group that will be used to read/write files when the default load routines are used.

Definition at line 384 of file OgrePageManager.h.

bool Ogre::PageManager::getPagingOperationsEnabled ( ) const
inline

Get whether paging operations are currently allowed to happen.

Definition at line 433 of file OgrePageManager.h.

const StrategyMap& Ogre::PageManager::getStrategies ( ) const

Get a reference to the registered strategies.

PageStrategy* Ogre::PageManager::getStrategy ( const String name)

Get a PageStrategy.

Parameters
nameThe name of the strategy to retrieve
Returns
Pointer to a PageStrategy, or null if the strategy was not found.
PagedWorld* Ogre::PageManager::getWorld ( const String name)

Get a named world.

Parameters
nameThe name of the world (not a filename, the identifying name)
Returns
The world, or null if the world doesn't exist.
const WorldMap& Ogre::PageManager::getWorlds ( ) const
inline

Get a reference to the worlds that are currently loaded.

Definition at line 181 of file OgrePageManager.h.

const WorldSectionFactoryMap& Ogre::PageManager::getWorldSectionFactories ( ) const

Get a reference to the registered strategies.

PagedWorldSectionFactory* Ogre::PageManager::getWorldSectionFactory ( const String name)

Get a PagedWorldSectionFactory.

Parameters
nameThe name of the factory to retrieve
Returns
Pointer to a PagedWorldSectionFactory, or null if the WorldSection was not found.
bool Ogre::PageManager::hasCamera ( Camera c) const

Returns whether or not a given camera is being watched by the paging system.

PagedWorld* Ogre::PageManager::loadWorld ( const String filename,
const String name = BLANKSTRING 
)

Load a new PagedWorld from a file.

Parameters
filenameThe name of the file to load (standard is .world)
nameOptionally give a name to the world (if no name is given, one will be generated).
PagedWorld* Ogre::PageManager::loadWorld ( const DataStreamPtr stream,
const String name = BLANKSTRING 
)

Load a new PagedWorld from a stream.

Parameters
streamA stream from which to load the world data
nameOptionally give a name to the world (if no name is given, one will be generated).
template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr)
inlineinherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
void *   
)
inlineinherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

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

Definition at line 108 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr)
inlineinherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

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

Definition at line 119 of file OgreMemoryAllocatedObject.h.

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

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz)
inlineinherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

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

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

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

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

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

Definition at line 91 of file OgreMemoryAllocatedObject.h.

void Ogre::PageManager::removeCamera ( Camera c)

Tells the paging system to stop tracking a given camera.

void Ogre::PageManager::removeContentCollectionFactory ( PageContentCollectionFactory f)

Remove a PageContentCollectionFactory implementation.

void Ogre::PageManager::removeContentFactory ( PageContentFactory f)

Remove a PageContentFactory implementation.

void Ogre::PageManager::removeStrategy ( PageStrategy strategy)

Remove a PageStrategy implementation.

void Ogre::PageManager::removeWorldSectionFactory ( PagedWorldSectionFactory f)

Remove a PagedWorldSectionFactory implementation.

void Ogre::PageManager::saveWorld ( PagedWorld world,
const String filename 
)

Save a PagedWorld instance to a file.

Parameters
worldThe world to be saved
filenameThe filename to save the data to
void Ogre::PageManager::saveWorld ( PagedWorld world,
const DataStreamPtr stream 
)

Save a PagedWorld instance to a file.

Parameters
worldThe world to be saved
streamThe stream to save the data to
void Ogre::PageManager::setDebugDisplayLevel ( uint8  lvl)
inline

Set the debug display level.

Remarks
This setting controls how much debug information is displayed in the scene. The exact interpretation of this value depends on the PageStrategy you're using, and whether the PageContent decides to also display debug information. Generally speaking, 0 means no debug display, 1 means simple debug display (usually the PageStrategy) and anything more than that is up to the classes involved.

Definition at line 420 of file OgrePageManager.h.

void Ogre::PageManager::setPageProvider ( PageProvider provider)
inline

Set the PageProvider which can provide streams for any Page.

Remarks
This is the top-level way that you can direct how Page data is loaded. When data for a Page is requested for a PagedWorldSection, the following sequence of classes will be checked to see if they have a provider willing to supply the stream: PagedWorldSection, PagedWorld, PageManager. If none of these do, then the default behaviour is to look for a file called worldname_sectionname_pageID.page.
Note
The caller remains responsible for the destruction of the provider.

Definition at line 313 of file OgrePageManager.h.

void Ogre::PageManager::setPageResourceGroup ( const String g)
inline

Set the resource group that will be used to read/write files when the default load routines are used.

Definition at line 388 of file OgrePageManager.h.

void Ogre::PageManager::setPagingOperationsEnabled ( bool  enabled)
inline

Pause or unpause all paging operations.

Remarks
Using this method you can stop pages being loaded or unloaded for a period of time, 'freezing' the current page state as it is.
Parameters
enabledTrue to proceed with normal paging operations, false to pause.

Definition at line 430 of file OgrePageManager.h.

Member Data Documentation

CameraList Ogre::PageManager::mCameraList
protected

Definition at line 465 of file OgrePageManager.h.

ContentCollectionFactoryMap Ogre::PageManager::mContentCollectionFactories
protected

Definition at line 459 of file OgrePageManager.h.

ContentFactoryMap Ogre::PageManager::mContentFactories
protected

Definition at line 460 of file OgrePageManager.h.

uint8 Ogre::PageManager::mDebugDisplayLvl
protected

Definition at line 467 of file OgrePageManager.h.

EventRouter Ogre::PageManager::mEventRouter
protected

Definition at line 466 of file OgrePageManager.h.

Grid2DPageStrategy* Ogre::PageManager::mGrid2DPageStrategy
protected

Definition at line 470 of file OgrePageManager.h.

Grid3DPageStrategy* Ogre::PageManager::mGrid3DPageStrategy
protected

Definition at line 471 of file OgrePageManager.h.

PageProvider* Ogre::PageManager::mPageProvider
protected

Definition at line 463 of file OgrePageManager.h.

String Ogre::PageManager::mPageResourceGroup
protected

Definition at line 464 of file OgrePageManager.h.

bool Ogre::PageManager::mPagingEnabled
protected

Definition at line 468 of file OgrePageManager.h.

SimplePageContentCollectionFactory* Ogre::PageManager::mSimpleCollectionFactory
protected

Definition at line 472 of file OgrePageManager.h.

StrategyMap Ogre::PageManager::mStrategies
protected

Definition at line 458 of file OgrePageManager.h.

NameGenerator Ogre::PageManager::mWorldNameGenerator
protected

Definition at line 462 of file OgrePageManager.h.

WorldMap Ogre::PageManager::mWorlds
protected

Definition at line 457 of file OgrePageManager.h.

WorldSectionFactoryMap Ogre::PageManager::mWorldSectionFactories
protected

Definition at line 461 of file OgrePageManager.h.


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