|  | OGRE-Next 3.0.0
    Object-Oriented Graphics Rendering Engine | 
| Modules | |
| Paging | |
| Some details on paging component. | |
| Property | |
| Files | |
| file | OgrePageFileFormats.h | 
| The paging file format is a composite one - a single file / stream can contain data which is not necessarily all read by a single class. | |
| Classes | |
| class | Ogre::Grid3DPageStrategy | 
| Page strategy which loads new pages based on a regular 3D grid.  More... | |
| class | Ogre::Grid3DPageStrategyData | 
| Specialisation of PageStrategyData for Grid3DPageStrategy.  More... | |
| class | Ogre::PageStrategy | 
| Defines the interface to a strategy class which is responsible for deciding when Page instances are requested for addition and removal from the paging system.  More... | |
| class | Ogre::PageStrategyData | 
| Abstract marker class representing the data held against the PagedWorldSection which is specifically used by the PageStrategy.  More... | |
| class | Ogre::SimplePageContentCollection | 
| Specialisation of PageContentCollection which just provides a simple list of PageContent instances.  More... | |
| class | Ogre::SimplePageContentCollectionFactory | 
| Factory class for SimplePageContentCollection.  More... | |
| Typedefs | |
| typedef vector< PageContent * >::type | Ogre::SimplePageContentCollection::ContentList | 
| Functions | |
| Ogre::Grid3DPageStrategy::Grid3DPageStrategy (PageManager *manager) | |
| Ogre::Grid3DPageStrategyData::Grid3DPageStrategyData () | |
| Ogre::PageStrategy::PageStrategy (const String &name, PageManager *manager) | |
| Ogre::PageStrategyData::PageStrategyData () | |
| Ogre::SimplePageContentCollection::SimplePageContentCollection (PageContentCollectionFactory *creator) | |
| Ogre::SimplePageContentCollectionFactory::SimplePageContentCollectionFactory () | |
| Ogre::Grid3DPageStrategy::~Grid3DPageStrategy () | |
| Ogre::Grid3DPageStrategyData::~Grid3DPageStrategyData () | |
| virtual | Ogre::PageStrategy::~PageStrategy () | 
| virtual | Ogre::PageStrategyData::~PageStrategyData () | 
| Ogre::SimplePageContentCollection::~SimplePageContentCollection () | |
| Ogre::SimplePageContentCollectionFactory::~SimplePageContentCollectionFactory () | |
| void | Ogre::Grid3DPageStrategyData::calculateCell (PageID inPageID, int32 *x, int32 *y, int32 *z) | 
| PageID | Ogre::Grid3DPageStrategyData::calculatePageID (int32 x, int32 y, int32 z) | 
| virtual PageContent * | Ogre::SimplePageContentCollection::createContent (const String &typeName) | 
| Create a new PageContent within this collection. | |
| PageStrategyData * | Ogre::Grid3DPageStrategy::createData () | 
| Create a PageStrategyData instance containing the data specific to this PageStrategy. | |
| virtual PageStrategyData * | Ogre::PageStrategy::createData ()=0 | 
| Create a PageStrategyData instance containing the data specific to this PageStrategy. | |
| PageContentCollection * | Ogre::SimplePageContentCollectionFactory::createInstance () | 
| virtual void | Ogre::SimplePageContentCollection::destroyContent (PageContent *coll) | 
| Destroy a PageContent within this page. | |
| void | Ogre::Grid3DPageStrategy::destroyData (PageStrategyData *d) | 
| Destroy a PageStrategyData instance containing the data specific to this PageStrategy. | |
| virtual void | Ogre::PageStrategy::destroyData (PageStrategyData *d)=0 | 
| Destroy a PageStrategyData instance containing the data specific to this PageStrategy. | |
| void | Ogre::SimplePageContentCollectionFactory::destroyInstance (PageContentCollection *c) | 
| void | Ogre::Grid3DPageStrategyData::determineGridLocation (const Vector3 &gridpos, int32 *x, int32 *y, int32 *z) | 
| Convert a grid position into a row and column index. | |
| virtual void | Ogre::SimplePageContentCollection::frameEnd (Real timeElapsed) | 
| Called when the frame ends. | |
| virtual void | Ogre::PageStrategy::frameEnd (Real timeElapsed, PagedWorldSection *section) | 
| Called when the frame ends. | |
| virtual void | Ogre::SimplePageContentCollection::frameStart (Real timeSinceLastFrame) | 
| Called when the frame starts. | |
| virtual void | Ogre::PageStrategy::frameStart (Real timeSinceLastFrame, PagedWorldSection *section) | 
| Called when the frame starts. | |
| virtual void | Ogre::Grid3DPageStrategyData::getBottomLeftGridSpace (int32 x, int32 y, int z, Vector3 &bl) | 
| Get the (grid space) bottom-left of a cell. | |
| virtual int32 | Ogre::Grid3DPageStrategyData::getCellRangeMaxX () const | 
| get the index range of all cells (values outside this will be ignored) | |
| virtual int32 | Ogre::Grid3DPageStrategyData::getCellRangeMaxY () const | 
| get the index range of all cells (values outside this will be ignored) | |
| virtual int32 | Ogre::Grid3DPageStrategyData::getCellRangeMaxZ () const | 
| get the index range of all cells (values outside this will be ignored) | |
| virtual int32 | Ogre::Grid3DPageStrategyData::getCellRangeMinX () const | 
| get the index range of all cells (values outside this will be ignored) | |
| virtual int32 | Ogre::Grid3DPageStrategyData::getCellRangeMinY () const | 
| get the index range of all cells (values outside this will be ignored) | |
| virtual int32 | Ogre::Grid3DPageStrategyData::getCellRangeMinZ () const | 
| get the index range of all cells (values outside this will be ignored) | |
| virtual Vector3 | Ogre::Grid3DPageStrategyData::getCellSize () const | 
| Get the size of the cells in the grid. | |
| virtual const ContentList & | Ogre::SimplePageContentCollection::getContentList () const | 
| Get const access to the list of content. | |
| virtual void | Ogre::Grid3DPageStrategyData::getCornersGridSpace (int32 x, int32 y, int32 z, Vector3 *pEightPoints) | 
| Get the (grid space) corners of a cell. | |
| virtual Real | Ogre::Grid3DPageStrategyData::getHoldRadius () const | 
| Get the Holding radius. | |
| virtual Real | Ogre::Grid3DPageStrategyData::getLoadRadius () const | 
| Get the loading radius. | |
| PageManager * | Ogre::PageStrategy::getManager () const | 
| virtual void | Ogre::Grid3DPageStrategyData::getMidPointGridSpace (int32 x, int32 y, int32 z, Vector3 &mid) | 
| const String & | Ogre::PageStrategy::getName () const | 
| const String & | Ogre::SimplePageContentCollectionFactory::getName () const | 
| virtual const Vector3 & | Ogre::Grid3DPageStrategyData::getOrigin (const Vector3 &worldOrigin) | 
| Get the origin of the grid in world space. | |
| PageID | Ogre::Grid3DPageStrategy::getPageID (const Vector3 &worldPos, PagedWorldSection *section) | 
| Get the page ID for a given world position. | |
| virtual PageID | Ogre::PageStrategy::getPageID (const Vector3 &worldPos, PagedWorldSection *section)=0 | 
| Get the page ID for a given world position. | |
| void | Ogre::SimplePageContentCollection::load () | 
| Load - will be called in main thread. | |
| bool | Ogre::Grid3DPageStrategyData::load (StreamSerialiser &stream) | 
| Load this data from a stream (returns true if successful) | |
| virtual bool | Ogre::PageStrategyData::load (StreamSerialiser &stream)=0 | 
| Load this data from a stream (returns true if successful) | |
| virtual void | Ogre::SimplePageContentCollection::notifyCamera (Camera *cam) | 
| Notify a section of the current camera. | |
| void | Ogre::Grid3DPageStrategy::notifyCamera (Camera *cam, PagedWorldSection *section) | 
| Called when a camera is used for any kind of rendering. | |
| virtual void | Ogre::PageStrategy::notifyCamera (Camera *cam, PagedWorldSection *section) | 
| Called when a camera is used for any kind of rendering. | |
| bool | Ogre::SimplePageContentCollection::prepare (StreamSerialiser &stream) | 
| Prepare data - may be called in the background. | |
| void | Ogre::Grid3DPageStrategyData::save (StreamSerialiser &stream) | 
| Save this data to a stream. | |
| virtual void | Ogre::SimplePageContentCollection::save (StreamSerialiser &stream) | 
| Save the collection to a stream. | |
| virtual void | Ogre::PageStrategyData::save (StreamSerialiser &stream)=0 | 
| Save this data to a stream. | |
| virtual void | Ogre::Grid3DPageStrategyData::setCellRange (int32 minX, int32 minY, int32 minZ, int32 maxX, int32 maxY, int32 maxZ) | 
| Set the index range of all cells (values outside this will be ignored) | |
| virtual void | Ogre::Grid3DPageStrategyData::setCellRangeMaxX (int32 maxX) | 
| Set the index range of all cells (values outside this will be ignored) | |
| virtual void | Ogre::Grid3DPageStrategyData::setCellRangeMaxY (int32 maxY) | 
| Set the index range of all cells (values outside this will be ignored) | |
| virtual void | Ogre::Grid3DPageStrategyData::setCellRangeMaxZ (int32 maxZ) | 
| get the index range of all cells (values outside this will be ignored) | |
| virtual void | Ogre::Grid3DPageStrategyData::setCellRangeMinX (int32 minX) | 
| Set the index range of all cells (values outside this will be ignored) | |
| virtual void | Ogre::Grid3DPageStrategyData::setCellRangeMinY (int32 minY) | 
| Set the index range of all cells (values outside this will be ignored) | |
| virtual void | Ogre::Grid3DPageStrategyData::setCellRangeMinZ (int32 minZ) | 
| Set the index range of all cells (values outside this will be ignored) | |
| virtual void | Ogre::Grid3DPageStrategyData::setCellSize (const Vector3 &sz) | 
| Set the size of the cells in the grid. | |
| virtual void | Ogre::Grid3DPageStrategyData::setHoldRadius (Real sz) | 
| Set the Holding radius. | |
| virtual void | Ogre::Grid3DPageStrategyData::setLoadRadius (Real sz) | 
| Set the loading radius. | |
| virtual void | Ogre::Grid3DPageStrategyData::setOrigin (const Vector3 &worldOrigin) | 
| Set the origin of the grid in world space. | |
| void | Ogre::SimplePageContentCollection::unload () | 
| Unload - will be called in main thread. | |
| void | Ogre::SimplePageContentCollection::unprepare () | 
| Unprepare data - may be called in the background. | |
| void | Ogre::Grid3DPageStrategy::updateDebugDisplay (Page *p, SceneNode *sn) | 
| Update the contents of the passed in SceneNode to reflect the debug display of a given page. | |
| virtual void | Ogre::PageStrategy::updateDebugDisplay (Page *p, SceneNode *sn)=0 | 
| Update the contents of the passed in SceneNode to reflect the debug display of a given page. | |
| Variables | |
| static const uint32 | Ogre::Grid3DPageStrategyData::CHUNK_ID | 
| static const uint16 | Ogre::Grid3DPageStrategyData::CHUNK_VERSION | 
| static String | Ogre::SimplePageContentCollectionFactory::FACTORY_NAME | 
| static const uint32 | Ogre::SimplePageContentCollection::SUBCLASS_CHUNK_ID | 
| static const uint16 | Ogre::SimplePageContentCollection::SUBCLASS_CHUNK_VERSION | 
| typedef vector<PageContent*>::type Ogre::SimplePageContentCollection::ContentList | 
| Ogre::Grid3DPageStrategy::Grid3DPageStrategy | ( | PageManager * | manager | ) | 
| Ogre::Grid3DPageStrategyData::Grid3DPageStrategyData | ( | ) | 
| 
 | inline | 
