NavigationManager | iOS SDK | 2GIS Documentation
iOS SDK
Maps
Search
Navigation
Urbi Pro
CityLens
On‑Premise
Account

NavigationManager

Root public interface of the navigator.

Extends: Hashable
public static func == (lhs: NavigationManager, rhs: NavigationManager) -> Bool

Returns a Boolean value indicating whether two values are equal.

public convenience init(
    platformContext: Context
) throws

Navigator API entry point, used in the SDK by default.

Parameters
platformContext
Methods
public func hash(into hasher: inout Hasher)

Hashes the essential components of this value by passing them to the given hasher.

Parameters
hasher
Hasher

Hasher to use when combining the components of this instance.

public func start() throws

Starts guidance in a mode with no route (free roam). In this mode, there is no route, and the navigator reports objects on the road near the user.

public func start(
    routeBuildOptions: RouteBuildOptions,
    trafficRoute: TrafficRoute? = nil
) throws

Starts the route guidance.

Parameters
routeBuildOptions
RouteBuildOptions

Parameters with which the navigator will rebuild the route.

trafficRoute
TrafficRoute?

Route on which tracking is started. If not set, the navigator builds a route from the current position.

public func startSimulation(
    routeBuildOptions: RouteBuildOptions,
    trafficRoute: TrafficRoute
) throws

Starts the simulation of route guidance.

Parameters
routeBuildOptions
RouteBuildOptions

Parameters with which the navigator will rebuild the route.

trafficRoute
TrafficRoute

Route guidance that triggers the simulation.

public func stop()

Stops the navigator operation.

Properties
var uiModel

Navigator model intended to be displayed in the UI.

var indoorDetector

Navigates indoors.

var mapFollowController

Controls the automatic return of the map to track the geo-position marker.

var mapManager

Navigator map manager.

var zoomFollowSettings

Settings of map scaling during the guidance mode.

var routeMapSettings

Route display settings on the map.

var routeSourceSettings

Settings for the source used to display the route on the map.

var simulationSettings

Route guidance simulation settings.

var voiceSelector

Manages voice packets in the current navigator session.

var exceedSpeedLimitSettings

Settings for speeding detection.

var dynamicRouteInfoSettings

Settings for getting and updating dynamic route data.

var soundNotificationSettings

Settings for sound alerts in the current navigator session.

var freeRoamSettings

Settings for driving without a route in free roam mode.

var alternativeRoutesProviderSettings

Settings of finding alternate routes in the guidance mode.