![]() |
OGRE-Next 3.0.0
Object-Oriented Graphics Rendering Engine
|
This class represents a collection of pages which make up a world. More...
#include <OgrePagedWorld.h>
Inheritance diagram for Ogre::PagedWorld:Public Types | |
| typedef map< String, PagedWorldSection * >::type | SectionMap |
Public Member Functions | |
| PagedWorld (const String &name, PageManager *manager) | |
| Constructor. | |
| virtual | ~PagedWorld () |
| virtual bool | _loadProceduralPage (Page *page, PagedWorldSection *section) |
| Give a world the opportunity to prepare page content procedurally. | |
| virtual bool | _prepareProceduralPage (Page *page, PagedWorldSection *section) |
| Give a world 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. | |
| virtual bool | _unloadProceduralPage (Page *page, PagedWorldSection *section) |
| Give a world the opportunity to unload page content procedurally. | |
| virtual bool | _unprepareProceduralPage (Page *page, PagedWorldSection *section) |
| Give a world the opportunity to unprepare page content procedurally. | |
| StreamSerialiser * | _writePageStream (PageID pageID, PagedWorldSection *section) |
| Get a serialiser set up to read Page data for the given PageID. | |
| PagedWorldSection * | createSection (const String &strategyName, SceneManager *sceneMgr, const String §ionName=BLANKSTRING) |
| Create a new manually defined section of the world. | |
| PagedWorldSection * | createSection (PageStrategy *strategy, SceneManager *sceneMgr, const String §ionName=BLANKSTRING) |
| Create a manually defined new section of the world. | |
| PagedWorldSection * | createSection (SceneManager *sceneMgr, const String &typeName, const String §ionName=BLANKSTRING) |
| Create a new section of the world based on a specialised type. | |
| void | destroyAllSections () |
| Destroy all world sections. | |
| void | destroySection (const String &name) |
| Destroy a section of world. | |
| void | destroySection (PagedWorldSection *sec) |
| Destroy a section of world. | |
| virtual void | frameEnd (Real timeElapsed) |
| Called when the frame ends. | |
| virtual void | frameStart (Real timeSinceLastFrame) |
| Called when the frame starts. | |
| PageManager * | getManager () const |
| Get the manager of this world. | |
| const String & | getName () const |
| PageProvider * | getPageProvider () const |
| Get the PageProvider which can provide streams for Pages in this world. | |
| PagedWorldSection * | getSection (const String &name) |
| Retrieve a section of the world. | |
| size_t | getSectionCount () const |
| Get the number of sections this world has. | |
| const SectionMap & | getSections () const |
| Retrieve a const reference to all the sections in this world. | |
| void | load (const DataStreamPtr &stream) |
| Load world data from a stream. | |
| void | load (const String &filename) |
| Load world data from a file. | |
| bool | load (StreamSerialiser &stream) |
| Load world data from a serialiser (returns true if successful) | |
| virtual void | notifyCamera (Camera *cam) |
| Notify a world of the current camera. | |
| void | save (const DataStreamPtr &stream) |
| Save world data to a stream. | |
| void | save (const String &filename) |
| Save world data to a file. | |
| void | save (StreamSerialiser &stream) |
| Save world data to a serialiser. | |
| void | setPageProvider (PageProvider *provider) |
| Set the PageProvider which can provide streams for Pages in this world. | |
Static Public Attributes | |
| static const uint32 | CHUNK_ID |
| static const uint32 | CHUNK_SECTIONDECLARATION_ID |
| static const uint16 | CHUNK_VERSION |
This class represents a collection of pages which make up a world.
| typedef map<String,PagedWorldSection*>::type Ogre::PagedWorld::SectionMap |
| Ogre::PagedWorld::PagedWorld | ( | const String & | name, |
| PageManager * | manager ) |
Constructor.
| name | The name of the world, which must be enough to identify the place where data for it can be loaded from (doesn't have to be a filename necessarily). |
| manager | The PageManager that is in charge of providing this world with services such as related object factories. |
Referenced by operator<<.
|
virtual |
|
virtual |
Give a world the opportunity to prepare page content procedurally.
|
virtual |
Give a world the opportunity to prepare page content procedurally.
| StreamSerialiser * Ogre::PagedWorld::_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 |
|
virtual |
Give a world the opportunity to unload page content procedurally.
|
virtual |
Give a world the opportunity to unprepare page content procedurally.
| StreamSerialiser * Ogre::PagedWorld::_writePageStream | ( | 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 |
| PagedWorldSection * Ogre::PagedWorld::createSection | ( | const String & | strategyName, |
| SceneManager * | sceneMgr, | ||
| const String & | sectionName = BLANKSTRING ) |
Create a new manually defined section of the world.
| strategyName | The name of the strategy to use (must be registered with PageManager) |
| sceneMgr | The SceneManager to use for this section |
| sectionName | An optional name to give the section (if none is provided, one will be generated) |
References Ogre::BLANKSTRING.
| PagedWorldSection * Ogre::PagedWorld::createSection | ( | PageStrategy * | strategy, |
| SceneManager * | sceneMgr, | ||
| const String & | sectionName = BLANKSTRING ) |
Create a manually defined new section of the world.
| strategy | The strategy to use |
| sceneMgr | The SceneManager to use for this section |
| sectionName | An optional name to give the section (if none is provided, one will be generated) |
References Ogre::BLANKSTRING.
| PagedWorldSection * Ogre::PagedWorld::createSection | ( | SceneManager * | sceneMgr, |
| const String & | typeName, | ||
| const String & | sectionName = BLANKSTRING ) |
Create a new section of the world based on a specialised type.
| sceneMgr | The SceneManager to use for this section. |
| typeName | The type of section to use (must be registered with PageManager), or blank to use the default type (simple grid) |
| sectionName | An optional name to give the section (if none is provided, one will be generated) |
References Ogre::BLANKSTRING.
| void Ogre::PagedWorld::destroyAllSections | ( | ) |
Destroy all world sections.
| void Ogre::PagedWorld::destroySection | ( | const String & | name | ) |
Destroy a section of world.
| void Ogre::PagedWorld::destroySection | ( | PagedWorldSection * | sec | ) |
Destroy a section of world.
|
virtual |
Called when the frame ends.
|
virtual |
Called when the frame starts.
|
inline |
Get the manager of this world.
|
inline |
|
inline |
Get the PageProvider which can provide streams for Pages in this world.
| PagedWorldSection * Ogre::PagedWorld::getSection | ( | const String & | name | ) |
Retrieve a section of the world.
|
inline |
Get the number of sections this world has.
|
inline |
Retrieve a const reference to all the sections in this world.
| void Ogre::PagedWorld::load | ( | const DataStreamPtr & | stream | ) |
Load world data from a stream.
| void Ogre::PagedWorld::load | ( | const String & | filename | ) |
Load world data from a file.
| bool Ogre::PagedWorld::load | ( | StreamSerialiser & | stream | ) |
Load world data from a serialiser (returns true if successful)
|
virtual |
Notify a world of the current camera.
| void Ogre::PagedWorld::save | ( | const DataStreamPtr & | stream | ) |
Save world data to a stream.
| void Ogre::PagedWorld::save | ( | const String & | filename | ) |
Save world data to a file.
| filename | The name of the file to create; this can either be an absolute filename or |
| void Ogre::PagedWorld::save | ( | StreamSerialiser & | stream | ) |
Save world data to a serialiser.
|
inline |
Set the PageProvider which can provide streams for Pages in this world.
|
static |
|
static |
|
static |