XRSession: метод requestHitTestSource()

Метод requestHitTestSource() интерфейса XRSession возвращает Promise, который разрешается объектом XRHitTestSource, который можно передать в XRFrame.getHitTestResults().

options

Объект с параметрами конфигурации, а именно:

space

XRSpace, который будет отслеживаться источником определения попадания.

entityTypes Необязательно

Array, определяющий типы сущностей, которые будут использоваться для создания источника определения попадания. Если тип сущности не указан, массив по умолчанию содержит единственный элемент с типом plane. Возможные типы:

• point: Вычисление результатов определения попадания на основе характерных точек, обнаруженных.
• plane: Вычисление результатов определения попадания на основе обнаруженных реальных плоскостей.
• mesh: Вычисление результатов определения попадания на основе обнаруженных мешей.

offsetRay Необязательно

Объект XRRay, используемый для выполнения определения попадания. Если объект XRRay не предоставлен, новый объект XRRay создается без параметров.

A Promise, который разрешается объектом XRHitTestSource.

Вместо генерации истинных исключений, requestHitTestSource() отклоняет возвращенное promise с DOMException, а именно, одним из следующих:

NotSupportedError DOMException

Выбрасывается, если hit-test не является включенной функцией в XRSystem.requestSession().

InvalidStateError DOMException

Выбрасывается, если сессия уже завершена.

NotAllowedError DOMException

Выбрасывается, если количество запросов чрезмерно. Некоторые браузеры могут ограничивать использование по соображениям конфиденциальности.

Для запроса источника определения попадания запустите XRSession с включенной функцией сессии hit-test. Затем настройте источник определения попадания и сохраните его для последующего использования в цикле обработки кадров, и вызовите XRFrame.getHitTestResults() для получения результата.

const xrSession = navigator.xr.requestSession("immersive-ar", {
  requiredFeatures: ["local", "hit-test"],
});

let hitTestSource = null;

xrSession
  .requestHitTestSource({
    space: viewerSpace, // obtained from xrSession.requestReferenceSpace("viewer");
    offsetRay: new XRRay({ y: 0.5 }),
  })
  .then((viewerHitTestSource) => {
    hitTestSource = viewerHitTestSource;
  });

// frame loop
function onXRFrame(time, xrFrame) {
  let hitTestResults = xrFrame.getHitTestResults(hitTestSource);

  // do things with the hit test results
}

• XRSession.requestHitTestSourceForTransientInput()