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.

Public Member Functions
override void	Apply (Path p)
	Main Post-Processing function.
Public Member Functions inherited from MonoModifier
virtual void	OnDestroy ()
void	OnDisable ()
void	OnEnable ()
virtual void	PreProcess (Path p)
Public Member Functions inherited from IPathModifier
void	Apply (Path p)
void	PreProcess (Path p)

Public Attributes
bool	splitAtEveryPortal
	Insert a vertex every time the path crosses a portal instead of only at the corners of the path.
bool	unwrap = true
	Determines if twists and bends should be straightened out before running the funnel algorithm.
Public Attributes inherited from MonoModifier
Seeker	seeker

Properties
override int	Order [get]
Properties inherited from MonoModifier
abstract int	Order [get]
	Modifiers will be executed from lower order to higher order.
Properties inherited from IPathModifier
int	Order [get]

Additional Inherited Members
Protected Member Functions inherited from MonoModifier
override void	Awake ()
	Alerts the Seeker that this modifier exists.

Member Function Documentation

override void Apply ( Path  p )

virtual

Main Post-Processing function.

Implements MonoModifier.

Member Data Documentation

bool splitAtEveryPortal

Insert a vertex every time the path crosses a portal instead of only at the corners of the path.

The resulting path will have exactly one vertex per portal if this is enabled. This may introduce vertices with the same position in the output (esp. in corners where many portals meet).

bool unwrap = true

Determines if twists and bends should be straightened out before running the funnel algorithm.

If the unwrap option is disabled the funnel will simply be projected onto the XZ plane. If the unwrap option is enabled then the funnel may be oriented arbitrarily and may have twists and bends. This makes it possible to support the funnel algorithm in XY space as well as in more complicated cases, such as on curved worlds.

Note

This has a performance overhead, so if you do not need it you can disable it to improve performance.

See Also

Pathfinding.Funnel.Unwrap for more example images.

Note

This is required if you want to use the funnel modifier for 2D games (i.e in the XY plane).

Property Documentation

override int Order

get

---

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

• /Users/arong/Unity/a-pathfinding-project/Assets/AstarPathfindingProject/Modifiers/FunnelModifier.cs