![]() |
OGRE-Next 3.0.0
Object-Oriented Graphics Rendering Engine
|
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>
Inheritance diagram for Ogre::PagedWorldSection: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 () |
| virtual bool | _loadProceduralPage (Page *page) |
| Give a section the opportunity to prepare page content procedurally. | |
| virtual bool | _prepareProceduralPage (Page *page) |
| Give a section the opportunity to prepare page content procedurally. | |
| virtual StreamSerialiser * | _readPageStream (PageID pageID) |
| Get a serialiser set up to read Page data for the given PageID. | |
| 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 StreamSerialiser * | _writePageStream (PageID pageID) |
| Get a serialiser set up to write Page data for the given PageID. | |
| virtual void | frameEnd (Real timeElapsed) |
| Called when the frame ends. | |
| virtual void | frameStart (Real timeSinceLastFrame) |
| Called when the frame starts. | |
| virtual const AxisAlignedBox & | getBoundingBox () const |
| Get the bounds of this section. | |
| PageManager * | getManager () const |
| virtual const String & | getName () const |
| Get the name of this section. | |
| virtual Page * | getPage (PageID pageID) |
| Retrieves a Page. | |
| virtual PageID | getPageID (const Vector3 &worldPos) |
| Get the page ID for a given world position. | |
| virtual PageProvider * | getPageProvider () const |
| Get the PageProvider which can provide streams for Pages in this section. | |
| virtual SceneManager * | getSceneManager () const |
| Get the current SceneManager. | |
| virtual PageStrategy * | getStrategy () const |
| Get the page strategy which this section is using. | |
| virtual PageStrategyData * | getStrategyData () const |
| Get the data required by the PageStrategy which is specific to this world section. | |
| virtual const String & | getType () |
| Get the type name of this section. | |
| virtual PagedWorld * | getWorld () const |
| Get the parent world. | |
| virtual void | holdPage (PageID pageID) |
| Ask for a page to be kept in memory if it's loaded. | |
| virtual bool | load (StreamSerialiser &stream) |
| Load this section from a stream (returns true if successful) | |
| virtual Page * | loadOrCreatePage (const Vector3 &worldPos) |
| Load or create a page against this section covering the given world space position. | |
| virtual void | loadPage (PageID pageID, bool forceSynchronous=false) |
| Ask for a page to be loaded with the given (section-relative) PageID. | |
| virtual void | notifyCamera (Camera *cam) |
| Notify a section of the current camera. | |
| virtual void | removeAllPages () |
| Remove all pages immediately. | |
| virtual void | save (StreamSerialiser &stream) |
| Save this section to a stream. | |
| virtual void | setBoundingBox (const AxisAlignedBox &box) |
| Set the bounds of this section. | |
| virtual void | setPageProvider (PageProvider *provider) |
| Set the PageProvider which can provide streams Pages in this section. | |
| virtual void | setSceneManager (const String &smName) |
| Change the SceneManager. | |
| virtual void | setSceneManager (SceneManager *sm) |
| Change the SceneManager. | |
| virtual void | setStrategy (const String &stratName) |
| Change the page strategy. | |
| virtual void | setStrategy (PageStrategy *strat) |
| Change the page strategy. | |
| virtual void | unloadPage (Page *p, bool forceSynchronous=false) |
| Ask for a page to be unloaded 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. | |
Static Public Attributes | |
| static const uint32 | CHUNK_ID |
| static const uint16 | CHUNK_VERSION |
Represents a section of the PagedWorld which uses a given PageStrategy, and which is made up of a generally localised set of Page instances.
| typedef map<PageID,Page*>::type Ogre::PagedWorldSection::PageMap |
| Ogre::PagedWorldSection::PagedWorldSection | ( | const String & | name, |
| PagedWorld * | parent, | ||
| SceneManager * | sm ) |
Construct a new instance, specifying the parent and scene manager.
Referenced by operator<<.
|
virtual |
|
virtual |
Give a section the opportunity to prepare page content procedurally.
|
virtual |
Give a section the opportunity to prepare page content procedurally.
|
virtual |
Get a serialiser set up to read Page data for the given PageID.
| pageID | The ID of the page being requested |
|
virtual |
Give a section the opportunity to unload page content procedurally.
|
virtual |
Give a section the opportunity to unprepare page content procedurally.
|
virtual |
Get a serialiser set up to write Page data for the given PageID.
| pageID | The ID of the page being requested |
|
virtual |
Called when the frame ends.
|
virtual |
Called when the frame starts.
|
virtual |
Get the bounds of this section.
| PageManager * Ogre::PagedWorldSection::getManager | ( | ) | const |
|
inlinevirtual |
Get the name of this section.
Get the page ID for a given world position.
|
inlinevirtual |
Get the PageProvider which can provide streams for Pages in this section.
|
inlinevirtual |
Get the current SceneManager.
|
inlinevirtual |
Get the page strategy which this section is using.
|
inlinevirtual |
Get the data required by the PageStrategy which is specific to this world section.
|
virtual |
Get the type name of this section.
|
inlinevirtual |
Get the parent world.
|
virtual |
Ask for a page to be kept in memory if it's loaded.
|
virtual |
Load this section from a stream (returns true if successful)
Load or create a page against this section covering the given world space position.
|
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 |
|
virtual |
Notify a section of the current camera.
|
virtual |
Remove all pages immediately.
|
virtual |
Save this section to a stream.
|
virtual |
Set the bounds of this section.
|
inlinevirtual |
Set the PageProvider which can provide streams Pages in this section.
|
virtual |
Change the SceneManager.
| smName | The instance name of the SceneManager |
|
virtual |
Change the SceneManager.
|
virtual |
Change the page strategy.
|
virtual |
Change the page strategy.
|
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 |
|
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 |
|
static |
|
static |