A* Pathfinding Project  3.7.2
The A* Pathfinding Project for Unity 3D
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties Events Macros Groups Pages
Public Types | Public Member Functions | Public Attributes | Properties | List of all members
StartEndModifier Class Reference
Modifiers

Adjusts start and end points of a path. More...

Detailed Description

Adjusts start and end points of a path.

Public Types

enum  Exactness { SnapToNode, Original, Interpolate, ClosestOnNode }
 Sets where the start and end points of a path should be placed. More...
 

Public Member Functions

override void Apply (Path _p, ModifierData source)
 Main Post-Processing function.
 
Vector3 GetClampedPoint (Vector3 from, Vector3 to, GraphNode hint)
 
- Public Member Functions inherited from PathModifier
void Awake (Seeker s)
 
void OnDestroy (Seeker s)
 
void PreProcess (Path p)
 
- Public Member Functions inherited from IPathModifier
void Apply (Path p, ModifierData source)
 
void PreProcess (Path p)
 

Public Attributes

bool addPoints
 Add points to the path instead of replacing.
 
Exactness exactEndPoint = Exactness.ClosestOnNode
 
Exactness exactStartPoint = Exactness.ClosestOnNode
 
LayerMask mask = -1
 
bool useGraphRaycasting
 
bool useRaycasting
 
- Public Attributes inherited from PathModifier
Seeker seeker
 

Properties

override ModifierData input [get]
 
override ModifierData output [get]
 
- Properties inherited from PathModifier
abstract ModifierData input [get]
 
abstract ModifierData output [get]
 
int Priority [get, set]
 Higher priority modifiers are executed first.
 
- Properties inherited from IPathModifier
ModifierData input [get]
 
ModifierData output [get]
 
int Priority [get, set]
 

Member Enumeration Documentation

enum Exactness

Sets where the start and end points of a path should be placed.

Enumerator:
SnapToNode 

The point is snapped to the first/last node in the path.

Original 

The point is set to the exact point which was passed when calling the pathfinding.

Interpolate 

The point is set to the closest point on the line between either the two first points or the two last points.

ClosestOnNode 

The point is set to the closest point on the node.

Note that for some node types (point nodes) the "closest point" is the node's position which makes this identical to Exactness.SnapToNode

Member Function Documentation

override void Apply ( Path  p,
ModifierData  source 
)
virtual

Main Post-Processing function.

Implements PathModifier.

Vector3 GetClampedPoint ( Vector3  from,
Vector3  to,
GraphNode  hint 
)

Member Data Documentation

bool addPoints

Add points to the path instead of replacing.

Exactness exactEndPoint = Exactness.ClosestOnNode
Exactness exactStartPoint = Exactness.ClosestOnNode
LayerMask mask = -1
bool useGraphRaycasting
bool useRaycasting

Property Documentation

override ModifierData input
get
override ModifierData output
get
The documentation for this class was generated from the following file: