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 vector< PageContent * >::type	ContentList

Public Member Functions
	SimplePageContentCollection (PageContentCollectionFactory *creator)
	~SimplePageContentCollection ()
virtual void	_notifyAttached (Page *parent)
	Internal method to notify a collection that it is attached.
virtual PageContent *	createContent (const String &typeName)
	Create a new PageContent within this collection.
virtual void	destroyContent (PageContent *coll)
	Destroy a PageContent within this page.
virtual void	frameEnd (Real timeElapsed)
	Called when the frame ends.
virtual void	frameStart (Real timeSinceLastFrame)
	Called when the frame starts.
virtual const ContentList &	getContentList () const
	Get const access to the list of content.
PageManager *	getManager () const
Page *	getParentPage () const
SceneManager *	getSceneManager () const
virtual const String &	getType () const
	Get the type of the collection, which will match it's factory.
void	load ()
	Load - will be called in main thread.
virtual void	notifyCamera (Camera *cam)
	Notify a section of the current camera.
void	operator delete (void *ptr)
void	operator delete (void *ptr, const char *, int, const char *)
void	operator delete (void *ptr, void *)
void	operator delete[] (void *ptr)
void	operator delete[] (void *ptr, const char *, int, const char *)
void *	operator new (size_t sz)
void *	operator new (size_t sz, const char *file, int line, const char *func)
	operator new, with debug line info
void *	operator new (size_t sz, void *ptr)
	placement operator new
void *	operator new[] (size_t sz)
void *	operator new[] (size_t sz, const char *file, int line, const char *func)
	array operator new, with debug line info
bool	prepare (StreamSerialiser &stream)
	Prepare data - may be called in the background.
virtual void	save (StreamSerialiser &stream)
	Save the collection to a stream.
void	unload ()
	Unload - will be called in main thread.
void	unprepare ()
	Unprepare data - may be called in the background.

Static Public Attributes
static const uint32	CHUNK_ID
static const uint16	CHUNK_VERSION
static const uint32	SUBCLASS_CHUNK_ID
static const uint16	SUBCLASS_CHUNK_VERSION

Protected Attributes
ContentList	mContentList
PageContentCollectionFactory *	mCreator
Page *	mParent

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

Definition at line 66 of file OgreSimplePageContentCollection.h.

Member Function Documentation

_notifyAttached()

virtual void Ogre::PageContentCollection::_notifyAttached ( Page * parent )

virtualinherited

Internal method to notify a collection that it is attached.

getManager()

PageManager * Ogre::PageContentCollection::getManager ( ) const

inherited

getParentPage()

Page * Ogre::PageContentCollection::getParentPage ( ) const

inherited

Definition at line 68 of file OgrePageContentCollection.h.

References mParent.

getSceneManager()

SceneManager * Ogre::PageContentCollection::getSceneManager ( ) const

inherited

getType()

virtual const String & Ogre::PageContentCollection::getType ( ) const

virtualinherited

Get the type of the collection, which will match it's factory.

operator delete() [1/3]

void Ogre::AllocatedObject< GeneralAllocPolicy >::operator delete ( void * ptr )

inherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

operator delete() [2/3]

void Ogre::AllocatedObject< GeneralAllocPolicy >::operator delete ( void * ptr, const char * , int , const char *  )

inherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

operator delete() [3/3]

void Ogre::AllocatedObject< GeneralAllocPolicy >::operator delete ( void * ptr, void *  )

inherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

operator delete[]() [1/2]

void Ogre::AllocatedObject< GeneralAllocPolicy >::operator delete[] ( void * ptr )

inherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

operator delete[]() [2/2]

void Ogre::AllocatedObject< GeneralAllocPolicy >::operator delete[] ( void * ptr, const char * , int , const char *  )

inherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

operator new() [1/3]

void * Ogre::AllocatedObject< GeneralAllocPolicy >::operator new ( size_t sz )

inherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

operator new() [2/3]

void * Ogre::AllocatedObject< GeneralAllocPolicy >::operator new ( size_t sz, const char * file, int line, const char * func )

inherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

operator new() [3/3]

void * Ogre::AllocatedObject< GeneralAllocPolicy >::operator new ( size_t sz, void * ptr )

inherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

operator new[]() [1/2]

void * Ogre::AllocatedObject< GeneralAllocPolicy >::operator new[] ( size_t sz )

inherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

operator new[]() [2/2]

void * Ogre::AllocatedObject< GeneralAllocPolicy >::operator new[] ( size_t sz, const char * file, int line, const char * func )

inherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

Member Data Documentation

CHUNK_ID

const uint32 Ogre::PageContentCollection::CHUNK_ID

staticinherited

Definition at line 61 of file OgrePageContentCollection.h.

CHUNK_VERSION

const uint16 Ogre::PageContentCollection::CHUNK_VERSION

staticinherited

Definition at line 62 of file OgrePageContentCollection.h.

mCreator

PageContentCollectionFactory* Ogre::PageContentCollection::mCreator

protectedinherited

Definition at line 58 of file OgrePageContentCollection.h.

mParent

Page* Ogre::PageContentCollection::mParent

protectedinherited

Definition at line 59 of file OgrePageContentCollection.h.

Referenced by getParentPage().

---

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

• OgreSimplePageContentCollection.h