Ogre::PageManager Class Reference
Components » Paging

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:
[legend]

## 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...
PageContent * | createContent (const String &typeName)
| Create a new instance of PageContent using the registered factories. More...
PageContentCollection * | createContentCollection (const String &typeName)
| Create a new instance of PageContentCollection using the registered factories. More...
PagedWorld * | createWorld (const String &name=StringUtil::BLANK)
| Create a new PagedWorld instance. More...
PagedWorldSection * | createWorldSection (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 CameraList & | getCameraList () const
| Returns a list of cameras being tracked. More...
const ContentCollectionFactoryMap & | getContentCollectionFactories () const
| Get a reference to the registered strategies. More...
PageContentCollectionFactory * | getContentCollectionFactory (const String &name)
| Get a PageContentCollectionFactory. More...
const ContentFactoryMap & | getContentFactories () const
| Get a reference to the registered strategies. More...
PageContentFactory * | getContentFactory (const String &name)
| Get a PageContentFactory. More...
uint8 | getDebugDisplayLevel () const
| Get the debug display level. More...
PageProvider * | getPageProvider () const
| Get the PageProvider which can provide streams for any Page. More...
const String & | getPageResourceGroup () 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 StrategyMap & | getStrategies () const
| Get a reference to the registered strategies. More...
PageStrategy * | getStrategy (const String &name)
| Get a PageStrategy. More...
PagedWorld * | getWorld (const String &name)
| Get a named world. More...
const WorldMap & | getWorlds () const
| Get a reference to the worlds that are currently loaded. More...
const WorldSectionFactoryMap & | getWorldSectionFactories () const
| Get a reference to the registered strategies. More...
PagedWorldSectionFactory * | getWorldSectionFactory (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...
PagedWorld * | loadWorld (const String &filename, const String &name=StringUtil::BLANK)
| Load a new PagedWorld from a file. More...
PagedWorld * | loadWorld (const DataStreamPtr &stream, const String &name=StringUtil::BLANK)
| 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
Grid2DPageStrategy * | mGrid2DPageStrategy
Grid3DPageStrategy * | mGrid3DPageStrategy
PageProvider * | mPageProvider
String | mPageResourceGroup
bool | mPagingEnabled
SimplePageContentCollectionFactory * | mSimpleCollectionFactory
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 136 of file OgrePageManager.h.

## Member Typedef Documentation

## CameraList

typedef vector<Camera*>::type Ogre::PageManager::CameraList

Definition at line 409 of file OgrePageManager.h.

## ContentCollectionFactoryMap

typedef map<String, PageContentCollectionFactory*>::type Ogre::PageManager::ContentCollectionFactoryMap

Definition at line 208 of file OgrePageManager.h.

## ContentFactoryMap

typedef map<String, PageContentFactory*>::type Ogre::PageManager::ContentFactoryMap

Definition at line 238 of file OgrePageManager.h.

## StrategyMap

typedef map<String, PageStrategy*>::type Ogre::PageManager::StrategyMap

Definition at line 186 of file OgrePageManager.h.

## WorldMap

typedef map<String, PagedWorld*>::type Ogre::PageManager::WorldMap

Definition at line 181 of file OgrePageManager.h.

## WorldSectionFactoryMap

typedef map<String, PagedWorldSectionFactory*>::type Ogre::PageManager::WorldSectionFactoryMap

Definition at line 269 of file OgrePageManager.h.

## Constructor & Destructor Documentation

## PageManager()

Ogre::PageManager::PageManager | ( |  | ) |

## ~PageManager()

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

virtual

## Member Function Documentation

## _loadProceduralPage()

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

## _prepareProceduralPage()

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

## _readPageStream()

StreamSerialiser* Ogre::PageManager::_readPageStream | ( | PageID | pageID,
|  | PagedWorldSection * | section
| ) |  |

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

Parameters

  pageID | The ID of the page being requested
  section | The parent section to which this page will belong

Remarks
  The StreamSerialiser returned is the responsibility of the caller to delete.

## _readWorldStream()

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.

## _unloadProceduralPage()

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

## _unprepareProceduralPage()

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

## _writePageStream()

StreamSerialiser* Ogre::PageManager::_writePageStream | ( | PageID | pageID,
|  | PagedWorldSection * | section
| ) |  |

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

Parameters

  pageID | The ID of the page being requested
  section | The parent section to which this page will belong

Remarks
  The StreamSerialiser returned is the responsibility of the caller to delete.

## _writeWorldStream()

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.

## addCamera()

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.

## addContentCollectionFactory()

void Ogre::PageManager::addContentCollectionFactory | ( | PageContentCollectionFactory * | f | ) |

Add a new PageContentCollectionFactory implementation.

Remarks
  The caller remains resonsible for destruction of this instance.

## addContentFactory()

void Ogre::PageManager::addContentFactory | ( | PageContentFactory * | f | ) |

Add a new PageContentFactory implementation.

Remarks
  The caller remains resonsible for destruction of this instance.

## addStrategy()

void Ogre::PageManager::addStrategy | ( | PageStrategy * | strategy | ) |

Add a new PageStrategy implementation.

Remarks
  The caller remains resonsible for destruction of this instance.

## addWorldSectionFactory()

void Ogre::PageManager::addWorldSectionFactory | ( | PagedWorldSectionFactory * | f | ) |

Add a new PagedWorldSectionFactory implementation.

Remarks
  The caller remains resonsible for destruction of this instance.

## createContent()

PageContent* Ogre::PageManager::createContent | ( | const String & | typeName | ) |

Create a new instance of PageContent using the registered factories.

Parameters

  typeName | The name of the type of content to create

## createContentCollection()

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

Create a new instance of PageContentCollection using the registered factories.

Parameters

  typeName | The name of the type of collection to create

## createStandardContentFactories()

void Ogre::PageManager::createStandardContentFactories | ( |  | ) |

protected

## createStandardStrategies()

void Ogre::PageManager::createStandardStrategies | ( |  | ) |

protected

## createWorld()

PagedWorld* Ogre::PageManager::createWorld | ( | const String & | name = `StringUtil::BLANK` | ) |

Create a new PagedWorld instance.

Parameters

  name | Optionally give a name to the world (if no name is given, one will be generated).

## createWorldSection()

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

  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)

## destroyContent()

void Ogre::PageManager::destroyContent | ( | PageContent * | c | ) |

Destroy an instance of PageContent.

## destroyContentCollection()

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

Destroy an instance of PageContentCollection.

## destroyWorld() [1/2]

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

Destroy a world.

## destroyWorld() [2/2]

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

Destroy a world.

## destroyWorldSection()

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

Destroy an instance of PagedWorldSection.

## getCameraList()

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

Returns a list of cameras being tracked.

## getContentCollectionFactories()

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

Get a reference to the registered strategies.

## getContentCollectionFactory()

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

Get a PageContentCollectionFactory.

Parameters

  name | The name of the factory to retrieve

Returns
  Pointer to a PageContentCollectionFactory, or null if the ContentCollection was not found.

## getContentFactories()

const ContentFactoryMap& Ogre::PageManager::getContentFactories | ( |  | ) | const

Get a reference to the registered strategies.

## getContentFactory()

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

Get a PageContentFactory.

Parameters

  name | The name of the factory to retrieve

Returns
  Pointer to a PageContentFactory, or null if the Content was not found.

## getDebugDisplayLevel()

uint8 Ogre::PageManager::getDebugDisplayLevel | ( |  | ) | const

Get the debug display level.

Definition at line 424 of file OgrePageManager.h.

## getPageProvider()

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

Get the PageProvider which can provide streams for any Page.

Definition at line 318 of file OgrePageManager.h.

## getPageResourceGroup()

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

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

Definition at line 386 of file OgrePageManager.h.

## getPagingOperationsEnabled()

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

Get whether paging operations are currently allowed to happen.

Definition at line 435 of file OgrePageManager.h.

## getStrategies()

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

Get a reference to the registered strategies.

## getStrategy()

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

Get a PageStrategy.

Parameters

  name | The name of the strategy to retrieve

Returns
  Pointer to a PageStrategy, or null if the strategy was not found.

## getWorld()

PagedWorld* Ogre::PageManager::getWorld | ( | const String & | name | ) |

Get a named world.

Parameters

  name | The name of the world (not a filename, the identifying name)

Returns
  The world, or null if the world doesn't exist.

## getWorlds()

const WorldMap& Ogre::PageManager::getWorlds | ( |  | ) | const

Get a reference to the worlds that are currently loaded.

Definition at line 183 of file OgrePageManager.h.

## getWorldSectionFactories()

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

Get a reference to the registered strategies.

## getWorldSectionFactory()

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

Get a PagedWorldSectionFactory.

Parameters

  name | The name of the factory to retrieve

Returns
  Pointer to a PagedWorldSectionFactory, or null if the WorldSection was not found.

## hasCamera()

bool Ogre::PageManager::hasCamera | ( | Camera * | c | ) | const

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

## loadWorld() [1/2]

PagedWorld* Ogre::PageManager::loadWorld | ( | const String & | filename,
|  | const String & | name = `StringUtil::BLANK`
| ) |  |

Load a new PagedWorld from a file.

Parameters

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

## loadWorld() [2/2]

PagedWorld* Ogre::PageManager::loadWorld | ( | const DataStreamPtr & | stream,
|  | const String & | name = `StringUtil::BLANK`
| ) |  |

Load a new PagedWorld from a stream.

Parameters

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

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

## removeCamera()

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

Tells the paging system to stop tracking a given camera.

## removeContentCollectionFactory()

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

Remove a PageContentCollectionFactory implementation.

## removeContentFactory()

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

Remove a PageContentFactory implementation.

## removeStrategy()

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

Remove a PageStrategy implementation.

## removeWorldSectionFactory()

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

Remove a PagedWorldSectionFactory implementation.

## saveWorld() [1/2]

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

Save a PagedWorld instance to a file.

Parameters

  world | The world to be saved
  filename | The filename to save the data to

## saveWorld() [2/2]

void Ogre::PageManager::saveWorld | ( | PagedWorld * | world,
|  | const DataStreamPtr & | stream
| ) |  |

Save a PagedWorld instance to a file.

Parameters

  world | The world to be saved
  stream | The stream to save the data to

## setDebugDisplayLevel()

void Ogre::PageManager::setDebugDisplayLevel | ( | uint8 | lvl | ) |

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 422 of file OgrePageManager.h.

## setPageProvider()

void Ogre::PageManager::setPageProvider | ( | PageProvider * | provider | ) |

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 315 of file OgrePageManager.h.

## setPageResourceGroup()

void Ogre::PageManager::setPageResourceGroup | ( | const String & | g | ) |

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

Definition at line 390 of file OgrePageManager.h.

## setPagingOperationsEnabled()

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

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

  enabled | True to proceed with normal paging operations, false to pause.

Definition at line 432 of file OgrePageManager.h.

## Member Data Documentation

## mCameraList

CameraList Ogre::PageManager::mCameraList

protected

Definition at line 467 of file OgrePageManager.h.

## mContentCollectionFactories

ContentCollectionFactoryMap Ogre::PageManager::mContentCollectionFactories

protected

Definition at line 461 of file OgrePageManager.h.

## mContentFactories

ContentFactoryMap Ogre::PageManager::mContentFactories

protected

Definition at line 462 of file OgrePageManager.h.

## mDebugDisplayLvl

uint8 Ogre::PageManager::mDebugDisplayLvl

protected

Definition at line 469 of file OgrePageManager.h.

## mEventRouter

EventRouter Ogre::PageManager::mEventRouter

protected

Definition at line 468 of file OgrePageManager.h.

## mGrid2DPageStrategy

Grid2DPageStrategy* Ogre::PageManager::mGrid2DPageStrategy

protected

Definition at line 472 of file OgrePageManager.h.

## mGrid3DPageStrategy

Grid3DPageStrategy* Ogre::PageManager::mGrid3DPageStrategy

protected

Definition at line 473 of file OgrePageManager.h.

## mPageProvider

PageProvider* Ogre::PageManager::mPageProvider

protected

Definition at line 465 of file OgrePageManager.h.

## mPageResourceGroup

String Ogre::PageManager::mPageResourceGroup

protected

Definition at line 466 of file OgrePageManager.h.

## mPagingEnabled

bool Ogre::PageManager::mPagingEnabled

protected

Definition at line 470 of file OgrePageManager.h.

## mSimpleCollectionFactory

SimplePageContentCollectionFactory* Ogre::PageManager::mSimpleCollectionFactory

protected

Definition at line 474 of file OgrePageManager.h.

## mStrategies

StrategyMap Ogre::PageManager::mStrategies

protected

Definition at line 460 of file OgrePageManager.h.

## mWorldNameGenerator

NameGenerator Ogre::PageManager::mWorldNameGenerator

protected

Definition at line 464 of file OgrePageManager.h.

## mWorlds

WorldMap Ogre::PageManager::mWorlds

protected

Definition at line 459 of file OgrePageManager.h.

## mWorldSectionFactories

WorldSectionFactoryMap Ogre::PageManager::mWorldSectionFactories

protected

Definition at line 463 of file OgrePageManager.h.

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

- OgrePageManager.h

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