A* Pathfinding Project  3.6.2
The A* Pathfinding Project for Unity 3D
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties Events Macros Groups Pages
FunnelModifier Class Reference

Simplifies paths on navmesh graphs using the funnel algorithm. More...

Detailed Description

Simplifies paths on navmesh graphs using the funnel algorithm.

The funnel algorithm is an algorithm which can, given a path corridor with nodes in the path where the nodes have an area, like triangles, it can find the shortest path inside it. This makes paths on navmeshes look much cleaner and smoother.

funnelModifier_on.png

Public Member Functions

override void Apply (Path p, ModifierData source)
 Main Post-Processing function.
 
bool RunFunnel (List< Vector3 > left, List< Vector3 > right, List< Vector3 > funnelPath)
 Calculate a funnel path from the left and right portal lists.
 
- Public Member Functions inherited from MonoModifier
virtual Vector3[] Apply (GraphNode[] path, Vector3 start, Vector3 end, int startIndex, int endIndex, NavGraph graph)
 
virtual Vector3[] Apply (Vector3[] path, Vector3 start, Vector3 end)
 
virtual void ApplyOriginal (Path p)
 
void Awake ()
 Alerts the Seeker that this modifier exists.
 
void OnDestroy ()
 
void OnDisable ()
 
void OnEnable ()
 
virtual void PreProcess (Path p)
 
- Public Member Functions inherited from IPathModifier
void Apply (Path p, ModifierData source)
 
void ApplyOriginal (Path p)
 
void PreProcess (Path p)
 

Properties

override ModifierData input [get]
 
override ModifierData output [get]
 
- Properties inherited from MonoModifier
abstract ModifierData input [get]
 
abstract ModifierData output [get]
 
int Priority [get, set]
 
- Properties inherited from IPathModifier
ModifierData input [get]
 
ModifierData output [get]
 
int Priority [get, set]
 

Additional Inherited Members

- Public Attributes inherited from MonoModifier
int priority = 0
 Higher priority modifiers are executed first.
 
Seeker seeker
 

Member Function Documentation

override void Apply ( Path  p,
ModifierData  source 
)
virtual

Main Post-Processing function.

Implements MonoModifier.

bool RunFunnel ( List< Vector3 >  left,
List< Vector3 >  right,
List< Vector3 >  funnelPath 
)

Calculate a funnel path from the left and right portal lists.

The result will be appended to funnelPath

Property Documentation

override ModifierData input
get
override ModifierData output
get

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