ナビゲーション イベントをリッスンする

お知らせ: GMSNavigatorDelegate プロトコルと GMSRoadSnappedLocationProviderDelegate プロトコルは、Navigation SDK for iOS バージョン 2.0 で廃止されました。交換の詳細については、リリースノートをご覧ください。

このガイドでは、ユーザーがルートをナビゲートする際に変化するさまざまなイベントをアプリがリッスンして応答できるようにします。このガイドでは、ルートの定義ではなく、ルート沿いのイベントへの応答について説明します。

概要

Navigation SDK for iOS には、ユーザーの現在地やルート上の状況、重要な時間と距離データに関連付けられたリスナーが用意されています。地図のビュー コントローラで、アプリは GMSRoadSnappedLocationProviderListener と GMSNavigatorListener のリスナーのプロトコルを採用する必要があります。

次のリストは、ナビゲーション イベントで使用可能なリスナー メソッドを示しています。

• GMSNavigatorListener.didArriveAtWaypoint: デスティネーションに到達したときにトリガーされます。
• GMSNavigatorListener.navigatorDidChangeRoute: ルートが変更されたときにトリガーされます。
• GMSNavigatorListener.didUpdateRemainingTime: ガイダンスがアクティブなときに、次の目的地までの時間が変更されるたびに繰り返し呼び出されます。
• GMSNavigatorListener.didUpdateRemainingDistance: ガイダンスが有効なときに、次の目的地までの距離が変更されるたびに繰り返し呼び出されます。
• GMSNavigatorListener.didUpdateDelayCategory: ガイダンスが有効なときに、次の目的地までの遅延カテゴリが変更されたときに呼び出されます。
• GMSNavigatorListener.didChangeSuggestedLightingMode - 推定照明条件が更新されたときにトリガーされます。たとえば、ユーザーの現在地で夜になると照明が変化します。
• GMSNavigatorListener.didUpdateSpeedingPercentage: ドライバーが制限速度を超えたときにトリガーされます。
• GMSRoadSnappedLocationProviderListener.didUpdateLocation: ユーザーの位置情報が変更されるたびに繰り返し呼び出されます。

注: アプリの設計で、このガイドの範囲外の処理が必要な場合は、Maps SDK for iOS の GMSMapViewDelegate プロトコルを使用することを検討してください。このプロトコルを使用すると、カメラの変更やスポットへの近接性など、他のイベントをリッスンできます。詳しくは、イベントをご覧ください。

コードの確認

イベント リスナーの Swift コードの表示/非表示を切り替える。

