Ogre::PageContent Class Referenceabstract
Components » Paging

Interface definition for a unit of content within a page. More...

`#include <OgrePageContent.h>`

Inheritance diagram for Ogre::PageContent:
[legend]

## Public Member Functions

| PageContent (PageContentFactory *creator)
virtual | ~PageContent ()
virtual void | _notifyAttached (PageContentCollection *parent)
| Internal method to notify a page that it is attached. More...
virtual void | frameEnd (Real timeElapsed)
| Called when the frame ends. More...
virtual void | frameStart (Real timeSinceLastFrame)
| Called when the frame starts. More...
PageManager * | getManager () const
SceneManager * | getSceneManager () const
virtual const String & | getType () const
| Get the type of the content, which will match it's factory. More...
virtual void | load ()=0
| Load - will be called in main thread. More...
virtual void | notifyCamera (Camera *cam)
| Notify a section of the current camera. More...
void | operator delete (void *ptr)
void | operator delete (void *ptr, void *)
void | operator delete (void *ptr, const char *, int, const char *)
void | operator delete[] (void *ptr)
void | operator delete[] (void *ptr, const char *, int, const char *)
void * | operator new (size_t sz, const char *file, int line, const char *func)
| operator new, with debug line info More...
void * | operator new (size_t sz)
void * | operator new (size_t sz, void *ptr)
| placement operator new More...
void * | operator new[] (size_t sz, const char *file, int line, const char *func)
| array operator new, with debug line info More...
void * | operator new[] (size_t sz)
virtual bool | prepare (StreamSerialiser &ser)=0
| Prepare data - may be called in the background. More...
virtual void | save (StreamSerialiser &stream)=0
| Save the content to a stream. More...
virtual void | unload ()=0
| Unload - will be called in main thread. More...
virtual void | unprepare ()=0
| Unprepare data - may be called in the background. More...

## Protected Attributes

PageContentFactory * | mCreator
PageContentCollection * | mParent

## Detailed Description

Interface definition for a unit of content within a page.

Definition at line 49 of file OgrePageContent.h.

## Constructor & Destructor Documentation

## PageContent()

Ogre::PageContent::PageContent | ( | PageContentFactory * | creator | ) |

## ~PageContent()

virtual Ogre::PageContent::~PageContent | ( |  | ) |

virtual

## Member Function Documentation

## _notifyAttached()

virtual void Ogre::PageContent::_notifyAttached | ( | PageContentCollection * | parent | ) |

virtual

Internal method to notify a page that it is attached.

## frameEnd()

virtual void Ogre::PageContent::frameEnd | ( | Real | timeElapsed | ) |

virtual

Called when the frame ends.

Definition at line 71 of file OgrePageContent.h.

## frameStart()

virtual void Ogre::PageContent::frameStart | ( | Real | timeSinceLastFrame | ) |

virtual

Called when the frame starts.

Definition at line 69 of file OgrePageContent.h.

## getManager()

PageManager* Ogre::PageContent::getManager | ( |  | ) | const

## getSceneManager()

SceneManager* Ogre::PageContent::getSceneManager | ( |  | ) | const

## getType()

virtual const String& Ogre::PageContent::getType | ( |  | ) | const

virtual

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

## load()

virtual void Ogre::PageContent::load | ( |  | ) |

pure virtual

Load - will be called in main thread.

## notifyCamera()

virtual void Ogre::PageContent::notifyCamera | ( | Camera * | cam | ) |

virtual

Notify a section of the current camera.

Definition at line 73 of file OgrePageContent.h.

## operator delete() [1/3]

template<class Alloc >

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

inherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

## operator delete() [2/3]

template<class Alloc >

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

inherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

## operator delete() [3/3]

template<class Alloc >

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

inherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

## operator delete[]() [1/2]

template<class Alloc >

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

inherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

## operator delete[]() [2/2]

template<class Alloc >

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

inherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

## operator new() [1/3]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::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() [2/3]

template<class Alloc >

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

inherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

## operator new() [3/3]

template<class Alloc >

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

inherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

## operator new[]() [1/2]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::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.

## operator new[]() [2/2]

template<class Alloc >

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

inherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

## prepare()

virtual bool Ogre::PageContent::prepare | ( | StreamSerialiser & | ser | ) |

pure virtual

Prepare data - may be called in the background.

## save()

virtual void Ogre::PageContent::save | ( | StreamSerialiser & | stream | ) |

pure virtual

Save the content to a stream.

## unload()

virtual void Ogre::PageContent::unload | ( |  | ) |

pure virtual

Unload - will be called in main thread.

## unprepare()

virtual void Ogre::PageContent::unprepare | ( |  | ) |

pure virtual

Unprepare data - may be called in the background.

## Member Data Documentation

## mCreator

PageContentFactory* Ogre::PageContent::mCreator

protected

Definition at line 52 of file OgrePageContent.h.

## mParent

PageContentCollection* Ogre::PageContent::mParent

protected

Definition at line 53 of file OgrePageContent.h.

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

- OgrePageContent.h

Copyright © 2012 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.