【初心者向け】ARCoachingOverlayViewの使い方

この記事では、ARKitのフレームワークであるARCoachingOverlayViewの使い方についてわかりやすく解説します。

ARCoachingOverlayViewとは

ARCoachingOverlayViewは、ARKitフレームワークで提供されるビューコンポーネントの1つで、AR体験を改善するために使用されます。このビューを使用すると、AR体験の中でユーザーにガイドやヒントを提供することができます。例えば、カメラを正しい位置に置いたり、オブジェクトを正確にタップしたりする方法を示すことができます。

ARCoachingOverlayViewは、ARセッションのステータスに応じて表示/非表示を切り替えることができます。セッションが実行中である場合は、ARCoachingOverlayViewが表示され、セッションが一時停止している場合は、非表示になります。

ARCoachingOverlayViewの実装手順

以下は、ARCoachingOverlayViewを実装する手順です。

1: ARCoachingOverlayViewのインスタンスを作成する
ARCoachingOverlayViewを使用するには、まずARCoachingOverlayViewのインスタンスを作成する必要があります。以下のように、ARSCNViewやARSKViewなどのビューと同じ方法でインスタンスを作成します。

let coachingOverlay = ARCoachingOverlayView()

2: ガイドに使用するテキストを設定する
ARCoachingOverlayViewのコーチングガイドには、タイトル、説明、イメージを表示できます。以下のように、それぞれのプロパティに値を設定します。

coachingOverlay.goal = .horizontalPlane
coachingOverlay.activatesAutomatically = true
coachingOverlay.session = sceneView.session

coachingOverlay.goal = .tracking
coachingOverlay.activatesAutomatically = true
coachingOverlay.session = sceneView.session

coachingOverlay.setActive(true, animated: true)

3: ARCoachingOverlayViewをビューに追加する
ARCoachingOverlayViewをビューに追加するには、以下のようにします。

sceneView.addSubview(coachingOverlay)

4: ARCoachingOverlayViewの表示/非表示を制御する
ARCoachingOverlayViewを表示/非表示にするには、以下のようにします。

// ARセッションが実行中の場合にのみ、ARCoachingOverlayView
override func viewWillAppear(_ animated: Bool) {
    super.viewWillAppear(animated)
    let configuration = ARWorldTrackingConfiguration()
    sceneView.session.run(configuration)
    coachingOverlay.setActive(true, animated: true)
}

override func viewWillDisappear(_ animated: Bool) {
    super.viewWillDisappear(animated)
    sceneView.session.pause()
    coachingOverlay.setActive(false, animated: true)
}

5: ARCoachingOverlayViewのデリゲートを設定する
ARCoachingOverlayViewには、デリゲートを設定することができます。デリゲートを設定することで、ARCoachingOverlayViewに関するイベントを受け取ることができます。以下のように、ARCoachingOverlayViewDelegateプロトコルを満たすオブジェクトを作成し、デリゲートプロパティに設定します。

class ViewController: UIViewController, ARCoachingOverlayViewDelegate {

    override func viewDidLoad() {
        super.viewDidLoad()

        // ARCoachingOverlayViewのインスタンスを作成する
        let coachingOverlay = ARCoachingOverlayView()

        // デリゲートを設定する
        coachingOverlay.delegate = self

        // ガイドに使用するテキストを設定する
        coachingOverlay.goal = .horizontalPlane
        coachingOverlay.activatesAutomatically = true
        coachingOverlay.session = sceneView.session

        // ARCoachingOverlayViewをビューに追加する
        sceneView.addSubview(coachingOverlay)

        // ARCoachingOverlayViewの表示/非表示を制御する
        coachingOverlay.setActive(true, animated: true)
    }

    // ARCoachingOverlayViewDelegateメソッド
    func coachingOverlayViewWillActivate(_ coachingOverlayView: ARCoachingOverlayView) {
        print("ARCoachingOverlayViewがアクティブになります。")
    }

    func coachingOverlayViewDidDeactivate(_ coachingOverlayView: ARCoachingOverlayView) {
        print("ARCoachingOverlayViewが非アクティブになりました。")
    }

    func coachingOverlayViewDidRequestSessionReset(_ coachingOverlayView: ARCoachingOverlayView) {
        print("ARセッションがリセットされました。")
    }
}

参考になれば幸いです！