Go to the documentation of this file.
29 #ifndef __Ogre_PageManager_H__
30 #define __Ogre_PageManager_H__
50 class PagedWorldSection;
51 class PagedWorldSectionFactory;
149 void destroyWorld(
const String& name);
399 void addCamera(
Camera* c);
403 void removeCamera(
Camera* c);
407 bool hasCamera(
Camera* c)
const;
450 void cameraPreRenderScene(
Camera* cam);
451 void cameraDestroyed(
Camera* cam);
456 void createStandardStrategies();
457 void createStandardContentFactories();
A interface class defining a listener which can be used to receive notifications of frame events.
PageProvider * getPageProvider() const
Get the PageProvider which can provide streams for any Page.
const String & getPageResourceGroup() const
Get the resource group that will be used to read/write files when the default load routines are used.
Superclass for all objects that wish to use custom memory allocators when their new / delete operator...
PageProvider * mPageProvider
virtual StreamSerialiser * readPageStream(PageID pageID, PagedWorldSection *section)
Get a serialiser set up to read Page data for the given PageID, or null if this provider cannot suppl...
Page strategy which loads new pages based on a regular 2D grid.
A viewpoint from which the scene will be rendered.
WorldSectionFactoryMap mWorldSectionFactories
map< String, PageContentCollectionFactory * >::type ContentCollectionFactoryMap
void setPageProvider(PageProvider *provider)
Set the PageProvider which can provide streams for any Page.
The PageManager is the entry point through which you load all PagedWorld instances,...
ContentFactoryMap mContentFactories
map< String, PageStrategy * >::type StrategyMap
ContentCollectionFactoryMap mContentCollectionFactories
virtual StreamSerialiser * writeWorldStream(const String &filename)
Get a serialiser set up to write PagedWorld data for the given world filename.
String mPageResourceGroup
virtual bool loadProceduralPage(Page *page, PagedWorldSection *section)
Give a provider the opportunity to load page content procedurally.
Abstract class that can be implemented by the user application to provide a way to retrieve or genera...
SimplePageContentCollectionFactory * mSimpleCollectionFactory
uint32 PageID
Identifier for a page.
void setPagingOperationsEnabled(bool enabled)
Pause or unpause all paging operations.
Defines the interface to a strategy class which is responsible for deciding when Page instances are r...
bool getPagingOperationsEnabled() const
Get whether paging operations are currently allowed to happen.
static const String BLANK
Constant blank string, useful for returning by ref where local does not exist.
Factory class for SimplePageContentCollection.
Grid3DPageStrategy * mGrid3DPageStrategy
map< String, PagedWorld * >::type WorldMap
Utility class to generate a sequentially numbered series of names.
void setDebugDisplayLevel(uint8 lvl)
Set the debug display level.
Manages the organisation and rendering of a 'scene' i.e.
Definition of the interface for a collection of PageContent instances.
This class represents a collection of pages which make up a world.
A factory class for creating types of world section.
Define the interface to a factory class that will create subclasses of PageContent.
Represents a section of the PagedWorld which uses a given PageStrategy, and which is made up of a gen...
Struct containing information about a frame event.
NameGenerator mWorldNameGenerator
Page strategy which loads new pages based on a regular 3D grid.
Utility class providing helper methods for reading / writing structured data held in a DataStream.
const WorldMap & getWorlds() const
Get a reference to the worlds that are currently loaded.
void setPageResourceGroup(const String &g)
Set the resource group that will be used to read/write files when the default load routines are used.
virtual StreamSerialiser * writePageStream(PageID pageID, PagedWorldSection *section)
Get a serialiser set up to write Page data for the given PageID, or null if this provider cannot supp...
Listener interface so you can be notified of Camera events.
map< String, PagedWorldSectionFactory * >::type WorldSectionFactoryMap
virtual bool unprepareProceduralPage(Page *page, PagedWorldSection *section)
Give a provider the opportunity to unprepare page content procedurally.
virtual bool prepareProceduralPage(Page *page, PagedWorldSection *section)
Give a provider the opportunity to prepare page content procedurally.
Interface definition for a unit of content within a page.
virtual bool unloadProceduralPage(Page *page, PagedWorldSection *section)
Give a provider the opportunity to unload page content procedurally.
map< String, PageContentFactory * >::type ContentFactoryMap
virtual StreamSerialiser * readWorldStream(const String &filename)
Get a serialiser set up to read PagedWorld data for the given world filename.
Define the interface to a factory class that will create subclasses of PageContentCollection.
Grid2DPageStrategy * mGrid2DPageStrategy
uint8 getDebugDisplayLevel() const
Get the debug display level.
vector< Camera * >::type CameraList
#define _OgrePagingExport
Copyright © 2012 Torus Knot Software Ltd

This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
Last modified Tue Apr 13 2021 08:53:15