OgrePageStrategy.h
Go to the documentation of this file.
1/*
2-----------------------------------------------------------------------------
3This source file is part of OGRE
4(Object-oriented Graphics Rendering Engine)
5For the latest info, see http://www.ogre3d.org/
6
7Copyright (c) 2000-2013 Torus Knot Software Ltd
8
9Permission is hereby granted, free of charge, to any person obtaining a copy
10of this software and associated documentation files (the "Software"), to deal
11in the Software without restriction, including without limitation the rights
12to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13copies of the Software, and to permit persons to whom the Software is
14furnished to do so, subject to the following conditions:
15
16The above copyright notice and this permission notice shall be included in
17all copies or substantial portions of the Software.
18
19THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25THE SOFTWARE.
26-----------------------------------------------------------------------------
27*/
28
29#ifndef __Ogre_PageStrategy_H__
30#define __Ogre_PageStrategy_H__
31
33
34
35namespace 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
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
#define _OgrePagingExport
Superclass for all objects that wish to use custom memory allocators when their new / delete operator...
A viewpoint from which the scene will be rendered.
Definition OgreCamera.h:87
The PageManager is the entry point through which you load all PagedWorld instances,...
Abstract marker class representing the data held against the PagedWorldSection which is specifically ...
Defines the interface to a strategy class which is responsible for deciding when Page instances are r...
Page class.
Definition OgrePage.h:51
Represents a section of the PagedWorld which uses a given PageStrategy, and which is made up of a gen...
Class representing a node in the scene graph.
Utility class providing helper methods for reading / writing structured data held in a DataStream.
Standard 3-dimensional vector.
Definition OgreVector3.h:52
virtual void frameEnd(Real timeElapsed, PagedWorldSection *section)
Called when the frame ends.
PageManager * getManager() const
virtual PageStrategyData * createData()=0
Create a PageStrategyData instance containing the data specific to this PageStrategy.
PageStrategy(const String &name, PageManager *manager)
virtual PageID getPageID(const Vector3 &worldPos, PagedWorldSection *section)=0
Get the page ID for a given world position.
virtual void destroyData(PageStrategyData *d)=0
Destroy a PageStrategyData instance containing the data specific to this PageStrategy.
virtual void updateDebugDisplay(Page *p, SceneNode *sn)=0
Update the contents of the passed in SceneNode to reflect the debug display of a given page.
virtual void notifyCamera(Camera *cam, PagedWorldSection *section)
Called when a camera is used for any kind of rendering.
virtual bool load(StreamSerialiser &stream)=0
Load this data from a stream (returns true if successful)
virtual void frameStart(Real timeSinceLastFrame, PagedWorldSection *section)
Called when the frame starts.
PageManager * mManager
virtual void save(StreamSerialiser &stream)=0
Save this data to a stream.
const String & getName() const
uint32 PageID
Identifier for a page.
float Real
Software floating point type.
_StringBase String

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