UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
DetourTileCacheBuilder.h File Reference

Go to the source code of this file.

Classes

struct  dtTileCacheLayerHeader
 
struct  dtTileCacheLayer
 
struct  dtTileCacheContour
 
struct  dtTileCacheContourSet
 
struct  dtTileCachePolyMesh
 
struct  dtTileCachePolyMeshDetail
 
struct  dtTileCacheDistanceField
 
class  dtTileCacheLogContext
 
struct  dtTileCacheAlloc
 
struct  dtTileCacheCompressor
 
class  dtFixedArray< T >
 

Functions

int getDirOffsetX (int dir)
 
int getDirOffsetY (int dir)
 
NAVMESH_API dtStatus dtBuildTileCacheLayer (dtTileCacheCompressor *comp, dtTileCacheLayerHeader *header, const unsigned short *heights, const unsigned char *areas, const unsigned char *cons, unsigned char **outData, int *outDataSize)
 
NAVMESH_API void dtFreeTileCacheLayer (dtTileCacheAlloc *alloc, dtTileCacheLayer *layer)
 
NAVMESH_API dtStatus dtDecompressTileCacheLayer (dtTileCacheAlloc *alloc, dtTileCacheCompressor *comp, const unsigned char *compressed, const int compressedSize, dtTileCacheLayer **layerOut)
 
NAVMESH_API dtTileCacheContourSetdtAllocTileCacheContourSet (dtTileCacheAlloc *alloc)
 
NAVMESH_API void dtFreeTileCacheContourSet (dtTileCacheAlloc *alloc, dtTileCacheContourSet *cset)
 
NAVMESH_API dtTileCachePolyMeshdtAllocTileCachePolyMesh (dtTileCacheAlloc *alloc)
 
NAVMESH_API void dtFreeTileCachePolyMesh (dtTileCacheAlloc *alloc, dtTileCachePolyMesh *lmesh)
 
NAVMESH_API dtTileCachePolyMeshDetaildtAllocTileCachePolyMeshDetail (dtTileCacheAlloc *alloc)
 
NAVMESH_API void dtFreeTileCachePolyMeshDetail (dtTileCacheAlloc *alloc, dtTileCachePolyMeshDetail *dmesh)
 
NAVMESH_API dtTileCacheDistanceFielddtAllocTileCacheDistanceField (dtTileCacheAlloc *alloc)
 
NAVMESH_API void dtFreeTileCacheDistanceField (dtTileCacheAlloc *alloc, dtTileCacheDistanceField *dfield)
 
NAVMESH_API dtStatus dtMarkCylinderArea (dtTileCacheLayer &layer, const dtReal *orig, const dtReal cs, const dtReal ch, const dtReal *pos, const dtReal radius, const dtReal height, const unsigned char areaId)
 
NAVMESH_API dtStatus dtMarkBoxArea (dtTileCacheLayer &layer, const dtReal *orig, const dtReal cs, const dtReal ch, const dtReal *pos, const dtReal *extent, const unsigned char areaId)
 
NAVMESH_API dtStatus dtMarkConvexArea (dtTileCacheLayer &layer, const dtReal *orig, const dtReal cs, const dtReal ch, const dtReal *verts, const int nverts, const dtReal hmin, const dtReal hmax, const unsigned char areaId)
 
NAVMESH_API dtStatus dtReplaceCylinderArea (dtTileCacheLayer &layer, const dtReal *orig, const dtReal cs, const dtReal ch, const dtReal *pos, const dtReal radius, const dtReal height, const unsigned char areaId, const unsigned char filterAreaId)
 
NAVMESH_API dtStatus dtReplaceBoxArea (dtTileCacheLayer &layer, const dtReal *orig, const dtReal cs, const dtReal ch, const dtReal *pos, const dtReal *extent, const unsigned char areaId, const unsigned char filterAreaId)
 
NAVMESH_API dtStatus dtReplaceConvexArea (dtTileCacheLayer &layer, const dtReal *orig, const dtReal cs, const dtReal ch, const dtReal *verts, const int nverts, const dtReal hmin, const dtReal hmax, const unsigned char areaId, const unsigned char filterAreaId)
 
NAVMESH_API dtStatus dtReplaceArea (dtTileCacheLayer &layer, const unsigned char areaId, const unsigned char filterAreaId)
 
NAVMESH_API dtStatus dtBuildTileCacheDistanceField (dtTileCacheAlloc *alloc, dtTileCacheLayer &layer, dtTileCacheDistanceField &dfield)
 
NAVMESH_API dtStatus dtBuildTileCacheRegions (dtTileCacheAlloc *alloc, const int minRegionArea, const int mergeRegionArea, dtTileCacheLayer &layer, dtTileCacheDistanceField dfield)
 
