/usr/include/OGRE/Paging/OgrePageStrategy.h is in libogre-1.8-dev 1.8.1+dfsg-0ubuntu3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 | /*
-----------------------------------------------------------------------------
This source file is part of OGRE
(Object-oriented Graphics Rendering Engine)
For the latest info, see http://www.ogre3d.org/
Copyright (c) 2000-2012 Torus Knot Software Ltd
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
-----------------------------------------------------------------------------
*/
#ifndef __Ogre_PageStrategy_H__
#define __Ogre_PageStrategy_H__
#include "OgrePagingPrerequisites.h"
namespace Ogre
{
/** \addtogroup Optional Components
* @{
*/
/** \addtogroup Paging
* Some details on paging component
*/
/*@{*/
/** Abstract marker class representing the data held against the PagedWorldSection
which is specifically used by the PageStrategy.
*/
class _OgrePagingExport PageStrategyData : public PageAlloc
{
public:
PageStrategyData() {}
virtual ~PageStrategyData() {}
/// Load this data from a stream (returns true if successful)
virtual bool load(StreamSerialiser& stream) = 0;
/// Save this data to a stream
virtual void save(StreamSerialiser& stream) = 0;
};
/** Defines the interface to a strategy class which is responsible for deciding
when Page instances are requested for addition and removal from the
paging system.
@remarks
The interface is deliberately light, with no specific mention of requesting
new Page instances. It is entirely up to the PageStrategy to respond
to the events raised on it and to call methods on other classes (such as
requesting new pages).
*/
class _OgrePagingExport PageStrategy : public PageAlloc
{
protected:
String mName;
PageManager* mManager;
public:
PageStrategy(const String& name, PageManager* manager)
: mName(name), mManager(manager)
{
}
virtual ~PageStrategy() {}
const String& getName() const { return mName; }
PageManager* getManager() const { return mManager; }
/// Called when the frame starts
virtual void frameStart(Real timeSinceLastFrame, PagedWorldSection* section) {}
/// Called when the frame ends
virtual void frameEnd(Real timeElapsed, PagedWorldSection* section) {}
/** Called when a camera is used for any kind of rendering.
@remarks
This is probably the primary way in which the strategy will request
new pages.
@param cam Camera which is being used for rendering. Class should not
rely on this pointer remaining valid permanently because no notification
will be given when the camera is destroyed.
*/
virtual void notifyCamera(Camera* cam, PagedWorldSection* section) {}
/** Create a PageStrategyData instance containing the data specific to this
PageStrategy.
@par
This data will be held by a given PagedWorldSection and the structure of
the data will be specific to the PageStrategy subclass.
*/
virtual PageStrategyData* createData() = 0;
/** Destroy a PageStrategyData instance containing the data specific to this
PageStrategy.
@par
This data will be held by a given PagedWorldSection and the structure of
the data will be specific to the PageStrategy subclass.
*/
virtual void destroyData(PageStrategyData* d) = 0;
/** Update the contents of the passed in SceneNode to reflect the
debug display of a given page.
@remarks
The PageStrategy is to have complete control of the contents of this
SceneNode, it must not be altered / added to by others.
*/
virtual void updateDebugDisplay(Page* p, SceneNode* sn) = 0;
/** Get the page ID for a given world position.
@return The page ID
*/
virtual PageID getPageID(const Vector3& worldPos, PagedWorldSection* section) = 0;
};
/*@}*/
/*@}*/
}
#endif
|