dtNavMeshCreateParams Struct Reference

#include <DetourNavMeshBuilder.h>

Public Attributes
Polygon Mesh Attributes
Used to create the base navigation graph. See rcPolyMesh for details related to these attributes.
const unsigned short *	verts
	The polygon mesh vertices. [(x, y, z) * vertCount] [Unit: vx].
int	vertCount
	The number vertices in the polygon mesh. [Limit: >= 3].
const unsigned short *	polys
	The polygon data. [Size: polyCount * 2 * nvp].
const unsigned short *	polyFlags
	The user defined flags assigned to each polygon. [Size: polyCount].
const unsigned char *	polyAreas
	The user defined area ids assigned to each polygon. [Size: polyCount].
int	polyCount
	Number of polygons in the mesh. [Limit: >= 1].
int	nvp
	Number maximum number of vertices per polygon. [Limit: >= 3].
Height Detail Attributes (Optional)
See rcPolyMeshDetail for details related to these attributes.
const unsigned int *	detailMeshes
	The height detail sub-mesh data. [Size: 4 * polyCount].
const dtReal *	detailVerts
	The detail mesh vertices. [Size: 3 * detailVertsCount] [Unit: wu].
int	detailVertsCount
	The number of vertices in the detail mesh.
const unsigned char *	detailTris
	The detail mesh triangles. [Size: 4 * detailTriCount].
int	detailTriCount
	The number of triangles in the detail mesh.
Off-Mesh Connections Attributes (Optional)
Used to define a custom edge within the navigation graph, an off-mesh connection is a user defined traversable connection, at least one side resides within a navigation mesh polygon.
const dtOffMeshLinkCreateParams *	offMeshCons
	Off-mesh connection data. [Size: offMeshConCount] [Unit: wu].
int	offMeshConCount
	The number of off-mesh connections. [Limit: >= 0].
Dynamic Area Attributes (Optional)
Used to define a custom dynamic obstacles from convex volumes
const dtDynamicAreaCreateParams *	dynamicAreas
	Dynamic Area data. [Size: dynamicAreaCount] [Unit: wu].
int	dynamicAreaCount
	The number of dynamic areas. [Limit: >= 0].
Tile Attributes
Note The tile grid/layer data can be left at zero if the destination is a single tile mesh.
unsigned int	userId
	The user defined id of the tile.
int	tileX
	The tile's x-grid location within the multi-tile destination mesh. (Along the x-axis.)
int	tileY
	The tile's y-grid location within the multi-tile desitation mesh. (Along the z-axis.)
int	tileLayer
	The tile's layer within the layered destination mesh. (Along the y-axis.) [Limit: >= 0].
dtReal	bmin [3]
	The minimum bounds of the tile. [(x, y, z)] [Unit: wu].
dtReal	bmax [3]
	The maximum bounds of the tile. [(x, y, z)] [Unit: wu].
General Configuration Attributes
dtReal	walkableHeight
	The agent height. [Unit: wu].
dtReal	walkableRadius
	The agent radius. [Unit: wu].
dtReal	walkableClimb
	The agent maximum traversable ledge. (Up/Down) [Unit: wu].
dtReal	cs
	The xz-plane cell size of the polygon mesh. [Limit: > 0] [Unit: wu].
dtReal	ch
	The y-axis cell height of the polygon mesh. [Limit: > 0] [Unit: wu].
unsigned char	tileResolutionLevel
	Tile resolution index //@UE.
bool	buildBvTree

Detailed Description

Represents the source data used to build an navigation mesh tile.

This structure is used to marshal data between the Recast mesh generation pipeline and Detour navigation components.

See the rcPolyMesh and rcPolyMeshDetail documentation for detailed information related to mesh structure.

Units are usually in voxels (vx) or world units (wu). The units for voxels, grid size, and cell size are all based on the values of cs and ch.

The standard navigation mesh build process is to create tile data using dtCreateNavMeshData, then add the tile to a navigation mesh using either the dtNavMesh single tile init() function or the dtNavMesh::addTile() function.

See also

dtCreateNavMeshData

Member Data Documentation

bmax

dtReal dtNavMeshCreateParams::bmax[3]

