iCelNavMesh Struct Reference

Polygon mesh representing the navigable areas of a Sector. More...

#include <tools/celnavmesh.h>

Inheritance diagram for iCelNavMesh:

List of all members.

Public Member Functions
virtual csList < csSimpleRenderMesh > *	GetAgentDebugMeshes (const csVector3 &pos) const =0
	Render proxy agent.
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 csBox3	GetBoundingBox () const =0
	Get navigation mesh bounding box.
virtual csList < csSimpleRenderMesh > *	GetDebugMeshes () const =0
	Render navigation mesh.
virtual iCelNavMeshParams *	GetParameters () const =0
	Get navigation mesh parameters.
virtual iSector *	GetSector () const =0
	Get navigation mesh sector.
virtual bool	SaveToFile (iFile *file) const =0
	Save to file.
virtual void	SetSector (iSector *sector)=0
	Set navigation mesh sector.
virtual iCelNavMeshPath *	ShortestPath (const csVector3 &from, const csVector3 &goal, int maxPathSize=32)=0
	Find the shortest path between two points.
virtual bool	Update (const csBox3 &boundingBox)=0
	Update the tiles of the navigation mesh that intersect with an axis aligned bounding box.
virtual bool	Update (const csOBB &boundingBox)=0
	Update the tiles of the navigation mesh that intersect with an oriented bounding box.

---

Detailed Description

Polygon mesh representing the navigable areas of a Sector.

Definition at line 195 of file celnavmesh.h.

---

Member Function Documentation

virtual csList<csSimpleRenderMesh>* iCelNavMesh::GetAgentDebugMeshes

(

const csVector3 &

pos

)

const [pure virtual]

Render proxy agent.

Remarks:

The user is responsible for freeing the returned pointer.

virtual csList<csSimpleRenderMesh>* iCelNavMesh::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 csBox3 iCelNavMesh::GetBoundingBox

(

)

const [pure virtual]

Get navigation mesh bounding box.

virtual csList<csSimpleRenderMesh>* iCelNavMesh::GetDebugMeshes

(

)

const [pure virtual]

Render navigation mesh.

Remarks:

The user is responsible for freeing the returned pointer.

virtual iCelNavMeshParams* iCelNavMesh::GetParameters

(

)

const [pure virtual]

Get navigation mesh parameters.

virtual iSector* iCelNavMesh::GetSector

(

)

const [pure virtual]

Get navigation mesh sector.

virtual bool iCelNavMesh::SaveToFile

(

iFile *

file

)

const [pure virtual]

Save to file.

virtual void iCelNavMesh::SetSector

(

iSector *

sector

)

[pure virtual]

Set navigation mesh sector.

virtual iCelNavMeshPath* iCelNavMesh::ShortestPath	(	const csVector3 &	from,
		const csVector3 &	goal,
		int	maxPathSize = 32
	)		[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.

virtual bool iCelNavMesh::Update

(

const csBox3 &

boundingBox

)

[pure virtual]

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

Parameters:

boundingBox

Bounding box representing the area to be updated.

Returns:

True in case everything went right and false otherwise.

virtual bool iCelNavMesh::Update

(

const csOBB &

boundingBox

)

[pure virtual]

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

Parameters:

boundingBox

Bounding box representing the area to be updated.

Returns:

True in case everything went right and false otherwise.

---

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

• tools/celnavmesh.h