YMKRoutePosition

class YMKRoutePosition : NSObject

Undocumented

SummarySummary

Instance methodsInstance methods

func onRoute(withRouteId routeId: String) -> Bool Check if this position on the same route as passed

func positionOnRoute(withRouteId routeId: String) -> YMKPolylinePosition? Return polyline position on route

func advance(withDistance distance: Double) -> YMKRoutePosition Create position shifted by distance

func distanceToWith(to: YMKRoutePosition) -> NSNumber? Distance to another point on the route

func precedes(withAnother another: YMKRoutePosition) -> Bool Determines if position precedes another position on the route

func precedesOrEquals(withAnother another: YMKRoutePosition) -> Bool Determines if position precedes or equals another position on the route

func equals(withAnother another: YMKRoutePosition) -> Bool Determines if position equals another position on the route

func heading() -> Double Heading movement on the route at this position

func distanceToFinish() -> Double Distance to the end of the route

func timeToFinish() -> Double Time to the end of the route

PropertiesProperties

var point: YMKPoint { get } As point on the map

Instance methodsInstance methods

onRoute(withRouteId:)onRoute(withRouteId:)

func onRoute(withRouteId routeId: String) -> Bool

Check if this position on the same route as passed.

positionOnRoute(withRouteId:)positionOnRoute(withRouteId:)

func positionOnRoute(withRouteId routeId: String) -> YMKPolylinePosition?

Return polyline position on route. If the position not on the passed route none will be returned.

advance(withDistance:)advance(withDistance:)

func advance(withDistance distance: Double) -> YMKRoutePosition

Create position shifted by distance. If the distance is more than remains route length, the end of the route will be returned. If the distance is less than a negative distance from the start, the beginning of the route will be returned.

distanceToWith(to:)distanceToWith(to:)

func distanceToWith(to: YMKRoutePosition) -> NSNumber?

Distance to another point on the route. Return none if point on another route. May be less 0 if position "to" stay before this position.

precedes(withAnother:)precedes(withAnother:)

func precedes(withAnother another: YMKRoutePosition) -> Bool

Determines if position precedes another position on the route. Throws if another position belongs to another route.

precedesOrEquals(withAnother:)precedesOrEquals(withAnother:)

func precedesOrEquals(withAnother another: YMKRoutePosition) -> Bool

Determines if position precedes or equals another position on the route. Throws if another position belongs to another route.

equals(withAnother:)equals(withAnother:)

func equals(withAnother another: YMKRoutePosition) -> Bool

Determines if position equals another position on the route. Throws if another position belongs to another route.

heading()heading()

func heading() -> Double

Heading movement on the route at this position. It is equal heading of the segment which is belonged position.

distanceToFinish()distanceToFinish()

func distanceToFinish() -> Double

Distance to the end of the route.

timeToFinish()timeToFinish()

func timeToFinish() -> Double

Time to the end of the route.

PropertiesProperties

pointpoint

var point: YMKPoint { get }

As point on the map