iCelNavMeshBuilder Struct Reference

Navigation mesh creator. More...

#include <tools/celnavmesh.h>

Inheritance diagram for iCelNavMeshBuilder:

List of all members.

Public Member Functions
virtual const iCelNavMeshParams *	GetNavMeshParams () const =0
	Get an object representation of the navigation mesh parameters.
virtual iCelNavMesh *	LoadNavMesh (iFile *file)=0
	Load a navigation mesh from a file.
virtual void	SetNavMeshParams (const iCelNavMeshParams *parameters)=0
	Set navigation mesh parameters.
virtual bool	SetSector (iSector *sector)=0
	Set an iSector as the current working sector and loads it's triangles.
	THREADED_INTERFACE (BuildNavMesh)
	Build a navigation mesh from the triangles in a Sector, using current configuration.

---

Detailed Description

Navigation mesh creator.

Definition at line 266 of file celnavmesh.h.

---

Member Function Documentation

virtual const iCelNavMeshParams* iCelNavMeshBuilder::GetNavMeshParams

(

)

const [pure virtual]

Get an object representation of the navigation mesh parameters.

Returns:

Pointer to navigation mesh parameters object.

virtual iCelNavMesh* iCelNavMeshBuilder::LoadNavMesh

(

iFile *

file

)

[pure virtual]

Load a navigation mesh from a file.

Parameters:

file	Pointer to file in the virtual filesystem.

Returns:

Pointer to the navigation mesh, or 0 if something went wrong.

virtual void iCelNavMeshBuilder::SetNavMeshParams

(

const iCelNavMeshParams *

parameters

)

[pure virtual]

Set navigation mesh parameters.

Remarks:

Should be called before iCelNavMeshBuilder::SetSector().

virtual bool iCelNavMeshBuilder::SetSector

(

iSector *

sector

)

[pure virtual]

Set an iSector as the current working sector and loads it's triangles.

Parameters:

sector

Pointer to the new iSector.

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 iCelNavMeshBuilder::SetNavMeshParams() before this method.

iCelNavMeshBuilder::THREADED_INTERFACE

(

BuildNavMesh

)

Build a navigation mesh from the triangles in a Sector, using current configuration.

Returns:

Pointer to the navigation mesh, or 0 if something went wrong.

Remarks:

A valid iSector must have been set using iCelNavMeshBuilder::SetSector() before calling this method.

---

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

• tools/celnavmesh.h