NavKitGuidanceEngine

public class NavKitGuidanceEngine : GuidanceEngine

Guidance engine based on the NavKit SDK.

Important

This is a Public Preview API. It may be changed or removed at any time.

Public

  • Declaration

    Swift

    public var unitsSystem: UnitsSystem

  • Generates guidance steps using the NavKit algorithm.

    Declaration

    Swift

    public func generateGuidance(inputParameters _: GuidanceParams) throws -> Guidance

    Parameters

    routeProgress

    Object that specifies the progress of the driver along the route.
    route

    Route along which progress is calculated and for which guidance steps are created.

  • Updates the engine with a new instruction.

    Declaration

    Swift

    public func nextInstruction(instruction: Instruction, distanceToNextInstruction distance: Measurement<UnitLength>)

    Parameters

    instruction

    Instruction to generate a new guidance step for.
    distanceToNextInstruction

    Distance to the next instruction.

  • Updates the distance to the maneuver in the current guidance step.

    Declaration

    Swift

    public func updateDistance(distance: Measurement<UnitLength>)

    Parameters

    distance

    Distance to the next maneuver.

  • Declaration

    Swift

    public func generateLaneGuidance(inputParameters _: GuidanceParams) -> LaneGuidanceInfo?

  • Declaration

    Swift

    public func reset()