navDataTag.h File Reference

Go to the source code of this file.

Classes
class	DtNavTag
class	DtNavTagExt

Functions
const unsigned int DT_DLL_vrfNavigation	semanticDataFromString (const DtString &s)
DtString DT_DLL_vrfNavigation	stringFromNavTag (const DtNavTag &navTag)
DT_DLL_vrfNavigation std::ostream &	operator<< (std::ostream &, const DtNavTag &)

Variables
Tag type indicators
These values are used as the first value in a nav tag array to differentiate between tag types and how the rest of the nav tag should be interpreted. For historical reasons, some values are used more than once. In these cases the size of the nav tag can be used to differentiate.
const int	DtNavDataTagAny = -1
const int	DtNavDataTagTransitionPoint = 1
const int	DtNavDataTagCoverPoint = 2
const unsigned int	DtNavDataTagTypeNull = 0
const unsigned int	DtNavDataTagTypePointOfInterest = 1
const unsigned int	DtNavDataTagTypeSoilType = 2
const unsigned int	DtNavDataTagTypeSemanticInfo = 3
Semantic tags
These values are used in the third value of a semantic information nav tag.
const unsigned int	DtNavDataTagSemanticUndefined = 0
const unsigned int	DtNavDataTagSemanticNoGo = 1
const unsigned int	DtNavDataTagSemanticRoad = 2
const unsigned int	DtNavDataTagSemanticPedestrianPath = 3
const unsigned int	DtNavDataTagSemanticCrosswalk = 4
const unsigned int	DtNavDataTagSemanticNoGoExclusive = 5
const unsigned int	DtNavDataTagSemanticDoor = 6
const unsigned int	DtNavDataTagSemanticLadder = 7
const unsigned int	DtNavDataTagSemanticCrawlRoute = 8
const unsigned int	DtNavDataTagSemanticGenericNavEdge = 9
const unsigned int	DtNavDataTagSemanticLadderEntryExit = 10
Nav tag ID ranges
Tag volumes may be optionally assigned unique IDs. This is required in specific cases to refer to specific tag volumes in code, but is often not necessary. Half of the permissible IDs are reserved for nav generation and half are reserved for dynamically added tag volumes.
const unsigned int	DtInvalidNavTagId = 0x0
const unsigned int	DtMinGeneratedNavTagId = 0x1
const unsigned int	DtMaxGeneratedNavTagId = 0x7fffffff
const unsigned int	DtMinDynamicNavTagId = 0x80000000
const unsigned int	DtMaxDynamicNavTagId = 0xffffffff

Function Documentation

const unsigned int DT_DLL_vrfNavigation semanticDataFromString

(

const DtString &

s

)

Checks for various semantic tags in the string and returns a semantic tag value if found. If the string can be directly converted to an integer, this integer is returned. Returns DtNavDataTagSemanticUndefined if neither of the above conditions are met.

DtString DT_DLL_vrfNavigation stringFromNavTag

(

const DtNavTag &

navTag

)

Converts a DtNavTag to a string for debug output.

DT_DLL_vrfNavigation std::ostream& operator<<	(	std::ostream &	,
		const DtNavTag &
	)

Outputs a DtNavTag to an output stream.

Variable Documentation

const int DtNavDataTagAny = -1

Tag for a nav vertex that indicates a transition point out of a nav area. The nav tag size will be 1 for transition points.

const int DtNavDataTagTransitionPoint = 1

Tag for a nav vertex that indicates a transition point out of a nav area. The nav tag size will be 1 for transition points.

const int DtNavDataTagCoverPoint = 2

Tag for a nav vertex that indicates point were an entity can find cover from a threat. The nav tag size will be 2 for cover points. Cover points are only used for nav graph vertices.

const unsigned int DtNavDataTagTypeNull = 0

Tag for a nav vertex that indicates a transition point out of a nav area. The nav tag size will be 1 for transition points.

const unsigned int DtNavDataTagTypePointOfInterest = 1

A nav tag that indicates a point of interest. Not often used.

const unsigned int DtNavDataTagTypeSoilType = 2

A nav tag that specifies the soil type of the terrain in this location. The nav tag size will be 2 for soil type. The second value will be the encoded soil type. Soil type is only used for tagging the nav mesh.

const unsigned int DtNavDataTagTypeSemanticInfo = 3

A nav tag that specifies semantic information. The nav tag size will be 3 for semantic info. The second value is always 100, and the third is the semantic tag. Possible values for the semantic tag are listed below.

const unsigned int DtNavDataTagSemanticUndefined = 0

const unsigned int DtNavDataTagSemanticNoGo = 1

const unsigned int DtNavDataTagSemanticRoad = 2

const unsigned int DtNavDataTagSemanticPedestrianPath = 3

const unsigned int DtNavDataTagSemanticCrosswalk = 4

const unsigned int DtNavDataTagSemanticNoGoExclusive = 5

const unsigned int DtNavDataTagSemanticDoor = 6

const unsigned int DtNavDataTagSemanticLadder = 7

const unsigned int DtNavDataTagSemanticCrawlRoute = 8

const unsigned int DtNavDataTagSemanticGenericNavEdge = 9

const unsigned int DtNavDataTagSemanticLadderEntryExit = 10

const unsigned int DtInvalidNavTagId = 0x0

const unsigned int DtMinGeneratedNavTagId = 0x1

const unsigned int DtMaxGeneratedNavTagId = 0x7fffffff

const unsigned int DtMinDynamicNavTagId = 0x80000000

const unsigned int DtMaxDynamicNavTagId = 0xffffffff