![]() |
OGRE-Next 3.0.0
Object-Oriented Graphics Rendering Engine
|
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>
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. | |
virtual bool | _prepareProceduralPage (Page *page, PagedWorldSection *section) |
Give a provider the opportunity to prepare page content procedurally. | |
StreamSerialiser * | _readPageStream (PageID pageID, PagedWorldSection *section) |
Get a serialiser set up to read Page data for the given PageID. | |
StreamSerialiser * | _readWorldStream (const String &filename) |
Get a serialiser set up to read PagedWorld data for the given world name. | |
virtual bool | _unloadProceduralPage (Page *page, PagedWorldSection *section) |
Give a manager the opportunity to unload page content procedurally. | |
virtual bool | _unprepareProceduralPage (Page *page, PagedWorldSection *section) |
Give a manager the opportunity to unprepare page content procedurally. | |
StreamSerialiser * | _writePageStream (PageID pageID, PagedWorldSection *section) |
Get a serialiser set up to write Page data for the given PageID. | |
StreamSerialiser * | _writeWorldStream (const String &filename) |
Get a serialiser set up to write PagedWorld data. | |
void | addCamera (Camera *c) |
Tells the paging system to start tracking a given camera. | |
void | addContentCollectionFactory (PageContentCollectionFactory *f) |
Add a new PageContentCollectionFactory implementation. | |
void | addContentFactory (PageContentFactory *f) |
Add a new PageContentFactory implementation. | |
void | addStrategy (PageStrategy *strategy) |
Add a new PageStrategy implementation. | |
void | addWorldSectionFactory (PagedWorldSectionFactory *f) |
Add a new PagedWorldSectionFactory implementation. | |
PageContent * | createContent (const String &typeName) |
Create a new instance of PageContent using the registered factories. | |
PageContentCollection * | createContentCollection (const String &typeName) |
Create a new instance of PageContentCollection using the registered factories. | |
PagedWorld * | createWorld (const String &name=BLANKSTRING) |
Create a new PagedWorld instance. | |
PagedWorldSection * | createWorldSection (const String &typeName, const String &name, PagedWorld *parent, SceneManager *sm) |
Create a new instance of PagedWorldSection using the registered factories. | |
void | destroyContent (PageContent *c) |
Destroy an instance of PageContent. | |
void | destroyContentCollection (PageContentCollection *coll) |
Destroy an instance of PageContentCollection. | |
void | destroyWorld (const String &name) |
Destroy a world. | |
void | destroyWorld (PagedWorld *world) |
Destroy a world. | |
void | destroyWorldSection (PagedWorldSection *s) |
Destroy an instance of PagedWorldSection. | |
const CameraList & | getCameraList () const |
Returns a list of cameras being tracked. | |
const ContentCollectionFactoryMap & | getContentCollectionFactories () const |
Get a reference to the registered strategies. | |
PageContentCollectionFactory * | getContentCollectionFactory (const String &name) |
Get a PageContentCollectionFactory. | |
const ContentFactoryMap & | getContentFactories () const |
Get a reference to the registered strategies. | |
PageContentFactory * | getContentFactory (const String &name) |
Get a PageContentFactory. | |
uint8 | getDebugDisplayLevel () const |
Get the debug display level. | |
PageProvider * | getPageProvider () const |
Get the PageProvider which can provide streams for any Page. | |
const String & | getPageResourceGroup () const |
Get the resource group that will be used to read/write files when the default load routines are used. | |
bool | getPagingOperationsEnabled () const |
Get whether paging operations are currently allowed to happen. | |
const StrategyMap & | getStrategies () const |
Get a reference to the registered strategies. | |
PageStrategy * | getStrategy (const String &name) |
Get a PageStrategy. | |
PagedWorld * | getWorld (const String &name) |
Get a named world. | |
const WorldMap & | getWorlds () const |
Get a reference to the worlds that are currently loaded. | |
const WorldSectionFactoryMap & | getWorldSectionFactories () const |
Get a reference to the registered strategies. | |
PagedWorldSectionFactory * | getWorldSectionFactory (const String &name) |
Get a PagedWorldSectionFactory. | |
bool | hasCamera (Camera *c) const |
Returns whether or not a given camera is being watched by the paging system. | |
PagedWorld * | loadWorld (const DataStreamPtr &stream, const String &name=BLANKSTRING) |
Load a new PagedWorld from a stream. | |
PagedWorld * | loadWorld (const String &filename, const String &name=BLANKSTRING) |
Load a new PagedWorld from a file. | |
void | removeCamera (Camera *c) |
Tells the paging system to stop tracking a given camera. | |
void | removeContentCollectionFactory (PageContentCollectionFactory *f) |
Remove a PageContentCollectionFactory implementation. | |
void | removeContentFactory (PageContentFactory *f) |
Remove a PageContentFactory implementation. | |
void | removeStrategy (PageStrategy *strategy) |
Remove a PageStrategy implementation. | |
void | removeWorldSectionFactory (PagedWorldSectionFactory *f) |
Remove a PagedWorldSectionFactory implementation. | |
void | saveWorld (PagedWorld *world, const DataStreamPtr &stream) |
Save a PagedWorld instance to a file. | |
void | saveWorld (PagedWorld *world, const String &filename) |
Save a PagedWorld instance to a file. | |
void | setDebugDisplayLevel (uint8 lvl) |
Set the debug display level. | |
void | setPageProvider (PageProvider *provider) |
Set the PageProvider which can provide streams for any Page. | |
void | setPageResourceGroup (const String &g) |
Set the resource group that will be used to read/write files when the default load routines are used. | |
void | setPagingOperationsEnabled (bool enabled) |
Pause or unpause all paging operations. | |
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.
vector<Camera*>::type Ogre::PageManager::CameraList |
map<String,PageStrategy*>::type Ogre::PageManager::StrategyMap |
map<String,PagedWorld*>::type Ogre::PageManager::WorldMap |
Ogre::PageManager::PageManager | ( | ) |
|
virtual |
|
virtual |
Give a provider the opportunity to prepare page content procedurally.
|
virtual |
Give a provider the opportunity to prepare page content procedurally.
StreamSerialiser * Ogre::PageManager::_readPageStream | ( | PageID | pageID, |
PagedWorldSection * | section ) |
Get a serialiser set up to read Page data for the given PageID.
pageID | The ID of the page being requested |
section | The parent section to which this page will belong |
StreamSerialiser * Ogre::PageManager::_readWorldStream | ( | const String & | filename | ) |
Get a serialiser set up to read PagedWorld data for the given world name.
|
virtual |
Give a manager the opportunity to unload page content procedurally.
|
virtual |
Give a manager the opportunity to unprepare page content procedurally.
StreamSerialiser * Ogre::PageManager::_writePageStream | ( | PageID | pageID, |
PagedWorldSection * | section ) |
Get a serialiser set up to write Page data for the given PageID.
pageID | The ID of the page being requested |
section | The parent section to which this page will belong |
StreamSerialiser * Ogre::PageManager::_writeWorldStream | ( | const String & | filename | ) |
Get a serialiser set up to write PagedWorld data.
void Ogre::PageManager::addCamera | ( | Camera * | c | ) |
Tells the paging system to start tracking a given camera.
void Ogre::PageManager::addContentCollectionFactory | ( | PageContentCollectionFactory * | f | ) |
Add a new PageContentCollectionFactory implementation.
void Ogre::PageManager::addContentFactory | ( | PageContentFactory * | f | ) |
Add a new PageContentFactory implementation.
void Ogre::PageManager::addStrategy | ( | PageStrategy * | strategy | ) |
Add a new PageStrategy implementation.
void Ogre::PageManager::addWorldSectionFactory | ( | PagedWorldSectionFactory * | f | ) |
Add a new PagedWorldSectionFactory implementation.
PageContent * Ogre::PageManager::createContent | ( | const String & | typeName | ) |
Create a new instance of PageContent using the registered factories.
typeName | The 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.
typeName | The name of the type of collection to create |
PagedWorld * Ogre::PageManager::createWorld | ( | const String & | name = BLANKSTRING | ) |
Create a new PagedWorld instance.
name | Optionally 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.
typeName | The name of the type of collection to create |
name | The instance name |
parent | The parent world |
sm | The 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.
name | The name of the factory to retrieve |
const ContentFactoryMap & Ogre::PageManager::getContentFactories | ( | ) | const |
Get a reference to the registered strategies.
PageContentFactory * Ogre::PageManager::getContentFactory | ( | const String & | name | ) |
Get a PageContentFactory.
name | The name of the factory to retrieve |
|
inline |
Get the debug display level.
|
inline |
Get the PageProvider which can provide streams for any Page.
|
inline |
Get the resource group that will be used to read/write files when the default load routines are used.
|
inline |
Get whether paging operations are currently allowed to happen.
const StrategyMap & Ogre::PageManager::getStrategies | ( | ) | const |
Get a reference to the registered strategies.
PageStrategy * Ogre::PageManager::getStrategy | ( | const String & | name | ) |
Get a PageStrategy.
name | The name of the strategy to retrieve |
PagedWorld * Ogre::PageManager::getWorld | ( | const String & | name | ) |
Get a named world.
name | The name of the world (not a filename, the identifying name) |
|
inline |
Get a reference to the worlds that are currently loaded.
const WorldSectionFactoryMap & Ogre::PageManager::getWorldSectionFactories | ( | ) | const |
Get a reference to the registered strategies.
PagedWorldSectionFactory * Ogre::PageManager::getWorldSectionFactory | ( | const String & | name | ) |
Get a PagedWorldSectionFactory.
name | The name of the factory to retrieve |
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 DataStreamPtr & | stream, |
const String & | name = BLANKSTRING ) |
Load a new PagedWorld from a stream.
stream | A stream from which to load the world data |
name | Optionally give a name to the world (if no name is given, one will be generated). |
PagedWorld * Ogre::PageManager::loadWorld | ( | const String & | filename, |
const String & | name = BLANKSTRING ) |
Load a new PagedWorld from a file.
filename | The name of the file to load (standard is .world) |
name | Optionally give a name to the world (if no name is given, one will be generated). |
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 DataStreamPtr & | stream ) |
Save a PagedWorld instance to a file.
world | The world to be saved |
stream | The stream to save the data to |
void Ogre::PageManager::saveWorld | ( | PagedWorld * | world, |
const String & | filename ) |
Save a PagedWorld instance to a file.
world | The world to be saved |
filename | The filename to save the data to |
|
inline |
Set the debug display level.
|
inline |
Set the PageProvider which can provide streams for any Page.
|
inline |
Set the resource group that will be used to read/write files when the default load routines are used.
|
inline |
Pause or unpause all paging operations.
enabled | True to proceed with normal paging operations, false to pause. |