CEL

Public API Reference

iCelHNavStruct Struct Reference

Hierarchical navigation structure representing the navigable areas of a Map. More...

#include <tools/celhpf.h>

Inheritance diagram for iCelHNavStruct:

List of all members.

Public Member Functions

virtual csArray
< csSimpleRenderMesh * > * 
GetAgentDebugMeshes (const csVector3 &pos, int red, int green, int blue, int alpha)=0
 Render proxy agent of the specified color.
virtual csArray
< csSimpleRenderMesh * > * 
GetDebugMeshes (iSector *sector=0)=0
 Render navigation structure.
virtual const iCelNavMeshParamsGetNavMeshParams () const =0
 Get an object representation of the navigation mesh parameters.
virtual void ResetAgentDebugMeshes ()=0
 Clear all previous proxy agents.
virtual bool SaveToFile (iVFS *vfs, const char *directory)=0
 Save this structure to a file.
virtual iCelHPathShortestPath (iMapNode *from, iMapNode *goal)=0
 Find the shortest path between two points.
virtual iCelHPathShortestPath (const csVector3 &from, iSector *fromSector, const csVector3 &goal, iSector *goalSector)=0
 Find the shortest path between two points.
virtual bool Update (const csOBB &boundingBox, iSector *sector=0)=0
 Update the tiles of the hierarchical navigation structure that intersect with an oriented bounding box.
virtual bool Update (const csBox3 &boundingBox, iSector *sector=0)=0
 Update the tiles of the hierarchical navigation structure that intersect with an axis aligned bounding box.

Detailed Description

Hierarchical navigation structure representing the navigable areas of a Map.

Definition at line 90 of file celhpf.h.


Member Function Documentation

virtual csArray<csSimpleRenderMesh*>* iCelHNavStruct::GetAgentDebugMeshes ( const csVector3 pos,
int  red,
int  green,
int  blue,
int  alpha 
) [pure virtual]

Render proxy agent of the specified color.

Adding to any previously got since construction or reset.

virtual csArray<csSimpleRenderMesh*>* iCelHNavStruct::GetDebugMeshes ( iSector sector = 0  )  [pure virtual]

Render navigation structure.

virtual const iCelNavMeshParams* iCelHNavStruct::GetNavMeshParams (  )  const [pure virtual]

Get an object representation of the navigation mesh parameters.

Returns:
Pointer to navigation mesh parameters object.
virtual void iCelHNavStruct::ResetAgentDebugMeshes (  )  [pure virtual]

Clear all previous proxy agents.

virtual bool iCelHNavStruct::SaveToFile ( iVFS vfs,
const char *  directory 
) [pure virtual]

Save this structure to a file.

Parameters:
vfs Pointer to the virtual file system. The file will be saved the file at the current directory of this file system.
file File name.
Returns:
True in case everything went right and false otherwise.
virtual iCelHPath* iCelHNavStruct::ShortestPath ( iMapNode from,
iMapNode goal 
) [pure virtual]

Find the shortest path between two points.

Parameters:
from Origin of the path.
goal Destination of the path.
Returns:
Pointer to the shortest path between the two points, or 0 in case something went wrong.
Remarks:
The path returned by this method will be rendered useless if the originating iCelHNavStruct is destroyed.
virtual iCelHPath* iCelHNavStruct::ShortestPath ( const csVector3 from,
iSector fromSector,
const csVector3 goal,
iSector goalSector 
) [pure virtual]

Find the shortest path between two points.

Parameters:
from Origin coordinates.
fromSector Origin sector.
goal Destination coordinates.
goalSector Destination sector.
Returns:
Pointer to the shortest path between the two points, or 0 in case something went wrong.
Remarks:
The path returned by this method will be rendered useless if the originating iCelHNavStruct is destroyed.
virtual bool iCelHNavStruct::Update ( const csOBB boundingBox,
iSector sector = 0 
) [pure virtual]

Update the tiles of the hierarchical navigation structure that intersect with an oriented bounding box.

Parameters:
boundingBox Bounding box representing the area to be updated.
sector Only update tiles from this sector, if specified.
Returns:
True in case everything went right and false otherwise.
Remarks:
A sector should be specified whenever possible.
virtual bool iCelHNavStruct::Update ( const csBox3 boundingBox,
iSector sector = 0 
) [pure virtual]

Update the tiles of the hierarchical navigation structure that intersect with an axis aligned bounding box.

Parameters:
boundingBox Bounding box representing the area to be updated.
sector Only update tiles from this sector, if specified.
Returns:
True in case everything went right and false otherwise.
Remarks:
A sector should be specified whenever possible.

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

Generated for CEL: Crystal Entity Layer 2.1 by doxygen 1.6.1