locationIndexOnPath

fun locationIndexOnPath(point: LatLng, poly: List<LatLng>, geodesic: Boolean, tolerance: Double = DEFAULT_TOLERANCE): Int

Computes whether (and where) a given point lies on or near a polyline, within a specified tolerance. The polyline is not closed -- the closing segment between the first point and the last point is not included.

Return

-1 if point does not lie on or near the polyline. 0 if point is between poly0 and poly1 (inclusive), 1 if between poly1 and poly2, ..., poly.size()-2 if between polypoly.size() - 2 and polypoly.size() - 1

Parameters

point

our needle

poly

our haystack

geodesic

the polyline is composed of great circle segments if geodesic is true, and of Rhumb segments otherwise

tolerance

tolerance (in meters)