CEL

Public API Reference

iCelHNavStructBuilder Struct Reference

Hierarchical navigation struct creator. More...

#include <tools/celhpf.h>

Inheritance diagram for iCelHNavStructBuilder:

List of all members.

Public Member Functions

virtual iCelHNavStructBuildHNavStruct ()=0
 Build a hierarchical navigation structure using the current configurations.
virtual const iCelNavMeshParamsGetNavMeshParams () const =0
 Get an object representation of the navigation mesh parameters.
virtual iCelHNavStructLoadHNavStruct (iVFS *vfs, const char *directory)=0
 Load a hierarchical navigation structure from a file.
virtual void SetNavMeshParams (const iCelNavMeshParams *parameters)=0
 Set navigation mesh parameters.
virtual bool SetSectors (csList< iSector * > sectorList)=0
 Set the Sectors used to build the navigation structure.

Detailed Description

Hierarchical navigation struct creator.

Definition at line 168 of file celhpf.h.


Member Function Documentation

virtual iCelHNavStruct* iCelHNavStructBuilder::BuildHNavStruct (  )  [pure virtual]

Build a hierarchical navigation structure using the current configurations.

Returns:
Pointer to the navigation mesh, or 0 if something went wrong.
virtual const iCelNavMeshParams* iCelHNavStructBuilder::GetNavMeshParams (  )  const [pure virtual]

Get an object representation of the navigation mesh parameters.

Returns:
Pointer to navigation mesh parameters object.
virtual iCelHNavStruct* iCelHNavStructBuilder::LoadHNavStruct ( iVFS vfs,
const char *  directory 
) [pure virtual]

Load a hierarchical navigation structure from a file.

Parameters:
vfs Pointer to the virtual file system. The file will be loaded from the current directory of this file system.
directory Directory name (vfs path).
Returns:
Pointer to the navigation mesh, or 0 if something went wrong.
virtual void iCelHNavStructBuilder::SetNavMeshParams ( const iCelNavMeshParams parameters  )  [pure virtual]

Set navigation mesh parameters.

Remarks:
Should be called before iCelHNavStructBuilder::SetSectors().
virtual bool iCelHNavStructBuilder::SetSectors ( csList< iSector * >  sectorList  )  [pure virtual]

Set the Sectors used to build the navigation structure.

Parameters:
sectorList List containing the sectors for which navmeshes will be built.
Returns:
True in case everything went right and false otherwise.
Remarks:
Even in case of a false return, the old sector information is lost. You should call iCelHNavStructBuilder::SetNavMeshParams() before this method.

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

Generated for CEL: Crystal Entity Layer 2.0 by doxygen 1.6.1