OgrePageStrategy.h
Go to the documentation of this file.
/*
-----------------------------------------------------------------------------
This source file is part of OGRE
(Object-oriented Graphics Rendering Engine)
For the latest info, see http://www.ogre3d.org/
Copyright (c) 2000-2013 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
{
class _OgrePagingExport PageStrategyData : public PageAlloc
{
public:
PageStrategyData() {}
virtual ~PageStrategyData() {}
virtual bool load(StreamSerialiser& stream) = 0;
virtual void save(StreamSerialiser& stream) = 0;
};
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; }
virtual void frameStart(Real timeSinceLastFrame, PagedWorldSection* section) {}
virtual void frameEnd(Real timeElapsed, PagedWorldSection* section) {}
virtual void notifyCamera(Camera* cam, PagedWorldSection* section) {}
virtual PageStrategyData* createData() = 0;
virtual void destroyData(PageStrategyData* d) = 0;
virtual void updateDebugDisplay(Page* p, SceneNode* sn) = 0;
virtual PageID getPageID(const Vector3& worldPos, PagedWorldSection* section) = 0;
};
}
#endif
_OgrePagingExport
#define _OgrePagingExport
Definition: OgrePagingPrerequisites.h:72
Ogre::PageStrategy::frameStart
virtual void frameStart(Real timeSinceLastFrame, PagedWorldSection *section)
Called when the frame starts.
Definition: OgrePageStrategy.h:91
Ogre::PageStrategyData::~PageStrategyData
virtual ~PageStrategyData()
Definition: OgrePageStrategy.h:53
Ogre::Page
Page class.
Definition: OgrePage.h:49
Ogre::PageStrategy::getName
const String & getName() const
Definition: OgrePageStrategy.h:87
Ogre::Real
float Real
Software floating point type.
Definition: OgrePrerequisites.h:70
OgrePagingPrerequisites.h
Ogre::PagedWorldSection
Represents a section of the PagedWorld which uses a given PageStrategy, and which is made up of a gen...
Definition: OgrePagedWorldSection.h:69
Ogre::SceneNode
Class representing a node in the scene graph.
Definition: OgreSceneNode.h:58
Ogre::PageStrategy::mName
String mName
Definition: OgrePageStrategy.h:76
Ogre::PageStrategy::mManager
PageManager * mManager
Definition: OgrePageStrategy.h:77
Ogre::PageStrategy::getManager
PageManager * getManager() const
Definition: OgrePageStrategy.h:88
Ogre::Vector3
Standard 3-dimensional vector.
Definition: OgreVector3.h:51
Ogre::PageStrategyData
Abstract marker class representing the data held against the PagedWorldSection which is specifically ...
Definition: OgrePageStrategy.h:49
Ogre::PageStrategy::~PageStrategy
virtual ~PageStrategy()
Definition: OgrePageStrategy.h:85
Ogre::PageManager
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.
Definition: OgrePageManager.h:136
Ogre::PageStrategyData::PageStrategyData
PageStrategyData()
Definition: OgrePageStrategy.h:52
Ogre::String
_StringBase String
Definition: OgrePrerequisites.h:439
Ogre::PageStrategy::frameEnd
virtual void frameEnd(Real timeElapsed, PagedWorldSection *section)
Called when the frame ends.
Definition: OgrePageStrategy.h:93
Ogre::StreamSerialiser
Utility class providing helper methods for reading / writing structured data held in a DataStream...
Definition: OgreStreamSerialiser.h:66
Ogre::Camera
A viewpoint from which the scene will be rendered.
Definition: OgreCamera.h:86
Ogre::PageID
uint32 PageID
Identifier for a page.
Definition: OgrePagingPrerequisites.h:58
Ogre
Definition: OgreAndroidLogListener.h:34
Ogre::PageStrategy::PageStrategy
PageStrategy(const String &name, PageManager *manager)
Definition: OgrePageStrategy.h:79
Ogre::PageStrategy::notifyCamera
virtual void notifyCamera(Camera *cam, PagedWorldSection *section)
Called when a camera is used for any kind of rendering.
Definition: OgrePageStrategy.h:102
Ogre::PageStrategy
Defines the interface to a strategy class which is responsible for deciding when Page instances are r...
Definition: OgrePageStrategy.h:73
Ogre::AllocatedObject
Superclass for all objects that wish to use custom memory allocators when their new / delete operator...
Definition: OgreMemoryAllocatedObject.h:58

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