Scanning Framework入門

このガイドでは、アプリにスキャンを導入する方法について説明します。基本フロー で、ユーザーがアプリを使ってスキャンする方法を確認の上、以下の ステップ に従ってアプリにスキャンを実装してください。

注釈

この機能はパブリックベータ版であり、機能性は将来のリリースで変更される可能性があります。ARDK機能のローンチタイプ（パブリックベータ版など）に関する詳細については、Lightshipのローンチタイプをご参照ください。

ロケーションをスキャンすると、画像のコレクションが作成され、テクスチャ付きの3Dメッシュに処理されます。一例をご紹介します。

ProcessedScan

現実世界のオブジェクトをスキャンし、テクスチャメッシュを移動可能なオブジェクトとしてアプリに取り込むことができます。または、ロケーションをスキャンして、ゲーム内でVPSロケーションを使用できるように VPS Wayspot として作動させることができます。

基本フロー

ユーザーがScanning Frameworkを使用してスキャンする際の基本フローは以下のとおりです。

The user presses Scan to create a scan using their device, scanning the desired object with their device camera, and pressing Stop. This triggers calls to ARScanManager.StartScanning() and StopScanning() and optionally displays scan visualizer output while the user is scanning with their device.
The user then presses Process to process the scan. This action triggers a call to ARScanManager.StartProcessing(). As the scan is processed by the Scanning Framework, your app can use ARScanManager.GetScanProgress() to check the progress and update a progress bar.
Once the Scanning Framework has finished processing the scan, the user can retrieve the resulting textured mesh. The user can also press Save to save the scan, which triggers a call from your app to ARScanManager.SaveCurrentScan() and saves the scan locally.

前提条件

Scanning Frameworkを使用するには、ARDKのAPIキーが必要になります。お持ちでない場合は、Lightshipアカウントダッシュボードに移動し、 プロジェクト の New Project（新しいプロジェクト） をクリックして新しいプロジェクトを作成し、 Create New Key（新しいキーを作成する） をクリックして、そのプロジェクトのAPIキーを作成します。

手順

2. Add Scanning Framework, Scanning UI, and Scanning Logic to Your Scene

空の GameObject をシーンに追加します。新しいスクリプトコンポーネント ScanningExampleManager を GameObject に追加し、スキャン用のUIハンドラを指定します。 ARScanManager のシリアライズ可能なフィールドを ScanningExampleManager に追加します。

using Niantic.ARDK.AR;
using Niantic.ARDK.AR.Scanning;
using Niantic.ARDK.Extensions;
using Niantic.ARDK.Extensions.Scanning;

public class ScanningExampleManager : MonoBehaviour
{
    [SerializeField]
    [Tooltip("The scene's ARScanManager")]
    private ARScanManager _scanManager;
    // ...
}

ARScanManager には、Scanning Frameworkで使いやすいマネージャーインターフェイスが搭載されています。 ARScanManager コンポーネントを ScanningExampleManager に追加し、 ScanningExampleManager の Scan Manager フィールドをこの ARScanManager インスタンスに設定します。
ScanningExampleManager でスキャンやUIのイベントハンドラを処理するためのUIをシーンに追加します。
1. シーンにUnity Canvasを作成し、Scan（スキャン）、Stop（停止） の各ボタンを追加します。
2. スキャンを開始するには、 ScanButtonPressed() メソッドを ScanningExampleManager に追加し、Scan ボタンの OnClick() に接続します。 ScanButtonPressed() でARScanManager.StartScan()` を呼び出し、スキャンを開始します。
```
public void ScanButtonPressed()
{
    _scanManager.StartScanning();
}
```
3. Scanning Frameworkには、スキャン中に提供される視覚化情報を制御するオプションがあります。この情報は、 ARScanManager で enableRaycastVisualization を使用するか、 enableVoxelVisualization フィールドで確認できます。
4. ユーザーは、デバイスのカメラをスキャンするオブジェクトに向け、オブジェクトの周りを移動する必要があります。スキャンの方法に関する基本的なガイダンスについては、スキャンのベストプラクティスを参照してください。
5. スキャン処理では、必要に応じて、ユーザーがスキャン内容を理解しやすいように視覚化を表示できます。ビジュアライザーを追加する方法は、後半の「スキャンの視覚化を追加する」のステップをご覧ください。
6. スキャンを終了するには、 StopButtonPressed() メソッドを ScanningExampleManager に追加し、Stop（停止） ボタンの OnClick() に接続します。スキャンを停止するには、 StopButtonPressed() で ARScanManager.StopScanning を呼び出します。
```
public void StopButtonPressed()
{
    _scanManager.StopScanning();
}
```
UIをシーンに追加してスキャン処理を行い、 ScanningExampleManager でUIイベントハンドラを指定します。
1. Once the user has finished scanning, the Scanning Framework needs to process and optimize the mesh. You can start processing the scan using ARScanManager.StartProcessing() as soon as ARScanManager.ScannerState is IScanner.State.ScanCompleted, but for this example we'll use a button to let the user manually start processing the scan.
2. Process（処理）、Cancel（キャンセル） の各ボタンをUnity Canvasに追加します。
  1. また、Progress（進行状況） という名前のスライダーをCanvasに追加します。
3. スキャン完了後に処理を開始するには、 ProcessButtonPressed() メソッドを ScanningExampleManager に追加し、Process（処理） ボタンの OnClick() に接続します。 ProcessButtonPressed() で、 ScannerState が ScanCompleted になっていることを確認し、 ARScanManager.StartProcessing() を呼び出してスキャン処理を開始します。
```
public void ProcessButtonPressed()
{
    IScanner.State state = _scanManager.ScannerState;
    if (state == IScanner.State.ScanCompleted)
    {
        // Start processing scan 
        _scanManager.StartProcessing();
    }
}
```
4. Scanning Frameworkには、スキャンの処理方法を制御するオプションがあります。この情報は、 ARScanManager で reconstructionMode を使用するか、 enableVoxelVisualization フィールドで確認できます。
5. この画像は、Unityの ARScanManager 設定のUIです。
6. To show how far along the scan process is, connect your Progress Slider to your ScannerExampleManager and update the slider value using ARScanManager.GetScanProgress().
```
[SerializableField]
private Slider _progressBar;

