1. Epic GamesDeveloper
  3. Detour

Detour

API > API/Runtime > API/Runtime/Navmesh

Classes

  Type Name Description
Public struct dtBVNode Bounding volume node. This structure is rarely if ever used by the end user.  
Public class dtChunkArray A simple dynamic array of integers.  
Public struct dtDynamicAreaCreateParams    
Public class dtIntArray A simple dynamic array of integers.  
Public struct dtLink Defines a link between polygons. This structure is rarely if ever used by the end user.  
Public struct dtLinkBuilderConfig    
Public struct dtLinkBuilderData    
Public struct dtMeshHeader Provides high level information related to a dtMeshTile object.  
Public struct dtMeshTile Defines a navigation mesh tile.  
Public class dtNavLinkBuilder    
Public struct dtNavLinkBuilderJumpDownConfig Configuration for generated jump down links.  
Public struct dtNavLinkBuilderJumpOverConfig Configuration for generated jump over links.  
Public class dtNavMesh A navigation mesh based on tiles of convex polygons.  
Public struct dtNavMeshCreateParams Represents the source data used to build an navigation mesh tile.  
Public struct dtNavMeshParams Configuration parameters used to define multi-tile navigation meshes.  
Public class dtNavMeshQuery Provides the ability to perform pathfinding related queries against a navigation mesh.  
Public struct dtNavMeshResParams Configuration parameters depending on navmesh resolution.  
Public struct dtNode    
Public class dtNodePool    
Public class dtNodeQueue    
Public struct dtOffMeshConnection This is an unsupported feature and has not been finished to production quality.  
Public struct dtOffMeshLinkCreateParams Copyright Epic Games, Inc.  
Public struct dtPoly Defines a polyogn within a dtMeshTile object.  
Public struct dtPolyDetail Defines the location of detail sub-mesh data within a dtMeshTile.  
Public class dtQueryFilter Defines polygon filtering and traversal costs for navigation mesh query operations.  
Public struct dtQueryFilterData [UE: moved all filter variables to struct, DO NOT mess with virtual functions here!]  
Public struct dtQueryResult    
Public struct dtQueryResultPack    
Public struct dtQuerySpecialLinkFilter By default dtQueryFilter will use virtual calls.  
Public class dtScopedDelete A simple helper class used to delete an array when it goes out of scope.  
Public struct ReadTilesHelper @UE BEGIN: helper for reading tiles  

Constants

Name Description
DT_BUFFER_TOO_SMALL  
DT_CONNECTION_INTERNAL Flags use to annotate dtLink::side with addotional data
DT_EXT_LINK A flag that indicates that an entity links to an external entity.
DT_FAILURE High level status.
DT_IN_PROGRESS  
DT_INVALID_CYCLE_PATH  
DT_INVALID_PARAM  
DT_LINK_FLAG_OFFMESH_CON  
DT_LINK_FLAG_OFFMESH_CON_BACKTRACKER  
DT_LINK_FLAG_OFFMESH_CON_BIDIR  
DT_LINK_FLAG_OFFMESH_CON_ENABLED  
DT_LINK_FLAG_SIDE_MASK  
DT_MIN_SALT_BITS Navmesh tiles' salt will have at least this much bits.
DT_NAVMESH_STATE_MAGIC A magic number used to detect the compatibility of navigation tile states.
DT_NAVMESH_STATE_VERSION A version number used to detect compatibility of navigation tile states.
DT_NAVMESH_VERSION A version number used to detect compatibility of navigation tile data.
DT_NULL_IDX  
DT_OFFMESH_CON_BIDIR A flag that indicates that an off-mesh connection can be traversed in both directions. (Is bidirectional.)
DT_OFFMESH_CON_CHEAPAREA  
DT_OFFMESH_CON_GENERATED  
DT_OFFMESH_CON_POINT  
DT_OFFMESH_CON_SEGMENT  
DT_OUT_OF_MEMORY  
DT_OUT_OF_NODES  
DT_PARTIAL_RESULT  
DT_RESOLUTION_COUNT  
DT_SALT_BASE  
DT_STATUS_DETAIL_MASK Detail information for status.
DT_SUCCESS  
DT_WRONG_VERSION Static const unsigned int DT_WRONG_MAGIC = 1 << 0; // Input data is not recognized. NOTE: UE magic removed to save memory

Typedefs

Name Description
dtAllocFunc A memory allocation function.
dtClusterRef A handle to a cluster within a navigation mesh tile.
dtFreeFunc A memory deallocation function.
dtNodeIndex  
dtReal  
dtStatsPostAddTileFunc  
dtStatsPreRemoveTileFunc  
dtStatus Copyright Epic Games, Inc.
UEType_uint64  

Enums

  Type Name Description
Public enum dtAllocHint Provides hint values on how the memory is expected to be used. Typically used by external memory allocation and tracking systems.  
Public enum dtNavLinkAction Copyright Epic Games, Inc. All Rights Reserved.  
Public enum dtNavLinkBuilderFlags    
Public enum dtNodeFlags Copyright Epic Games, Inc.  
Public enum dtPolyTypes Flags representing the type of a navigation mesh polygon.  
Public enum dtRotation @UE BEGIN  
Public enum dtStraightPathFlags Vertex flags returned by dtNavMeshQuery::findStraightPath.  
Public enum dtStraightPathOptions Options for dtNavMeshQuery::findStraightPath.  
Public enum dtTileFlags Tile flags used for various functions and fields.  

Functions

  Type Name Description
Public function T

dtAbs ( T a
)

 Returns the absolute value.
Public function int

dtAlign ( int x
)

  
Public function void *

dtAlloc ( int size,
dtAllocHint hint
)

 Allocates a memory block.
Public function void

dtAllocSetCustom ( dtAllocFunc* allocFunc,
dtFreeFunc* freeFunc
)

 Sets the base custom allocation functions to be used by Detour.
Public function double

dtAtan2 ( double x,
double y
)

  
Public function float

dtAtan2 ( float x,
float y
)

  
Public function void

dtCalcPolyCenter ( dtReal* tc,
const unsigned short* idx,
int nidx,
const dtReal* verts
)

 Derives the centroid of a convex polygon.
Public function double

dtCeil ( double x
)

  
Public function float

dtCeil ( float x
)

  
Public function dtReal

dtClamp ( dtReal v,
dtReal mn,
dtReal mx
)

  
Public function T

dtClamp ( T v,
T mn,
T mx
)

 Clamps the value to the specified range.
Public function bool

dtClosestHeightPointTriangle ( const dtReal* p,
const dtReal* a,
const dtReal* b,
const dtReal* c,
dtReal& h
)

 Derives the y-axis height of the closest point on the triangle from the specified reference point.
Public function void

dtClosestPtPointTriangle ( dtReal* closest,
const dtReal* p,
const dtReal* a,
const dtReal* b,
const dtReal* c
)

 Derives the closest point on a triangle from the specified reference point.
Public function void

dtComputeTileOffsetFromRotation ( const dtReal* position,
const dtReal* rotationCenter,
const dtReal rotationDeg,
const dtReal tileWidth,
const dtReal tileHeight,
int& deltaX,
int& deltaY
)

 Compute XY offset caused by the given rotation
Public function double

dtCos ( double x
)

  
Public function float

dtCos ( float x
)

  
Public function bool

dtDistancePtPolyEdgesSqr ( const dtReal* pt,
const dtReal* verts,
const int nverts,
dtReal* ed,
dtReal* et
)

  
Public function dtReal

dtDistancePtSegSqr ( const dtReal* pt,
const dtReal* p,
const dtReal* q
)

  
Public function dtReal

dtDistancePtSegSqr2D ( const dtReal* pt,
const dtReal* p,
const dtReal* q,
dtReal& t
)

  
Public function double

dtFloor ( double x
)

  
Public function float

dtFloor ( float x
)

  
Public function double

dtfMod ( double x,
double y
)

  
Public function float

dtfMod ( float x,
float y
)

  
Public function void

dtFree ( void* ptr,
dtAllocHint hint
)

 Deallocates a memory block.
Public function unsigned int

dtIlog2 ( unsigned int v
)

  
Public function bool

