A* Pathfinding Project  3.1.4
The A* Pathfinding Project for Unity 3D
 All Classes Namespaces Files Functions Variables Enumerations Properties Groups Pages
StartEndModifier Class Reference

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

+ Inheritance diagram for StartEndModifier:
+ Collaboration diagram for StartEndModifier:

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, Node hint)
 
- Public Member Functions inherited from Modifier
virtual void ApplyOriginal (Path p)
 
void Awake (Seeker s)
 
void OnDestroy (Seeker s)
 
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)
 

Public Attributes

bool addPoints = false
 Add points to the path instead of replacing.
 
Exactness exactEndPoint = Exactness.Original
 
Exactness exactStartPoint = Exactness.Original
 
LayerMask mask = -1
 
bool useGraphRaycasting = false
 
bool useRaycasting = false
 
- Public Attributes inherited from Modifier
int priority = 0
 Higher priority modifiers are executed first.
 
Seeker seeker
 

Properties

override ModifierData input [get]
 
override ModifierData output [get]
 
- Properties inherited from Modifier
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]
 

Detailed Description

Adjusts start and end points of a path.

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 many node types the "closest point" is the node's position which makes this identical to Exactness.SnapToNode

Member Data Documentation

bool addPoints = false

Add points to the path instead of replacing.


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