Loading...
Searching...
No Matches
Ogre::Grid3DPageStrategyData Class Reference
Optional Components » Paging

Specialisation of PageStrategyData for Grid3DPageStrategy. More...

`#include <OgreGrid3DPageStrategy.h>`

Inheritance diagram for Ogre::Grid3DPageStrategyData:
[legend]

## Public Member Functions

| Grid3DPageStrategyData ()
| ~Grid3DPageStrategyData ()
void | calculateCell (PageID inPageID, int32 *x, int32 *y, int32 *z)
PageID | calculatePageID (int32 x, int32 y, int32 z)
void | determineGridLocation (const Vector3 &gridpos, int32 *x, int32 *y, int32 *z)
| Convert a grid position into a row and column index.
virtual void | getBottomLeftGridSpace (int32 x, int32 y, int z, Vector3 &bl)
| Get the (grid space) bottom-left of a cell.
virtual int32 | getCellRangeMaxX () const
| get the index range of all cells (values outside this will be ignored)
virtual int32 | getCellRangeMaxY () const
| get the index range of all cells (values outside this will be ignored)
virtual int32 | getCellRangeMaxZ () const
| get the index range of all cells (values outside this will be ignored)
virtual int32 | getCellRangeMinX () const
| get the index range of all cells (values outside this will be ignored)
virtual int32 | getCellRangeMinY () const
| get the index range of all cells (values outside this will be ignored)
virtual int32 | getCellRangeMinZ () const
| get the index range of all cells (values outside this will be ignored)
virtual Vector3 | getCellSize () const
| Get the size of the cells in the grid.
virtual void | getCornersGridSpace (int32 x, int32 y, int32 z, Vector3 *pEightPoints)
| Get the (grid space) corners of a cell.
virtual Real | getHoldRadius () const
| Get the Holding radius.
virtual Real | getLoadRadius () const
| Get the loading radius.
virtual void | getMidPointGridSpace (int32 x, int32 y, int32 z, Vector3 &mid)
virtual const Vector3 & | getOrigin (const Vector3 &worldOrigin)
| Get the origin of the grid in world space.
bool | load (StreamSerialiser &stream) override
| Load this data from a stream (returns true if successful).
void | save (StreamSerialiser &stream) override
| Save this data to a stream.
virtual void | setCellRange (int32 minX, int32 minY, int32 minZ, int32 maxX, int32 maxY, int32 maxZ)
| Set the index range of all cells (values outside this will be ignored).
virtual void | setCellRangeMaxX (int32 maxX)
| Set the index range of all cells (values outside this will be ignored).
virtual void | setCellRangeMaxY (int32 maxY)
| Set the index range of all cells (values outside this will be ignored).
virtual void | setCellRangeMaxZ (int32 maxZ)
| get the index range of all cells (values outside this will be ignored)
virtual void | setCellRangeMinX (int32 minX)
| Set the index range of all cells (values outside this will be ignored).
virtual void | setCellRangeMinY (int32 minY)
| Set the index range of all cells (values outside this will be ignored).
virtual void | setCellRangeMinZ (int32 minZ)
| Set the index range of all cells (values outside this will be ignored).
virtual void | setCellSize (const Vector3 &sz)
| Set the size of the cells in the grid.
virtual void | setHoldRadius (Real sz)
| Set the Holding radius.
virtual void | setLoadRadius (Real sz)
| Set the loading radius.
virtual void | setOrigin (const Vector3 &worldOrigin)
| Set the origin of the grid in world space.
Public Member Functions inherited from Ogre::PageStrategyData
| PageStrategyData ()
virtual | ~PageStrategyData ()

## Static Public Attributes

static const uint32 | CHUNK_ID
static const uint16 | CHUNK_VERSION

## Detailed Description

Specialisation of PageStrategyData for Grid3DPageStrategy.

Structurally this data defines with a 3D grid of pages, with the logical origin in the center of the entire grid. The grid cells are indexed from 0 as a 'centre' slot, supporting both positive and negative values. so (0,0,0) is the centre cell, (1,0,0) is the cell to the right of the centre, (0,0,1) is the cell in front of the centre, (0,1,0) the cell above the center, etc. The maximum extent of each axis is -512 to +511, so in other words enough for over 2 billion different entries.

  To limit the page load requests that are generated to a fixed region, you can set the min and max cell indexes (inclusive)for each direction; if a page request would address a cell outside this range it is ignored so you don't have the expense of checking for page data that will never exist.

  The data format for this in a file is:
  Grid3DPageStrategyData (Identifier 'G3DD')
  [Version 1]

  Name | Type | Description
  Grid origin | Vector3 | World origin of the grid.
  Grid cell size | Vector3 | The size of each cell (page) in the grid
  Grid cell range (minx, maxx, miny, maxy, minz, maxz) | int16 * 6 | The extents of the world in cell indexes
  Load radius | Real | The outer radius at which new pages should start loading
  Hold radius | Real | The radius at which existing pages should be held if already loaded but not actively loaded (should be larger than Load radius)

See also
  Grid2DPageStrategyData

The documentation for this class was generated from the following file:

- OgreGrid3DPageStrategy.h