| 
 | inline | 
| Ogre::SimplePageContentCollection::SimplePageContentCollection | ( | PageContentCollectionFactory * | creator | ) | 
| 
 | inline | 
| Ogre::Grid3DPageStrategy::~Grid3DPageStrategy | ( | ) | 
| Ogre::Grid3DPageStrategyData::~Grid3DPageStrategyData | ( | ) | 
| 
 | inlinevirtual | 
| 
 | inlinevirtual | 
| Ogre::SimplePageContentCollection::~SimplePageContentCollection | ( | ) | 
| 
 | inline | 
| void Ogre::Grid3DPageStrategyData::calculateCell | ( | PageID | inPageID, | 
| int32 * | x, | ||
| int32 * | y, | ||
| int32 * | z | ||
| ) | 
| 
 | virtual | 
Create a new PageContent within this collection.
| typeName | The name of the type of content (see PageManager::getContentFactories) | 
| 
 | virtual | 
Create a PageStrategyData instance containing the data specific to this PageStrategy.
Implements Ogre::PageStrategy.
| 
 | pure virtual | 
Create a PageStrategyData instance containing the data specific to this PageStrategy.
Implemented in Ogre::Grid2DPageStrategy, and Ogre::Grid3DPageStrategy.
| 
 | inlinevirtual | 
