WebXR 平面検出モジュール

const session = await navigator.xr.requestSession("immersive-ar", {
  requiredFeatures: ["plane-detection"]
});

enum XRPlaneOrientation {
    "horizontal",
    "vertical"
};

[Exposed=Window]
interface XRPlane {
    [SameObject] readonly attribute XRSpace planeSpace;

    readonly attribute FrozenArray<DOMPointReadOnly> polygon;
    readonly attribute XRPlaneOrientation? orientation;
    readonly attribute DOMHighResTimeStamp lastChangedTime;
    readonly attribute DOMString? semanticLabel;
};

[Exposed=Window]
interface XRPlaneSet {
  readonly setlike<XRPlane>;
};

partial interface XRFrame {
  readonly attribute XRPlaneSet detectedPlanes;
};

partial interface XRSession {
  Promise<undefined> initiateRoomCapture();
};

このメソッドが呼び出されたとき、ユーザーエージェントは次の手順を実行しなければなりません。

1. session を this とします。

2. promise を、session の関連するレルムにおける新しい Promise とします。

3. session の ended 値が `true` の場合、promise を "InvalidStateError" DOMException で拒否し、 promise を返します。

4. ルームキャプチャ完了が `true` の場合、 promise を "InvalidStateError" DOMException で拒否し、promise を返します。

5. plane-detection 機能記述子が、 session のXR デバイスにおける session のモード用の有効な機能のリストに含まれていない場合、 promise を "NotSupportedError" DOMException で拒否し、 promise を返します。

6. session のXR デバイスが手動キャプチャをサポートしていない場合、または XRSystem がルームキャプチャは不要であると判断した場合:

   1. session のルームキャプチャ完了を `true` に設定します。

   2. promise を解決します。

   3. promise を返します。

7. 次の手順を実行するタスクをキューに入れます。

   1. session のXR デバイスのルームキャプチャメソッドを呼び出して結果を待ち、その結果を result に代入します。

   2. 次の手順を実行します。

      result が `true` の場合:

      promise を解決します。

      それ以外の場合:

      promise を "OperationError" DOMException で拒否します。

   3. session のルームキャプチャ完了を `true` に設定します。

8. promise を返します。

frame の平面を 更新するために、ユーザーエージェントは次の手順を実行しなければなりません。

1. session を、frame のセッションとします。

2. device を、session のXR デバイスとします。

3. plane-detection 機能記述子が、 session のモード用の device の有効な機能のリストに含まれていない場合、これらの手順を中止します。

4. trackedPlanes を、frame の時刻における追跡中の平面を取得するために、device のネイティブ平面検出機能を呼び出した結果とします。

5. trackedPlanes 内の各 native plane について、次を実行します。

   1. 必要に応じて、native plane が trackedPlanes に存在しなかったものとして扱い、次の項目へ進みます。この方法で項目を 無視するかどうかを判断するために使用できる基準については、§ 6 プライバシーとセキュリティに関する考慮事項を参照してください。

   2. session の追跡される平面の集合に、 native plane に対応するオブジェクト plane が含まれている場合、 plane、native plane、および frame を指定して平面オブジェクトを更新するアルゴリズムを呼び出し、次の 項目へ進みます。

   3. plane を、native plane および frame を指定して平面オブジェクトを作成する アルゴリズムを呼び出した結果とします。

   4. plane を session の追跡される平面の集合に追加します。

6. このアルゴリズムの呼び出し中に作成も更新もされなかった各オブジェクトを、session の追跡される 平面の集合から削除します。

7. frame の detectedPlanes を追跡される平面の集合に設定します。

ネイティブ平面オブジェクト native plane および XRFrame frame から平面 オブジェクトを作成するために、ユーザーエージェントは次の手順を実行しなければなりません。

1. result を XRPlane の新しいインスタンスとします。

2. result のネイティブエンティティを native plane に設定します。

3. result の planeSpace を、session が frame の session に設定され、ネイティブ原点が native plane の ネイティブ原点を追跡するよう設定された新しい XRSpace オブジェクトに設定します。

4. result、native plane、および frame を指定して平面オブジェクトを更新するアルゴリズムを呼び出します。

5. result を返します。

このように作成された平面オブジェクト result は、渡されたネイティブ平面 オブジェクト native plane に対応するといいます。

ネイティブ平面オブジェクト native plane および XRFrame frame から平面 オブジェクトを更新するために、ユーザーエージェントは次の手順を実行しなければなりません。

1. plane のフレームを frame に設定します。

2. native plane が基盤となるシステムによって垂直として分類される場合、 plane の orientation を "vertical" に設定します。それ以外で、native plane が基盤となるシステムによって水平として分類される場合、 plane の orientation を "horizontal" に設定します。それ以外の場合、plane の orientation を null に設定します。

3. plane の polygon を、ネイティブ平面における多角形の表現の違いを考慮するために必要なすべての変換を行った、 native plane の多角形を表す新しい頂点配列に設定します。

4. plane の semanticLabel を、セマンティックラベルを含む新しい文字列に設定します。

5. 必要に応じて、§ 6 プライバシーとセキュリティに関する考慮事項で説明されているように、 plane の polygon の詳細度を低下させます。

6. plane の lastChangedTime を時刻に設定します。

// `planes` は、アプリケーションが認識しているすべての検出済み平面と、
// それらが更新されたタイムスタンプを追跡します。最初は空のマップです。
const planes = Map();

function onXRFrame(timestamp, frame) {
  const detectedPlanes = frame.detectedPlanes;

  // まず、認識していた平面のいずれかが追跡されなくなったかどうかを確認します。
  for (const [plane, timestamp] of planes) {
    if(!detectedPlanes.has(plane)) {
      // 削除された平面を処理します。`plane` は前のフレームには存在しましたが、
      // 現在は追跡されていません。

      // その平面が存在しなくなったことが分かっているため、マップから削除します。
      planes.delete(plane);
    }
  }

  // 次に、引き続き追跡されているすべての平面を処理します。
  // これには、以前に確認した追跡中の平面（更新されている可能性があります）と、
  // 新しい平面の両方が含まれます。
  detectedPlanes.forEach(plane => {
    if (planes.has(plane)) {
      // 以前に確認した平面を処理します。

      if(plane.lastChangedTime > planes.get(plane)) {
        // 更新された、以前に確認した平面を処理します。
        // これは、平面のいずれかのプロパティが以前とは異なることを意味します。
        // 最も可能性が高いのは、多角形が変更されたことです。

        ... // 平面を描画する、または描画用に準備するなど。

        // 平面を更新した時刻を更新します。
        planes.set(plane, plane.lastChangedTime);
      } else {
        // 現在のフレームで更新されなかった、以前に確認した平面を処理します。
        // 他の空間を基準とする平面の姿勢は変更されている可能性があることに注意してください。
      }
    } else {
      // 新しい平面を処理します。

      // 平面を更新した時刻を設定します。
      planes.set(plane, plane.lastChangedTime);
    }

    // 平面を以前に確認したかどうか、または更新されたかどうかにかかわらず、
    // その姿勢は変更されている可能性があります。
    const planePose = frame.getPose(plane.planeSpace, xrReferenceSpace);
  });

  frame.session.requestAnimationFrame(onXRFrame);
}