GuidanceEngine

public protocol GuidanceEngine : ManagableEngine

The GuidanceEngine protocol defines functionality related to navigation guidance steps.

Important

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

  • The unit system to be used by GuidanceEngine

    Declaration

    Swift

    var unitsSystem: UnitsSystem { get set }

  • Generates a guidance object related to the current position on the route based on input parameters.

    Declaration

    Swift

    func generateGuidance(inputParameters: GuidanceParams) throws -> Guidance

    Parameters

    inputParameters

    Input parameters for guidance generation.

    Return Value

    Guidance object containing guidance information related to the current position on the route.

  • Generates a lane guidance object related to the current position on the route based on input parameters.

    Declaration

    Swift

    func generateLaneGuidance(inputParameters: GuidanceParams) -> LaneGuidanceInfo?

    Parameters

    inputParameters

    Input parameters for lane guidance generation.

    Return Value

    Lane guidance info object containing lane guidance information related to the current position on the route.