dtIntersectSegmentPoly2D ( const dtReal* p0,
const dtReal* p1,
const dtReal* verts,
int nverts,
dtReal& tmin,
dtReal& tmax,
int& segMin,
int& segMax
)

  
Public function bool

dtIntersectSegSeg2D ( const dtReal* ap,
const dtReal* aq,
const dtReal* bp,
const dtReal* bq,
dtReal& s,
dtReal& t
)

  
Public function float

dtLerp ( float a,
float b,
float t
)

  
Public function dtReal

dtMax ( dtReal a,
dtReal b
)

  
Public function T

dtMax ( T a,
T b
)

 Returns the maximum of two values.
Public function void

dtMemCpy ( void* dst,
void* src,
int size
)

  
Public function T

dtMin ( T a,
T b
)

 Returns the minimum of two values.
Public function dtReal

dtMin ( dtReal a,
dtReal b
)

  
Public function bool

dtNavMeshDataSwapEndian ( unsigned char* data,
const int dataSize
)

 Swaps endianess of the tile data.
Public function bool

dtNavMeshHeaderSwapEndian ( unsigned char* data,
const int dataSize
)

 Swaps the endianess of the tile data's header (dtMeshHeader).
Public function unsigned int

dtNextPow2 ( unsigned int v
)

  
Public function int

dtOppositeTile ( int side
)

  
Public function bool

dtOverlapBounds ( const dtReal* amin,
const dtReal* amax,
const dtReal* bmin,
const dtReal* bmax
)

 Determines if two axis-aligned bounding boxes overlap.
Public function bool

dtOverlapPolyPoly2D ( const dtReal* polya,
const int npolya,
const dtReal* polyb,
const int npolyb
)

 Determines if the two convex polygons overlap on the xz-plane.
Public function bool

dtOverlapQuantBounds ( const unsigned short amin,
const unsigned short amax,
const unsigned short bmin,
const unsigned short bmax
)

 Determines if two axis-aligned bounding boxes overlap.
Public function bool

dtPointInPolygon ( const dtReal* pt,
const dtReal* verts,
const int nverts
)

 Determines if the specified point is inside the convex polygon on the xz-plane.
Public function void

dtRandomPointInConvexPoly ( const dtReal* pts,
const int npts,
dtReal* areas,
const dtReal s,
const dtReal t,
dtReal* out
)

  
Public function void

dtRotate90 ( unsigned short* dest,
const unsigned short* v,
const unsigned short* center,
const dtRotation rot
)

 Rotate vector around center position by increments of 90 degrees.
Public function void

dtRotate90 ( dtReal* dest,
const dtReal* v,
const dtReal* center,
const dtRotation rot
)

 Rotate vector around center position by increments of 90 degrees.
Public function dtRotation

dtSelectRotation ( dtReal rotationDeg
)

 Select a 90 degree increment value from an input angle in degree.
Public function double

dtSin ( double x
)

  
Public function float

dtSin ( float x
)

  
Public function T

dtSqr ( T a
)

 Returns the square of the value.
Public function double

dtSqrt ( double x
)

  
Public function float

dtSqrt ( float x
)

  
Public function void  
Public function bool

dtStatusDetail ( dtStatus status,
unsigned int detail
)

 Returns true if specific detail is set.
Public function bool Returns true of status is failure.
Public function bool Returns true of status is in progress.
Public function bool Returns true of status is success.
Public function void

dtSwap ( T& a,
T& b
)

 Swaps the values of the two parameters.
Public function void

dtSwapByte ( unsigned char* a,
unsigned char* b
)

  
Public function void

dtSwapEndian ( short* v
)

  
Public function void

dtSwapEndian ( unsigned int* v
)

  
Public function void

dtSwapEndian ( int* v
)

  
Public function void

dtSwapEndian ( unsigned long long int* v
)

  
Public function void

dtSwapEndian ( long long int* v
)

  
Public function void

dtSwapEndian ( float* v
)

  
Public function void

dtSwapEndian ( double* v
)

 @UE BEGIN Adding support for LWCoords.
Public function void

dtSwapEndian ( unsigned short* v
)

  
Public function bool

