![]() |
OGRE 14.3
Object-Oriented Graphics Rendering Engine
|
Render large modular structures. More...
Classes | |
class | Ogre::Grid2DPageStrategy |
Page strategy which loads new pages based on a regular 2D grid. More... | |
class | Ogre::Grid2DPageStrategyData |
Specialisation of PageStrategyData for Grid2DPageStrategy. More... | |
class | Ogre::Grid3DPageStrategy |
Page strategy which loads new pages based on a regular 3D grid. More... | |
class | Ogre::Grid3DPageStrategyData |
Specialisation of PageStrategyData for Grid3DPageStrategy. More... | |
class | Ogre::Page |
Page class. More... | |
class | Ogre::PageContent |
Interface definition for a unit of content within a page. More... | |
class | Ogre::PageContentCollection |
Definition of the interface for a collection of PageContent instances. More... | |
class | Ogre::PageContentCollectionFactory |
Define the interface to a factory class that will create subclasses of PageContentCollection. More... | |
class | Ogre::PageContentFactory |
Define the interface to a factory class that will create subclasses of PageContent. More... | |
class | Ogre::PagedWorld |
This class represents a collection of pages which make up a world. More... | |
class | Ogre::PagedWorldSection |
Represents a section of the PagedWorld which uses a given PageStrategy, and which is made up of a generally localised set of Page instances. More... | |
class | Ogre::PagedWorldSectionFactory |
A factory class for creating types of world section. More... | |
class | 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. More... | |
class | Ogre::PageProvider |
Abstract class that can be implemented by the user application to provide a way to retrieve or generate page data from a source of their choosing. More... | |
class | Ogre::PageStrategy |
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. More... | |
class | Ogre::PageStrategyData |
Abstract marker class representing the data held against the PagedWorldSection which is specifically used by the PageStrategy. More... | |
class | Ogre::SimplePageContentCollection |
Specialisation of PageContentCollection which just provides a simple list of PageContent instances. More... | |
class | Ogre::SimplePageContentCollectionFactory |
Factory class for SimplePageContentCollection. More... | |
Typedefs | |
typedef std::vector< PageContent * > | Ogre::SimplePageContentCollection::ContentList |
Enumerations | |
enum | Ogre::Grid2DMode { Ogre::G2D_X_Z = 0 , Ogre::G2D_X_Y = 1 , Ogre::G2D_Y_Z = 2 } |
The 2D grid mode. More... | |
Functions | |
Ogre::Grid3DPageStrategy::Grid3DPageStrategy (PageManager *manager) | |
Ogre::Grid3DPageStrategyData::Grid3DPageStrategyData () | |
Ogre::PageStrategy::PageStrategy (const String &name, PageManager *manager) | |
Ogre::PageStrategyData::PageStrategyData () | |
Ogre::SimplePageContentCollection::SimplePageContentCollection (PageContentCollectionFactory *creator) | |
Ogre::SimplePageContentCollectionFactory::SimplePageContentCollectionFactory () | |
Ogre::Grid3DPageStrategy::~Grid3DPageStrategy () | |
Ogre::Grid3DPageStrategyData::~Grid3DPageStrategyData () | |
virtual | Ogre::PageStrategy::~PageStrategy () |
virtual | Ogre::PageStrategyData::~PageStrategyData () |
Ogre::SimplePageContentCollection::~SimplePageContentCollection () | |
Ogre::SimplePageContentCollectionFactory::~SimplePageContentCollectionFactory () | |
void | Ogre::Grid3DPageStrategyData::calculateCell (PageID inPageID, int32 *x, int32 *y, int32 *z) |
PageID | Ogre::Grid3DPageStrategyData::calculatePageID (int32 x, int32 y, int32 z) |
virtual PageContent * | Ogre::SimplePageContentCollection::createContent (const String &typeName) |
Create a new PageContent within this collection. | |
PageStrategyData * | Ogre::Grid3DPageStrategy::createData () override |
Create a PageStrategyData instance containing the data specific to this PageStrategy. | |
virtual PageStrategyData * | Ogre::PageStrategy::createData ()=0 |
Create a PageStrategyData instance containing the data specific to this PageStrategy. | |
PageContentCollection * | Ogre::SimplePageContentCollectionFactory::createInstance () override |
virtual void | Ogre::SimplePageContentCollection::destroyContent (PageContent *coll) |
Destroy a PageContent within this page. | |
void | Ogre::Grid3DPageStrategy::destroyData (PageStrategyData *d) override |
Destroy a PageStrategyData instance containing the data specific to this PageStrategy. | |
virtual void | Ogre::PageStrategy::destroyData (PageStrategyData *d)=0 |
Destroy a PageStrategyData instance containing the data specific to this PageStrategy. | |
void | Ogre::SimplePageContentCollectionFactory::destroyInstance (PageContentCollection *c) override |
void | Ogre::Grid3DPageStrategyData::determineGridLocation (const Vector3 &gridpos, int32 *x, int32 *y, int32 *z) |
Convert a grid position into a row and column index. | |
virtual void | Ogre::PageStrategy::frameEnd (Real timeElapsed, PagedWorldSection *section) |
Called when the frame ends. | |
void | Ogre::SimplePageContentCollection::frameEnd (Real timeElapsed) override |
Called when the frame ends. | |
virtual void | Ogre::PageStrategy::frameStart (Real timeSinceLastFrame, PagedWorldSection *section) |
Called when the frame starts. | |
void | Ogre::SimplePageContentCollection::frameStart (Real timeSinceLastFrame) override |
Called when the frame starts. | |
virtual void | Ogre::Grid3DPageStrategyData::getBottomLeftGridSpace (int32 x, int32 y, int z, Vector3 &bl) |
Get the (grid space) bottom-left of a cell. | |
virtual int32 | Ogre::Grid3DPageStrategyData::getCellRangeMaxX () const |
get the index range of all cells (values outside this will be ignored) | |
virtual int32 | Ogre::Grid3DPageStrategyData::getCellRangeMaxY () const |
get the index range of all cells (values outside this will be ignored) | |
virtual int32 | Ogre::Grid3DPageStrategyData::getCellRangeMaxZ () const |
get the index range of all cells (values outside this will be ignored) | |
virtual int32 | Ogre::Grid3DPageStrategyData::getCellRangeMinX () const |
get the index range of all cells (values outside this will be ignored) | |
virtual int32 | Ogre::Grid3DPageStrategyData::getCellRangeMinY () const |
get the index range of all cells (values outside this will be ignored) | |
virtual int32 | Ogre::Grid3DPageStrategyData::getCellRangeMinZ () const |
get the index range of all cells (values outside this will be ignored) | |
virtual Vector3 | Ogre::Grid3DPageStrategyData::getCellSize () const |
Get the size of the cells in the grid. | |
virtual const ContentList & | Ogre::SimplePageContentCollection::getContentList () const |
Get const access to the list of content. | |
virtual void | Ogre::Grid3DPageStrategyData::getCornersGridSpace (int32 x, int32 y, int32 z, Vector3 *pEightPoints) |
Get the (grid space) corners of a cell. | |
virtual Real | Ogre::Grid3DPageStrategyData::getHoldRadius () const |
Get the Holding radius. | |
virtual Real | Ogre::Grid3DPageStrategyData::getLoadRadius () const |
Get the loading radius. | |
PageManager * | Ogre::PageStrategy::getManager () const |
virtual void | Ogre::Grid3DPageStrategyData::getMidPointGridSpace (int32 x, int32 y, int32 z, Vector3 &mid) |
const String & | Ogre::PageStrategy::getName () const |
const String & | Ogre::SimplePageContentCollectionFactory::getName () const override |
virtual const Vector3 & | Ogre::Grid3DPageStrategyData::getOrigin (const Vector3 &worldOrigin) |
Get the origin of the grid in world space. | |
PageID | Ogre::Grid3DPageStrategy::getPageID (const Vector3 &worldPos, PagedWorldSection *section) override |
Get the page ID for a given world position. | |
virtual PageID | Ogre::PageStrategy::getPageID (const Vector3 &worldPos, PagedWorldSection *section)=0 |
Get the page ID for a given world position. | |
bool | Ogre::Grid3DPageStrategyData::load (StreamSerialiser &stream) override |
Load this data from a stream (returns true if successful) | |
virtual bool | Ogre::PageStrategyData::load (StreamSerialiser &stream)=0 |
Load this data from a stream (returns true if successful) | |
void | Ogre::SimplePageContentCollection::load () override |
Load - will be called in main thread. | |
void | Ogre::Grid3DPageStrategy::notifyCamera (Camera *cam, PagedWorldSection *section) override |
Called when a camera is used for any kind of rendering. | |
virtual void | Ogre::PageStrategy::notifyCamera (Camera *cam, PagedWorldSection *section) |
Called when a camera is used for any kind of rendering. | |
void | Ogre::SimplePageContentCollection::notifyCamera (Camera *cam) override |
Notify a section of the current camera. | |
bool | Ogre::SimplePageContentCollection::prepare (StreamSerialiser &stream) override |
Prepare data - may be called in the background. | |
void | Ogre::Grid3DPageStrategyData::save (StreamSerialiser &stream) override |
Save this data to a stream. | |
virtual void | Ogre::PageStrategyData::save (StreamSerialiser &stream)=0 |
Save this data to a stream. | |
void | Ogre::SimplePageContentCollection::save (StreamSerialiser &stream) override |
Save the collection to a stream. | |
virtual void | Ogre::Grid3DPageStrategyData::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 | Ogre::Grid3DPageStrategyData::setCellRangeMaxX (int32 maxX) |
Set the index range of all cells (values outside this will be ignored) | |
virtual void | Ogre::Grid3DPageStrategyData::setCellRangeMaxY (int32 maxY) |
Set the index range of all cells (values outside this will be ignored) | |
virtual void | Ogre::Grid3DPageStrategyData::setCellRangeMaxZ (int32 maxZ) |
get the index range of all cells (values outside this will be ignored) | |
virtual void | Ogre::Grid3DPageStrategyData::setCellRangeMinX (int32 minX) |
Set the index range of all cells (values outside this will be ignored) | |
virtual void | Ogre::Grid3DPageStrategyData::setCellRangeMinY (int32 minY) |
Set the index range of all cells (values outside this will be ignored) | |
virtual void | Ogre::Grid3DPageStrategyData::setCellRangeMinZ (int32 minZ) |
Set the index range of all cells (values outside this will be ignored) | |
virtual void | Ogre::Grid3DPageStrategyData::setCellSize (const Vector3 &sz) |
Set the size of the cells in the grid. | |
virtual void | Ogre::Grid3DPageStrategyData::setHoldRadius (Real sz) |
Set the Holding radius. | |
virtual void | Ogre::Grid3DPageStrategyData::setLoadRadius (Real sz) |
Set the loading radius. | |
virtual void | Ogre::Grid3DPageStrategyData::setOrigin (const Vector3 &worldOrigin) |
Set the origin of the grid in world space. | |
void | Ogre::SimplePageContentCollection::unload () override |
Unload - will be called in main thread. | |
void | Ogre::SimplePageContentCollection::unprepare () override |
Unprepare data - may be called in the background. | |
void | Ogre::Grid3DPageStrategy::updateDebugDisplay (Page *p, SceneNode *sn) override |
Update the contents of the passed in SceneNode to reflect the debug display of a given page. | |
virtual void | Ogre::PageStrategy::updateDebugDisplay (Page *p, SceneNode *sn)=0 |
Update the contents of the passed in SceneNode to reflect the debug display of a given page. | |
Variables | |
static const uint32 | Ogre::Grid3DPageStrategyData::CHUNK_ID |
static const uint16 | Ogre::Grid3DPageStrategyData::CHUNK_VERSION |
static String | Ogre::SimplePageContentCollectionFactory::FACTORY_NAME |
static const uint32 | Ogre::SimplePageContentCollection::SUBCLASS_CHUNK_ID |
static const uint16 | Ogre::SimplePageContentCollection::SUBCLASS_CHUNK_VERSION |
Render large modular structures.
Some details on paging component
Some details on paging component
Some details on paging component
Some details on paging component
Some details on paging component
Some details on paging component
Some details on paging component
Some details on paging component
Some details on paging component
Some details on paging component
Some details on paging component
Some details on paging component
The paging file format is a composite one - a single file / stream can contain data which is not necessarily all read by a single class. Instead, data chunks can be read by different classes, allowing the format to be extended to different types smoothly.
Paging world files have by default an extension ".world", but that is not a requirement. Internally, the only thing that matters is the data chunks and their identifiers, which are 4-character codes embedded in a uint32 as calculated by StreamSerialiser::makeIdentifier. All data will be read and written using DataStream and the StreamSerialiser class.
Data types are expressed at the lowest level exposed by the StreamSerialiser class, which is used to read / write this file.
Name | Type | Description |
World Name | char* | The name of the world - should be unique |
PagedWorldSection List | Chunk List | A variable-length list of nested PagedWorldSection chunks |
Name | Type | Description |
World Section Name | char* | The name of the world section - should be unique within world |
Bounding box | AABB | AABB of this world section in world space |
PageStrategy name | char* | The name of the PageStrategy class this world section uses to manage pages |
Page Strategy Data | Nested Chunk | PageStrategy specific data for this world section |
Name | Type | Description |
PageStrategy defined | ??? | This chunk will contain data as defined by the specific PageStrategyData used by the parent PagedWorldSection |
Name | Type | Description |
Page ID | uint32 | The identifier of the page |
PageContentCollection list | Nested chunk list | 1-n nested chunks of type PageContentCollection |
Name | Type | Description |
Factory name | char* | The name of the content collection factory |
PageContentCollectionData chunk | Nested chunk | Data required to initialise & configure the content collection |
Name | Type | Description |
PageContentCollection subclass defined | ??? | This chunk will contain data as defined by the specific PageContentCollection subclass |
Name | Type | Description |
Factory name | char* | The name of the content factory |
PageContentData chunk | Nested chunk | Data required to initialise & configure the content |
Name | Type | Description |
PageContent subclass defined | ??? | This chunk will contain data as defined by the specific PageContent subclass |
typedef std::vector<PageContent*> Ogre::SimplePageContentCollection::ContentList |
enum Ogre::Grid2DMode |
Ogre::Grid3DPageStrategyData::Grid3DPageStrategyData | ( | ) |
Ogre::Grid3DPageStrategyData::~Grid3DPageStrategyData | ( | ) |
|
virtual |
Set the origin of the grid in world space.
|
inlinevirtual |
Get the origin of the grid in world space.
|
virtual |
Set the size of the cells in the grid.
|
inlinevirtual |
Get the size of the cells in the grid.
|
virtual |
Set the loading radius.
|
inlinevirtual |
Get the loading radius.
|
virtual |
Set the Holding radius.
|
inlinevirtual |
Get the Holding radius.
|
virtual |
Set the index range of all cells (values outside this will be ignored)
|
virtual |
Set the index range of all cells (values outside this will be ignored)
|
virtual |
Set the index range of all cells (values outside this will be ignored)
|
virtual |
Set the index range of all cells (values outside this will be ignored)
|
virtual |
Set the index range of all cells (values outside this will be ignored)
|
virtual |
Set the index range of all cells (values outside this will be ignored)
|
virtual |
get the index range of all cells (values outside this will be ignored)
|
inlinevirtual |
get the index range of all cells (values outside this will be ignored)
|
inlinevirtual |
get the index range of all cells (values outside this will be ignored)
|
inlinevirtual |
get the index range of all cells (values outside this will be ignored)
|
inlinevirtual |
get the index range of all cells (values outside this will be ignored)
|
inlinevirtual |
get the index range of all cells (values outside this will be ignored)
|
inlinevirtual |
get the index range of all cells (values outside this will be ignored)
|
overridevirtual |
Load this data from a stream (returns true if successful)
Implements Ogre::PageStrategyData.
|
overridevirtual |
Save this data to a stream.
Implements Ogre::PageStrategyData.
|
virtual |
|
virtual |
Get the (grid space) bottom-left of a cell.
|
virtual |
Get the (grid space) corners of a cell.
Populates pEightPoints in anticlockwise order from the bottom left point.
void Ogre::Grid3DPageStrategyData::determineGridLocation | ( | const Vector3 & | gridpos, |
int32 * | x, | ||
int32 * | y, | ||
int32 * | z ) |
Convert a grid position into a row and column index.
void Ogre::Grid3DPageStrategyData::calculateCell | ( | PageID | inPageID, |
int32 * | x, | ||
int32 * | y, | ||
int32 * | z ) |
Ogre::Grid3DPageStrategy::Grid3DPageStrategy | ( | PageManager * | manager | ) |
Ogre::Grid3DPageStrategy::~Grid3DPageStrategy | ( | ) |
|
overridevirtual |
Called when a camera is used for any kind of rendering.
This is probably the primary way in which the strategy will request new pages.
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. |
section |
Reimplemented from Ogre::PageStrategy.
|
overridevirtual |
Create a PageStrategyData instance containing the data specific to this PageStrategy.
Implements Ogre::PageStrategy.
|
overridevirtual |
Destroy a PageStrategyData instance containing the data specific to this PageStrategy.
Implements Ogre::PageStrategy.
Update the contents of the passed in SceneNode to reflect the debug display of a given page.
The PageStrategy is to have complete control of the contents of this SceneNode, it must not be altered / added to by others.
Implements Ogre::PageStrategy.
|
overridevirtual |
|
inline |
|
inlinevirtual |
|
pure virtual |
Load this data from a stream (returns true if successful)
Implemented in Ogre::Grid2DPageStrategyData, and Ogre::Grid3DPageStrategyData.
|
pure virtual |
Save this data to a stream.
Implemented in Ogre::Grid2DPageStrategyData, and Ogre::Grid3DPageStrategyData.
|
inline |
|
inlinevirtual |
|
inline |
|
inline |
|
inlinevirtual |
Called when the frame starts.
|
inlinevirtual |
Called when the frame ends.
|
inlinevirtual |
Called when a camera is used for any kind of rendering.
This is probably the primary way in which the strategy will request new pages.
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. |
section |
Reimplemented in Ogre::Grid2DPageStrategy, and Ogre::Grid3DPageStrategy.
|
pure virtual |
Create a PageStrategyData instance containing the data specific to this PageStrategy.
Implemented in Ogre::Grid2DPageStrategy, and Ogre::Grid3DPageStrategy.
References OGRE_NODISCARD.
|
pure virtual |
Destroy a PageStrategyData instance containing the data specific to this PageStrategy.
Implemented in Ogre::Grid2DPageStrategy, and Ogre::Grid3DPageStrategy.
References destroyData().
Referenced by destroyData().
Update the contents of the passed in SceneNode to reflect the debug display of a given page.
The PageStrategy is to have complete control of the contents of this SceneNode, it must not be altered / added to by others.
Implemented in Ogre::Grid2DPageStrategy, and Ogre::Grid3DPageStrategy.
References updateDebugDisplay().
Referenced by updateDebugDisplay().
|
pure virtual |
Get the page ID for a given world position.
Implemented in Ogre::Grid2DPageStrategy, and Ogre::Grid3DPageStrategy.
References getPageID().
Referenced by getPageID().
Ogre::SimplePageContentCollection::SimplePageContentCollection | ( | PageContentCollectionFactory * | creator | ) |
Ogre::SimplePageContentCollection::~SimplePageContentCollection | ( | ) |
|
virtual |
Create a new PageContent within this collection.
typeName | The name of the type of content (see PageManager::getContentFactories) |
|
virtual |
Destroy a PageContent within this page.
This is equivalent to calling detachContent and PageManager::destroyContent.
|
inlinevirtual |
Get const access to the list of content.
|
overridevirtual |
Save the collection to a stream.
Implements Ogre::PageContentCollection.
|
overridevirtual |
Called when the frame starts.
Implements Ogre::PageContentCollection.
|
overridevirtual |
Called when the frame ends.
Implements Ogre::PageContentCollection.
|
overridevirtual |
Notify a section of the current camera.
Implements Ogre::PageContentCollection.
|
overridevirtual |
Prepare data - may be called in the background.
Implements Ogre::PageContentCollection.
|
overridevirtual |
Load - will be called in main thread.
Implements Ogre::PageContentCollection.
|
overridevirtual |
Unload - will be called in main thread.
Implements Ogre::PageContentCollection.
|
overridevirtual |
Unprepare data - may be called in the background.
Implements Ogre::PageContentCollection.
|
inline |
|
inline |
|
inlineoverridevirtual |
Implements Ogre::PageContentCollectionFactory.
References FACTORY_NAME.
|
inlineoverridevirtual |
Implements Ogre::PageContentCollectionFactory.
References OGRE_NODISCARD.
|
inlineoverridevirtual |
Implements Ogre::PageContentCollectionFactory.
|
static |
|
static |
|
static |
|
static |