YMKPolylineIndex

class YMKPolylineIndex : NSObject

Provides methods for binding locations to a polyline

SummarySummary

Instance methodsInstance methods

func closestPolylinePosition(with point: YMKPoint,                                priority: YMKPolylineIndexPriority,                         maxLocationBias: Double) -> YMKPolylinePosition? Finds closest polyline position

func closestPolylinePosition(with point: YMKPoint,                            positionFrom: YMKPolylinePosition,                              positionTo: YMKPolylinePosition,                         maxLocationBias: Double) -> YMKPolylinePosition? Finds the closest polyline position between the two positions

Instance methodsInstance methods

closestPolylinePosition(with:priority:maxLocationBias:)closestPolylinePosition(with:priority:maxLocationBias:)

func closestPolylinePosition(with point: YMKPoint,                                priority: YMKPolylineIndexPriority,                         maxLocationBias: Double) -> YMKPolylinePosition?

Finds closest polyline position. Returns null if there is no position that satisfies the condition distance(point, position) < maxLocationBias.

Two modes are available: 1. Find the closest polyline position to a raw point YMKPolylineIndexPriorityClosestToRawPoint 2. Find the closest polyline position to the polyline start YMKPolylineIndexPriorityClosestToStart.

closestPolylinePosition(with:positionFrom:positionTo:maxLocationBias:)closestPolylinePosition(with:positionFrom:positionTo:maxLocationBias:)

func closestPolylinePosition(with point: YMKPoint,                            positionFrom: YMKPolylinePosition,                              positionTo: YMKPolylinePosition,                         maxLocationBias: Double) -> YMKPolylinePosition?

Finds the closest polyline position between the two positions. Returns null if there is no position that satisfies the condition distance(point, position) < maxLocationBias.