Перейти к основному содержимому

Маршруты

В этом разделе описывается работа с маршрутами для разных видов транспорта. Вы можете создавать маршруты двумя способами:

Построение маршрута​

Для работы с маршрутом вам понадобится два объекта:

  • TrafficRouter для создания или загрузки маршрута;
  • источник данных RouteMapObjectSource для отображения маршрута на карте.

  1. Чтобы создать новый маршрут, вызовите метод findRoute(), передав координаты точек в виде объектов RouteSearchPoint и параметры маршрута (RouteSearchOptions). Дополнительно можно указать список промежуточных точек маршрута (RouteSearchPoint).

    let startPoint = RouteSearchPoint(coordinates: GeoPoint(latitude: 55.759909, longitude: 37.618806))
    let finishPoint = RouteSearchPoint(coordinates: GeoPoint(latitude: 55.752425, longitude: 37.613983))
    let routeSearchOptions = RouteSearchOptions.car(CarRouteSearchOptions())

    let trafficRouter = TrafficRouter(context: sdk.context)
    let routesFuture = trafficRouter.findRoute(
        startPoint: startPoint,
        finishPoint: finishPoint,
        routeSearchOptions: routeSearchOptions
    )

    Вызов findRoute() вернёт отложенный результат со списком объектов TrafficRoute.

  2. Чтобы отобразить найденный маршрут на карте, создайте объекты RouteMapObject на основе полученных объектов TrafficRoute и добавьте их в источник данных RouteMapObjectSource.

    // Создаём источник данных
    let routeMapObjectSource = RouteMapObjectSource(context: sdk.context, routeVisualizationType: .normal)
    map.addSource(source: routeMapObjectSource)

    // Добавляем созданный маршрут на карту
    self.routeSearchCancellable = routesFuture.sinkOnMainThread { routes in
        for (index, route) in routes.enumerated() {
            let routeMapObject = RouteMapObject(
                route: route,
                isActive: index == 0,
                index: RouteIndex(value: UInt64(index)),
                displayFlags: nil
            )
            routeMapObjectSource.addObject(item: routeMapObject)
        }
    } failure: { error in
        print("Не удалось найти маршрут: \(error)")
    }

Точки маршрута​

Для построения маршрута необходимо получить точки типа GeoPoint, которые далее используются для создания RouteSearchPoint. Существует множество способов это сделать, ниже описаны некоторые из них.

Получение точек по нажатию на карту​

Чтобы получить географические координаты места нажатия, нужно получить ScreenPoint, как в примере Получение объектов по экранным координатам:

