OgrePageManager.h
Go to the documentation of this file.
1 /*
2 -----------------------------------------------------------------------------
3 This source file is part of OGRE
4 (Object-oriented Graphics Rendering Engine)
5 For the latest info, see http://www.ogre3d.org/
6 
7 Copyright (c) 2000-2013 Torus Knot Software Ltd
8 
9 Permission is hereby granted, free of charge, to any person obtaining a copy
10 of this software and associated documentation files (the "Software"), to deal
11 in the Software without restriction, including without limitation the rights
12 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 copies of the Software, and to permit persons to whom the Software is
14 furnished to do so, subject to the following conditions:
15 
16 The above copyright notice and this permission notice shall be included in
17 all copies or substantial portions of the Software.
18 
19 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 THE SOFTWARE.
26 -----------------------------------------------------------------------------
27 */
28 
29 #ifndef __Ogre_PageManager_H__
30 #define __Ogre_PageManager_H__
31 
33 #include "OgreString.h"
35 #include "OgreCommon.h"
36 #include "OgreCamera.h"
37 #include "OgreFrameListener.h"
38 #include "OgreNameGenerator.h"
39 
40 namespace Ogre
41 {
50  class PagedWorldSection;
51  class PagedWorldSectionFactory;
52 
53 
60  {
61  public:
63  virtual ~PageProvider() {}
64 
71  virtual bool prepareProceduralPage(Page* page, PagedWorldSection* section) { return false; }
78  virtual bool loadProceduralPage(Page* page, PagedWorldSection* section) { return false; }
86  virtual bool unloadProceduralPage(Page* page, PagedWorldSection* section) { return false; }
94  virtual bool unprepareProceduralPage(Page* page, PagedWorldSection* section) { return false; }
95 
101  virtual StreamSerialiser* readWorldStream(const String& filename) { return 0; }
107  virtual StreamSerialiser* writeWorldStream(const String& filename) { return 0; }
116  virtual StreamSerialiser* readPageStream(PageID pageID, PagedWorldSection* section) { return 0; }
117 
126  virtual StreamSerialiser* writePageStream(PageID pageID, PagedWorldSection* section) { return 0; }
127  };
128 
137  {
138  public:
139  PageManager();
140  virtual ~PageManager();
141 
146  PagedWorld* createWorld(const String& name = StringUtil::BLANK);
147 
149  void destroyWorld(const String& name);
150 
152  void destroyWorld(PagedWorld* world);
153 
159  PagedWorld* loadWorld(const String& filename, const String& name = StringUtil::BLANK);
165  PagedWorld* loadWorld(const DataStreamPtr& stream, const String& name = StringUtil::BLANK);
170  void saveWorld(PagedWorld* world, const String& filename);
175  void saveWorld(PagedWorld* world, const DataStreamPtr& stream);
180  PagedWorld* getWorld(const String& name);
183  const WorldMap& getWorlds() const { return mWorlds; }
184 
185 
191  void addStrategy(PageStrategy* strategy);
192 
195  void removeStrategy(PageStrategy* strategy);
196 
201  PageStrategy* getStrategy(const String& name);
202 
205  const StrategyMap& getStrategies() const;
206 
207 
213  void addContentCollectionFactory(PageContentCollectionFactory* f);
214 
217  void removeContentCollectionFactory(PageContentCollectionFactory* f);
218 
223  PageContentCollectionFactory* getContentCollectionFactory(const String& name);
224 
229  PageContentCollection* createContentCollection(const String& typeName);
230 
232  void destroyContentCollection(PageContentCollection* coll);
233 
236  const ContentCollectionFactoryMap& getContentCollectionFactories() const;
237 
243  void addContentFactory(PageContentFactory* f);
244 
247  void removeContentFactory(PageContentFactory* f);
248 
253  PageContentFactory* getContentFactory(const String& name);
254 
257  const ContentFactoryMap& getContentFactories() const;
258 
263  PageContent* createContent(const String& typeName);
264 
266  void destroyContent(PageContent* c);
267 
268 
274  void addWorldSectionFactory(PagedWorldSectionFactory* f);
275 
278  void removeWorldSectionFactory(PagedWorldSectionFactory* f);
279 
284  PagedWorldSectionFactory* getWorldSectionFactory(const String& name);
285 
293  PagedWorldSection* createWorldSection(const String& typeName,
294  const String& name, PagedWorld* parent, SceneManager* sm);
295 
297  void destroyWorldSection(PagedWorldSection* s);
298 
301  const WorldSectionFactoryMap& getWorldSectionFactories() const;
302 
303 
315  void setPageProvider(PageProvider* provider) { mPageProvider = provider; }
316 
318  PageProvider* getPageProvider() const { return mPageProvider; }
319 
327  virtual bool _prepareProceduralPage(Page* page, PagedWorldSection* section);
335  virtual bool _loadProceduralPage(Page* page, PagedWorldSection* section);
343  virtual bool _unloadProceduralPage(Page* page, PagedWorldSection* section);
351  virtual bool _unprepareProceduralPage(Page* page, PagedWorldSection* section);
359  StreamSerialiser* _readPageStream(PageID pageID, PagedWorldSection* section);
360 
368  StreamSerialiser* _writePageStream(PageID pageID, PagedWorldSection* section);
374  StreamSerialiser* _readWorldStream(const String& filename);
375 
381  StreamSerialiser* _writeWorldStream(const String& filename);
382 
386  const String& getPageResourceGroup() const { return mPageResourceGroup; }
390  void setPageResourceGroup(const String& g) { mPageResourceGroup = g; }
391 
399  void addCamera(Camera* c);
400 
403  void removeCamera(Camera* c);
404 
407  bool hasCamera(Camera* c) const;
408 
411  const CameraList& getCameraList() const;
412 
422  void setDebugDisplayLevel(uint8 lvl) { mDebugDisplayLvl = lvl; }
424  uint8 getDebugDisplayLevel() const { return mDebugDisplayLvl; }
425 
432  void setPagingOperationsEnabled(bool enabled) { mPagingEnabled = enabled; }
433 
435  bool getPagingOperationsEnabled() const { return mPagingEnabled; }
436 
437 
438  protected:
439 
441  {
442  public:
446 
447  EventRouter() : pManager(0), pWorldMap(0), pCameraList(0) {}
449 
450  void cameraPreRenderScene(Camera* cam);
451  void cameraDestroyed(Camera* cam);
452  bool frameStarted(const FrameEvent& evt);
453  bool frameEnded(const FrameEvent& evt);
454  };
455 
456  void createStandardStrategies();
457  void createStandardContentFactories();
458 
471 
475  };
476 
479 }
480 
481 #endif
Ogre::FrameListener
A interface class defining a listener which can be used to receive notifications of frame events.
Definition: OgreFrameListener.h:79
OgreNameGenerator.h
Ogre::PageManager::getPageProvider
PageProvider * getPageProvider() const
Get the PageProvider which can provide streams for any Page.
Definition: OgrePageManager.h:318
Ogre::PageManager::getPageResourceGroup
const String & getPageResourceGroup() const
Get the resource group that will be used to read/write files when the default load routines are used.
Definition: OgrePageManager.h:386
Ogre::AllocatedObject
Superclass for all objects that wish to use custom memory allocators when their new / delete operator...
Definition: OgreMemoryAllocatedObject.h:58
Ogre
Definition: OgreAndroidLogListener.h:34
Ogre::PageManager::mPageProvider
PageProvider * mPageProvider
Definition: OgrePageManager.h:465
Ogre::PageProvider::readPageStream
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...
Definition: OgrePageManager.h:116
Ogre::Grid2DPageStrategy
Page strategy which loads new pages based on a regular 2D grid.
Definition: OgreGrid2DPageStrategy.h:231
Ogre::map
Definition: OgrePrerequisites.h:533
Ogre::PageManager::EventRouter::~EventRouter
~EventRouter()
Definition: OgrePageManager.h:448
Ogre::Camera
A viewpoint from which the scene will be rendered.
Definition: OgreCamera.h:86
Ogre::PageManager::mWorldSectionFactories
WorldSectionFactoryMap mWorldSectionFactories
Definition: OgrePageManager.h:463
Ogre::PageManager::EventRouter::pCameraList
CameraList * pCameraList
Definition: OgrePageManager.h:445
OgrePagingPrerequisites.h
Ogre::PageManager::EventRouter::EventRouter
EventRouter()
Definition: OgrePageManager.h:447
Ogre::PageManager::EventRouter::pManager
PageManager * pManager
Definition: OgrePageManager.h:443
Ogre::PageManager::mPagingEnabled
bool mPagingEnabled
Definition: OgrePageManager.h:470
Ogre::PageManager::ContentCollectionFactoryMap
map< String, PageContentCollectionFactory * >::type ContentCollectionFactoryMap
Definition: OgrePageManager.h:208
Ogre::PageManager::setPageProvider
void setPageProvider(PageProvider *provider)
Set the PageProvider which can provide streams for any Page.
Definition: OgrePageManager.h:315
Ogre::PageManager
The PageManager is the entry point through which you load all PagedWorld instances,...
Definition: OgrePageManager.h:136
Ogre::PageProvider::PageProvider
PageProvider()
Definition: OgrePageManager.h:62
Ogre::PageManager::mContentFactories
ContentFactoryMap mContentFactories
Definition: OgrePageManager.h:462
Ogre::PageManager::StrategyMap
map< String, PageStrategy * >::type StrategyMap
Definition: OgrePageManager.h:186
Ogre::PageManager::mContentCollectionFactories
ContentCollectionFactoryMap mContentCollectionFactories
Definition: OgrePageManager.h:461
Ogre::PageProvider::writeWorldStream
virtual StreamSerialiser * writeWorldStream(const String &filename)
Get a serialiser set up to write PagedWorld data for the given world filename.
Definition: OgrePageManager.h:107
Ogre::PageManager::mPageResourceGroup
String mPageResourceGroup
Definition: OgrePageManager.h:466
Ogre::String
_StringBase String
Definition: OgrePrerequisites.h:439
OgreResourceGroupManager.h
Ogre::PageManager::mCameraList
CameraList mCameraList
Definition: OgrePageManager.h:467
Ogre::PageProvider::loadProceduralPage
virtual bool loadProceduralPage(Page *page, PagedWorldSection *section)
Give a provider the opportunity to load page content procedurally.
Definition: OgrePageManager.h:78
Ogre::PageProvider
Abstract class that can be implemented by the user application to provide a way to retrieve or genera...
Definition: OgrePageManager.h:59
Ogre::PageManager::mSimpleCollectionFactory
SimplePageContentCollectionFactory * mSimpleCollectionFactory
Definition: OgrePageManager.h:474
Ogre::PageID
uint32 PageID
Identifier for a page.
Definition: OgrePagingPrerequisites.h:58
Ogre::PageManager::setPagingOperationsEnabled
void setPagingOperationsEnabled(bool enabled)
Pause or unpause all paging operations.
Definition: OgrePageManager.h:432
Ogre::PageManager::mDebugDisplayLvl
uint8 mDebugDisplayLvl
Definition: OgrePageManager.h:469
Ogre::PageStrategy
Defines the interface to a strategy class which is responsible for deciding when Page instances are r...
Definition: OgrePageStrategy.h:73
Ogre::PageManager::getPagingOperationsEnabled
bool getPagingOperationsEnabled() const
Get whether paging operations are currently allowed to happen.
Definition: OgrePageManager.h:435
Ogre::StringUtil::BLANK
static const String BLANK
Constant blank string, useful for returning by ref where local does not exist.
Definition: OgreString.h:196
Ogre::SimplePageContentCollectionFactory
Factory class for SimplePageContentCollection.
Definition: OgreSimplePageContentCollection.h:111
Ogre::PageManager::mGrid3DPageStrategy
Grid3DPageStrategy * mGrid3DPageStrategy
Definition: OgrePageManager.h:473
Ogre::PageManager::WorldMap
map< String, PagedWorld * >::type WorldMap
Definition: OgrePageManager.h:181
Ogre::NameGenerator
Utility class to generate a sequentially numbered series of names.
Definition: OgreNameGenerator.h:56
OgreFrameListener.h
Ogre::PageManager::setDebugDisplayLevel
void setDebugDisplayLevel(uint8 lvl)
Set the debug display level.
Definition: OgrePageManager.h:422
Ogre::SceneManager
Manages the organisation and rendering of a 'scene' i.e.
Definition: OgreSceneManager.h:143
Ogre::PageManager::EventRouter
Definition: OgrePageManager.h:440
Ogre::PageContentCollection
Definition of the interface for a collection of PageContent instances.
Definition: OgrePageContentCollection.h:55
Ogre::PagedWorld
This class represents a collection of pages which make up a world.
Definition: OgrePagedWorld.h:57
Ogre::PagedWorldSectionFactory
A factory class for creating types of world section.
Definition: OgrePagedWorldSection.h:301
Ogre::Page
Page class.
Definition: OgrePage.h:49
Ogre::PageContentFactory
Define the interface to a factory class that will create subclasses of PageContent.
Definition: OgrePageContentFactory.h:50
Ogre::PageProvider::~PageProvider
virtual ~PageProvider()
Definition: OgrePageManager.h:63
OgreCommon.h
Ogre::PagedWorldSection
Represents a section of the PagedWorld which uses a given PageStrategy, and which is made up of a gen...
Definition: OgrePagedWorldSection.h:69
Ogre::FrameEvent
Struct containing information about a frame event.
Definition: OgreFrameListener.h:44
Ogre::PageManager::mWorldNameGenerator
NameGenerator mWorldNameGenerator
Definition: OgrePageManager.h:464
Ogre::Grid3DPageStrategy
Page strategy which loads new pages based on a regular 3D grid.
Definition: OgreGrid3DPageStrategy.h:203
Ogre::SharedPtr< DataStream >
Ogre::uint8
unsigned char uint8
Definition: OgrePlatform.h:361
Ogre::StreamSerialiser
Utility class providing helper methods for reading / writing structured data held in a DataStream.
Definition: OgreStreamSerialiser.h:66
Ogre::PageManager::getWorlds
const WorldMap & getWorlds() const
Get a reference to the worlds that are currently loaded.
Definition: OgrePageManager.h:183
Ogre::PageManager::setPageResourceGroup
void setPageResourceGroup(const String &g)
Set the resource group that will be used to read/write files when the default load routines are used.
Definition: OgrePageManager.h:390
Ogre::PageManager::EventRouter::pWorldMap
WorldMap * pWorldMap
Definition: OgrePageManager.h:444
Ogre::PageProvider::writePageStream
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...
Definition: OgrePageManager.h:126
Ogre::Camera::Listener
Listener interface so you can be notified of Camera events.
Definition: OgreCamera.h:91
Ogre::PageManager::WorldSectionFactoryMap
map< String, PagedWorldSectionFactory * >::type WorldSectionFactoryMap
Definition: OgrePageManager.h:269
Ogre::PageProvider::unprepareProceduralPage
virtual bool unprepareProceduralPage(Page *page, PagedWorldSection *section)
Give a provider the opportunity to unprepare page content procedurally.
Definition: OgrePageManager.h:94
Ogre::PageProvider::prepareProceduralPage
virtual bool prepareProceduralPage(Page *page, PagedWorldSection *section)
Give a provider the opportunity to prepare page content procedurally.
Definition: OgrePageManager.h:71
Ogre::PageContent
Interface definition for a unit of content within a page.
Definition: OgrePageContent.h:49
Ogre::PageManager::mStrategies
StrategyMap mStrategies
Definition: OgrePageManager.h:460
Ogre::PageProvider::unloadProceduralPage
virtual bool unloadProceduralPage(Page *page, PagedWorldSection *section)
Give a provider the opportunity to unload page content procedurally.
Definition: OgrePageManager.h:86
OgreCamera.h
Ogre::PageManager::mEventRouter
EventRouter mEventRouter
Definition: OgrePageManager.h:468
Ogre::PageManager::mWorlds
WorldMap mWorlds
Definition: OgrePageManager.h:459
OgreString.h
Ogre::vector
Definition: OgrePrerequisites.h:491
Ogre::PageManager::ContentFactoryMap
map< String, PageContentFactory * >::type ContentFactoryMap
Definition: OgrePageManager.h:238
Ogre::PageProvider::readWorldStream
virtual StreamSerialiser * readWorldStream(const String &filename)
Get a serialiser set up to read PagedWorld data for the given world filename.
Definition: OgrePageManager.h:101
Ogre::PageContentCollectionFactory
Define the interface to a factory class that will create subclasses of PageContentCollection.
Definition: OgrePageContentCollectionFactory.h:47
Ogre::PageManager::mGrid2DPageStrategy
Grid2DPageStrategy * mGrid2DPageStrategy
Definition: OgrePageManager.h:472
Ogre::PageManager::getDebugDisplayLevel
uint8 getDebugDisplayLevel() const
Get the debug display level.
Definition: OgrePageManager.h:424
Ogre::PageManager::CameraList
vector< Camera * >::type CameraList
Definition: OgrePageManager.h:409
_OgrePagingExport
#define _OgrePagingExport
Definition: OgrePagingPrerequisites.h:72

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