dtNavMeshCreateParams

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

Windows
MacOS
Linux

References

Module

Navmesh

Header

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

Include

#include "Detour/DetourNavMeshBuilder.h"

Syntax

struct dtNavMeshCreateParams

Remarks

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

This section contains detailed documentation for members that don't have a source file. It reduces clutter in the main section of the header.

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](API\Runtime\Navmesh\Detour\dtNavMeshCreateParams\cs) and [ch](API\Runtime\Navmesh\Detour\dtNavMeshCreateParams\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.

Variables

Name Description

Public variable

float[3]

 

bmax

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

Public variable

float[3]

 

bmin

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

Public variable

bool

 

buildBvTree

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

Public variable

float

 

ch

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

Public variable

unsigned short

 

clusterCount

Number of unique clusters.

Public variable

float

 

cs

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

Public variable

const unsigned ...

 

detailMeshes

The height detail sub-mesh data. [Size: 4 * [polyCount](API\Runtime\Navmesh\Detour\dtNavMeshCreateParams\polyCount)].

Public variable

int

 

detailTriCount

The number of triangles in the detail mesh.

Public variable

const unsigned ...

 

detailTris

The detail mesh triangles. [Size: 4 * [detailTriCount](API\Runtime\Navmesh\Detour\dtNavMeshCreateParams\detailTriCount)].

Public variable

const float ...

 

detailVerts

The detail mesh vertices. [Size: 3 * [detailVertsCount](API\Runtime\Navmesh\Detour\dtNavMeshCreateParams\detailVertsCount)] [Unit: wu].

Public variable

int

 

detailVertsCount

The number of vertices in the detail mesh.

Public variable

int

 

dynamicAreaCount

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

Public variable

const dtDynamic...

 

dynamicAreas

Dynamic Area data. [Size: [dynamicAreaCount](API\Runtime\Navmesh\Detour\dtNavMeshCreateParams\dynamicAreaCount)] [Unit: wu].

Public variable

int

 

nvp

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

Public variable

int

 

offMeshConCount

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

Public variable

const dtOffMesh...

 

offMeshCons

Off-mesh connection data. [Size: [offMeshConCount](API\Runtime\Navmesh\Detour\dtNavMeshCreateParams\offMeshConCount)] [Unit: wu].

Public variable

const unsigned ...

 

polyAreas

The user defined area ids assigned to each polygon. [Size: [polyCount](API\Runtime\Navmesh\Detour\dtNavMeshCreateParams\polyCount)].

Public variable

unsigned short ...

 

polyClusters

Cluster Id for each polygon [Size: [polyCount](API\Runtime\Navmesh\Detour\dtNavMeshCreateParams\polyCount)].

Public variable

int

 

polyCount

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

Public variable

const unsigned ...

 

polyFlags

The user defined flags assigned to each polygon. [Size: [polyCount](API\Runtime\Navmesh\Detour\dtNavMeshCreateParams\polyCount)].

Public variable

const unsigned ...

 

polys

The polygon data. [Size: [polyCount](API\Runtime\Navmesh\Detour\dtNavMeshCreateParams\polyCount) * 2 * [nvp](API\Runtime\Navmesh\Detour\dtNavMeshCreateParams\nvp)].

Public variable

int

 

tileLayer

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

Public variable

int

 

tileX

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

Public variable

int

 

tileY

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

Public variable

unsigned int

 

userId

The user defined id of the tile.

Public variable

int

 

vertCount

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

Public variable

const unsigned ...

 

verts

The polygon mesh vertices. [(x, y, z) * [vertCount](API\Runtime\Navmesh\Detour\dtNavMeshCreateParams\vertCount)] [Unit: vx].

Public variable

float

 

walkableClimb

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

Public variable

float

 

walkableHeight

The agent height. [Unit: wu].

Public variable

float

 

walkableRadius

The agent radius. [Unit: wu].

See Also

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss