iCelHNavStruct Struct Reference

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

#include <tools/celhpf.h>

Inheritance diagram for iCelHNavStruct:

[legend]

List of all members.

Public Member Functions
virtual csList < csSimpleRenderMesh > *	GetAgentDebugMeshes (const csVector3 &pos, int red, int green, int blue, int alpha) const =0
	Render proxy agent of the specified color.
virtual csList < csSimpleRenderMesh > *	GetDebugMeshes () const =0
	Render navigation structure.
virtual const iCelNavMeshParams *	GetNavMeshParams () const =0
	Get an object representation of the navigation mesh parameters.
virtual bool	SaveToFile (iVFS *vfs, const char *directory)=0
	Save this structure to a file.
virtual iCelHPath *	ShortestPath (iMapNode *from, iMapNode *goal)=0
	Find the shortest path between two points.
virtual iCelHPath *	ShortestPath (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 89 of file celhpf.h.

---

Member Function Documentation

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

Render proxy agent of the specified color.

Remarks:

The user is responsible for freeing the returned pointer.

virtual csList<csSimpleRenderMesh>* iCelHNavStruct::GetDebugMeshes

(

)

const [pure virtual]

Render navigation structure.

Remarks:

The user is responsible for freeing the returned pointer.

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 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:

• tools/celhpf.h