Implements Ogre::PageContentCollectionFactory.
References OGRE_NEW.
| 
 | virtual | 
Destroy a PageContent within this page.
This is equivalent to calling detachContent and PageManager::destroyContent.
| 
 | virtual | 
Destroy a PageStrategyData instance containing the data specific to this PageStrategy.
Implements Ogre::PageStrategy.
| 
 | pure virtual | 
Destroy a PageStrategyData instance containing the data specific to this PageStrategy.
Implemented in Ogre::Grid2DPageStrategy, and Ogre::Grid3DPageStrategy.
| 
 | inlinevirtual | 
Implements Ogre::PageContentCollectionFactory.
References OGRE_DELETE.
| void Ogre::Grid3DPageStrategyData::determineGridLocation | ( | const Vector3 & | gridpos, | 
| int32 * | x, | ||
| int32 * | y, | ||
| int32 * | z | ||
| ) | 
Convert a grid position into a row and column index.
| 
 | virtual | 
Called when the frame ends.
Implements Ogre::PageContentCollection.
| 
 | inlinevirtual | 
Called when the frame ends.
| 
 | virtual | 
Called when the frame starts.
Implements Ogre::PageContentCollection.
| 
 | inlinevirtual | 
Called when the frame starts.
| 
 | virtual | 