func tap(location: CGPoint) {
	let scale = UIScreen.main.nativeScale
	let point = ScreenPoint(x: Float(location.x * scale), y: Float(location.y * scale))
	...

ScreenPoint можно преобразовать в географические координаты с помощью метода screenToMap():

func tap(location: CGPoint) {
	let scale = UIScreen.main.nativeScale
	let point = ScreenPoint(x: Float(location.x * scale), y: Float(location.y * scale))
	let geoPoint = map.camera.projection.screenToMap(point: point)
	...

Таким образом, мы получим координаты в точке нажатия на карту.

Получение координат объекта в месте нажатия на карту​

Можно получить координаты объекта (здания, дороги), который находится в месте клика. Для этого понадобится метод getRenderedObjects(). В нем нужно получить объект класса DgisMapObject, который имеет поле id. Этот идентификатор является стабильным числовым идентификатором объекта справочника, с помощью которого можно выполнить поисковый запрос и получить информацию об объекте, в том числе географические координаты его центра.

private func tap(point: ScreenPoint, tapRadius: ScreenDistance) {
	let scale = UIScreen.main.nativeScale
	let point = ScreenPoint(x: Float(location.x * scale), y: Float(location.y * scale))
	self.getRenderedObjectsCancellable?.cancel()
	let cancel = self.map.getRenderedObjects(centerPoint: point).sinkOnMainThread(
		receiveValue: {
			infos in
			// Получим ближайший к месту нажатия объект класса DgisMapObject
				guard let info = infos.first(
					where: {
						$0.item.item is DgisMapObject
					}
				) else { return }
				let mapObject = info.item.item as! DgisMapObject

				// Создадим поисковый запрос по идентификатору этого объекта
				self.searchCancellable?.cancel()
				self.searchCancellable = self.searchManager.searchByDirectoryObjectId(
					objectId: mapObject.id
				)
				// Получим объект из поискового запроса
				.sinkOnMainThread(receiveValue: { [weak self] object in
					self?.directoryObject = object
					// Получим координаты объекта в виде GeoPoint
					let geoPoint = self?.directoryObject?.markerPosition?.point
				},
					failure: { .. }
				)

		},
		failure: { ... }
	)
	...
}
Координаты больших объектов

Координаты центра для больших объектов (например, МКАД) могут находиться далеко за пределами области видимости камеры, так как полученный объект не учитывает расположение камеры или места нажатия на карту. С такими объектами лучше использовать другие способы получения координат.

Проезд промежуточных точек​

Для маршрута с промежуточными точками предполагается, что пользователь посетит каждую из этих точек на маршруте по очереди. Если промежуточная точка пропущена, маршрут может перестроиться:

  • Если по данным GPS видно, что пользователь движется не в сторону нужной промежуточной точки, маршрут перестраивается относительно текущего положения пользователя так, чтобы он посетил пропущенную точку. Когда посещение точки будет зафиксировано, маршрут продолжится.
  • Если момент посещения промежуточной точки не зафиксирован из-за слабого сигнала GPS, но позже положение пользователя зафиксировано на маршруте по направлению к следующей точке или около него, точка считается пройденной и маршрут продолжается.

Параметры поиска маршрута​

Для автомобилей​

Чтобы построить маршрут для легкового автомобиля, укажите свойство car в RouteSearchOptions. Дополнительно вы можете настроить параметры построения маршрута CarRouteSearchOptions:

  • avoidTollRoads: избегать ли платных дорог (по умолчанию false).
  • avoidUnpavedRoads: избегать ли грунтовых дорог (по умолчанию false).
  • avoidFerries: избегать ли паромных переправ (по умолчанию false).
  • avoidLockedRoads: избегать ли закрытых для проезда дорог (по умолчанию true).
  • routeSearchType: способ учёта данных о пробках при построении маршрута. Вы можете строить маршрут с учётом реальных (jam) или статистических (statistic) данных о пробках или построить кратчайший по расстоянию маршрут, даже если он не является оптимальным по времени (shortest).
  • excludedAreas: список областей (не более 25), которые следует избегать при построении маршрута. Подробнее см. в разделе Исключение областей ниже.
let carOptions = CarRouteSearchOptions(
    avoidTollRoads: true,
    avoidUnpavedRoads: true,
    avoidFerries: true,
    avoidLockedRoads: true,
    routeSearchType: RouteSearchType.jam,
    excludedAreas: []
)

let routeSearchOptions = RouteSearchOptions.car(carOptions)

Передайте готовые параметры routeSearchOptions в вызов функции findRoute() при построении маршрута.

Для такси​

Чтобы построить маршрут для такси, укажите свойство taxi в RouteSearchOptions.

Дополнительно вы можете настроить параметры построения маршрута TaxiRouteSearchOptions. Для поиска маршрута для такси нужно сначала задать параметры поиска обычных автомобильных маршрутов, а затем переиспользовать их в параметре car:

let taxiOptions = TaxiRouteSearchOptions(
    car: carOptions,
)

let routeSearchOptions = RouteSearchOptions.taxi(taxiOptions)

Передайте готовые параметры routeSearchOptions в вызов функции findRoute() при построении маршрута.

Для грузового транспорта​

Чтобы построить маршрут для грузового транспорта, укажите свойство truck в RouteSearchOptions. Дополнительно вы можете настроить параметры построения маршрута TruckRouteSearchOptions:

  • car: базовые параметры поиска любых автомобильных маршрутов: см. параметры поиска маршрута для автомобилей.
  • truckLength: длина грузовика в миллиметрах.
  • truckHeight: высота грузовика в миллиметрах.
  • truckWidth: ширина грузовика в миллиметрах.
  • actualMass: фактическая масса грузовика в килограммах.
  • maxPermittedMass: разрешённая максимальная масса грузовика в килограммах.
  • axleLoad: нагрузка на ось в килограммах.
  • dangerousCargo: перевозится ли опасный груз (по умолчанию false).
  • explosiveCargo: перевозятся ли взрывчатые вещества в грузе (по умолчанию false).
  • passIds: список идентификаторов пропусков, которые разрешают движение грузового транспорта в пропускных зонах (TruckPassZonePassId).
  • fallbackOnCar: переключаться ли на поиск маршрута для легкового автомобиля, если по заданным параметрам невозможно найти грузовой маршрут (по умолчанию false).
let truckOptions = TruckRouteSearchOptions(
    car: carOptions,
    truckLength: 12000,                 // 12 метров
    truckHeight: 4200,                  // 4,2 метра
    truckWidth: 2500,                   // 2,5 метра
    actualMass: 18000,                  // 18 тонн
    maxPermittedMass: 20000,            // 20 тонн
    axleLoad: 8000,                     // 8 тонн
    dangerousCargo: true,
    explosiveCargo: false,
    passIds: Set<TruckPassZonePassId>(),
    fallbackOnCar: true
)

let routeSearchOptions = RouteSearchOptions.truck(truckOptions)

Передайте готовые параметры routeSearchOptions в вызов функции findRoute() при построении маршрута.

Построение на онлайн-данных

Для построения маршрутов для грузового транспорта используются только онлайн-данные. В офлайн-режиме маршруты не строятся.

Для общественного транспорта​

Чтобы построить маршрут для проезда на общественном транспорте, укажите свойство publicTransport в RouteSearchOptions. Дополнительно вы можете настроить параметры построения маршрута PublicTransportRouteSearchOptions:

  • startTime: время старта маршрута в UTC. Если не указано, используется текущее время.
  • useSchedule: учитывать ли расписание движения общественного транспорта.
  • transportTypes: список типов общественного транспорта, которые могут быть использованы для проезда по маршруту. Если список пустой, маршрут будет строиться для всех поддерживаемых типов транспорта. Полный список типов см. в PublicTransportTypeOptionSet.
let publicTransportOptions = PublicTransportRouteSearchOptions(
    startTime: Date(),
    useSchedule: true,
    transportTypes: [
        .bus,                // Автобус
        .trolleybus,         // Троллейбус
        .tram,               // Трамвай
        .metro,              // Метро
        .suburbanTrain       // Пригородные поезда
    ]
)

let routeSearchOptions = RouteSearchOptions.publicTransport(publicTransportOptions)

Передайте готовые параметры routeSearchOptions в вызов функции findRoute() при построении маршрута.

Для велосипедов​

Чтобы построить маршрут для велосипеда, укажите свойство bicycle в RouteSearchOptions. Дополнительно вы можете настроить параметры построения маршрута BicycleRouteSearchOptions:

  • avoidCarRoads: избегать ли автомобильных дорог (по умолчанию false).
  • avoidStairways: избегать ли лестниц (по умолчанию false).
  • avoidUnderpassesAndOverpasses: избегать ли подземных и надземных переходов (по умолчанию false).
  • excludedAreas: список областей (не более 25), которые следует избегать при построении маршрута. Подробнее см. в разделе Исключение областей ниже.
let bicycleOptions = BicycleRouteSearchOptions(
    avoidCarRoads: false,
    avoidStairways: true,
    avoidUnderpassesAndOverpasses: true,
    excludedAreas: []
)

let routeSearchOptions = RouteSearchOptions.bicycle(bicycleOptions)

Передайте готовые параметры routeSearchOptions в вызов функции findRoute() при построении маршрута.

Для самокатов​

Чтобы построить маршрут для самоката, укажите свойство scooter в RouteSearchOptions. Дополнительно вы можете настроить параметры построения маршрута ScooterRouteSearchOptions:

  • avoidCarRoads: избегать ли автомобильных дорог (по умолчанию true).
  • avoidStairways: избегать ли лестниц (по умолчанию true).
  • avoidUnderpassesAndOverpasses: избегать ли подземных и надземных переходов (по умолчанию true).
  • excludedAreas: список областей (не более 25), которые следует избегать при построении маршрута. Подробнее см. в разделе Исключение областей ниже.
let scooterOptions = ScooterRouteSearchOptions(
    avoidCarRoads: true,
    avoidStairways: true,
    avoidUnderpassesAndOverpasses: true,
    excludedAreas: []
)

let routeSearchOptions = RouteSearchOptions.scooter(scooterOptions)

Передайте готовые параметры routeSearchOptions в вызов функции findRoute() при построении маршрута.

Для пешеходов​

Пешеходные маршруты могут включать в себя перемещения внутри зданий (например, вы можете построить маршрут до определённого магазина в торговом центре). Если одна из точек маршрута находится внутри здания, для неё необходимо указать дополнительные параметры objectId (идентификатор объекта, к которому нужно проложить маршрут) и levelId (идентификатор этажа здания, на котором находится объект).

let indoorPoint = RouteSearchPoint(
    coordinates: GeoPoint(latitude: 55.752425, longitude: 37.613983),
    objectId: DgisObjectId(objectId: 67890, entranceId: 2),
    levelId: LevelId(value: 3)
)

Подробнее о ведении по маршруту внутри зданий см. в разделе Навигация.

Чтобы построить пешеходный маршрут, укажите свойство pedestrian в RouteSearchOptions. Дополнительно вы можете настроить параметры построения маршрута PedestrianRouteSearchOptions:

  • avoidStairways: избегать ли лестниц (по умолчанию false).
  • avoidUnderpassesAndOverpasses: избегать ли подземных и надземных переходов (по умолчанию false).
  • useIndoor: строить ли маршруты внутри зданий (по умолчанию true).
  • excludedAreas: список областей (не более 25), которые следует избегать при построении маршрута. Подробнее см. в разделе Исключение областей ниже.
let pedestrianOptions = PedestrianRouteSearchOptions(
    avoidStairways: false,
    avoidUnderpassesAndOverpasses: false,
	useIndoor: false,
    excludedAreas: []
)

let routeSearchOptions = RouteSearchOptions.pedestrian(pedestrianOptions)

Передайте готовые параметры routeSearchOptions в вызов функции findRoute() при построении маршрута.

Исключение областей​

Чтобы исключить определённую область при построении маршрута, создайте объект ExcludedArea со следующими параметрами:

  • type: геометрическая форма исключаемой области. Список возможных значений см. в ExcludedAreaType.
  • severity: приоритет исключения области (насколько важно её избегать). Список возможных значений см. в ExcludedAreaSeverity.
  • extent: размер исключаемой области (не более 25 км).
  • points: координаты точек исключаемой области типа GeoPoint (не более 500).

Пример исключаемой области в форме многоугольника:

// Вершины многоугольника
let points = [
    GeoPoint(latitude: 55.759909, longitude: 37.618806),
    GeoPoint(latitude: 55.752425, longitude: 37.613983),
    GeoPoint(latitude: 55.753567, longitude: 37.622995),
    GeoPoint(latitude: 55.760523, longitude: 37.625613)
]

let polygonExcludedArea = ExcludedArea(
    type: ExcludedAreaType.polygon,
    severity: ExcludedAreaSeverity.hard,
    extent: RouteDistance(value: 500),
    points: points
)

Готовый маршрут​

Вы можете предварительно создать маршрут с помощью Routing API и сохранить его для использования в мобильном SDK. Сохранённый маршрут доступен для использования в течение 24 часов. Маршруты для общественного транспорта недоступны для сохранения.

  1. Создайте маршрут с помощью Routing API, сохраните его и скопируйте идентификатор маршрута: см. Сохранение маршрута.

  2. Вызовите метод fetchSharedRoute() и передайте идентификатор сохранённого маршрута.

    let routeId = "ROUTE_ID"

    let trafficRouter = TrafficRouter(context: sdk.context)
    let sharedRouteFuture = trafficRouter.fetchSharedRoute(requestId: routeId)

    Вызов вернёт отложенный результат с объектом SharedRouteData, который содержит набор маршрутов ([TrafficRoute]), точки маршрута и параметры поиска.

  3. Чтобы отобразить маршрут на карте, создайте объекты RouteMapObject на основе полученных объектов TrafficRoute и добавьте их в источник данных RouteMapObjectSource.

    // Создаём источник данных
    let routeMapObjectSource = RouteMapObjectSource(context: sdk.context, routeVisualizationType: .normal)
    map.addSource(source: routeMapObjectSource)

    // Добавляем полученный маршрут на карту
    self.sharedRouteCancellable = sharedRouteFuture.sinkOnMainThread { sharedRouteData in
        for (index, route) in sharedRouteData.routes.enumerated() {
            let routeMapObject = RouteMapObject(
                route: route,
                isActive: index == 0,
                index: RouteIndex(value: UInt64(index)),
                displayFlags: nil
            )
            routeMapObjectSource.addObject(item: routeMapObject)
        }
    } failure: { error in
        print("Не удалось получить маршрут: \(error)")
    }

Офлайн-режим​

По умолчанию построение маршрута работает в гибридном режиме: в первую очередь используются данные с серверов 2ГИС. Если за определённое время не удаётся построить маршрут на онлайн-данных, используются предварительно загруженные данные, если они есть.

Чтобы загрузить данные для работы офлайн, необходимо получить соответствующие права в ключе доступа и скачать необходимые территории. См. подготовительные шаги к работе с офлайн-данными.

Следующие функции доступны только в онлайн-режиме: