dtOffMeshConnection Struct Reference

#include <DetourNavMesh.h>

Public Member Functions
void	setFlags (unsigned char conTypeFlags)
	Sets link flags.
bool	getBiDirectional () const
	Gets the link direction.
bool	getSnapToCheapestArea () const
	Gets the link snap mode.
bool	getIsGenerated () const
	Indicates if the link was automatically generated.

Public Attributes
dtReal	pos [6]
	The endpoints of the connection. [(ax, ay, az, bx, by, bz)].
dtReal	rad
	The radius of the endpoints. [Limit: >= 0].
dtReal	height
	The snap height of endpoints (less than 0 = use step height)
unsigned long long int	userId
	The id of the offmesh connection. (User assigned when the navigation mesh is built.)
unsigned short	poly
	The polygon reference of the connection within the tile.
unsigned char	side
	End point side.
unsigned char	flags
	Link flags.

Detailed Description

Defines an navigation mesh off-mesh connection within a dtMeshTile object. An off-mesh connection is a user defined traversable connection made up to two vertices.

Member Function Documentation

getBiDirectional()

bool dtOffMeshConnection::getBiDirectional ( ) const

inline

Gets the link direction.

getIsGenerated()

bool dtOffMeshConnection::getIsGenerated ( ) const

inline

Indicates if the link was automatically generated.

getSnapToCheapestArea()

bool dtOffMeshConnection::getSnapToCheapestArea ( ) const

inline

Gets the link snap mode.

setFlags()

void dtOffMeshConnection::setFlags ( unsigned char  conTypeFlags )

inline

Sets link flags.

Member Data Documentation

flags

unsigned char dtOffMeshConnection::flags

Link flags.

height

dtReal dtOffMeshConnection::height

The snap height of endpoints (less than 0 = use step height)

poly

unsigned short dtOffMeshConnection::poly

The polygon reference of the connection within the tile.

pos

dtReal dtOffMeshConnection::pos[6]

The endpoints of the connection. [(ax, ay, az, bx, by, bz)].

For a properly built navigation mesh, vertex A will always be within the bounds of the mesh. Vertex B is not required to be within the bounds of the mesh.

rad

dtReal dtOffMeshConnection::rad

The radius of the endpoints. [Limit: >= 0].

side

unsigned char dtOffMeshConnection::side

End point side.

userId

unsigned long long int dtOffMeshConnection::userId

The id of the offmesh connection. (User assigned when the navigation mesh is built.)

---

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

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