OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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-2014 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 "OgreCommon.h"
34 #include "OgreNameGenerator.h"
35 
36 namespace Ogre
37 {
38  class PageManager;
39 
56  {
57  protected:
61 
62  public:
63  static const uint32 CHUNK_ID;
64  static const uint16 CHUNK_VERSION;
73  PagedWorld(const String& name, PageManager* manager);
74  virtual ~PagedWorld();
75 
76  const String& getName() const { return mName; }
78  PageManager* getManager() const { return mManager; }
79 
81  void load(const String& filename);
83  void load(const DataStreamPtr& stream);
85  bool load(StreamSerialiser& stream);
90  void save(const String& filename);
92  void save(const DataStreamPtr& stream);
94  void save(StreamSerialiser& stream);
95 
110  PagedWorldSection* createSection(SceneManager* sceneMgr,
111  const String& typeName,
112  const String& sectionName = BLANKSTRING);
113 
114 
128  PagedWorldSection* createSection(const String& strategyName, SceneManager* sceneMgr,
129  const String& sectionName = BLANKSTRING);
130 
131 
144  PagedWorldSection* createSection(PageStrategy* strategy, SceneManager* sceneMgr,
145  const String& sectionName = BLANKSTRING);
147  void destroySection(const String& name);
149  void destroySection(PagedWorldSection* sec);
151  void destroyAllSections();
152 
154  size_t getSectionCount() const { return mSections.size(); }
155 
157  PagedWorldSection* getSection(const String& name);
158 
161  const SectionMap& getSections() const { return mSections; }
162 
174  void setPageProvider(PageProvider* provider) { mPageProvider = provider; }
175 
177  PageProvider* getPageProvider() const { return mPageProvider; }
178 
186  virtual bool _prepareProceduralPage(Page* page, PagedWorldSection* section);
194  virtual bool _loadProceduralPage(Page* page, PagedWorldSection* section);
202  virtual bool _unloadProceduralPage(Page* page, PagedWorldSection* section);
210  virtual bool _unprepareProceduralPage(Page* page, PagedWorldSection* section);
218  StreamSerialiser* _readPageStream(PageID pageID, PagedWorldSection* section);
219 
227  StreamSerialiser* _writePageStream(PageID pageID, PagedWorldSection* section);
228 
230  virtual void frameStart(Real timeSinceLastFrame);
232  virtual void frameEnd(Real timeElapsed);
234  virtual void notifyCamera(Camera* cam);
235 
238  _OgrePagingExport friend std::ostream& operator <<( std::ostream& o, const PagedWorld& p );
239 
240 
241  protected:
244  };
245 
249 }
250 
251 #endif
A viewpoint from which the scene will be rendered.
Definition: OgreCamera.h:82
float Real
Software floating point type.
unsigned int uint32
Definition: OgrePlatform.h:420
Utility class to generate a sequentially numbered series of names.
The PageManager is the entry point through which you load all PagedWorld instances, and the place where PageStrategy instances and factory classes are registered to customise the paging behaviour.
Manages the organisation and rendering of a 'scene' i.e.
This class represents a collection of pages which make up a world.
const String BLANKSTRING
Constant blank string, useful for returning by ref where local does not exist.
Definition: OgreCommon.h:574
PageProvider * mPageProvider
const String & getName() const
const SectionMap & getSections() const
Retrieve a const reference to all the sections in this world.
size_t getSectionCount() const
Get the number of sections this world has.
static const uint32 CHUNK_ID
static const uint32 CHUNK_SECTIONDECLARATION_ID
Superclass for all objects that wish to use custom memory allocators when their new / delete operator...
map< String, PagedWorldSection * >::type SectionMap
#define _OgrePagingExport
Utility class providing helper methods for reading / writing structured data held in a DataStream...
SectionMap mSections
void setPageProvider(PageProvider *provider)
Set the PageProvider which can provide streams for Pages in this world.
std::ostream & operator<<(std::ostream &o, const TRect< T > &r)
Definition: OgreCommon.h:666
Page class.
Definition: OgrePage.h:49
PageManager * mManager
PageManager * getManager() const
Get the manager of this world.
NameGenerator mSectionNameGenerator
_StringBase String
Definition: OgreCommon.h:53
PageProvider * getPageProvider() const
Get the PageProvider which can provide streams for Pages in this world.
unsigned short uint16
Definition: OgrePlatform.h:421
Abstract class that can be implemented by the user application to provide a way to retrieve or genera...
Represents a section of the PagedWorld which uses a given PageStrategy, and which is made up of a gen...
Defines the interface to a strategy class which is responsible for deciding when Page instances are r...
uint32 PageID
Identifier for a page.
static const uint16 CHUNK_VERSION