NAVMESH_API dtStatus dtBuildTileCacheRegionsMonotone (dtTileCacheAlloc *alloc, const int minRegionArea, const int mergeRegionArea, dtTileCacheLayer &layer)
 
NAVMESH_API dtStatus dtBuildTileCacheRegionsChunky (dtTileCacheAlloc *alloc, const int minRegionArea, const int mergeRegionArea, dtTileCacheLayer &layer, int regionChunkSize)
 
NAVMESH_API dtStatus dtBuildTileCacheContours (dtTileCacheAlloc *alloc, dtTileCacheLayer &layer, const int walkableClimb, const dtReal maxError, const dtReal simplificationElevationRatio, const dtReal cs, const dtReal ch, dtTileCacheContourSet &lcset, const bool skipContourSimplification=false)
 
NAVMESH_API dtStatus dtBuildTileCachePolyMesh (dtTileCacheAlloc *alloc, dtTileCacheLogContext *ctx, dtTileCacheContourSet &lcset, dtTileCachePolyMesh &mesh, const int walkableClimb)
 
NAVMESH_API dtStatus dtBuildTileCachePolyMeshDetail (dtTileCacheAlloc *alloc, const dtReal cs, const dtReal ch, const dtReal sampleDist, const dtReal sampleMaxError, dtTileCacheLayer &layer, dtTileCachePolyMesh &lmesh, dtTileCachePolyMeshDetail &dmesh)
 
NAVMESH_API bool dtTileCacheHeaderSwapEndian (unsigned char *data, const int dataSize)
 

Function Documentation

◆ dtAllocTileCacheContourSet()

NAVMESH_API dtTileCacheContourSet * dtAllocTileCacheContourSet ( dtTileCacheAlloc alloc)

◆ dtAllocTileCacheDistanceField()

NAVMESH_API dtTileCacheDistanceField * dtAllocTileCacheDistanceField ( dtTileCacheAlloc alloc)

◆ dtAllocTileCachePolyMesh()

NAVMESH_API dtTileCachePolyMesh * dtAllocTileCachePolyMesh ( dtTileCacheAlloc alloc)

◆ dtAllocTileCachePolyMeshDetail()

NAVMESH_API dtTileCachePolyMeshDetail * dtAllocTileCachePolyMeshDetail ( dtTileCacheAlloc alloc)

◆ dtBuildTileCacheContours()

NAVMESH_API dtStatus dtBuildTileCacheContours ( dtTileCacheAlloc alloc,
dtTileCacheLayer layer,
const int  walkableClimb,
const dtReal  maxError,
const dtReal  simplificationElevationRatio,
const dtReal  cs,
const dtReal  ch,
dtTileCacheContourSet lcset,
const bool  skipContourSimplification = false 
)

◆ dtBuildTileCacheDistanceField()

NAVMESH_API dtStatus dtBuildTileCacheDistanceField ( dtTileCacheAlloc alloc,
dtTileCacheLayer layer,
dtTileCacheDistanceField dfield 
)

◆ dtBuildTileCacheLayer()

NAVMESH_API dtStatus dtBuildTileCacheLayer ( dtTileCacheCompressor comp,
dtTileCacheLayerHeader header,
const unsigned short heights,
const unsigned char areas,
const unsigned char cons,
unsigned char **  outData,
int *  outDataSize 
)

◆ dtBuildTileCachePolyMesh()

NAVMESH_API dtStatus dtBuildTileCachePolyMesh ( dtTileCacheAlloc alloc,
dtTileCacheLogContext ctx,
dtTileCacheContourSet lcset,
dtTileCachePolyMesh mesh,
const int  walkableClimb 
)

◆ dtBuildTileCachePolyMeshDetail()

NAVMESH_API dtStatus dtBuildTileCachePolyMeshDetail ( dtTileCacheAlloc alloc,
const dtReal  cs,
const dtReal  ch,
const dtReal  sampleDist,
const dtReal  sampleMaxError,
dtTileCacheLayer layer,
dtTileCachePolyMesh lmesh,
dtTileCachePolyMeshDetail dmesh 
)

◆ dtBuildTileCacheRegions()

NAVMESH_API dtStatus dtBuildTileCacheRegions ( dtTileCacheAlloc alloc,
const int  minRegionArea,
const int  mergeRegionArea,
dtTileCacheLayer layer,
dtTileCacheDistanceField  dfield 
)

◆ dtBuildTileCacheRegionsChunky()

