SharpNav.Crowds.PathCorridor Class Reference

Public Member Functions
	PathCorridor (int maxPath)
void	Reset (int reference, Vector3 pos)
	Resets the path to the first polygon. More...
void	SetCorridor (Vector3 target, int[] path, int npath)
	The current corridor position is expected to be within the first polygon in the path. The target is expected to be in the last polygon. More...
bool	MovePosition (Vector3 npos, NavMeshQuery navquery)
	Move along the NavMeshQuery and update the position More...
int	FindCorners (Vector3[] cornerVerts, int[] cornerFlags, int[] cornerPolys, int maxCorners, NavMeshQuery navquery)
bool	OptimizePathTopology (NavMeshQuery navquery)
	Use a local area path search to try to reoptimize this corridor More...
void	OptimizePathVisibility (Vector3 next, float pathOptimizationRange, NavMeshQuery navquery)
	Use an efficient local visibility search to try to optimize the corridor between the current position and the next. More...
int	MergeCorridorStartMoved (int[] path, int npath, int maxPath, int[] visited, int nvisited)
	Merge two paths after the start is changed More...
int	MergeCorridorStartShortcut (int[] path, int npath, int maxPath, int[] visited, int nvisited)
	Merge two paths when a shorter path is found More...
bool	MoveOverOffmeshConnection (int offMeshConRef, int[] refs, ref Vector3 startPos, ref Vector3 endPos, NavMeshQuery navquery)
bool	FixPathStart (int safeRef, Vector3 safePos)
	Adjust the beginning of the path More...
bool	IsValid (int maxLookAhead, NavMeshQuery navquery)
	Determines whether all the polygons in the path are valid More...
int	GetFirstPoly ()
int	GetLastPoly ()

Properties
Vector3	Pos [get]
Vector3	Target [get]
int[]	Path [get]
int	PathCount [get]

Detailed Description

Definition at line 20 of file PathCorridor.cs.

Member Function Documentation

FixPathStart()

bool SharpNav.Crowds.PathCorridor.FixPathStart	(	int	safeRef,
		Vector3	safePos
	)

Adjust the beginning of the path

Parameters

safeRef	The starting polygon reference
safePos	The starting position

Returns

True if path start changed, false if not

Definition at line 397 of file PathCorridor.cs.

IsValid()

bool SharpNav.Crowds.PathCorridor.IsValid	(	int	maxLookAhead,
		NavMeshQuery	navquery
	)

Determines whether all the polygons in the path are valid

Parameters

maxLookAhead	The amount of polygons to examine
navquery	The NavMeshQuery

Returns

True if all valid, false if otherwise

Definition at line 422 of file PathCorridor.cs.

MergeCorridorStartMoved()

int SharpNav.Crowds.PathCorridor.MergeCorridorStartMoved	(	int[]	path,
		int	npath,
		int	maxPath,
		int[]	visited,
		int	nvisited
	)

Merge two paths after the start is changed

Parameters

path	The current path
npath	Current path length
maxPath	Maximum path length allowed
visited	The visited polygons
nvisited	Visited path length

Returns

New path length

Definition at line 250 of file PathCorridor.cs.

MergeCorridorStartShortcut()

int SharpNav.Crowds.PathCorridor.MergeCorridorStartShortcut	(	int[]	path,
		int	npath,
		int	maxPath,
		int[]	visited,
		int	nvisited
	)

Merge two paths when a shorter path is found

Parameters

path	The current path
npath	Current path length
maxPath	Maximum path length allowed
visited	The visited polygons
nvisited	Visited path length

Returns

New path length

Definition at line 307 of file PathCorridor.cs.

MovePosition()

bool SharpNav.Crowds.PathCorridor.MovePosition	(	Vector3	npos,
		NavMeshQuery	navquery
	)

Move along the NavMeshQuery and update the position

Parameters

npos	Current position
navquery	The NavMeshQuery

Returns

True if position changed, false if not

Definition at line 115 of file PathCorridor.cs.

OptimizePathTopology()

bool SharpNav.Crowds.PathCorridor.OptimizePathTopology

(

NavMeshQuery

navquery

)

Use a local area path search to try to reoptimize this corridor

Parameters

navquery

The NavMeshQuery

Returns

True if optimized, false if not

Definition at line 183 of file PathCorridor.cs.

OptimizePathVisibility()

void SharpNav.Crowds.PathCorridor.OptimizePathVisibility	(	Vector3	next,
		float	pathOptimizationRange,
		NavMeshQuery	navquery
	)

Use an efficient local visibility search to try to optimize the corridor between the current position and the next.

Parameters

next	The next postion
pathOptimizationRange	The range
navquery	The NavMeshQuery

Definition at line 213 of file PathCorridor.cs.

Reset()

void SharpNav.Crowds.PathCorridor.Reset	(	int	reference,
		Vector3	pos
	)

Resets the path to the first polygon.

Parameters

reference	The starting polygon reference
pos	Starting position

Definition at line 87 of file PathCorridor.cs.

SetCorridor()

void SharpNav.Crowds.PathCorridor.SetCorridor	(	Vector3	target,
		int[]	path,
		int	npath
	)

The current corridor position is expected to be within the first polygon in the path. The target is expected to be in the last polygon.

Parameters

target	The target
path	The polygon path
npath	The path length

Definition at line 102 of file PathCorridor.cs.

---

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

• C:/gamedev/unity/DA20.1X/Assets/CodeRespawn/DungeonArchitect/ThirdParty/SharpNav/Crowds/PathCorridor.cs