/*
 * Copyright 2020 Google Inc. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import GoogleNavigation
import UIKit

class ViewController: UIViewController,
  GMSNavigatorListener,
  GMSRoadSnappedLocationProviderListener
{

  var mapView: GMSMapView!
  var locationManager: CLLocationManager!

  override func loadView() {

    locationManager = CLLocationManager()

    let camera = GMSCameraPosition.camera(withLatitude: 47.67, longitude: -122.20, zoom: 14)
    mapView = GMSMapView.map(withFrame: CGRect.zero, camera: camera)

    // Add listeners for GMSNavigator and GMSRoadSnappedLocationProvider.
    mapView.navigator?.add(self)
    mapView.roadSnappedLocationProvider?.add(self)

    // Set the time update threshold (seconds) and distance update threshold (meters).
    mapView.navigator?.timeUpdateThreshold = 10
    mapView.navigator?.distanceUpdateThreshold = 100

    // Show the terms and conditions.
    let companyName = "Ride Sharing Co."
    GMSNavigationServices.showTermsAndConditionsDialogIfNeeded(
      withCompanyName: companyName
    ) { termsAccepted in
      if termsAccepted {
        // Enable navigation if the user accepts the terms.
        self.mapView.isNavigationEnabled = true

        // Request authorization to use location services.
        self.locationManager.requestAlwaysAuthorization()

        // Request authorization for alert notifications which deliver guidance instructions
        // in the background.
        UNUserNotificationCenter.current().requestAuthorization(options: [.alert]) {
          granted, error in
          // Handle denied authorization to display notifications.
          if !granted || error != nil {
            print("Authorization to deliver notifications was rejected.")
          }
        }
      } else {
        // Handle the case when the user rejects the terms and conditions.
      }
    }

    view = mapView

    makeButton()
  }

  // Create a route and start guidance.
  @objc func startNav() {
    var destinations = [GMSNavigationWaypoint]()
    destinations.append(
      GMSNavigationWaypoint.init(
        placeID: "ChIJnUYTpNASkFQR_gSty5kyoUk",
        title: "PCC Natural Market")!)
    destinations.append(
      GMSNavigationWaypoint.init(
        placeID: "ChIJJ326ROcSkFQRBfUzOL2DSbo",
        title: "Marina Park")!)

    mapView.navigator?.setDestinations(destinations) { routeStatus in
      guard routeStatus == .OK else {
        print("Handle route statuses that are not OK.")
        return
      }
      self.mapView.navigator?.isGuidanceActive = true
      self.mapView.cameraMode = .following
      self.mapView.locationSimulator?.simulateLocationsAlongExistingRoute()
    }

    mapView.roadSnappedLocationProvider?.startUpdatingLocation()
  }

  // Listener to handle continuous location updates.
  func locationProvider(
    _ locationProvider: GMSRoadSnappedLocationProvider,
    didUpdate location: CLLocation
  ) {
    print("Location: \(location.description)")
  }

  // Listener to handle speeding events.
  func navigator(
    _ navigator: GMSNavigator, didUpdateSpeedingPercentage percentageAboveLimit: CGFloat
  ) {
    print("Speed is \(percentageAboveLimit) above the limit.")
  }

  // Listener to handle arrival events.
  func navigator(_ navigator: GMSNavigator, didArriveAt waypoint: GMSNavigationWaypoint) {
    print("You have arrived at: \(waypoint.title)")
    mapView.navigator?.continueToNextDestination()
    mapView.navigator?.isGuidanceActive = true
  }

  // Listener for route change events.
  func navigatorDidChangeRoute(_ navigator: GMSNavigator) {
    print("The route has changed.")
  }

  // Listener for time to next destination.
  func navigator(_ navigator: GMSNavigator, didUpdateRemainingTime time: TimeInterval) {
    print("Time to next destination: \(time)")
  }

  // Delegate for distance to next destination.
  func navigator(
    _ navigator: GMSNavigator,
    didUpdateRemainingDistance distance: CLLocationDistance
  ) {
    let miles = distance * 0.00062137
    print("Distance to next destination: \(miles) miles.")
  }

  // Delegate for traffic updates to next destination
  func navigator(
    _ navigator: GMSNavigator,
    didUpdate delayCategory: GMSNavigationDelayCategory
  ) {
    print("Delay category to next destination: \(String(describing: delayCategory)).")
  }

  // Delegate for suggested lighting mode changes.
  func navigator(
    _ navigator: GMSNavigator,
    didChangeSuggestedLightingMode lightingMode: GMSNavigationLightingMode
  ) {
    print("Suggested lighting mode has changed: \(String(describing: lightingMode))")

    // Change to the suggested lighting mode.
    mapView.lightingMode = lightingMode
  }

  // Add a button to the view.
  func makeButton() {
    // Start navigation.
    let navButton = UIButton(frame: CGRect(x: 5, y: 150, width: 200, height: 35))
    navButton.backgroundColor = .blue
    navButton.alpha = 0.5
    navButton.setTitle("Start navigation", for: .normal)
    navButton.addTarget(self, action: #selector(startNav), for: .touchUpInside)
    self.mapView.addSubview(navButton)
  }

}

イベント リスナーの Objective-C コードを表示/非表示にする。

/*
 * Copyright 2020 Google Inc. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#import "ViewController.h"
@import GoogleNavigation;

@interface ViewController () <GMSNavigatorListener, GMSRoadSnappedLocationProviderListener>

@end

@implementation ViewController {
  GMSMapView *_mapView;
  CLLocationManager *_locationManager;
}

- (void)loadView {

  _locationManager = [[CLLocationManager alloc] init];

  GMSCameraPosition *camera = [GMSCameraPosition cameraWithLatitude:47.67
                                                          longitude:-122.20
                                                               zoom:14];
  _mapView = [GMSMapView mapWithFrame:CGRectZero camera:camera];

  // Add listeners for GMSNavigator and GMSRoadSnappedLocationProvider.
  [_mapView.navigator addListener:self];
  [_mapView.roadSnappedLocationProvider addListener:self];

  // Set the time update threshold (seconds) and distance update threshold (meters).
  _mapView.navigator.timeUpdateThreshold = 10;
  _mapView.navigator.distanceUpdateThreshold = 100;

  // Show the terms and conditions.
  NSString *companyName = @"Ride Sharing Co.";
  [GMSNavigationServices
   showTermsAndConditionsDialogIfNeededWithCompanyName:companyName
                                              callback:^(BOOL termsAccepted) {
     if (termsAccepted) {
       // Enable navigation if the user accepts the terms.
       _mapView.navigationEnabled = YES;

       // Request authorization to use location services.
       [_locationManager requestAlwaysAuthorization];

     } else {
       // Handle the case when the user rejects the terms and conditions.
     }
   }];

  self.view = _mapView;

  [self makeButton];
}

// Create a route and initiate navigation.
- (void)startNav {
  NSArray<GMSNavigationWaypoint *> *destinations =
  @[[[GMSNavigationWaypoint alloc] initWithPlaceID:@"ChIJnUYTpNASkFQR_gSty5kyoUk"
                                             title:@"PCC Natural Market"],
    [[GMSNavigationWaypoint alloc] initWithPlaceID:@"ChIJJ326ROcSkFQRBfUzOL2DSbo"
                                             title:@"Marina Park"]];

  [_mapView.navigator setDestinations:destinations
                             callback:^(GMSRouteStatus routeStatus){
                               _mapView.navigator.guidanceActive = YES;
                               _mapView.navigator.sendsBackgroundNotifications = YES;
                               _mapView.cameraMode = GMSNavigationCameraModeFollowing;
                               [_mapView.locationSimulator simulateLocationsAlongExistingRoute];
                             }];

  [_mapView.roadSnappedLocationProvider startUpdatingLocation];
}

#pragma mark - GMSNavigatorListener
// Listener for continuous location updates.
- (void)locationProvider:(GMSRoadSnappedLocationProvider *)locationProvider
      didUpdateLocation:(CLLocation *)location {
  NSLog(@"Location: %@", location.description);
}

// Listener to handle speeding events.
- (void)navigator:(GMSNavigator *)navigator
    didUpdateSpeedingPercentage:(CGFloat)percentageAboveLimit {
  NSLog(@"Speed is %f percent above the limit.", percentageAboveLimit);
}

// Listener to handle arrival events.
- (void)navigator:(GMSNavigator *)navigator didArriveAtWaypoint:(GMSNavigationWaypoint *)waypoint {
  NSLog(@"You have arrived at: %@", waypoint.title);
  [_mapView.navigator continueToNextDestination];
  _mapView.navigator.guidanceActive = YES;
}

// Listener for route change events.
- (void)navigatorDidChangeRoute:(GMSNavigator *)navigator {
  NSLog(@"The route has changed.");
}

// Listener for time to next destination.
- (void)navigator:(GMSNavigator *)navigator didUpdateRemainingTime:(NSTimeInterval)time {
  NSLog(@"Time to next destination: %f", time);
}

// Listener for distance to next destination.
- (void)navigator:(GMSNavigator *)navigator
      didUpdateRemainingDistance:(CLLocationDistance)distance {
  double miles = distance * 0.00062137;
  NSLog(@"%@", [NSString stringWithFormat:@"Distance to next destination: %.2f.", miles]);
}

// Listener for traffic updates for next destination
- (void)navigator:(GMSNavigator *)navigator
    didUpdateDelayCategory:(GMSNavigationDelayCategory)delayCategory {
  NSLog(@"Delay category to next destination: %ld.", delayCategory);
}

// Listener for suggested lighting mode changes.
-(void)navigator:(GMSNavigator *)navigator
      didChangeSuggestedLightingMode:(GMSNavigationLightingMode)lightingMode {
  NSLog(@"Suggested lighting mode has changed: %ld", (long)lightingMode);

  // Change to the suggested lighting mode.
  _mapView.lightingMode = lightingMode;
}

#pragma mark - Programmatic UI elements

// Add a button to the view.
- (void)makeButton {
  // Start navigation.
  UIButton *navButton = [UIButton buttonWithType:UIButtonTypeCustom];
  [navButton addTarget:self
                action:@selector(startNav)
      forControlEvents:UIControlEventTouchUpInside];
  [navButton setTitle:@"Navigate" forState:UIControlStateNormal];
  [navButton setBackgroundColor:[UIColor blueColor]];
  [navButton setAlpha:0.5];
  navButton.frame = CGRectMake(5.0, 150.0, 100.0, 35.0);
  [_mapView addSubview:navButton];
}

@end

必要なプロトコルへの準拠を宣言する

ナビゲーション メソッドを実装する前に、ビュー コントローラは次のプロトコルを採用する必要があります。

Swift

class ViewController: UIViewController, GMSNavigatorListener,
GMSRoadSnappedLocationProviderListener {

Objective-C

@interface ViewController () <GMSNavigatorListener,
GMSRoadSnappedLocationProviderListener>

@end

ナビゲーション プロトコルを採用したら、リスナーをビュー コントローラに設定します。たとえば、次のコードを viewDidLoad() メソッドに追加できます。

Swift

mapView.navigator?.add(self) mapView.roadSnappedLocationProvider?.add(self)

Objective-C

[_mapView.navigator addListener:self]; [_mapView.roadSnappedLocationProvider
addListener:self];

位置情報の更新の受信または停止

ユーザーの進行状況を地図上に表示するには、位置情報の更新が必要です。

location インスタンスは、次のプロパティを公開します。

Location プロパティ	説明
標高	現在の高度。
coordinate.latitude	道路にスナップされた現在の緯度座標。
coordinate.longitude	道路にスナップされた現在の経度座標。
コース	現在の方位（度単位）。
速度	現在の速度。
timestamp	現在の測定値の日時。

注意: 位置情報の更新はバッテリー駆動時間に影響する可能性があるため、必要な場合にのみ更新を有効にしてください。stopUpdatingLocation 関数を呼び出します。

位置情報の更新を継続的に受信するには、mapView.roadSnappedLocationProvider.startUpdatingLocation を呼び出し、GMSRoadSnappedLocationProviderListener を使用して didUpdateLocation イベントを処理します。

次の例では、startUpdatingLocation を呼び出しています。

Swift

mapView.roadSnappedLocationProvider.startUpdatingLocation()

Objective-C

[_mapView.roadSnappedLocationProvider startUpdatingLocation];

次のコードは、didUpdateLocation イベントを処理する GMSRoadSnappedLocationProviderListener を作成します。

Swift

func locationProvider(_ locationProvider: GMSRoadSnappedLocationProvider,
didUpdate location: CLLocation) { print("Location: \(location.description)") }

Objective-C

-   (void)locationProvider:(GMSRoadSnappedLocationProvider *)locationProvider
    didUpdateLocation:(CLLocation *)location { NSLog(@"Location: %@",
    location.description); }

アプリがバックグラウンドにあるときに位置情報の更新を受信するには、allowsBackgroundLocationUpdates を true に設定します。

Swift

mapView.roadSnappedLocationProvider.allowsBackgroundLocationUpdates = true

Objective-C

 _mapView.roadSnappedLocationProvider.allowsBackgroundLocationUpdates = YES;

到着イベントの検出

アプリは didArriveAtWaypoint イベントを使用して、目的地に到達したかどうかを検出します。ガイダンスを再開して次のウェイポイントに進むには、continueToNextDestination() を呼び出してガイダンスを再度有効にします。アプリは、continueToNextDestination() を呼び出した後にガイダンスを再度有効にする必要があります。

アプリが continueToNextDestination を呼び出すと、ナビゲータには前の目的地に関するデータが残らなくなります。ルート経路に関する情報を分析する場合は、continueToNextDestination() を呼び出す前にナビゲーターから取得する必要があります。

次のコード例は、didArriveAtWaypoint イベントを処理するメソッドを示しています。

Swift

func navigator(_ navigator: GMSNavigator, didArriveAt waypoint:
GMSNavigationWaypoint) { print("You have arrived at: \(waypoint.title)")
mapView.navigator?.continueToNextDestination()
mapView.navigator?.isGuidanceActive = true }

Objective-C

-   (void)navigator:(GMSNavigator *)navigator
    didArriveAtWaypoint:(GMSNavigationWaypoint *)waypoint { NSLog(@"You have
    arrived at: %@", waypoint.title); [_mapView.navigator
    continueToNextDestination]; _mapView.navigator.guidanceActive = YES; }

ルート変更の最新情報の受信

ルート変更のたびに通知を受け取るには、navigatorDidChangeRoute イベントを処理するメソッドを作成します。新しいルートにアクセスするには、GMSNavigator の routeLegs プロパティと currentRouteLeg プロパティを使用します。

Swift

func navigatorDidChangeRoute(_ navigator: GMSNavigator) { print("The route has
changed.") }

Objective-C

-   (void)navigatorDidChangeRoute:(GMSNavigator *)navigator { NSLog(@"The route
    has changed."); }

目的地までの所要時間の更新の受信

目的地までの所要時間の継続的な更新を受け取るには、didUpdateRemainingTime イベントを処理するメソッドを作成します。time パラメータには、次のデスティネーションに到達するまでの推定時間（秒単位）を指定します。

Swift

func navigator(_ navigator: GMSNavigator, didUpdateRemainingTime time:
TimeInterval) { print("Time to next destination: \(time)") }

Objective-C

-   (void)navigator:(GMSNavigator *)navigator
    didUpdateRemainingTime:(NSTimeInterval)time { NSLog(@"Time to next
    destination: %f", time); }

次の目的地までの推定所要時間の最小変化を設定するには、GMSNavigator の timeUpdateThreshold プロパティを設定します。値は秒単位で指定します。このプロパティが設定されていない場合、サービスはデフォルト値の 1 秒を使用します。

Swift

navigator?.timeUpdateThreshold = 10

Objective-C

navigator.timeUpdateThreshold = 10;

目的地までの距離の更新情報の受信

目的地までの距離の継続的な更新を受け取るには、didUpdateRemainingDistance イベントを処理するメソッドを作成します。distance パラメータには、次の目的地までの推定距離（メートル単位）が指定されます。

Swift

func navigator(_ navigator: GMSNavigator, didUpdateRemainingDistance distance:
CLLocationDistance) { let miles = distance * 0.00062137 print("Distance to next
destination: \(miles) miles.") }

Objective-C

-   (void)navigator:(GMSNavigator *)navigator
    didUpdateRemainingDistance:(CLLocationDistance)distance { double miles =
    distance * 0.00062137; NSLog(@"%@", [NSString stringWithFormat:@"Distance to
    next destination: %.2f.", miles]); }

次の目的地までの推定距離の最小変化を設定するには、GMSNavigator に distanceUpdateThreshold プロパティを設定します（値はメートル単位で指定します）。このプロパティが設定されていない場合、サービスは 1 メートルのデフォルト値を使用します。

Swift

navigator?.distanceUpdateThreshold = 100

Objective-C

navigator.distanceUpdateThreshold = 100;

交通情報の受信

残りのルートの交通状況を継続的に更新するには、didUpdateDelayCategory イベントを処理するメソッドを作成します。delayCategoryToNextDestination の呼び出しは、0 ～ 3 の値を提供する GMSNavigationDelayCategory を返します。カテゴリの更新は、アプリ ユーザーの現在の位置に基づいて行われます。トラフィック データが利用できない場合は、GMSNavigationDelayCategory は 0 を返します。1 ～ 3 の数値は、流れが弱い順から強い順を示します。

Swift

func navigator(_ navigator: GMSNavigator, didUpdate delayCategory:
GMSNavigationDelayCategory) { print("Traffic flow to next destination:
\(delayCategory)") }

Objective-C

-   (void)navigator:(GMSNavigator *)navigator
    didUpdateDelayCategory:(GMSNavigationDelayCategory)delayCategory {
    NSLog(@"Traffic flow to next destination: %ld", (long)delayCategory); }

GMSNavigationDelayCategory プロパティは、次の遅延レベルを公開します。

遅延のカテゴリ	説明
GMSNavigationDelayCategoryNoData	0 - 利用不可、交通状況のデータなし、または
	ルート。
GMSNavigationDelayCategoryHeavy	1 - 重い。
GMSNavigationDelayCategoryMedium	2 - 中程度。
GMSNavigationDelayCategoryLight	3 - ライト。

速度違反の更新の受信

ドライバーが制限速度を超えたときに更新を受け取るには、didUpdateSpeedingPercentage イベントを処理するメソッドを作成します。

Swift

// Listener to handle speeding events. func navigator( _ navigator:
GMSNavigator, didUpdateSpeedingPercentage percentageAboveLimit: CGFloat ) {
print("Speed is \(percentageAboveLimit) above the limit.") }

Objective-C

// Listener to handle speeding events. - (void)navigator:(GMSNavigator
*)navigator didUpdateSpeedingPercentage:(CGFloat)percentageAboveLimit {
NSLog(@"Speed is %f percent above the limit.", percentageAboveLimit); }

推奨される照明モードの変更

照明の推定変化の更新を受け取るには、didChangeSuggestedLightingMode イベントを処理するメソッドを作成します。

Swift

// Define a listener for suggested changes to lighting mode. func navigator(_
navigator: GMSNavigator, didChangeSuggestedLightingMode lightingMode:
GMSNavigationLightingMode) { print("Suggested lighting mode has changed:
\(String(describing: lightingMode))")

 // Make the suggested change. mapView.lightingMode = lightingMode }

Objective-C

// Define a listener for suggested changes to lighting mode.
-(void)navigator:(GMSNavigator *)navigator didChangeSuggestedLightingMode:
(GMSNavigationLightingMode)lightingMode { NSLog(@"Suggested lighting mode has
changed: %ld", (long)lightingMode);

 // Make the suggested change. _mapView.lightingMode = lightingMode; }