XRSession: метод requestHitTestSourceForTransientInput()

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

options

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

profile

Строка, определяющая имя профиля входного источника временного входного источника, который будет использоваться для вычисления результатов проверки на соответствие.

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

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

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

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

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

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

Вместо того, чтобы выбрасывать истинные исключения, requestHitTestSourceForTransientInput() отклоняет возвращённый промис с DOMException, а именно, одним из следующих:

NotSupportedError DOMException

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

InvalidStateError DOMException

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

NotAllowedError DOMException

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

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

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

let transientHitTestSource = null;

xrSession
  .requestHitTestSourceForTransientInput({
    profile: "generic-touchscreen",
    offsetRay: new XRRay(),
  })
  .then((touchScreenHitTestSource) => {
    transientHitTestSource = touchScreenHitTestSource;
  });

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

  // do things with the transient hit test results
}

• XRSession.requestHitTestSource()