OGRE  1.12.8
Object-Oriented Graphics Rendering Engine
Ogre::PageContent Class Referenceabstract

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

#include <OgrePageContent.h>

+ Inheritance diagram for Ogre::PageContent:

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...
 
PageManagergetManager () const
 
SceneManagergetSceneManager () const
 
virtual const StringgetType () 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...
 
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...
 

Detailed Description

Interface definition for a unit of content within a page.

Constructor & Destructor Documentation

◆ PageContent()

Ogre::PageContent::PageContent ( PageContentFactory creator)

◆ ~PageContent()

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

Member Function Documentation

◆ getManager()

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

◆ getSceneManager()

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

◆ _notifyAttached()

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

Internal method to notify a page that it is attached.

◆ getType()

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

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

◆ save()

virtual void Ogre::PageContent::save ( StreamSerialiser stream)
pure virtual

Save the content to a stream.

◆ frameStart()

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

Called when the frame starts.

◆ frameEnd()

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

Called when the frame ends.

◆ notifyCamera()

virtual void Ogre::PageContent::notifyCamera ( Camera cam)
inlinevirtual

Notify a section of the current camera.

◆ prepare()

virtual bool Ogre::PageContent::prepare ( StreamSerialiser ser)
pure virtual

Prepare data - may be called in the background.

◆ load()

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

Load - will be called in main thread.

◆ 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.


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