Type Alias WaypointResult

WaypointResult: {
    distance: number;
    index: number;
    nearest: Point;
    path: Path;
    positionRelative: number;
    rank: number;
}

Result

distance: number
Closest distance to path. See also nearest
index: number
Index of this path in original paths array
nearest: Point
Nearest point on path. See also distance
path: Path
Path being compared against
positionRelative: number
Relative position on this path segment 0 being start, 0.5 middle and so on.
rank: number
Rank of this result, 0 being highest.