Get the (grid space) bottom-left of a cell.
| 
 | inlinevirtual | 
get the index range of all cells (values outside this will be ignored)
| 
 | inlinevirtual | 
get the index range of all cells (values outside this will be ignored)
| 
 | inlinevirtual | 
get the index range of all cells (values outside this will be ignored)
| 
 | inlinevirtual | 
get the index range of all cells (values outside this will be ignored)
| 
 | inlinevirtual | 
get the index range of all cells (values outside this will be ignored)
| 
 | inlinevirtual | 
get the index range of all cells (values outside this will be ignored)
| 
 | inlinevirtual | 
Get the size of the cells in the grid.
| 
 | inlinevirtual | 
Get const access to the list of content.
| 
 | virtual | 
Get the (grid space) corners of a cell.
| 
 | inlinevirtual | 
Get the Holding radius.
| 
 | inlinevirtual | 
Get the loading radius.
| 
 | inline | 
| 
 | virtual | 
| 
 | inline | 
| 
 | inlinevirtual | 
Implements Ogre::PageContentCollectionFactory.
| 
 | inlinevirtual | 
Get the origin of the grid in world space.
| 
 | virtual | 
| 
 | pure virtual | 
Get the page ID for a given world position.
Implemented in Ogre::Grid2DPageStrategy, and Ogre::Grid3DPageStrategy.
| 
 | virtual | 
Load - will be called in main thread.
Implements Ogre::PageContentCollection.
| 
 | virtual | 
Load this data from a stream (returns true if successful)
Implements Ogre::PageStrategyData.
| 
 | pure virtual | 
Load this data from a stream (returns true if successful)
Implemented in Ogre::Grid2DPageStrategyData, and Ogre::Grid3DPageStrategyData.
| 
 | virtual | 
Notify a section of the current camera.
Implements Ogre::PageContentCollection.
| 
 | virtual | 
Called when a camera is used for any kind of rendering.
| cam | Camera which is being used for rendering. Class should not rely on this pointer remaining valid permanently because no notification will be given when the camera is destroyed. | 
Reimplemented from Ogre::PageStrategy.
| 
 | inlinevirtual | 
Called when a camera is used for any kind of rendering.
| cam | Camera which is being used for rendering. Class should not rely on this pointer remaining valid permanently because no notification will be given when the camera is destroyed. | 
Reimplemented in Ogre::Grid2DPageStrategy, and Ogre::Grid3DPageStrategy.
| 
 | virtual | 
Prepare data - may be called in the background.
Implements Ogre::PageContentCollection.
| 
 | virtual | 
Save this data to a stream.
Implements Ogre::PageStrategyData.
| 
 | virtual | 
Save the collection to a stream.
Implements Ogre::PageContentCollection.
| 
 | pure virtual | 
Save this data to a stream.
Implemented in Ogre::Grid2DPageStrategyData, and Ogre::Grid3DPageStrategyData.
| 
 | virtual | 
Set the index range of all cells (values outside this will be ignored)
| 
 | virtual | 
Set the index range of all cells (values outside this will be ignored)
| 
 | virtual | 
Set the index range of all cells (values outside this will be ignored)
| 
 | virtual | 
get the index range of all cells (values outside this will be ignored)
| 
 | virtual | 
Set the index range of all cells (values outside this will be ignored)
| 
 | virtual | 
Set the index range of all cells (values outside this will be ignored)
| 
 | virtual | 
Set the index range of all cells (values outside this will be ignored)
| 
 | virtual | 
Set the size of the cells in the grid.
| 
 | virtual | 
Set the Holding radius.
| 
 | virtual | 
Set the loading radius.
| 
 | virtual | 
Set the origin of the grid in world space.
| 
 | virtual | 
Unload - will be called in main thread.
Implements Ogre::PageContentCollection.
| 
 | virtual | 
Unprepare data - may be called in the background.
Implements Ogre::PageContentCollection.
Update the contents of the passed in SceneNode to reflect the debug display of a given page.
Implements Ogre::PageStrategy.
Update the contents of the passed in SceneNode to reflect the debug display of a given page.
Implemented in Ogre::Grid2DPageStrategy, and Ogre::Grid3DPageStrategy.
| 
 | static | 
| 
 | static | 
| 
 | static | 
| 
 | static | 
| 
 | static |