Quantum.Navigation.PathFinder Class Reference

Navmesh TA* pathfinder class. More...

Inherits IDisposable, and Quantum.Navigation.IPathFinderData.

Public Member Functions
	PathFinder (Native.Allocator allocator, Int32 openNodesSize, Int32 rawPathSize=256, RawPathAllocationStrategy rawPathAllocationStrategy=RawPathAllocationStrategy.Fixed)
	Create a pathfinder object. More...
	PathFinder (Native.Allocator allocator, NavMesh navmesh, Int32 rawPathSize=256, RawPathAllocationStrategy rawPathAllocationStrategy=RawPathAllocationStrategy.Fixed)
	Create a pathfinder for a certain navmesh. More...
void	Dispose ()
	Dispose the pathfinder object. More...
FindPathResult	FindPath (FrameThreadSafe frame, FPVector2 start, FPVector2 end, bool automaticTargetCorrection, FP automaticTargetCorrectionRadius, NavMeshRegionMask regionMask, PathQuality quality=PathQuality.Good, NavMesh navmesh=null)
	Find path. More...
FindPathResult	FindPath (FrameThreadSafe frame, FPVector3 start, FPVector3 end, bool automaticTargetCorrection, FP automaticTargetCorrectionRadius, NavMeshRegionMask regionMask, PathQuality quality=PathQuality.Good, NavMesh navmesh=null)
	See FindPath(FrameThreadSafe, FPVector2, FPVector2, bool, FP, NavMeshRegionMask, PathQuality, NavMesh) More...
void	SetNavMesh (NavMesh navmesh)
	Bind a navmesh to a pathfinder. More...

Public Attributes
PathVertex[]	RawPath => _rawPath
	The un-funneled raw path. More...
Int32	RawPathSize => _rawPathSize
	The size of the RawPath. More...

Detailed Description

Navmesh TA* pathfinder class.

Constructor & Destructor Documentation

PathFinder() [1/2]

Quantum.Navigation.PathFinder.PathFinder ( Native.Allocator  allocator, Int32  openNodesSize, Int32  rawPathSize = 256, RawPathAllocationStrategy  rawPathAllocationStrategy = RawPathAllocationStrategy.Fixed  )

inline

Create a pathfinder object.

Parameters

allocator	Allocator
openNodesSize	The maximum number of open nodes the A* can work with (usually Navigation.Constants.PathFinderSize
rawPathSize	The raw path size
rawPathAllocationStrategy	Fail path or allocate when above rawPathSize

PathFinder() [2/2]

Quantum.Navigation.PathFinder.PathFinder ( Native.Allocator  allocator, NavMesh  navmesh, Int32  rawPathSize = 256, RawPathAllocationStrategy  rawPathAllocationStrategy = RawPathAllocationStrategy.Fixed  )

inline

Create a pathfinder for a certain navmesh.

Uses the triangle count as pathfinder size.

Parameters

allocator	Allocator
navmesh	Navmesh object
rawPathSize	The raw path size
rawPathAllocationStrategy	Fail path or allocate when above rawPathSize

Member Function Documentation

SetNavMesh()

void Quantum.Navigation.PathFinder.SetNavMesh ( NavMesh  navmesh )

inline

Bind a navmesh to a pathfinder.

Parameters

navmesh

Navmesh object

Dispose()

void Quantum.Navigation.PathFinder.Dispose ( )

inline

Dispose the pathfinder object.

FindPath() [1/2]

FindPathResult Quantum.Navigation.PathFinder.FindPath ( FrameThreadSafe  frame, FPVector2  start, FPVector2  end, bool  automaticTargetCorrection, FP  automaticTargetCorrectionRadius, NavMeshRegionMask  regionMask, PathQuality  quality = PathQuality.Good, NavMesh  navmesh = null  )

inline

Find path.

Parameters

frame	The frame object.
start	Starting position
end	Target position
automaticTargetCorrection	If the target is outside the navmesh the position will be tried to be corrected.
automaticTargetCorrectionRadius	The range of cells used to validated the target position.
regionMask	Region mask is used to check if navmesh parts are active or inactive
quality	The path quality
navmesh	The navmesh to operate on

Returns

The corrected end position

FindPath() [2/2]

FindPathResult Quantum.Navigation.PathFinder.FindPath ( FrameThreadSafe  frame, FPVector3  start, FPVector3  end, bool  automaticTargetCorrection, FP  automaticTargetCorrectionRadius, NavMeshRegionMask  regionMask, PathQuality  quality = PathQuality.Good, NavMesh  navmesh = null  )

inline

See FindPath(FrameThreadSafe, FPVector2, FPVector2, bool, FP, NavMeshRegionMask, PathQuality, NavMesh)

Member Data Documentation

RawPathSize

Int32 Quantum.Navigation.PathFinder.RawPathSize => _rawPathSize

The size of the RawPath.

RawPath

PathVertex [] Quantum.Navigation.PathFinder.RawPath => _rawPath

The un-funneled raw path.