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 
112  PagedWorldSection* createSection(SceneManager* sceneMgr,
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 
146  PagedWorldSection* createSection(PageStrategy* strategy, SceneManager* sceneMgr,
147  const String& sectionName = StringUtil::BLANK);
149  void destroySection(const String& name);
151  void destroySection(PagedWorldSection* sec);
153  void destroyAllSections();
154 
156  size_t getSectionCount() const { return mSections.size(); }
157 
159  PagedWorldSection* getSection(const String& name);
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);
220  StreamSerialiser* _readPageStream(PageID pageID, PagedWorldSection* section);
221 
229  StreamSerialiser* _writePageStream(PageID pageID, PagedWorldSection* section);
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

Copyright © 2012 Torus Knot Software Ltd
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
Last modified Wed Oct 16 2013 14:35:43