OGRE  master
Object-Oriented Graphics Rendering Engine
Ogre::SimplePageContentCollection Class Reference

Specialisation of PageContentCollection which just provides a simple list of PageContent instances. More...

#include <OgreSimplePageContentCollection.h>

+ Inheritance diagram for Ogre::SimplePageContentCollection:

Public Types

typedef std::vector< PageContent * > ContentList
 

Public Member Functions

 SimplePageContentCollection (PageContentCollectionFactory *creator)
 
 ~SimplePageContentCollection ()
 
virtual PageContentcreateContent (const String &typeName)
 Create a new PageContent within this collection. More...
 
virtual void destroyContent (PageContent *coll)
 Destroy a PageContent within this page. More...
 
void frameEnd (Real timeElapsed) override
 Called when the frame ends. More...
 
void frameStart (Real timeSinceLastFrame) override
 Called when the frame starts. More...
 
virtual const ContentListgetContentList () const
 Get const access to the list of content. More...
 
void load () override
 Load - will be called in main thread. More...
 
void notifyCamera (Camera *cam) override
 Notify a section of the current camera. More...
 
bool prepare (StreamSerialiser &stream) override
 Prepare data - may be called in the background. More...
 
void save (StreamSerialiser &stream) override
 Save the collection to a stream. More...
 
void unload () override
 Unload - will be called in main thread. More...
 
void unprepare () override
 Unprepare data - may be called in the background. More...
 
- Public Member Functions inherited from Ogre::PageContentCollection
 PageContentCollection (PageContentCollectionFactory *creator)
 
virtual ~PageContentCollection ()
 
virtual void _notifyAttached (Page *parent)
 Internal method to notify a collection that it is attached. More...
 
PageManagergetManager () const
 
PagegetParentPage () const
 
SceneManagergetSceneManager () const
 
virtual const StringgetType () const
 Get the type of the collection, which will match it's factory. More...
 

Static Public Attributes

static const uint32 SUBCLASS_CHUNK_ID
 
static const uint16 SUBCLASS_CHUNK_VERSION
 
- Static Public Attributes inherited from Ogre::PageContentCollection
static const uint32 CHUNK_ID
 
static const uint16 CHUNK_VERSION
 

Detailed Description

Specialisation of PageContentCollection which just provides a simple list of PageContent instances.

The data format for this in a file is:
SimplePageContentCollectionData (Identifier 'SPCD')
[Version 1]
Name Type Description
Nested contents Nested chunk list A sequence of nested PageContent chunks

Member Typedef Documentation

◆ ContentList

Constructor & Destructor Documentation

◆ SimplePageContentCollection()

Ogre::SimplePageContentCollection::SimplePageContentCollection ( PageContentCollectionFactory creator)

◆ ~SimplePageContentCollection()

Ogre::SimplePageContentCollection::~SimplePageContentCollection ( )

Member Function Documentation

◆ createContent()

virtual PageContent* Ogre::SimplePageContentCollection::createContent ( const String typeName)
virtual

Create a new PageContent within this collection.

Parameters
typeNameThe name of the type of content (see PageManager::getContentFactories)

◆ destroyContent()

virtual void Ogre::SimplePageContentCollection::destroyContent ( PageContent coll)
virtual

Destroy a PageContent within this page.

This is equivalent to calling detachContent and PageManager::destroyContent.

◆ getContentList()

virtual const ContentList& Ogre::SimplePageContentCollection::getContentList ( ) const
inlinevirtual

Get const access to the list of content.

◆ save()

void Ogre::SimplePageContentCollection::save ( StreamSerialiser stream)
overridevirtual

Save the collection to a stream.

Implements Ogre::PageContentCollection.

◆ frameStart()

void Ogre::SimplePageContentCollection::frameStart ( Real  timeSinceLastFrame)
overridevirtual

Called when the frame starts.

Implements Ogre::PageContentCollection.

◆ frameEnd()

void Ogre::SimplePageContentCollection::frameEnd ( Real  timeElapsed)
overridevirtual

Called when the frame ends.

Implements Ogre::PageContentCollection.

◆ notifyCamera()

void Ogre::SimplePageContentCollection::notifyCamera ( Camera cam)
overridevirtual

Notify a section of the current camera.

Implements Ogre::PageContentCollection.

◆ prepare()

bool Ogre::SimplePageContentCollection::prepare ( StreamSerialiser ser)
overridevirtual

Prepare data - may be called in the background.

Implements Ogre::PageContentCollection.

◆ load()

void Ogre::SimplePageContentCollection::load ( )
overridevirtual

Load - will be called in main thread.

Implements Ogre::PageContentCollection.

◆ unload()

void Ogre::SimplePageContentCollection::unload ( )
overridevirtual

Unload - will be called in main thread.

Implements Ogre::PageContentCollection.

◆ unprepare()

void Ogre::SimplePageContentCollection::unprepare ( )
overridevirtual

Unprepare data - may be called in the background.

Implements Ogre::PageContentCollection.

Member Data Documentation

◆ SUBCLASS_CHUNK_ID

const uint32 Ogre::SimplePageContentCollection::SUBCLASS_CHUNK_ID
static

◆ SUBCLASS_CHUNK_VERSION

const uint16 Ogre::SimplePageContentCollection::SUBCLASS_CHUNK_VERSION
static

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