OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
OgrePageStrategy.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_PageStrategy_H__
30 #define __Ogre_PageStrategy_H__
31 
33 
34 
35 namespace Ogre
36 {
44 
45 
50  {
51  public:
53  virtual ~PageStrategyData() {}
54 
56  virtual bool load(StreamSerialiser& stream) = 0;
58  virtual void save(StreamSerialiser& stream) = 0;
59 
60 
61  };
62 
63 
74  {
75  protected:
78  public:
79  PageStrategy(const String& name, PageManager* manager)
80  : mName(name), mManager(manager)
81  {
82 
83  }
84 
85  virtual ~PageStrategy() {}
86 
87  const String& getName() const { return mName; }
88  PageManager* getManager() const { return mManager; }
89 
91  virtual void frameStart(Real timeSinceLastFrame, PagedWorldSection* section) {}
93  virtual void frameEnd(Real timeElapsed, PagedWorldSection* section) {}
102  virtual void notifyCamera(Camera* cam, PagedWorldSection* section) {}
103 
110  virtual PageStrategyData* createData() = 0;
111 
118  virtual void destroyData(PageStrategyData* d) = 0;
119 
126  virtual void updateDebugDisplay(Page* p, SceneNode* sn) = 0;
127 
131  virtual PageID getPageID(const Vector3& worldPos, PagedWorldSection* section) = 0;
132  };
133 
136 }
137 
138 #endif
A viewpoint from which the scene will be rendered.
Definition: OgreCamera.h:82
float Real
Software floating point type.
virtual void frameStart(Real timeSinceLastFrame, PagedWorldSection *section)
Called when the frame starts.
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.
Class representing a node in the scene graph.
Definition: OgreSceneNode.h:53
virtual void notifyCamera(Camera *cam, PagedWorldSection *section)
Called when a camera is used for any kind of rendering.
PageStrategy(const String &name, PageManager *manager)
PageManager * mManager
virtual void frameEnd(Real timeElapsed, PagedWorldSection *section)
Called when the frame ends.
Superclass for all objects that wish to use custom memory allocators when their new / delete operator...
#define _OgrePagingExport
Utility class providing helper methods for reading / writing structured data held in a DataStream...
Standard 3-dimensional vector.
Definition: OgreVector3.h:50
Page class.
Definition: OgrePage.h:49
Abstract marker class representing the data held against the PagedWorldSection which is specifically ...
PageManager * getManager() const
_StringBase String
Definition: OgreCommon.h:53
Represents a section of the PagedWorld which uses a given PageStrategy, and which is made up of a gen...
const String & getName() const
Defines the interface to a strategy class which is responsible for deciding when Page instances are r...
uint32 PageID
Identifier for a page.