Table of Contents

Class ARKitFrameSource

Переключиться на руководство

Пространство имен
easyar
Сборка
EasyAR.Sense.dll

Компонент easyar.ARKitCameraDevice для управления устройством камеры ARKit на сцене, предоставляющий расширение функциональности в среде Unity.

Этот источник кадров является устройством отслеживания движения, которое выводит данные о движении в ARSession.

public class ARKitFrameSource : FrameSource
Наследование
ARKitFrameSource
Наследуемые члены

Поля

DesiredFocusMode

Желаемый режим фокусировки. Изменения вступают в силу только при внесении до события DeviceOpened или метода OnEnable.

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

public ARKitCameraDeviceFocusMode DesiredFocusMode

Свойства

Camera

Предоставляется только при создании нового источника кадров. Доступно только во время процесса Assemble().

На настольных устройствах или телефонах эта камера представляет Camera в виртуальном мире, соответствующее реальному камере в физической среде; ее матрица проекции и положение будут соответствовать реальной камере и контролироваться EasyAR. На гарнитурах эта камера используется только для отображения диагностического текста перед глазами, не для рендеринга изображения, и камера не контролируется EasyAR.

protected override Camera Camera { get; }

CameraCandidate

Альтернатива для Camera, действует только если не используется Unity XR Origin. Если не установлено, используется Camera.main.

public Camera CameraCandidate { get; set; }

CameraFrameStarted

Предоставляется только при создании нового источника кадров. Доступно в течение всего жизненного цикла ARSession.

Начался ли ввод кадров с камеры.

protected override bool CameraFrameStarted { get; }

DesiredFrameRate

Желаемая частота кадров изображения камеры. Изменения вступают в силу только при внесении до события DeviceOpened.

Используется ближайшее значение из SupportedFrameRate. Если не установлено, используется значение по умолчанию.

public Optional<double> DesiredFrameRate { get; set; }

DesiredSize

Желаемый размер изображения камеры. Изменения вступают в силу только при внесении до события DeviceOpened.

Используется ближайший размер из значений в SupportedSize. Если не установлено, используется значение по умолчанию.

public Optional<Vector2Int> DesiredSize { get; set; }

DeviceCameras

Предоставляется только при создании нового источника кадров. Доступно только когда CameraFrameStarted равно true.

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

Убедитесь, что значение корректно, когда CameraFrameStarted равно true.

protected override List<FrameSourceCamera> DeviceCameras { get; }

Display

Предоставляется только при создании нового источника кадров. Доступно только во время процесса Assemble().

Предоставляет информацию о системе отображения. Вы можете использовать DefaultSystemDisplay или DefaultHMDDisplay для получения информации по умолчанию.

protected override IDisplay Display { get; }

FrameRate

Текущая частота кадров устройства. Доступно только при значении Opened true.

Установка (set) использует ближайшее значение из SupportedFrameRate.

public double FrameRate { get; set; }

IsAvailable

Предоставляется только при создании нового источника кадров. Доступно только во время процесса Assemble().

Доступен ли текущий источник кадров.

Если значение равно null, будет вызван CheckAvailability(), и значение будет получено после завершения Coroutine.

protected override Optional<bool> IsAvailable { get; }

IsCameraUnderControl

Предоставляется только при создании нового источника кадров. Доступно только во время процесса Assemble().

Когда значение равно true, сессия будет обновлять transform камеры и рендерить изображение с камеры.

При создании расширения для гарнитуры оно должно быть false. Вы должны полностью контролировать 3D-камеру в сцене. Вы должны обрабатывать рендеринг камеры, особенно в режиме VST.

protected override bool IsCameraUnderControl { get; }

IsHMD

Предоставляется только при создании нового источника кадров. Доступно только во время процесса Assemble().

Является ли текущий источник кадров гарнитурой. Если это гарнитура, диагностическая информация будет отображаться на 3D-панели перед камерой.

Некоторые фильтры кадров могут работать по-разному на устройстве.

protected override bool IsHMD { get; }

Opened

Открыта ли камера.

public bool Opened { get; }

Size

Текущий размер изображения. Доступно только при значении Opened true.

Установка (set) использует ближайший размер из значений в SupportedSize.

Если размер изображения изменен во время записи FrameRecorder, запись данных прекратится; для продолжения записи необходимо остановить и начать заново.

public Vector2Int Size { get; set; }

SupportedFrameRate

Все поддерживаемые частоты кадров для текущего устройства. Доступно только при значении Opened true.

public List<double> SupportedFrameRate { get; }

SupportedSize

Все поддерживаемые размеры изображения для текущего устройства. Доступно только при значении Opened true.

public List<Vector2Int> SupportedSize { get; }

enabled

Начинает/останавливает захват видеопотока во время работы ARSession. После запуска сессии захват начнется только когда MonoBehaviour.enabled равно true.

public bool enabled { get; set; }

Методы

Close()

Закрыть устройство.

public void Close()

OnSessionStart(ARSession)

Предоставляется только при создании нового источника кадров. Доступно только во время процесса StartSession().

Обрабатывает запуск сессии, если этот источник кадров был собран в Assembly. Этот метод предназначен для отложенной инициализации; здесь можно выполнить специфичную для AR инициализацию.

protected override void OnSessionStart(ARSession session)

Параметры

session

OnSessionStop()

Предоставляется только при создании нового источника кадров. Доступно во время StopSession(bool) или других процессов остановки/повреждения сессии.

Обрабатывает остановку сессии, если этот источник кадров был собран в Assembly. Здесь можно уничтожить ресурсы, созданные в StartSession() и во время работы сессии, и восстановить внутреннее состояние. Этот метод гарантированно вызывается перед уничтожением сессии. Если источник кадров уничтожается до сессии, он не будет вызван, и сессия будет повреждена.

protected override void OnSessionStop()

Open()

Открыть устройство. Если Open() и Close() не вызваны вручную, ARSession автоматически вызовет Open() после запуска.

public void Open()

События

DeviceClosed

Событие закрытия устройства.

public event Action DeviceClosed

DeviceOpened

Событие открытия устройства, где bool указывает на успешность операции.

public event Action<bool, PermissionStatus, string> DeviceOpened