Detour

Classes
struct	AtomsUtils::dtPoly
struct	AtomsUtils::dtMeshHeader
struct	AtomsUtils::dtMeshTile
struct	AtomsUtils::dtNavMeshParams
class	AtomsUtils::dtNavMesh
struct	AtomsUtils::dtNavMeshCreateParams
class	AtomsUtils::dtQueryFilter
class	AtomsUtils::dtNavMeshQuery

Typedefs
typedef Type_uint64	AtomsUtils::dtPolyRef
typedef Type_uint64	AtomsUtils::dtTileRef

Functions
ATOMSUTILS_EXPORT dtNavMesh *	AtomsUtils::dtAllocNavMesh ()
ATOMSUTILS_EXPORT void	AtomsUtils::dtFreeNavMesh (dtNavMesh *navmesh)
ATOMSUTILS_EXPORT bool	AtomsUtils::dtCreateNavMeshData (dtNavMeshCreateParams *params, unsigned char **outData, int *outDataSize)
ATOMSUTILS_EXPORT dtNavMeshQuery *	AtomsUtils::dtAllocNavMeshQuery ()
ATOMSUTILS_EXPORT void	AtomsUtils::dtFreeNavMeshQuery (dtNavMeshQuery *query)

Detailed Description

Members in this module are used to create, manipulate, and query navigation meshes.

Note

This is a summary list of members. Use the index or search feature to find minor members.

Members in this module are wrappers around the standard math library

Typedef Documentation

dtPolyRef

typedef Type_uint64 AtomsUtils::dtPolyRef

A handle to a polygon within a navigation mesh tile.

dtTileRef

typedef Type_uint64 AtomsUtils::dtTileRef

A handle to a tile within a navigation mesh.

Function Documentation

dtAllocNavMesh()

ATOMSUTILS_EXPORT dtNavMesh* AtomsUtils::dtAllocNavMesh

(

)

Allocates a navigation mesh object using the Detour allocator.

Returns

A navigation mesh that is ready for initialization, or null on failure.

dtAllocNavMeshQuery()

ATOMSUTILS_EXPORT dtNavMeshQuery* AtomsUtils::dtAllocNavMeshQuery

(

)

Allocates a query object using the Detour allocator.

Returns

An allocated query object, or null on failure.

dtCreateNavMeshData()

ATOMSUTILS_EXPORT bool AtomsUtils::dtCreateNavMeshData	(	dtNavMeshCreateParams *	params,
		unsigned char **	outData,
		int *	outDataSize
	)

Builds navigation mesh tile data from the provided tile creation data.

Parameters

[in]	params	Tile creation data.
[out]	outData	The resulting tile data.
[out]	outDataSize	The size of the tile data array.

Returns

True if the tile data was successfully created.

dtFreeNavMesh()

ATOMSUTILS_EXPORT void AtomsUtils::dtFreeNavMesh

(

dtNavMesh *

navmesh

)

Frees the specified navigation mesh object using the Detour allocator.

Parameters

[in]

navmesh

A navigation mesh allocated using dtAllocNavMesh

dtFreeNavMeshQuery()

ATOMSUTILS_EXPORT void AtomsUtils::dtFreeNavMeshQuery

(

dtNavMeshQuery *

query

)

Frees the specified query object using the Detour allocator.

Parameters

[in]

query

A query object allocated using dtAllocNavMeshQuery