private void Update()
{
    IScanner.State state = _scanManager.ScannerState; 

    if (state == IScanner.State.Processing)
    {
        _progressBar.gameObject.SetActive(true);
        _progressBar.value = _scanManager.GetScanProgress();
    }
    else
    {
        _progressBar.gameObject.SetActive(false);
    }
}
```
7. To let the user cancel the scan processing, add a CancelButtonPressed() method in your ScanningExampleManager and connect it to your Cancel button's OnClick(). In CancelButtonPressed(), call ARScanManager.CancelProcessing() to cancel the in-progress scan processing.
```
public void CancelProcessButtonPressed()
{
    _scanManager.CancelProcessing();
}
```

4. Handle Processed Scan Mesh Results

処理済みのスキャンのメッシュを受け取るためのイベントハンドラを追加します。

In your ScanningExampleManager add a ARScanManager.ScanProcessed event handler to receive the processed mesh.
Create a prefab to display the result mesh and assign it to the component. The prefab should have a MeshFilter and MeshRenderer component. Create a GameObject in the scene to be the parent of this prefab. You can consult the Assets/ARDKExamples/Scanning/ScannedObjectPrefab.prefab in the ARDK Examples package for an example.
Add the parent object to the script as _scannedObjectParent. When you instantiate the scannedObject, Unity needs this parent.

The following example sets the ARScanManager.ScanProcessed handler to ScanResultHandler. In ScanResultHandler an instance of _scannedObjectPrefab and _scannedObjectParent is required to initiate the scanned object.

private GameObject scannedObject;

[SerializeField]
private GameObject _scannedObjectPrefab;
[SerializeField]
private GameObject _scannedObjectParent;

private void Start()
{
    // ...other init code as needed...
    _scanManager.ScanProcessed += ScanResultHandler;
}

private void ScanResultHandler(TexturedMesh texturedMesh, IScanner.State state, Vector3 centerPosition)
{
    if (texturedMesh != null) 
    {
        if (scannedObject == null)
        {
            scannedObject = Instantiate(_scannedObjectPrefab, _scannedObjectParent);
        }
        Bounds meshBoundary = texturedMesh.mesh.bounds;
        scannedObject.transform.localPosition = -1 * meshBoundary.center;
        scannedObject.transform.localScale = Vector3.one / meshBoundary.extents.magnitude;
        scannedObject.GetComponent<MeshFilter>().sharedMesh = texturedMesh.mesh;
        if (texturedMesh.texture != null)
            scannedObject.GetComponent<Renderer>().material.mainTexture = texturedMesh.texture;
    }
} 

ユーザーが処理済みのスキャンのメッシュをローカルデバイスに保存するためのUIを追加します。
1. Unity Canvasに、Save（保存） ボタンを追加します。
2. To let the user save the processed scan, add a SaveButtonPressed() method in your ScanningExampleManager and connect it to your Save button's OnClick(). In SaveButtonPressed(), call ARScanManager.SaveCurrentScan() to save the scan on the local device.
```
public void SaveButtonPressed()
{
    _scanManager.SaveCurrentScan();
}
```
3. また、ユーザーが別のスキャンを開始できるように、 ARScanManager.Restart() を使用してScan Managerを再起動することもできます。
4. ARScanManager also provides methods to manage locally saved scans, such as getting a list of saved scans via ARScanManager.GetSavedScans(), or deleted a saved scan via ARScanManager.DeleteScan().

この画像は、処理済みのスキャンのメッシュがデバイスに表示されている様子です。

ProcessedScan

次の手順

次に、VPSのスキャンの実行については VPSのスキャンを、スキャンの視覚化と処理についてはスキャンの設定を参照してください。