Type Alias WaypointResult

Result

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

Index

Properties

distance index nearest path positionRelative rank

Properties

distance

distance: number

Closest distance to path. See also nearest

index

index: number

Index of this path in original paths array

nearest

nearest: Point

Nearest point on path. See also distance

path

path: Path

Path being compared against

positionRelative

positionRelative: number

Relative position on this path segment 0 being start, 0.5 middle and so on.

rank

rank: number

Rank of this result, 0 being highest.