tripkit-android / com.skedgo.tripkit.common.util / PolyUtil / locationIndexOnPath


open static fun locationIndexOnPath(point:TripKitLatLng!, poly:MutableList<TripKitLatLng!>!, geodesic:Boolean, tolerance:Double):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.


point - TripKitLatLng!: our needle

poly - MutableList<TripKitLatLng!>!: our haystack

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

tolerance - Double: tolerance (in meters)

Return Int: -1 if point does not lie on or near the polyline. 0 if point is between poly[0] and poly[1] (inclusive), 1 if between poly[1] and poly[2], ..., poly.size()-2 if between poly[poly.size() - 2] and poly[poly.size() - 1]

open static fun locationIndexOnPath(point:TripKitLatLng!, polyline:MutableList<TripKitLatLng!>!, geodesic:Boolean):Int

Same as `[#locationIndexOnPath(TripKitLatLng, List, boolean, double)`](./

with a default tolerance of 0.1 meters.