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

Model

Navigator model intended to be displayed in the UI.

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

Returns a Boolean value indicating whether two values are equal.

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 betterRouteResponse(
    response: BetterRouteResponse
)

User response on the application of the suggested better route.

Parameters
response
Properties
var stateChannel
StatefulChannel<State>

Navigator state.

var state

Navigator state.

var locationChannel
StatefulChannel<Location?>

Current geoposition that the navigator is working with.

var location

Current geoposition that the navigator is working with.

var locationAvailableChannel
StatefulChannel<Bool>

Flag that indicates whether the current geoposition is used for navigation. After obtaining the geoposition, the navigator decides whether it is suitable for navigation (for example, if the geoposition has too large error, the navigator may decide that it is not suitable for navigation). If the geoposition is suitable for navigation, the navigator sets true in this channel, if not - false.
Even if the value in this channel is false, the geoposition can be updated in the location_channel.

var locationAvailable

Flag that indicates whether the current geoposition is used for navigation. After obtaining the geoposition, the navigator decides whether it is suitable for navigation (for example, if the geoposition has too large error, the navigator may decide that it is not suitable for navigation). If the geoposition is suitable for navigation, the navigator sets true in this channel, if not - false.
Even if the value in this channel is false, the geoposition can be updated in the location_channel.

var routeChannel
StatefulChannel<RouteInfo>

Route with maneuvers.
In the free roam mode (StateChannel::FreeRoam), there is no route that the user is following. That is why the navigator represents the road section on that the user is currently moving as a route and returns it as the current route. This description of the road is not a full-fledged route, because it has no finish line and maneuvers.

var route

Route with maneuvers.
In the free roam mode (StateChannel::FreeRoam), there is no route that the user is following. That is why the navigator represents the road section on that the user is currently moving as a route and returns it as the current route. This description of the road is not a full-fledged route, because it has no finish line and maneuvers.

var dynamicRouteInfoChannel
StatefulChannel<DynamicRouteInfo>

Traffic events and traffic data on the route or on the predicted part of the route for FreeRoam mode.

var dynamicRouteInfo

Traffic events and traffic data on the route or on the predicted part of the route for FreeRoam mode.

var routePositionChannel
StatefulChannel<RoutePoint?>

Current user position on the route.

var routePosition

Current user position on the route.

var exceedingMaxSpeedLimitChannel
StatefulChannel<Bool>

Flag of exceeding the maximum allowed speed.

var exceedingMaxSpeedLimit

Flag of exceeding the maximum allowed speed.

var betterRouteChannel
StatefulChannel<BetterRouteInfo?>

Signal about finding an alternative route with a shorter expected travel time. If the value in the channel is nil, it means that an alternative route is found or is no longer relevant.

var betterRoute

Signal about finding an alternative route with a shorter expected travel time. If the value in the channel is nil, it means that an alternative route is found or is no longer relevant.

var distance
Measurement<UnitLength>?

Distance from the current position to the end of the route.

var duration

Travel time from the current position to the end of the route.

var isFreeRoam