NAVMESH_API dtStatus dtBuildTileCacheRegionsChunky ( dtTileCacheAlloc alloc,
const int  minRegionArea,
const int  mergeRegionArea,
dtTileCacheLayer layer,
int  regionChunkSize 
)

◆ dtBuildTileCacheRegionsMonotone()

NAVMESH_API dtStatus dtBuildTileCacheRegionsMonotone ( dtTileCacheAlloc alloc,
const int  minRegionArea,
const int  mergeRegionArea,
dtTileCacheLayer layer 
)

◆ dtDecompressTileCacheLayer()

NAVMESH_API dtStatus dtDecompressTileCacheLayer ( dtTileCacheAlloc alloc,
dtTileCacheCompressor comp,
const unsigned char compressed,
const int  compressedSize,
dtTileCacheLayer **  layerOut 
)

◆ dtFreeTileCacheContourSet()

NAVMESH_API void dtFreeTileCacheContourSet ( dtTileCacheAlloc alloc,
dtTileCacheContourSet cset 
)

◆ dtFreeTileCacheDistanceField()

NAVMESH_API void dtFreeTileCacheDistanceField ( dtTileCacheAlloc alloc,
dtTileCacheDistanceField dfield 
)

◆ dtFreeTileCacheLayer()

NAVMESH_API void dtFreeTileCacheLayer ( dtTileCacheAlloc alloc,
dtTileCacheLayer layer 
)

◆ dtFreeTileCachePolyMesh()

NAVMESH_API void dtFreeTileCachePolyMesh ( dtTileCacheAlloc alloc,
dtTileCachePolyMesh lmesh 
)

◆ dtFreeTileCachePolyMeshDetail()

NAVMESH_API void dtFreeTileCachePolyMeshDetail ( dtTileCacheAlloc alloc,
dtTileCachePolyMeshDetail dmesh 
)

◆ dtMarkBoxArea()

NAVMESH_API dtStatus dtMarkBoxArea ( dtTileCacheLayer layer,
const dtReal orig,
const dtReal  cs,
const dtReal  ch,
const dtReal pos,
const dtReal extent,
const unsigned char  areaId 
)

◆ dtMarkConvexArea()

NAVMESH_API dtStatus dtMarkConvexArea ( dtTileCacheLayer layer,
const dtReal orig,
const dtReal  cs,
const dtReal  ch,
const dtReal verts,
const int  nverts,
const dtReal  hmin,
const dtReal  hmax,
const unsigned char  areaId 
)

◆ dtMarkCylinderArea()

NAVMESH_API dtStatus dtMarkCylinderArea ( dtTileCacheLayer layer,
const dtReal orig,
const dtReal  cs,
const dtReal  ch,
const dtReal pos,
const dtReal  radius,
const dtReal  height,
const unsigned char  areaId 
)

◆ dtReplaceArea()

NAVMESH_API dtStatus dtReplaceArea ( dtTileCacheLayer layer,
const unsigned char  areaId,
const unsigned char  filterAreaId 
)

◆ dtReplaceBoxArea()

NAVMESH_API dtStatus dtReplaceBoxArea ( dtTileCacheLayer layer,
const dtReal orig,
const dtReal  cs,
const dtReal  ch,
const dtReal pos,
const dtReal extent,
const unsigned char  areaId,
const unsigned char  filterAreaId 
)

◆ dtReplaceConvexArea()

NAVMESH_API dtStatus dtReplaceConvexArea ( dtTileCacheLayer layer,
const dtReal orig,
const dtReal  cs,
const dtReal  ch,
const dtReal verts,
const int  nverts,
const dtReal  hmin,
const dtReal  hmax,
const unsigned char  areaId,
const unsigned char  filterAreaId 
)

◆ dtReplaceCylinderArea()

NAVMESH_API dtStatus dtReplaceCylinderArea ( dtTileCacheLayer layer,
const dtReal orig,
const dtReal  cs,
const dtReal  ch,
const dtReal pos,
const dtReal  radius,
const dtReal  height,
const unsigned char  areaId,
const unsigned char  filterAreaId 
)

◆ dtTileCacheHeaderSwapEndian()

NAVMESH_API bool dtTileCacheHeaderSwapEndian ( unsigned char data,
const int  dataSize 
)

Swaps the endianess of the compressed tile data's header (dtTileCacheLayerHeader). Tile layer data does not need endian swapping as it consist only of bytes. UE: not anymore, there are short types as well now

Parameters
[in,out]dataThe tile data array.
[in]dataSizeThe size of the data array.

◆ getDirOffsetX()

int getDirOffsetX ( int  dir)
inline

◆ getDirOffsetY()

int getDirOffsetY ( int  dir)
inline