OgreTerrainLodManager.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_TerrainLodManager_H__
30 #define __Ogre_TerrainLodManager_H__
31 
33 #include "OgreWorkQueue.h"
34 
35 
36 namespace Ogre
37 {
38  class Terrain;
53  {
54  public:
59 
61  {
62  LoadLodRequest( TerrainLodManager* r, uint16 preparedLod, uint16 loadedLod, uint16 target )
63  : requestee(r)
64  , currentPreparedLod(preparedLod)
65  , currentLoadedLod(loadedLod)
66  , requestedLod(target)
67  {
68  }
73  _OgreTerrainExport friend std::ostream& operator<<(std::ostream& o, const LoadLodRequest& r)
74  { return o; }
75  };
76 
77  struct LodInfo
78  {
81  bool isLast;
84  };
85  public:
87  TerrainLodManager(Terrain* t, const String& filename = "");
88  virtual ~TerrainLodManager();
89 
91  virtual bool canHandleRequest(const WorkQueue::Request* req, const WorkQueue* srcQ);
92  virtual bool canHandleResponse(const WorkQueue::Response* res, const WorkQueue* srcQ);
94  virtual void handleResponse(const WorkQueue::Response* res, const WorkQueue* srcQ);
95 
96  void updateToLodLevel(int lodLevel, bool synchronous = false);
98  static void saveLodData(StreamSerialiser& stream, Terrain* terrain);
99 
106  void fillBufferAtLod(uint lodLevel, const float* data, uint dataSize );
113  void readLodData(uint16 lowerLodBound, uint16 higherLodBound);
115 
116  int getHighestLodPrepared(){ return mHighestLodPrepared; }
117  int getHighestLodLoaded(){ return mHighestLodLoaded; }
118  int getTargetLodLevel(){ return mTargetLodLevel; }
119 
121  {
122  if(!mLodInfoTable)
123  buildLodInfoTable();
124  return mLodInfoTable[lodLevel];
125  }
126  private:
127  void init();
129 
147  static void separateData(float* data, uint16 size, uint16 numLodLevels, LodsData& lods );
148  private:
153 
158 
161  };
164 }
165 
166 #endif
Ogre::TerrainLodManager::fillBufferAtLod
void fillBufferAtLod(uint lodLevel, const float *data, uint dataSize)
Copy geometry data from buffer to mHeightData/mDeltaData.
Ogre::TerrainLodManager::LodData
vector< float >::type LodData
Definition: OgreTerrainLodManager.h:57
Ogre::WorkQueue
Interface to a general purpose request / response style background work queue.
Definition: OgreWorkQueue.h:71
Ogre::AllocatedObject
Superclass for all objects that wish to use custom memory allocators when their new / delete operator...
Definition: OgreMemoryAllocatedObject.h:59
Ogre::WorkQueue::Request
General purpose request structure.
Definition: OgreWorkQueue.h:84
Ogre
Definition: OgreAndroidLogListener.h:35
Ogre::TerrainLodManager::LodInfo::size
uint size
Definition: OgreTerrainLodManager.h:83
Ogre::TerrainLodManager::canHandleResponse
virtual bool canHandleResponse(const WorkQueue::Response *res, const WorkQueue *srcQ)
Return whether this handler can process a given response.
Ogre::TerrainLodManager::LoadLodRequest::LoadLodRequest
LoadLodRequest(TerrainLodManager *r, uint16 preparedLod, uint16 loadedLod, uint16 target)
Definition: OgreTerrainLodManager.h:62
Ogre::TerrainLodManager::getHighestLodPrepared
int getHighestLodPrepared()
Definition: OgreTerrainLodManager.h:116
Ogre::TerrainLodManager::handleResponse
virtual void handleResponse(const WorkQueue::Response *res, const WorkQueue *srcQ)
The handler method every subclass must implement.
Ogre::TerrainLodManager::mHighestLodPrepared
int mHighestLodPrepared
Which LOD level is demanded.
Definition: OgreTerrainLodManager.h:156
Ogre::TerrainLodManager::separateData
static void separateData(float *data, uint16 size, uint16 numLodLevels, LodsData &lods)
Separate geometry data by LOD level.
_OgreTerrainExport
#define _OgreTerrainExport
Definition: OgreTerrainPrerequisites.h:58
Ogre::TerrainLodManager::saveLodData
static void saveLodData(StreamSerialiser &stream, Terrain *terrain)
Save each LOD level separately compressed so seek is possible.
Ogre::TerrainLodManager::canHandleRequest
virtual bool canHandleRequest(const WorkQueue::Request *req, const WorkQueue *srcQ)
Return whether this handler can process a given request.
Ogre::TerrainLodManager::LodInfo::treeEnd
uint treeEnd
Definition: OgreTerrainLodManager.h:80
Ogre::Terrain
The main containing class for a chunk of terrain.
Definition: OgreTerrain.h:264
Ogre::TerrainLodManager::mWorkQueueChannel
uint16 mWorkQueueChannel
Definition: OgreTerrainLodManager.h:152
Ogre::TerrainLodManager
Terrain LOD data manager.
Definition: OgreTerrainLodManager.h:53
Ogre::uint16
unsigned short uint16
Definition: OgrePlatform.h:360
Ogre::WorkQueue::Response
General purpose response structure.
Definition: OgreWorkQueue.h:123
Ogre::uint32
unsigned int uint32
Definition: OgrePlatform.h:359
Ogre::TerrainLodManager::buildLodInfoTable
void buildLodInfoTable()
Ogre::TerrainLodManager::getLodInfo
LodInfo & getLodInfo(uint lodLevel)
Definition: OgreTerrainLodManager.h:120
Ogre::TerrainLodManager::mLastRequestSynchronous
bool mLastRequestSynchronous
Is increaseLodLevel() running?
Definition: OgreTerrainLodManager.h:160
Ogre::String
_StringBase String
Definition: OgrePrerequisites.h:439
Ogre::TerrainLodManager::getTargetLodLevel
int getTargetLodLevel()
Definition: OgreTerrainLodManager.h:118
Ogre::TerrainLodManager::~TerrainLodManager
virtual ~TerrainLodManager()
Ogre::TerrainLodManager::WORKQUEUE_LOAD_LOD_DATA_REQUEST
static const uint16 WORKQUEUE_LOAD_LOD_DATA_REQUEST
Definition: OgreTerrainLodManager.h:90
OgreTerrainPrerequisites.h
Ogre::TerrainLodManager::updateToLodLevel
void updateToLodLevel(int lodLevel, bool synchronous=false)
Ogre::TerrainLodManager::LodInfo::treeStart
uint treeStart
Definition: OgreTerrainLodManager.h:79
Ogre::vector::type
std::vector< T, A > type
Definition: OgrePrerequisites.h:494
Ogre::TerrainLodManager::LodInfo::isLast
bool isLast
Definition: OgreTerrainLodManager.h:81
Ogre::TerrainLodManager::init
void init()
Ogre::TerrainLodManager::mLodInfoTable
LodInfo * mLodInfoTable
Definition: OgreTerrainLodManager.h:154
Ogre::WorkQueue::ResponseHandler
Interface definition for a handler of responses.
Definition: OgreWorkQueue.h:197
Ogre::TerrainLodManager::mIncreaseLodLevelInProgress
bool mIncreaseLodLevelInProgress
Highest LOD level loaded in GPU.
Definition: OgreTerrainLodManager.h:159
Ogre::TerrainLodManager::TerrainLodManager
TerrainLodManager(Terrain *t, DataStreamPtr &stream)
Ogre::TerrainLodManager::LoadLodRequest::requestedLod
uint16 requestedLod
Definition: OgreTerrainLodManager.h:72
Ogre::TerrainLodManager::TerrainLodManager
TerrainLodManager(Terrain *t, const String &filename="")
Ogre::TerrainLodManager::LodInfo::resolution
uint16 resolution
Definition: OgreTerrainLodManager.h:82
Ogre::TerrainLodManager::mHighestLodLoaded
int mHighestLodLoaded
Highest LOD level stored in memory i.e. mHeightData/mDeltaData.
Definition: OgreTerrainLodManager.h:157
Ogre::TerrainLodManager::waitForDerivedProcesses
void waitForDerivedProcesses()
Ogre::TerrainLodManager::TERRAINLODDATA_CHUNK_VERSION
static const uint16 TERRAINLODDATA_CHUNK_VERSION
Definition: OgreTerrainLodManager.h:56
Ogre::TerrainLodManager::LoadLodRequest
Definition: OgreTerrainLodManager.h:61
Ogre::TerrainLodManager::mStreamOffset
size_t mStreamOffset
Definition: OgreTerrainLodManager.h:151
Ogre::SharedPtr< DataStream >
Ogre::TerrainLodManager::readLodData
void readLodData(uint16 lowerLodBound, uint16 higherLodBound)
Read separated geometry data from file into allocated memory.
Ogre::TerrainLodManager::getHighestLodLoaded
int getHighestLodLoaded()
Definition: OgreTerrainLodManager.h:117
Ogre::StreamSerialiser
Utility class providing helper methods for reading / writing structured data held in a DataStream.
Definition: OgreStreamSerialiser.h:67
OgreWorkQueue.h
Ogre::uint
unsigned int uint
Definition: OgrePrerequisites.h:114
Ogre::TerrainLodManager::TERRAINLODDATA_CHUNK_ID
static const uint32 TERRAINLODDATA_CHUNK_ID
Definition: OgreTerrainLodManager.h:55
Ogre::TerrainLodManager::mTargetLodLevel
int mTargetLodLevel
Definition: OgreTerrainLodManager.h:155
Ogre::TerrainLodManager::LodsData
vector< LodData >::type LodsData
Definition: OgreTerrainLodManager.h:58
Ogre::WorkQueue::RequestHandler
Interface definition for a handler of requests.
Definition: OgreWorkQueue.h:162
Ogre::TerrainLodManager::handleRequest
virtual WorkQueue::Response * handleRequest(const WorkQueue::Request *req, const WorkQueue *srcQ)
The handler method every subclass must implement.
Ogre::TerrainLodManager::LoadLodRequest::currentLoadedLod
uint16 currentLoadedLod
Definition: OgreTerrainLodManager.h:71
Ogre::TerrainLodManager::LoadLodRequest::requestee
TerrainLodManager * requestee
Definition: OgreTerrainLodManager.h:69
Ogre::TerrainLodManager::LoadLodRequest::operator<<
_OgreTerrainExport friend std::ostream & operator<<(std::ostream &o, const LoadLodRequest &r)
Definition: OgreTerrainLodManager.h:73
Ogre::vector
Definition: OgrePrerequisites.h:492
Ogre::TerrainLodManager::LoadLodRequest::currentPreparedLod
uint16 currentPreparedLod
Definition: OgreTerrainLodManager.h:70
Ogre::TerrainLodManager::LodInfo
Definition: OgreTerrainLodManager.h:78
Ogre::TerrainLodManager::mTerrain
Terrain * mTerrain
Definition: OgreTerrainLodManager.h:149
Ogre::TerrainLodManager::mDataStream
DataStreamPtr mDataStream
Definition: OgreTerrainLodManager.h:150

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