OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Ogre::PageStrategy Class Referenceabstract

Defines the interface to a strategy class which is responsible for deciding when Page instances are requested for addition and removal from the paging system. More...

#include <OgrePageStrategy.h>

+ Inheritance diagram for Ogre::PageStrategy:
+ Collaboration diagram for Ogre::PageStrategy:

Public Member Functions

 PageStrategy (const String &name, PageManager *manager)
 
virtual ~PageStrategy ()
 
virtual PageStrategyDatacreateData ()=0
 Create a PageStrategyData instance containing the data specific to this PageStrategy. More...
 
virtual void destroyData (PageStrategyData *d)=0
 Destroy a PageStrategyData instance containing the data specific to this PageStrategy. More...
 
virtual void frameEnd (Real timeElapsed, PagedWorldSection *section)
 Called when the frame ends. More...
 
virtual void frameStart (Real timeSinceLastFrame, PagedWorldSection *section)
 Called when the frame starts. More...
 
PageManagergetManager () const
 
const StringgetName () const
 
virtual PageID getPageID (const Vector3 &worldPos, PagedWorldSection *section)=0
 Get the page ID for a given world position. More...
 
virtual void notifyCamera (Camera *cam, PagedWorldSection *section)
 Called when a camera is used for any kind of rendering. 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 void updateDebugDisplay (Page *p, SceneNode *sn)=0
 Update the contents of the passed in SceneNode to reflect the debug display of a given page. More...
 

Protected Attributes

PageManagermManager
 
String mName
 

Detailed Description

Defines the interface to a strategy class which is responsible for deciding when Page instances are requested for addition and removal from the paging system.

Remarks
The interface is deliberately light, with no specific mention of requesting new Page instances. It is entirely up to the PageStrategy to respond to the events raised on it and to call methods on other classes (such as requesting new pages).

Definition at line 73 of file OgrePageStrategy.h.

Constructor & Destructor Documentation

Ogre::PageStrategy::PageStrategy ( const String name,
PageManager manager 
)
inline

Definition at line 79 of file OgrePageStrategy.h.

virtual Ogre::PageStrategy::~PageStrategy ( )
inlinevirtual

Definition at line 85 of file OgrePageStrategy.h.

Member Function Documentation

virtual PageStrategyData* Ogre::PageStrategy::createData ( )
pure virtual

Create a PageStrategyData instance containing the data specific to this PageStrategy.

This data will be held by a given PagedWorldSection and the structure of the data will be specific to the PageStrategy subclass.

Implemented in Ogre::Grid2DPageStrategy, and Ogre::Grid3DPageStrategy.

virtual void Ogre::PageStrategy::destroyData ( PageStrategyData d)
pure virtual

Destroy a PageStrategyData instance containing the data specific to this PageStrategy.

This data will be held by a given PagedWorldSection and the structure of the data will be specific to the PageStrategy subclass.

Implemented in Ogre::Grid2DPageStrategy, and Ogre::Grid3DPageStrategy.

virtual void Ogre::PageStrategy::frameEnd ( Real  timeElapsed,
PagedWorldSection section 
)
inlinevirtual

Called when the frame ends.

Definition at line 93 of file OgrePageStrategy.h.

virtual void Ogre::PageStrategy::frameStart ( Real  timeSinceLastFrame,
PagedWorldSection section 
)
inlinevirtual

Called when the frame starts.

Definition at line 91 of file OgrePageStrategy.h.

PageManager* Ogre::PageStrategy::getManager ( ) const
inline

Definition at line 88 of file OgrePageStrategy.h.

const String& Ogre::PageStrategy::getName ( void  ) const
inline

Definition at line 87 of file OgrePageStrategy.h.

virtual PageID Ogre::PageStrategy::getPageID ( const Vector3 worldPos,
PagedWorldSection section 
)
pure virtual

Get the page ID for a given world position.

Returns
The page ID

Implemented in Ogre::Grid2DPageStrategy, and Ogre::Grid3DPageStrategy.

virtual void Ogre::PageStrategy::notifyCamera ( Camera cam,
PagedWorldSection section 
)
inlinevirtual

Called when a camera is used for any kind of rendering.

Remarks
This is probably the primary way in which the strategy will request new pages.
Parameters
camCamera which is being used for rendering. Class should not rely on this pointer remaining valid permanently because no notification will be given when the camera is destroyed.

Reimplemented in Ogre::Grid2DPageStrategy, and Ogre::Grid3DPageStrategy.

Definition at line 102 of file OgrePageStrategy.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr)
inlineinherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
void *   
)
inlineinherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

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

Definition at line 108 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr)
inlineinherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

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

Definition at line 119 of file OgreMemoryAllocatedObject.h.

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

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz)
inlineinherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

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

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

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

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

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

Definition at line 91 of file OgreMemoryAllocatedObject.h.

virtual void Ogre::PageStrategy::updateDebugDisplay ( Page p,
SceneNode sn 
)
pure virtual

Update the contents of the passed in SceneNode to reflect the debug display of a given page.

Remarks
The PageStrategy is to have complete control of the contents of this SceneNode, it must not be altered / added to by others.

Implemented in Ogre::Grid2DPageStrategy, and Ogre::Grid3DPageStrategy.

Member Data Documentation

PageManager* Ogre::PageStrategy::mManager
protected

Definition at line 77 of file OgrePageStrategy.h.

String Ogre::PageStrategy::mName
protected

Definition at line 76 of file OgrePageStrategy.h.


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