OgrePagedWorld.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_PagedWorld_H__
30 #define __Ogre_PagedWorld_H__
31 
33 #include "OgreString.h"
34 #include "OgreDataStream.h"
35 #include "OgreCommon.h"
36 #include "OgreNameGenerator.h"
37 
38 namespace Ogre
39 {
40  class PageManager;
41 
58  {
59  protected:
63 
64  public:
65  static const uint32 CHUNK_ID;
66  static const uint16 CHUNK_VERSION;
75  PagedWorld(const String& name, PageManager* manager);
76  virtual ~PagedWorld();
77 
78  const String& getName() const { return mName; }
80  PageManager* getManager() const { return mManager; }
81 
83  void load(const String& filename);
85  void load(const DataStreamPtr& stream);
87  bool load(StreamSerialiser& stream);
92  void save(const String& filename);
94  void save(const DataStreamPtr& stream);
96  void save(StreamSerialiser& stream);
97 
113  const String& typeName,
114  const String& sectionName = StringUtil::BLANK);
115 
116 
130  PagedWorldSection* createSection(const String& strategyName, SceneManager* sceneMgr,
131  const String& sectionName = StringUtil::BLANK);
132 
133 
147  const String& sectionName = StringUtil::BLANK);
149  void destroySection(const String& name);
154 
156  size_t getSectionCount() const { return mSections.size(); }
157 
160 
163  const SectionMap& getSections() const { return mSections; }
164 
176  void setPageProvider(PageProvider* provider) { mPageProvider = provider; }
177 
179  PageProvider* getPageProvider() const { return mPageProvider; }
180 
188  virtual bool _prepareProceduralPage(Page* page, PagedWorldSection* section);
196  virtual bool _loadProceduralPage(Page* page, PagedWorldSection* section);
204  virtual bool _unloadProceduralPage(Page* page, PagedWorldSection* section);
212  virtual bool _unprepareProceduralPage(Page* page, PagedWorldSection* section);
221 
230 
232  virtual void frameStart(Real timeSinceLastFrame);
234  virtual void frameEnd(Real timeElapsed);
236  virtual void notifyCamera(Camera* cam);
237 
240  _OgrePagingExport friend std::ostream& operator <<( std::ostream& o, const PagedWorld& p );
241 
242 
243  protected:
246  };
247 
251 }
252 
253 #endif
Ogre::PagedWorld::CHUNK_SECTIONDECLARATION_ID
static const uint32 CHUNK_SECTIONDECLARATION_ID
Definition: OgrePagedWorld.h:67
Ogre::PagedWorld::notifyCamera
virtual void notifyCamera(Camera *cam)
Notify a world of the current camera.
OgreNameGenerator.h
Ogre::PagedWorld::_prepareProceduralPage
virtual bool _prepareProceduralPage(Page *page, PagedWorldSection *section)
Give a world the opportunity to prepare page content procedurally.
Ogre::AllocatedObject
Superclass for all objects that wish to use custom memory allocators when their new / delete operator...
Definition: OgreMemoryAllocatedObject.h:59
Ogre
Definition: OgreAndroidLogListener.h:35
Ogre::PagedWorld::frameStart
virtual void frameStart(Real timeSinceLastFrame)
Called when the frame starts.
Ogre::PagedWorld::load
bool load(StreamSerialiser &stream)
Load world data from a serialiser (returns true if successful)
Ogre::map
Definition: OgrePrerequisites.h:534
Ogre::Camera
A viewpoint from which the scene will be rendered.
Definition: OgreCamera.h:87
Ogre::PagedWorld::mPageProvider
PageProvider * mPageProvider
Definition: OgrePagedWorld.h:62
OgrePagingPrerequisites.h
Ogre::PagedWorld::load
void load(const String &filename)
Load world data from a file.
Ogre::PagedWorld::mSections
SectionMap mSections
Definition: OgrePagedWorld.h:244
Ogre::PagedWorld::CHUNK_VERSION
static const uint16 CHUNK_VERSION
Definition: OgrePagedWorld.h:66
Ogre::uint16
unsigned short uint16
Definition: OgrePlatform.h:360
Ogre::PagedWorld::_loadProceduralPage
virtual bool _loadProceduralPage(Page *page, PagedWorldSection *section)
Give a world the opportunity to prepare page content procedurally.
Ogre::PageManager
The PageManager is the entry point through which you load all PagedWorld instances,...
Definition: OgrePageManager.h:137
Ogre::PagedWorld::mManager
PageManager * mManager
Definition: OgrePagedWorld.h:61
Ogre::PagedWorld::mSectionNameGenerator
NameGenerator mSectionNameGenerator
Definition: OgrePagedWorld.h:245
Ogre::PagedWorld::getName
const String & getName() const
Definition: OgrePagedWorld.h:78
Ogre::PagedWorld::load
void load(const DataStreamPtr &stream)
Load world data from a stream.
Ogre::uint32
unsigned int uint32
Definition: OgrePlatform.h:359
Ogre::PagedWorld::PagedWorld
PagedWorld(const String &name, PageManager *manager)
Constructor.
Ogre::String
_StringBase String
Definition: OgrePrerequisites.h:439
Ogre::PagedWorld::_unprepareProceduralPage
virtual bool _unprepareProceduralPage(Page *page, PagedWorldSection *section)
Give a world the opportunity to unprepare page content procedurally.
Ogre::PageProvider
Abstract class that can be implemented by the user application to provide a way to retrieve or genera...
Definition: OgrePageManager.h:60
Ogre::PageID
uint32 PageID
Identifier for a page.
Definition: OgrePagingPrerequisites.h:58
Ogre::PagedWorld::getSection
PagedWorldSection * getSection(const String &name)
Retrieve a section of the world.
Ogre::PageStrategy
Defines the interface to a strategy class which is responsible for deciding when Page instances are r...
Definition: OgrePageStrategy.h:74
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::PagedWorld::~PagedWorld
virtual ~PagedWorld()
Ogre::operator<<
std::ostream & operator<<(std::ostream &o, const TRect< T > &r)
Definition: OgreCommon.h:636
Ogre::NameGenerator
Utility class to generate a sequentially numbered series of names.
Definition: OgreNameGenerator.h:57
Ogre::PagedWorld::frameEnd
virtual void frameEnd(Real timeElapsed)
Called when the frame ends.
Ogre::SceneManager
Manages the organisation and rendering of a 'scene' i.e.
Definition: OgreSceneManager.h:144
Ogre::PagedWorld::save
void save(const DataStreamPtr &stream)
Save world data to a stream.
Ogre::PagedWorld::mName
String mName
Definition: OgrePagedWorld.h:60
Ogre::PagedWorld
This class represents a collection of pages which make up a world.
Definition: OgrePagedWorld.h:58
Ogre::PagedWorld::save
void save(StreamSerialiser &stream)
Save world data to a serialiser.
Ogre::Page
Page class.
Definition: OgrePage.h:51
Ogre::PagedWorld::destroySection
void destroySection(PagedWorldSection *sec)
Destroy a section of world.
Ogre::PagedWorld::_readPageStream
StreamSerialiser * _readPageStream(PageID pageID, PagedWorldSection *section)
Get a serialiser set up to read Page data for the given PageID.
OgreCommon.h
Ogre::PagedWorld::save
void save(const String &filename)
Save world data to a file.
Ogre::PagedWorldSection
Represents a section of the PagedWorld which uses a given PageStrategy, and which is made up of a gen...
Definition: OgrePagedWorldSection.h:70
Ogre::SharedPtr< DataStream >
Ogre::PagedWorld::createSection
PagedWorldSection * createSection(PageStrategy *strategy, SceneManager *sceneMgr, const String &sectionName=StringUtil::BLANK)
Create a manually defined new section of the world.
Ogre::StreamSerialiser
Utility class providing helper methods for reading / writing structured data held in a DataStream.
Definition: OgreStreamSerialiser.h:67
Ogre::PagedWorld::getManager
PageManager * getManager() const
Get the manager of this world.
Definition: OgrePagedWorld.h:80
Ogre::PagedWorld::getSections
const SectionMap & getSections() const
Retrieve a const reference to all the sections in this world.
Definition: OgrePagedWorld.h:163
Ogre::PagedWorld::_writePageStream
StreamSerialiser * _writePageStream(PageID pageID, PagedWorldSection *section)
Get a serialiser set up to read Page data for the given PageID.
Ogre::PagedWorld::_unloadProceduralPage
virtual bool _unloadProceduralPage(Page *page, PagedWorldSection *section)
Give a world the opportunity to unload page content procedurally.
Ogre::Real
float Real
Software floating point type.
Definition: OgrePrerequisites.h:70
Ogre::PagedWorld::getPageProvider
PageProvider * getPageProvider() const
Get the PageProvider which can provide streams for Pages in this world.
Definition: OgrePagedWorld.h:179
Ogre::PagedWorld::destroySection
void destroySection(const String &name)
Destroy a section of world.
Ogre::PagedWorld::CHUNK_ID
static const uint32 CHUNK_ID
Definition: OgrePagedWorld.h:65
Ogre::PagedWorld::createSection
PagedWorldSection * createSection(const String &strategyName, SceneManager *sceneMgr, const String &sectionName=StringUtil::BLANK)
Create a new manually defined section of the world.
Ogre::PagedWorld::createSection
PagedWorldSection * createSection(SceneManager *sceneMgr, const String &typeName, const String &sectionName=StringUtil::BLANK)
Create a new section of the world based on a specialised type.
OgreString.h
Ogre::PagedWorld::SectionMap
map< String, PagedWorldSection * >::type SectionMap
Definition: OgrePagedWorld.h:161
Ogre::PagedWorld::getSectionCount
size_t getSectionCount() const
Get the number of sections this world has.
Definition: OgrePagedWorld.h:156
OgreDataStream.h
Ogre::PagedWorld::destroyAllSections
void destroyAllSections()
Destroy all world sections.
Ogre::PagedWorld::setPageProvider
void setPageProvider(PageProvider *provider)
Set the PageProvider which can provide streams for Pages in this world.
Definition: OgrePagedWorld.h:176
_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.