DetourNavMesh.h File Reference

#include "CoreMinimal.h"
#include "Detour/DetourAlloc.h"
#include "Detour/DetourStatus.h"
#include "DetourLargeWorldCoordinates.h"
#include "Logging/LogMacros.h"
#include <stdint.h>

Go to the source code of this file.

Classes
struct	dtPoly
struct	dtPolyDetail
	Defines the location of detail sub-mesh data within a dtMeshTile. More...
struct	dtLink
struct	dtBVNode
struct	dtOffMeshConnection
struct	dtMeshHeader
struct	dtMeshTile
struct	dtNavMeshResParams
	Configuration parameters depending on navmesh resolution. More...
struct	dtNavMeshParams
class	dtNavMesh
struct	ReadTilesHelper

Macros
#define	USE_64BIT_ADDRESS   1

Typedefs
typedef uint64_t	UEType_uint64
typedef UEType_uint64	dtPolyRef
typedef UEType_uint64	dtTileRef
typedef UEType_uint64	dtClusterRef
	A handle to a cluster within a navigation mesh tile.
typedef void()	dtStatsPostAddTileFunc(const dtMeshTile &TileAdd)
typedef void()	dtStatsPreRemoveTileFunc(const dtMeshTile &tileRemove)

Enumerations
enum	dtTileFlags { DT_TILE_FREE_DATA = 0x01 }
enum	dtStraightPathFlags { DT_STRAIGHTPATH_START = 0x01 , DT_STRAIGHTPATH_END = 0x02 , DT_STRAIGHTPATH_OFFMESH_CONNECTION = 0x04 }
	Vertex flags returned by dtNavMeshQuery::findStraightPath. More...
enum	dtStraightPathOptions { DT_STRAIGHTPATH_AREA_CROSSINGS = 0x01 , DT_STRAIGHTPATH_ALL_CROSSINGS = 0x02 }
	Options for dtNavMeshQuery::findStraightPath. More...
enum	dtPolyTypes { DT_POLYTYPE_GROUND = 0 , DT_POLYTYPE_OFFMESH_POINT = 1 }
	Flags representing the type of a navigation mesh polygon. More...

Functions
NAVMESH_API	DECLARE_LOG_CATEGORY_EXTERN (LogDetour, Log, All)
NAVMESH_API void	dtStatsSetCustom (dtStatsPostAddTileFunc *addFunc, dtStatsPreRemoveTileFunc *removeFunc)
NAVMESH_API dtNavMesh *	dtAllocNavMesh ()
NAVMESH_API void	dtFreeNavMesh (dtNavMesh *navmesh)

Variables
const unsigned int	DT_NULL_LINK = 0xffffffff
	A value that indicates the entity does not link to anything.
Tile Serialization Constants
These constants are used to detect whether a navigation tile's data and state format is compatible with the current build.

Macro Definition Documentation

USE_64BIT_ADDRESS

#define USE_64BIT_ADDRESS   1

Typedef Documentation

dtClusterRef

typedef UEType_uint64 dtClusterRef

A handle to a cluster within a navigation mesh tile.

dtStatsPostAddTileFunc

typedef void() dtStatsPostAddTileFunc(const dtMeshTile &TileAdd)

dtStatsPreRemoveTileFunc

typedef void() dtStatsPreRemoveTileFunc(const dtMeshTile &tileRemove)

UEType_uint64

typedef uint64_t UEType_uint64

Enumeration Type Documentation

dtPolyTypes

enum dtPolyTypes

Flags representing the type of a navigation mesh polygon.

Enumerator
DT_POLYTYPE_GROUND	The polygon is a standard convex polygon that is part of the surface of the mesh.
DT_POLYTYPE_OFFMESH_POINT	The polygon is an off-mesh connection consisting of two vertices.

dtStraightPathFlags

enum dtStraightPathFlags

Vertex flags returned by dtNavMeshQuery::findStraightPath.

Enumerator
DT_STRAIGHTPATH_START	The vertex is the start position in the path.
DT_STRAIGHTPATH_END	The vertex is the end position in the path.
DT_STRAIGHTPATH_OFFMESH_CONNECTION	The vertex is the start of an off-mesh connection.

dtStraightPathOptions

enum dtStraightPathOptions

Options for dtNavMeshQuery::findStraightPath.

Enumerator
DT_STRAIGHTPATH_AREA_CROSSINGS	Add a vertex at every polygon edge crossing where area changes.
DT_STRAIGHTPATH_ALL_CROSSINGS	Add a vertex at every polygon edge crossing.

dtTileFlags

enum dtTileFlags

Tile flags used for various functions and fields. For an example, see dtNavMesh::addTile().

Enumerator
DT_TILE_FREE_DATA	The navigation mesh owns the tile memory and is responsible for freeing it.

Function Documentation

DECLARE_LOG_CATEGORY_EXTERN()

NAVMESH_API DECLARE_LOG_CATEGORY_EXTERN	(	LogDetour	,
		Log	,
		All
	)

dtStatsSetCustom()

NAVMESH_API void dtStatsSetCustom	(	dtStatsPostAddTileFunc *	addFunc,
		dtStatsPreRemoveTileFunc *	removeFunc
	)

Variable Documentation

DT_NULL_LINK

const unsigned int DT_NULL_LINK = 0xffffffff

inline

A value that indicates the entity does not link to anything.