OgreGrid2DPageStrategy.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_Grid2DPageStrategy_H__
30 #define __Ogre_Grid2DPageStrategy_H__
31 
33 #include "OgrePageStrategy.h"
34 #include "OgreVector2.h"
35 #include "OgreVector3.h"
36 #include "OgreQuaternion.h"
37 
38 namespace Ogre
39 {
49  enum Grid2DMode
51  {
53  G2D_X_Z = 0,
55  G2D_X_Y = 1,
57  G2D_Y_Z = 2
58  };
121  {
122  protected:
141 
143 
144  public:
145  static const uint32 CHUNK_ID;
146  static const uint16 CHUNK_VERSION;
147 
150 
152  virtual void setMode(Grid2DMode mode);
153 
155  virtual Grid2DMode getMode() const { return mMode; }
156 
158  virtual void setOrigin(const Vector3& worldOrigin);
160  virtual const Vector3& getOrigin(const Vector3& worldOrigin) { return mWorldOrigin; }
162  virtual void setCellSize(Real sz);
164  virtual Real getCellSize() const { return mCellSize; }
166  virtual void setLoadRadius(Real sz);
168  virtual Real getLoadRadius() const { return mLoadRadius; }
170  virtual void setHoldRadius(Real sz);
172  virtual Real getHoldRadius() const { return mHoldRadius; }
174  virtual Real getLoadRadiusInCells() { return mLoadRadiusInCells; }
176  virtual Real getHoldRadiusInCells(){ return mHoldRadiusInCells; }
177 
179  virtual void setCellRange(int32 minX, int32 minY, int32 maxX, int32 maxY);
181  virtual void setCellRangeMinX(int32 minX);
183  virtual void setCellRangeMinY(int32 minY);
185  virtual void setCellRangeMaxX(int32 maxX);
187  virtual void setCellRangeMaxY(int32 maxY);
189  virtual int32 getCellRangeMinX() const { return mMinCellX; }
191  virtual int32 getCellRangeMinY() const { return mMinCellY; }
193  virtual int32 getCellRangeMaxX() const { return mMaxCellX; }
195  virtual int32 getCellRangeMaxY() const { return mMaxCellY; }
196 
198  bool load(StreamSerialiser& stream);
200  void save(StreamSerialiser& stream);
201 
203  virtual void convertWorldToGridSpace(const Vector3& world, Vector2& grid);
205  virtual void convertGridToWorldSpace(const Vector2& grid, Vector3& world);
207  virtual void getMidPointGridSpace(int32 x, int32 y, Vector2& mid);
209  virtual void getBottomLeftGridSpace(int32 x, int32 y, Vector2& bl);
214  virtual void getCornersGridSpace(int32 x, int32 y, Vector2* pFourPoints);
215 
217  void determineGridLocation(const Vector2& gridpos, int32* x, int32* y);
218 
220  void calculateCell(PageID inPageID, int32* x, int32* y);
221 
222  };
223 
224 
232  {
233  public:
235 
237 
238  // Overridden members
239  void notifyCamera(Camera* cam, PagedWorldSection* section);
243  PageID getPageID(const Vector3& worldPos, PagedWorldSection* section);
244  };
245 
248 }
249 
250 #endif
Ogre::Grid2DPageStrategyData::setMode
virtual void setMode(Grid2DMode mode)
Set the grid alignment mode.
Ogre::Grid2DPageStrategyData::setLoadRadius
virtual void setLoadRadius(Real sz)
Set the loading radius.
Ogre::int32
int int32
Definition: OgrePlatform.h:362
Ogre::Grid2DPageStrategyData::setCellRange
virtual void setCellRange(int32 minX, int32 minY, int32 maxX, int32 maxY)
Set the index range of all cells (values outside this will be ignored)
Ogre
Definition: OgreAndroidLogListener.h:35
Ogre::Grid2DPageStrategy::updateDebugDisplay
void updateDebugDisplay(Page *p, SceneNode *sn)
Update the contents of the passed in SceneNode to reflect the debug display of a given page.
Ogre::Grid2DPageStrategy::Grid2DPageStrategy
Grid2DPageStrategy(PageManager *manager)
Ogre::Grid2DPageStrategy
Page strategy which loads new pages based on a regular 2D grid.
Definition: OgreGrid2DPageStrategy.h:232
Ogre::G2D_X_Y
@ G2D_X_Y
Grid is in the X/Y plane.
Definition: OgreGrid2DPageStrategy.h:55
Ogre::Camera
A viewpoint from which the scene will be rendered.
Definition: OgreCamera.h:87
Ogre::Grid2DPageStrategy::notifyCamera
void notifyCamera(Camera *cam, PagedWorldSection *section)
Called when a camera is used for any kind of rendering.
OgrePagingPrerequisites.h
Ogre::Grid2DPageStrategyData::convertWorldToGridSpace
virtual void convertWorldToGridSpace(const Vector3 &world, Vector2 &grid)
Convert a world point to grid space (not relative to origin)
Ogre::Grid2DPageStrategyData::getCellRangeMinY
virtual int32 getCellRangeMinY() const
get the index range of all cells (values outside this will be ignored)
Definition: OgreGrid2DPageStrategy.h:191
OgreQuaternion.h
Ogre::uint16
unsigned short uint16
Definition: OgrePlatform.h:360
Ogre::PageManager
The PageManager is the entry point through which you load all PagedWorld instances,...
Definition: OgrePageManager.h:137
Ogre::Grid2DPageStrategy::destroyData
void destroyData(PageStrategyData *d)
Destroy a PageStrategyData instance containing the data specific to this PageStrategy.
Ogre::Grid2DPageStrategyData::setCellRangeMaxX
virtual void setCellRangeMaxX(int32 maxX)
Set the index range of all cells (values outside this will be ignored)
Ogre::PageStrategyData
Abstract marker class representing the data held against the PagedWorldSection which is specifically ...
Definition: OgrePageStrategy.h:50
Ogre::Grid2DPageStrategy::~Grid2DPageStrategy
~Grid2DPageStrategy()
Ogre::uint32
unsigned int uint32
Definition: OgrePlatform.h:359
Ogre::Grid2DPageStrategyData::setCellSize
virtual void setCellSize(Real sz)
Set the size of the cells in the grid.
Ogre::Grid2DPageStrategyData::getCellRangeMaxX
virtual int32 getCellRangeMaxX() const
get the index range of all cells (values outside this will be ignored)
Definition: OgreGrid2DPageStrategy.h:193
Ogre::Grid2DPageStrategyData::mHoldRadius
Real mHoldRadius
Hold radius.
Definition: OgreGrid2DPageStrategy.h:134
Ogre::Grid2DPageStrategyData::setHoldRadius
virtual void setHoldRadius(Real sz)
Set the Holding radius.
Ogre::SceneNode
Class representing a node in the scene graph.
Definition: OgreSceneNode.h:59
Ogre::PageID
uint32 PageID
Identifier for a page.
Definition: OgrePagingPrerequisites.h:58
Ogre::PageStrategy
Defines the interface to a strategy class which is responsible for deciding when Page instances are r...
Definition: OgrePageStrategy.h:74
Ogre::Grid2DPageStrategyData::getCellRangeMinX
virtual int32 getCellRangeMinX() const
get the index range of all cells (values outside this will be ignored)
Definition: OgreGrid2DPageStrategy.h:189
Ogre::Grid2DPageStrategyData::getMidPointGridSpace
virtual void getMidPointGridSpace(int32 x, int32 y, Vector2 &mid)
Get the (grid space) mid point of a cell.
Ogre::Grid2DPageStrategyData::CHUNK_VERSION
static const uint16 CHUNK_VERSION
Definition: OgreGrid2DPageStrategy.h:146
Ogre::Grid2DPageStrategyData::save
void save(StreamSerialiser &stream)
Save this data to a stream.
Ogre::Grid2DPageStrategyData::updateDerivedMetrics
void updateDerivedMetrics()
Ogre::Grid2DPageStrategyData::mOrigin
Vector2 mOrigin
Origin (grid-aligned world space)
Definition: OgreGrid2DPageStrategy.h:128
Ogre::Grid2DPageStrategyData::getCellSize
virtual Real getCellSize() const
Get the size of the cells in the grid.
Definition: OgreGrid2DPageStrategy.h:164
Ogre::Grid2DPageStrategyData::getOrigin
virtual const Vector3 & getOrigin(const Vector3 &worldOrigin)
Get the origin of the grid in world space.
Definition: OgreGrid2DPageStrategy.h:160
Ogre::Grid2DPageStrategyData::getCornersGridSpace
virtual void getCornersGridSpace(int32 x, int32 y, Vector2 *pFourPoints)
Get the (grid space) corners of a cell.
Ogre::Grid2DPageStrategyData::load
bool load(StreamSerialiser &stream)
Load this data from a stream (returns true if successful)
Ogre::Grid2DPageStrategyData::mMaxCellX
int32 mMaxCellX
Definition: OgreGrid2DPageStrategy.h:139
Ogre::Grid2DPageStrategyData::calculatePageID
PageID calculatePageID(int32 x, int32 y)
Ogre::Page
Page class.
Definition: OgrePage.h:51
Ogre::Grid2DPageStrategyData::mMinCellY
int32 mMinCellY
Definition: OgreGrid2DPageStrategy.h:138
Ogre::G2D_X_Z
@ G2D_X_Z
Grid is in the X/Z plane.
Definition: OgreGrid2DPageStrategy.h:53
Ogre::Grid2DMode
Grid2DMode
The 2D grid mode.
Definition: OgreGrid2DPageStrategy.h:51
Ogre::Grid2DPageStrategyData::mMinCellX
int32 mMinCellX
Definition: OgreGrid2DPageStrategy.h:137
Ogre::PagedWorldSection
Represents a section of the PagedWorld which uses a given PageStrategy, and which is made up of a gen...
Definition: OgrePagedWorldSection.h:70
Ogre::Grid2DPageStrategyData::getHoldRadius
virtual Real getHoldRadius() const
Get the Holding radius.
Definition: OgreGrid2DPageStrategy.h:172
Ogre::Grid2DPageStrategyData::mHoldRadiusInCells
Real mHoldRadiusInCells
Definition: OgreGrid2DPageStrategy.h:136
Ogre::StreamSerialiser
Utility class providing helper methods for reading / writing structured data held in a DataStream.
Definition: OgreStreamSerialiser.h:67
Ogre::Grid2DPageStrategyData::setCellRangeMinX
virtual void setCellRangeMinX(int32 minX)
Set the index range of all cells (values outside this will be ignored)
Ogre::G2D_Y_Z
@ G2D_Y_Z
Grid is in the Y/Z plane.
Definition: OgreGrid2DPageStrategy.h:57
Ogre::Grid2DPageStrategyData::convertGridToWorldSpace
virtual void convertGridToWorldSpace(const Vector2 &grid, Vector3 &world)
Convert a grid point to world space - note only 2 axes populated.
Ogre::Grid2DPageStrategyData::mLoadRadiusInCells
Real mLoadRadiusInCells
Definition: OgreGrid2DPageStrategy.h:135
Ogre::Grid2DPageStrategyData::mLoadRadius
Real mLoadRadius
Load radius.
Definition: OgreGrid2DPageStrategy.h:132
Ogre::Grid2DPageStrategyData::getLoadRadius
virtual Real getLoadRadius() const
Get the loading radius.
Definition: OgreGrid2DPageStrategy.h:168
Ogre::Grid2DPageStrategyData::getCellRangeMaxY
virtual int32 getCellRangeMaxY() const
get the index range of all cells (values outside this will be ignored)
Definition: OgreGrid2DPageStrategy.h:195
Ogre::Vector2
Standard 2-dimensional vector.
Definition: OgreVector2.h:52
Ogre::Grid2DPageStrategyData
Specialisation of PageStrategyData for Grid2DPageStrategy.
Definition: OgreGrid2DPageStrategy.h:121
Ogre::Grid2DPageStrategyData::calculateCell
void calculateCell(PageID inPageID, int32 *x, int32 *y)
Ogre::Grid2DPageStrategyData::~Grid2DPageStrategyData
~Grid2DPageStrategyData()
Ogre::Grid2DPageStrategyData::mWorldOrigin
Vector3 mWorldOrigin
Origin (world space)
Definition: OgreGrid2DPageStrategy.h:126
OgreVector2.h
Ogre::Grid2DPageStrategyData::setCellRangeMaxY
virtual void setCellRangeMaxY(int32 maxY)
Set the index range of all cells (values outside this will be ignored)
Ogre::Grid2DPageStrategyData::getBottomLeftGridSpace
virtual void getBottomLeftGridSpace(int32 x, int32 y, Vector2 &bl)
Get the (grid space) bottom-left of a cell.
Ogre::Grid2DPageStrategy::getPageID
PageID getPageID(const Vector3 &worldPos, PagedWorldSection *section)
Get the page ID for a given world position.
Ogre::Real
float Real
Software floating point type.
Definition: OgrePrerequisites.h:70
Ogre::Grid2DPageStrategyData::mCellSize
Real mCellSize
Grid cell (page) size.
Definition: OgreGrid2DPageStrategy.h:130
Ogre::Grid2DPageStrategyData::setOrigin
virtual void setOrigin(const Vector3 &worldOrigin)
Set the origin of the grid in world space.
Ogre::Grid2DPageStrategyData::CHUNK_ID
static const uint32 CHUNK_ID
Definition: OgreGrid2DPageStrategy.h:145
Ogre::Grid2DPageStrategyData::Grid2DPageStrategyData
Grid2DPageStrategyData()
Ogre::Grid2DPageStrategyData::mMode
Grid2DMode mMode
Orientation of the grid.
Definition: OgreGrid2DPageStrategy.h:124
Ogre::Grid2DPageStrategyData::determineGridLocation
void determineGridLocation(const Vector2 &gridpos, int32 *x, int32 *y)
Convert a grid position into a row and column index.
Ogre::Grid2DPageStrategyData::getLoadRadiusInCells
virtual Real getLoadRadiusInCells()
Get the load radius as a multiple of cells.
Definition: OgreGrid2DPageStrategy.h:174
OgreVector3.h
Ogre::Grid2DPageStrategyData::setCellRangeMinY
virtual void setCellRangeMinY(int32 minY)
Set the index range of all cells (values outside this will be ignored)
Ogre::Vector3
Standard 3-dimensional vector.
Definition: OgreVector3.h:52
Ogre::Grid2DPageStrategyData::mMaxCellY
int32 mMaxCellY
Definition: OgreGrid2DPageStrategy.h:140
Ogre::Grid2DPageStrategyData::getHoldRadiusInCells
virtual Real getHoldRadiusInCells()
Get the Hold radius as a multiple of cells.
Definition: OgreGrid2DPageStrategy.h:176
Ogre::Grid2DPageStrategy::createData
PageStrategyData * createData()
Create a PageStrategyData instance containing the data specific to this PageStrategy.
OgrePageStrategy.h
Ogre::Grid2DPageStrategyData::getMode
virtual Grid2DMode getMode() const
Set the grid alignment mode.
Definition: OgreGrid2DPageStrategy.h:155
_OgrePagingExport
#define _OgrePagingExport
Definition: OgrePagingPrerequisites.h:72

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