dtTransformTileData ( unsigned char* data,
const int dataSize,
const int offsetX,
const int offsetY,
const dtReal tileWidth,
const dtReal tileHeight,
const dtReal rotationDeg,
const dtReal bvQuantFactor
)

 @UE BEGIN Offset and rotate around center the data in the tile
Public function dtReal

dtTriArea2D ( const dtReal* a,
const dtReal* b,
const dtReal* c
)

 Derives the signed xz-plane area of the triangle ABC, or the relationship of line AB to point C.
Public function void

dtVadd ( dtReal* dest,
const dtReal* v1,
const dtReal* v2
)

 Performs a vector addition. (v1_ + v2_)
Public function void

dtVcopy ( dtReal* dest,
const dtReal* a
)

 Performs a vector copy.
Public function void

dtVcross ( dtReal* dest,
const dtReal* v1,
const dtReal* v2
)

 Derives the cross product of two vectors. (v1_ x v2_)
Public function dtReal

dtVdist ( const dtReal* v1,
const dtReal* v2
)

 Returns the distance between two points.
Public function dtReal

dtVdist2D ( const dtReal* v1,
const dtReal* v2
)

 Derives the distance between the specified points on the xz-plane.
Public function dtReal

dtVdist2DSqr ( const dtReal* v1,
const dtReal* v2
)

 Derives the square of the distance between the specified points on the xz-plane.
Public function dtReal

dtVdistSqr ( const dtReal* v1,
const dtReal* v2
)

 Returns the square of the distance between two points.
Public function dtReal

dtVdot ( const dtReal* v1,
const dtReal* v2
)

 Derives the dot product of two vectors. (v1_ . v2_)
Public function dtReal

dtVdot2D ( const dtReal* u,
const dtReal* v
)

 Derives the dot product of two vectors on the xz-plane.
Public function bool

dtVequal ( const dtReal* p0,
const dtReal* p1
)

 Performs a 'sloppy' colocation check of the specified points.
Public function bool

dtVisEqual ( const unsigned short* a,
const unsigned short* b
)

 Returns true if the vectors are the same.
Public function dtReal

dtVlen ( const dtReal* v
)

 Derives the scalar length of the vector.
Public function dtReal

dtVlenSqr ( const dtReal* v
)

 Derives the square of the scalar length of the vector. (len * len)
Public function void

dtVlerp ( dtReal* dest,
const dtReal* v1,
const dtReal* v2,
const dtReal t
)

 Performs a linear interpolation between two vectors. (v1_ toward v2_)
Public function void

dtVmad ( dtReal* dest,
const dtReal* v1,
const dtReal* v2,
const dtReal s
)

 Performs a scaled vector addition. (v1_ + (v2 * `s))
Public function void

dtVmax ( dtReal* mx,
const dtReal* v
)

 Selects the maximum value of each element from the specified vectors.
Public function void

dtVmin ( dtReal* mn,
const dtReal* v
)

 Selects the minimum value of each element from the specified vectors.
Public function void Normalizes the vector.
Public function dtReal

dtVperp2D ( const dtReal* u,
const dtReal* v
)

 Derives the xz-plane 2D perp product of the two vectors.
Public function void

dtVRot90 ( dtReal* dest,
const dtReal* v,
const dtRotation rot
)

 Rotate by 90 degree increments.
Public function void

dtVRot90 ( unsigned short* dest,
const unsigned short* v,
const dtRotation rot
)

 Rotate by 90 degree increments.
Public function void

dtVscale ( dtReal* dest,
const dtReal* v,
const dtReal t
)

 Scales the vector by the specified value. (v_ * t_)
Public function void

dtVset ( dtReal* dest,
const dtReal x,
const dtReal y,
const dtReal z
)

 Sets the vector elements to the specified values.
Public function void

dtVsub ( dtReal* dest,
const dtReal* v1,
const dtReal* v2
)

 Performs a vector subtraction. (v1_ - v2_)

Variables

  Type Name Description
Public variable const unsigned int DT_NULL_LINK A value that indicates the entity does not link to anything.
Public variable dtReal DT_REAL_MAX  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page