![]() |
OGRE 14.3
Object-Oriented Graphics Rendering Engine
|
#include <OgrePage.h>
Public Types | |
| typedef std::vector< PageContentCollection * > | ContentCollectionList |
Public Member Functions | |
| Page (PageID pageID, PagedWorldSection *parent) | |
| virtual | ~Page () |
| void | _notifyModified () |
| Tell the page that it is modified. | |
| virtual PageContentCollection * | createContentCollection (const String &typeName) |
| Create a new PageContentCollection within this page. | |
| virtual void | destroyAllContentCollections () |
| Destroy all PageContentCollections within this page. | |
| virtual void | destroyContentCollection (PageContentCollection *coll) |
| Destroy a PageContentCollection within this page. | |
| virtual void | frameEnd (Real timeElapsed) |
| Called when the frame ends. | |
| virtual void | frameStart (Real timeSinceLastFrame) |
| Called when the frame starts. | |
| virtual PageContentCollection * | getContentCollection (size_t index) |
| Get a content collection. | |
| virtual size_t | getContentCollectionCount () const |
| Get the number of content collections. | |
| const ContentCollectionList & | getContentCollectionList () const |
| Get the list of content collections. | |
| virtual unsigned long | getFrameLastHeld () |
| Get the frame number in which this Page was last loaded or held. | |
| virtual PageID | getID () const |
| Get the ID of this page, unique within the parent. | |
| PageManager * | getManager () const |
| virtual PagedWorldSection * | getParentSection () const |
| Get the PagedWorldSection this page belongs to. | |
| SceneManager * | getSceneManager () const |
| bool | isDeferredProcessInProgress () const |
| If true, it's not safe to access this Page at this time, contents may be changing. | |
| virtual bool | isHeld () const |
| Returns whether this page was 'held' in the last frame, that is was it either directly needed, or requested to stay in memory (held - as in a buffer region for example). | |
| bool | isModified () const |
| virtual void | load (bool synchronous) |
| Load this page. | |
| virtual void | notifyCamera (Camera *cam) |
| Notify a section of the current camera. | |
| virtual void | save () |
| Save page data to an automatically generated file name. | |
| virtual void | save (const String &filename) |
| Save page data to a file. | |
| virtual void | save (StreamSerialiser &stream) |
| Save page data to a serialiser. | |
| virtual void | touch () |
| 'Touch' the page to let it know it's being used | |
| virtual void | unload () |
| Unload this page. | |
Static Public Attributes | |
| static const uint32 | CHUNK_CONTENTCOLLECTION_DECLARATION_ID |
| static const uint32 | CHUNK_ID |
| static const uint16 | CHUNK_VERSION |
Page class.
| typedef std::vector<PageContentCollection*> Ogre::Page::ContentCollectionList |
| Ogre::Page::Page | ( | PageID | pageID, |
| PagedWorldSection * | parent ) |
Referenced by operator<<.
|
virtual |
| PageManager * Ogre::Page::getManager | ( | ) | const |
| SceneManager * Ogre::Page::getSceneManager | ( | ) | const |
|
inline |
If true, it's not safe to access this Page at this time, contents may be changing.
|
inlinevirtual |
Get the ID of this page, unique within the parent.
|
inlinevirtual |
Get the PagedWorldSection this page belongs to.
|
inlinevirtual |
|
virtual |
'Touch' the page to let it know it's being used
|
virtual |
Load this page.
| synchronous | Whether to force this to happen synchronously. |
|
virtual |
Unload this page.
|
virtual |
Returns whether this page was 'held' in the last frame, that is was it either directly needed, or requested to stay in memory (held - as in a buffer region for example).
If not, this page is eligible for removal.
|
virtual |
Save page data to an automatically generated file name.
|
virtual |
Save page data to a file.
|
virtual |
Save page data to a serialiser.
|
virtual |
Called when the frame starts.
|
virtual |
Called when the frame ends.
|
virtual |
Notify a section of the current camera.
|
virtual |
Create a new PageContentCollection within this page.
This is equivalent to calling PageManager::createContentCollection and then attachContentCollection.
| typeName | The name of the type of content collection (see PageManager::getContentCollectionFactories) |
|
virtual |
Destroy a PageContentCollection within this page.
This is equivalent to calling detachContentCollection and PageManager::destroyContentCollection.
|
virtual |
Destroy all PageContentCollections within this page.
|
virtual |
Get the number of content collections.
|
virtual |
Get a content collection.
| const ContentCollectionList & Ogre::Page::getContentCollectionList | ( | ) | const |
Get the list of content collections.
|
inline |
Tell the page that it is modified.
|
inline |
|
static |
|
static |
|
static |