The maximum bounds of the tile. [(x, y, z)] [Unit: wu].

bmin

dtReal dtNavMeshCreateParams::bmin[3]

The minimum bounds of the tile. [(x, y, z)] [Unit: wu].

buildBvTree

bool dtNavMeshCreateParams::buildBvTree

True if a bounding volume tree should be built for the tile.

Note

The BVTree is not normally needed for layered navigation meshes.

ch

dtReal dtNavMeshCreateParams::ch

The y-axis cell height of the polygon mesh. [Limit: > 0] [Unit: wu].

cs

dtReal dtNavMeshCreateParams::cs

The xz-plane cell size of the polygon mesh. [Limit: > 0] [Unit: wu].

detailMeshes

const unsigned int* dtNavMeshCreateParams::detailMeshes

The height detail sub-mesh data. [Size: 4 * polyCount].

detailTriCount

int dtNavMeshCreateParams::detailTriCount

The number of triangles in the detail mesh.

detailTris

const unsigned char* dtNavMeshCreateParams::detailTris

The detail mesh triangles. [Size: 4 * detailTriCount].

detailVerts

const dtReal* dtNavMeshCreateParams::detailVerts

The detail mesh vertices. [Size: 3 * detailVertsCount] [Unit: wu].

detailVertsCount

int dtNavMeshCreateParams::detailVertsCount

The number of vertices in the detail mesh.

dynamicAreaCount

int dtNavMeshCreateParams::dynamicAreaCount

The number of dynamic areas. [Limit: >= 0].

dynamicAreas

const dtDynamicAreaCreateParams* dtNavMeshCreateParams::dynamicAreas

Dynamic Area data. [Size: dynamicAreaCount] [Unit: wu].

nvp

int dtNavMeshCreateParams::nvp

Number maximum number of vertices per polygon. [Limit: >= 3].

offMeshConCount

int dtNavMeshCreateParams::offMeshConCount

The number of off-mesh connections. [Limit: >= 0].

offMeshCons

const dtOffMeshLinkCreateParams* dtNavMeshCreateParams::offMeshCons

Off-mesh connection data. [Size: offMeshConCount] [Unit: wu].

polyAreas

const unsigned char* dtNavMeshCreateParams::polyAreas

The user defined area ids assigned to each polygon. [Size: polyCount].

polyCount

int dtNavMeshCreateParams::polyCount

Number of polygons in the mesh. [Limit: >= 1].

polyFlags

const unsigned short* dtNavMeshCreateParams::polyFlags

The user defined flags assigned to each polygon. [Size: polyCount].

polys

const unsigned short* dtNavMeshCreateParams::polys

The polygon data. [Size: polyCount * 2 * nvp].

tileLayer

int dtNavMeshCreateParams::tileLayer

The tile's layer within the layered destination mesh. (Along the y-axis.) [Limit: >= 0].

tileResolutionLevel

unsigned char dtNavMeshCreateParams::tileResolutionLevel

Tile resolution index //@UE.

tileX

int dtNavMeshCreateParams::tileX

The tile's x-grid location within the multi-tile destination mesh. (Along the x-axis.)

tileY

int dtNavMeshCreateParams::tileY

The tile's y-grid location within the multi-tile desitation mesh. (Along the z-axis.)

userId

unsigned int dtNavMeshCreateParams::userId

The user defined id of the tile.

vertCount

int dtNavMeshCreateParams::vertCount

The number vertices in the polygon mesh. [Limit: >= 3].

verts

const unsigned short* dtNavMeshCreateParams::verts

The polygon mesh vertices. [(x, y, z) * vertCount] [Unit: vx].

walkableClimb

dtReal dtNavMeshCreateParams::walkableClimb

The agent maximum traversable ledge. (Up/Down) [Unit: wu].

walkableHeight

dtReal dtNavMeshCreateParams::walkableHeight

The agent height. [Unit: wu].

walkableRadius

dtReal dtNavMeshCreateParams::walkableRadius

The agent radius. [Unit: wu].

---

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

• Engine/Source/Runtime/Navmesh/Public/Detour/DetourNavMeshBuilder.h