Table of Contents

Namespace easyar

Классы

APIExtend

Расширяет EasyAR Sense API и Unity API, предоставляя удобство для операций, таких как преобразование данных.

APIKeyAccessData

Данные аутентификации облачной службы EasyAR с использованием API Key. Для получения связанных данных посетите EasyAR Developer Center (https://www.easyar.cn).

ARAssembly

Assembly компонентов AR. Реализует типичную сборку всех компонентов EasyAR Sense.

ARCoreARFoundationFrameSource

Пользовательский frame source, соединяющий вывод AR Foundation ARCore с вводом EasyAR в сцене. Он предоставляет поддержку AR Foundation через функцию custom camera EasyAR Sense.

Этот frame source является устройством motion tracking и выводит данные движения в ARSession.

Для использования этого frame source требуется ``AR Foundation``. Необходимо настроить AR Foundation согласно официальной документации.

ARCoreFrameSource

A MonoBehaviour that controls the ARCore camera device (easyar.ARCoreCameraDevice) in the scene and provides functional extensions in the Unity environment.

This frame source is a motion tracking device and outputs motion data in ARSession.

AREngineFrameSource

A custom frame source that connects the output of the AREngine camera device in the scene to EasyAR input. It provides Huawei AR Engine support through the custom camera feature of EasyAR Sense.

This frame source is a motion tracking device and outputs motion data in ARSession.

This frame source does not use ``Huawei AR Engine Unity SDK`` and it does not need to be added.

ARFoundationFrameSource

A custom frame source that connects AR Foundation output in the scene to EasyAR input. It provides AR Foundation support through the custom camera feature of EasyAR Sense.

This frame source is a motion tracking device and outputs motion data in ARSession.

To use this frame source, ``AR Foundation`` is required. You need to configure AR Foundation according to the official documentation.

ARKitARFoundationFrameSource

Пользовательский frame source, соединяющий вывод AR Foundation ARKit с вводом EasyAR в сцене. Он предоставляет поддержку AR Foundation через функцию custom camera EasyAR Sense.

Этот frame source является устройством motion tracking и выводит данные движения в ARSession.

Для использования этого frame source требуется ``AR Foundation``. Необходимо настроить AR Foundation согласно официальной документации.

ARKitFrameSource

A MonoBehaviour that controls the ARKit camera device (easyar.ARKitCameraDevice) in the scene and provides functional extensions in the Unity environment.

This frame source is a motion tracking device and outputs motion data in ARSession.

ARSession

A MonoBehaviour that controls an AR session in the scene. A session contains a group of components assembled into ARAssembly and controls the data flow of the entire lifecycle. This component is the entry point for AR. Multiple active instances are not allowed at the same time.

All functions of EasyAR components can be used only after StartSession().

The relative transform between Camera and some AR components is controlled by session. One of the objects is called CenterObject; it stays still in the scene, and other objects move relative to this CenterObject. This object is selected according to the value of CenterMode. For more details, see the description of ARSession.ARCenterMode.

ARSession.FlipOptions

Параметры зеркального рендеринга.

ARSessionFactory

Фабрика ARSession.

ARSessionFactory.Resources

Ресурсы, необходимые для создания соответствующих компонентов.

ActiveController

MonoBehaviour, управляющий activeSelf.

Стратегии по умолчанию: TargetController по умолчанию использует ActiveWhileTracked, а XROriginChildController по умолчанию использует ActiveAfterFirstTracked.

Можно использовать OverrideStrategy, чтобы переопределить стратегию по умолчанию. Установите MonoBehaviour.enabled в false, чтобы отключить управление.

AppSecretAccessData

Данные аутентификации облачной службы EasyAR с использованием App Secret. Для получения связанных данных посетите EasyAR Developer Center (https://www.easyar.cn).

AssembleOptions

Параметры сборки для ARSession.

AssembleOptions.DeviceListDownload

Параметры загрузки списка устройств.

Buffer

Buffer хранит исходный массив байтов и может использоваться для доступа к данным изображения. В Java API можно получить buffer из `Image`_, а затем copy данные в массив байтов Java. Во всех версиях EasyAR Sense можно получать доступ к данным изображения. См. `Image`_.

BufferDictionary

Отображение путей файлов в `Buffer`_. Используется для представления нескольких файлов, размещенных в памяти.

BufferPool

BufferPool реализует пул памяти. Он может использоваться для функций, которые многократно выделяют память одинакового размера, например для пользовательского доступа к камере, уменьшая время выделения памяти.

CameraDeviceDisplay

Отображение обычной камеры. Можно имитировать поворот экрана в Unity Editor или на ПК для особых требований к размещению экрана.

CameraDeviceFrameSource

A MonoBehaviour that controls easyar.CameraDevice in the scene and provides functional extensions in the Unity environment.

This frame source is not a motion tracking device and does not output motion data in ARSession.

CameraImageRenderer

MonoBehaviour, управляющий рендерингом изображения camera в сцене. Действителен только когда IsCameraUnderControl у frame source session имеет значение true.

CameraParameters

camera parameters, включая размер изображения, focal length, principal point, тип camera и угол поворота camera относительно device natural orientation.

CloudLocalizerFrameFilter

MonoBehaviour, который управляет easyar.CloudLocalizer в scene и предоставляет функциональные расширения в среде Unity.

В большинстве случаев следует использовать MegaTrackerFrameFilter.

CloudRecognizationResponse

Ответ на запрос распознавания.

CloudRecognizerFrameFilter

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

DenseSpatialMapBlockController

MonoBehaviour, управляющий блоками сетки карты, созданными easyar.DenseSpatialMap в сцене.

DenseSpatialMapBuilderFrameFilter

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

DeviceFrameSourceCamera

Device camera, предоставляющая данные frame camera во frame source.

DeviceFrameSourceCamera.CameraExtrinsics

Внешние параметры камеры, обычно калибровочная матрица, выражающая физическое смещение камеры относительно начала pose устройства/головы.

DiagnosticsController

Diagnostics controller для текущего ARSession. Пусть он будет вашим помощником в разработке, а не первым отключаемым компонентом.

DiagnosticsController.MessageOutputOptions

Параметры вывода сообщений.

Display

Устройство отображения.

DisplayEmulator

Эмулятор поворота.

EasyARCameraImageRendererFeature

Render feature для рендеринга изображений камеры AR-устройства при использовании URP. Этот render feature нужно добавить в список renderer feature объекта forward renderer asset.

EasyARController

Статический прокси для класса EasyAR Sense Engine, в основном используемый для инициализации Sense.

EasyARSettings

Конфигурация information for the EasyAR Sense Unity Plugin.

EasyARSettings.LibVariantConfig

Конфигурация варианта библиотеки EasyAR Sense.

EasyARSettings.Permission

Конфигурация разрешений.

EasyARSettings.TargetGizmoConfig

Конфигурация Gizmos для Target.

EasyARSettings.TargetGizmoConfig.ImageTargetConfig

Конфигурация Gizmos для ImageTarget.

EasyARSettings.TargetGizmoConfig.ObjectTargetConfig

Конфигурация Gizmos для ObjectTarget.

EasyARSettings.UnityXROptions

Параметры конфигурации, связанные с Unity XR Framework.

EasyARSettings.UnityXROptions.AutoSwitchOptions

Параметры автоматического переключения объектов Unity XR, например объектов AR Foundation.

EasyARSettings.UnityXROptions.AutoSwitchOptions.EditorOptions

Параметры режима редактирования.

EasyARSettings.UnityXROptions.AutoSwitchOptions.PlayerOptions

Параметры режима выполнения.

EasyARSettings.Workaround

Workaround for Unity.

EditorCameraDeviceFrameSource

MonoBehaviour, управляющий easyar.CameraDevice в редакторе; предоставляется только для диагностики при разработке. Обычно при использовании этого frame source все видимые эффекты отличаются от работы на устройстве. Его можно использовать для разработки логики приложения, не связанной с AR-эффектами, но нельзя использовать для оценки работы AR, например обнаружения, отслеживания или локализации.

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

EventDumpRecorder

Регистратор дампа событий. Используется для сохранения ключевой диагностической информации в файлы EED. Все члены этого класса являются потокобезопасными.

ExplicitAddressAccessData

Данные аутентификации облачной службы EasyAR, для которых требуется адрес доступа.

ExternalDeviceFrameSource

Frame source, представляющий внешнее устройство. Обычно это head-mounted устройство, в котором рендеринг camera и отслеживание устройства выполняются SDK устройства.

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

При использовании пробных продуктов, например license Personal Edition, пробной XR license или пробного сервиса Mega, на пользовательской камере или гарнитуре EasyAR Sense после каждого запуска перестает отвечать на фиксированное ограниченное время.

ExternalDeviceMotionFrameSource

Frame source, представляющий внешнее устройство с возможностью motion tracking. Обычно представляет head-mounted device, где camera rendering и device tracking выполняются SDK устройства.

Этот frame source является устройством motion tracking и выводит данные движения в ARSession.

Можно наследоваться от него, чтобы реализовать ввод устройства, например headset, но motion tracking нужно реализовать самостоятельно. Motion tracking EasyAR нельзя напрямую использовать на внешних устройствах. Нужно самостоятельно получать изображения и pose data из оборудования или других источников и передавать их в EasyAR. EasyAR не предоставляет возможность получения этих данных, но предоставляет возможность запускать функции EasyAR после передачи данных в EasyAR.

При использовании trial-продуктов, таких как personal license, trial XR license или trial Mega service, на custom camera или headset, EasyAR Sense после каждого запуска перестает отвечать на фиксированное ограниченное время.

ExternalDeviceRotationFrameSource

Frame source, представляющий внешнее устройство с возможностью 3DOF rotation tracking. Обычно представляет head-mounted device, где camera rendering и device tracking выполняются SDK устройства.

Этот frame source является устройством 3DOF rotation tracking и выводит данные вращения в ARSession.

Можно наследоваться от него, чтобы реализовать ввод устройства, например headset, но tracking нужно реализовать самостоятельно. 3DOF rotation tracking EasyAR нельзя напрямую использовать на внешних устройствах. Нужно самостоятельно получать изображения и данные вращения из оборудования или других источников и передавать их в EasyAR. EasyAR не предоставляет возможность получения этих данных, но предоставляет возможность запускать функции EasyAR после передачи данных в EasyAR.

При использовании trial-продуктов, таких как personal license, trial XR license или trial Mega service, на custom camera или headset, EasyAR Sense после каждого запуска перестает отвечать на фиксированное ограниченное время.

ExternalFrameSource

Внешний frame source представляет frame source, не встроенный в EasyAR Sense. Он используется для поддержки AR Engine, AR Foundation или гарнитур, а также может использоваться для определения собственного frame source.

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

При использовании пробных продуктов, например license Personal Edition, пробной XR license или пробного сервиса Mega, на пользовательской камере или гарнитуре EasyAR Sense после каждого запуска перестает отвечать на фиксированное ограниченное время.

ExternalImageStreamFrameSource

Внешний frame source, который принимает только входной image stream.

Этот frame source не является устройством motion tracking и не выводит данные движения в ARSession.

Можно наследоваться от него, чтобы реализовать custom camera только с вводом изображений. Его нельзя использовать для реализации ввода headset. Нужно самостоятельно получать изображения из оборудования или других источников, например с Android camera, подключенной по USB, и передавать их в EasyAR. EasyAR не предоставляет возможность получения этих данных, но предоставляет возможность запускать функции EasyAR после передачи данных в EasyAR.

При использовании trial-продуктов, таких как personal license, trial XR license или trial Mega service, на custom camera или headset, EasyAR Sense после каждого запуска перестает отвечать на фиксированное ограниченное время.

FixedAddressAPIKeyAccessData

Данные аутентификации облачной службы EasyAR с использованием API Key. Для получения связанных данных посетите EasyAR Developer Center (https://www.easyar.cn).

FrameFilter

Frame filter представляет функцию EasyAR, работающую с использованием входных данных frame.

FramePlayer

A MonoBehaviour that controls easyar.InputFramePlayer and easyar.VideoInputFramePlayer in the scene and provides functional extensions in the Unity environment.

It is used when FrameSource is FramePlayer, or when "Frame Player" is selected in "Session Validation Tool" of the DiagnosticsController inspector in the editor.

FrameRecorder

MonoBehaviour, управляющий easyar.InputFrameRecorder и easyar.VideoInputFrameRecorder в сцене и предоставляющий функциональные расширения в среде Unity.

Он будет автоматически собран в Assembly.

enabled может управлять началом и окончанием записи.

FrameRecorder.RecordFinishEvent

Событие завершения записи. Параметр callback равен false при ошибке записи.

FrameRecorder.RecordStartEvent

Событие начала записи. Параметр callback — имя записываемого файла.

FrameRecorder.RecordingConfiguration

Конфигурация записи.

FrameRecorder.RecordingConfiguration.FilePathInfo

Информация о пути файла. Путь записанного файла равен Path.Combine(Application.persistentDataPath, FolderPath, Name + extension), когда Type равен PersistentDataPath, и Path.Combine(FolderPath, Name + extension), когда Type равен Absolute. extension определяется Format.

FrameSource

A frame source represents the data source of frame input data. It provides image data, or image data together with motion data.

You can implement a custom camera by inheriting from some subtypes of FrameSource, but you cannot directly inherit from FrameSource. A custom camera usually represents a new device or a new data input method.

When using trial products (Personal license, trial XR license, trial Mega service, etc.) on custom cameras or headsets, EasyAR Sense will stop responding for a fixed limited time after each startup.

FrameSourceCamera

Camera, предоставляющая данные кадров camera во frame source.

Image

Image хранит данные изображения и используется для представления image в памяти. Image предоставляет доступ к исходным данным в виде массива байтов, а также интерфейсы для доступа к информации, такой как width/height. Во всех версиях EasyAR Sense можно получить доступ к данным изображения. В iOS доступ можно получить так :: #import #import easyar_OutputFrame * outputFrame = [outputFrameBuffer peek]; if (outputFrame != nil) { easyar_Image * i = [[outputFrame inputFrame] image]; easyar_Buffer * b = [i buffer]; char * bytes = calloc([b size], 1); memcpy(bytes, [b data], [b size]); // use bytes here free(bytes); } В Android, :: import cn.easyar.*; OutputFrame outputFrame = outputFrameBuffer.peek(); if (outputFrame != null) { InputFrame inputFrame = outputFrame.inputFrame(); Image i = inputFrame.image(); Buffer b = i.buffer(); byte[] bytes = new byte[b.size()]; b.copyToByteArray(0, bytes, 0, bytes.length); // use bytes here b.dispose(); i.dispose(); inputFrame.dispose(); outputFrame.dispose(); }

ImageHelper

Вспомогательный класс для изображений.

ImageMaterial

Материал, используемый для рендеринга Image.

ImageTarget

ImageTarget представляет target для planar image, which can be tracked by `ImageTracker`_. Values in ImageTarget must first be filled by create... methods before they can be read. Then, after it is successfully loaded into `ImageTracker`_ through `ImageTracker.loadTarget`_, it can be detected and tracked by `ImageTracker`_.

ImageTargetController

MonoBehaviour, управляющий ImageTarget в сцене и предоставляющий функциональные расширения в среде Unity. После успешной загрузки данные target доступны через Target.

Данные target загружаются отдельно. Загрузка происходит после успешного запуска session, и полная загрузка выполняется только один раз за жизненный цикл. Если session остановится в середине загрузки, загрузка будет выполнена снова после следующего запуска session.

ImageTargetController.ImageFileSourceData

Данные изображения для создания target.

ImageTargetController.SourceData

Данные для создания target.

ImageTargetController.TargetDataFileSourceData

target data для создания target. Имя и масштаб Target определяются в файле etd.

ImageTargetController.TargetSourceData

Данные для создания target ImageTarget.

ImageTargetController.Texture2DSourceData

Данные Texture2D для создания target.

ImageTargetParameters

ImageTargetParameters представляет параметры, необходимые для создания `ImageTarget`_.

ImageTrackerFrameFilter

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

InertialCameraDeviceFrameSource

A MonoBehaviour that controls the InertialCameraDevice (InertialCameraDeviceFrameSource) in the scene and provides functional extensions in the Unity environment.

This frame source is a 5DOF (rotation + horizontal displacement) tracking device and outputs data in ARSession.

InputFrame

Input frame. Содержит изображение, camera parameters, timestamp, transform camera относительно мировой системы координат и tracking status. Camera parameters, timestamp, transform camera относительно мировой системы координат и tracking status являются необязательными, но отдельные алгоритмические компоненты могут предъявлять особые требования к входным данным.

MegaBlockController

MonoBehaviour для block, отслеживаемого MegaCloudFrameFilter в сцене.

Только если сервис содержит данные для соответствующего block ID, а корректный MegaBlockController загружен в MegaCloudFrameFilter, он может нормально использоваться в ARSession, а содержимое будет отображаться правильно.

MegaBlockController.BlockInfo

Информация Block.

MegaBlockController.BlockInfoSourceData

Источник информации для создания block.

MegaBlockController.SourceData

Данные для создания target.

MegaCloudFrameFilter

MonoBehaviour, управляющий компонентами облачного сервиса Mega в сцене.

MegaGoBlockController

MonoBehaviour для block, отслеживаемого MegaGoTrackerFrameFilter в сцене.

MegaGoBlockController.BlockInfo

Информация Block.

MegaGoBlockController.FileSourceData

Файловые данные для создания target.

MegaGoBlockController.SourceData

Данные для создания target.

MegaGoTrackerFrameFilter

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

MegaGoTrackerLocalizationResponse

Ответ локализации MegaGoTracker.

MegaLandmarkFilterResponse

Ответ на запрос Mega Landmark filter.

MegaLandmarkFilterWrapper

Функция фильтрации облачной локализации Mega Landmark VPS.

MegaLocalizationResponse

Ответ на запрос Mega localization.

MegaRequestTimeParameters

Параметры времени запроса Mega.

MegaTrackerFrameFilter

A MonoBehaviour который управляет easyar.MegaTracker in the scene and provides functional extensions in the Unity environment.

MotionInputData

Входные данные движения. Содержит timestamp, transform относительно мировой системы координат и status tracking.

MotionTrackerFrameSource

A MonoBehaviour that controls easyar.MotionTrackerCameraDevice in the scene and provides functional extensions in the Unity environment.

This frame source is a motion tracking device and outputs motion data in ARSession.

ObjectTarget

ObjectTarget представляет 3D object target, который может отслеживаться `ObjectTracker`_. Размер ObjectTarget определяется файлом `obj`. Размер можно изменить, изменив `scale`. `scale` по умолчанию равен 1. После успешной загрузки ObjectTarget в `ObjectTracker`_ через `ObjectTracker.loadTarget`_ он может обнаруживаться и отслеживаться `ObjectTracker`_.

ObjectTargetController

MonoBehaviour, управляющий ObjectTarget в сцене и предоставляющий функциональные расширения в среде Unity. После успешной загрузки данные target доступны через Target.

Данные target загружаются отдельно. Загрузка происходит после успешного запуска session, и полная загрузка выполняется только один раз за жизненный цикл. Если session остановится в середине загрузки, загрузка будет выполнена снова после следующего запуска session.

ObjectTargetController.ObjFileSourceData

Данные Obj-файла для создания target.

ObjectTargetController.SourceData

Данные для создания target.

ObjectTargetController.TargetSourceData

Данные для создания target ObjectTarget.

ObjectTargetParameters

ObjectTargetParameters представляет параметры, необходимые для создания `ObjectTarget`_.

ObjectTrackerFrameFilter

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

PicoFrameSource

Custom frame source that connects Pico output to EasyAR input in the scene. It provides Pico support through the custom camera feature of EasyAR Sense.

This frame source is a motion tracking device and outputs motion data in ARSession.

To use this frame source, ``PICO Unity Integration SDK`` is required. You need to configure PICO Unity Integration SDK according to the official documentation.

PoseUtility
RefBase
RokidFrameSource

Custom frame source that connects Rokid output to EasyAR input in the scene. It provides Rokid support through the custom camera feature of EasyAR Sense.

This frame source is a motion tracking device and outputs motion data in ARSession.

To use this frame source, ``Rokid Unity OpenXR Plugin (com.rokid.openxr)`` is required. You need to configure Rokid Unity OpenXR Plugin (com.rokid.openxr) according to the official documentation.

SenseLibrary

Инструмент для получения информации о библиотеке EasyAR Sense.

ServiceAccessData

Данные аутентификации облачной службы EasyAR.

SessionReport

Отчет Session. Используется для запроса доступности компонентов или причин повреждения session и т. п.

SessionReport.AvailabilityReport

Отчет о доступности.

SessionReport.AvailabilityReport.DeviceListDownloadResult

Результат загрузки списка устройств.

SessionReport.AvailabilityReport.Item

Элемент доступности.

SessionReport.SessionBrokenException

Конкретное исключение повреждения session.

SparseSpatialMapBuildTargetController

MonoBehaviour, управляющий map, созданной easyar.SparseSpatialMap в сцене.

SparseSpatialMapBuilderFrameFilter

easyar.SparseSpatialMap MonoBehaviour, управляемый в сцене и предоставляющий построение карты для easyar.SparseSpatialMap.

SparseSpatialMapController

MonoBehaviour для map, отслеживаемой easyar.SparseSpatialMap в сцене.

SparseSpatialMapController.MapManagerSourceData

Источник MapManager для создания map.

SparseSpatialMapController.SourceData

Данные для создания target.

SparseSpatialMapController.SparseSpatialMapInfo

Информация sparse map.

SparseSpatialMapPointCloudRenderer

Рендерит облака точек разреженной пространственной карты как частицы.

SparseSpatialMapPointCloudRenderer.PointCloudParticleParameter

Параметры для рендеринга частиц облака точек.

SparseSpatialMapTrackerFrameFilter

MonoBehaviour, управляющий easyar.SparseSpatialMap в сцене и предоставляющий локализационное отслеживание для easyar.SparseSpatialMap.

SparseSpatialMapWorkerFrameFilter

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

SurfaceTargetController

MonoBehaviour, управляющий surface target в сцене. Surface target является виртуальным узлом, представляющим узел, относительно которого движется camera при surface tracking.

SurfaceTrackerFrameFilter

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

Target

Target является базовым классом всех целей в EasyAR, которые могут отслеживаться `ImageTracker`_ или другими алгоритмами.

TargetController

MonoBehaviour, управляющий отслеживаемым target в сцене и предоставляющий расширения функций в среде Unity.

ThreeDofCameraDeviceFrameSource

A MonoBehaviour that controls the 3DOF camera device (ThreeDofCameraDeviceFrameSource) in the scene and provides functional extensions in the Unity environment.

This frame source is a 3DOF rotation tracking device and outputs data in ARSession.

TokenAccessData

Данные аутентификации облачной службы EasyAR с использованием token. Для получения связанных данных посетите EasyAR Developer Center (https://www.easyar.cn).

UnityPackage

Инструмент для получения информации о пакете.

VideoRecorder

Um/Un MonoBehaviour que управляет Recorder в scene и предоставляет функциональные расширения в среде Unity.

Пользователь полностью контролирует содержимое записываемого видео. The screen recording feature does not silently record the screen or camera output; recorded video data must be continuously passed in through RecordFrame(RenderTexture).

Note: Available only in non-Enterprise Sense on Android GLES2/3 with multithreaded rendering disabled.

VideoRecorder.AudioProfiles

Профиль аудио.

VideoRecorder.VideoProfiles

Профиль видео.

VisionOSARKitFrameSource

A MonoBehaviour that controls the VisionOS ARKit camera device (easyar.VisionOSARKitCameraDevice) in the scene and provides functional extensions in the Unity environment.

This frame source is a motion tracking device and outputs motion data in ARSession.

When using trial products (Personal license, trial XR license, trial Mega service, etc.) on custom cameras or headsets, EasyAR Sense will stop responding for a fixed limited time after each startup.

XREALFrameSource

A MonoBehaviour that controls the XREAL camera device (easyar.XREALCameraDevice) in the scene and provides functional extensions in the Unity environment.

This frame source is a motion tracking device and outputs motion data in ARSession.

When using trial products (Personal license, trial XR license, trial Mega service, etc.) on custom cameras or headsets, EasyAR Sense will stop responding for a fixed limited time after each startup.

XROriginChildController

Корневой узел MonoBehaviour для дочерних объектов XROrigin, которыми нужно управлять в сцене. Если этот узел не задан вручную в сцене, он будет автоматически создан при необходимости.

XROrigin - виртуальный узел, представляющий узел, относительно которого движется camera в системе motion tracking. Он будет выбран или создан автоматически. Если XROrigin фреймворка Unity XR существует, он будет выбран.

Структуры

ARSessionFactory.FrameSourceSortMethod

Метод сортировки для frame source.

BlockInfo

Модель, полученная dense reconstruction, представляется треугольной сеткой, называемой mesh. Поскольку mesh часто обновляется, для эффективности mesh всей реконструированной модели разделяется на множество mesh blocks. Mesh block состоит из куба со стороной около 1 метра и содержит такие элементы, как vertex и index.

BlockInfo описывает содержимое mesh block. Здесь (x,y,z) является индексом mesh block. Умножив (x,y,z) на физический размер каждого mesh block, можно получить координаты origin этого mesh block в world coordinate system. Части, которые нужно отобразить, можно заранее отфильтровать по положению mesh block в мире, чтобы сэкономить время рендеринга.
</p>
LocationResult

Показание местоположения. latitude и longitude указаны в градусах. altitude указана в метрах. horizontalAccuracy — горизонтальная точность, в метрах. verticalAccuracy — точность в направлении гравитации, в метрах.

Matrix33F

Квадратная матрица третьего порядка. Данные расположены в порядке row-major.

Matrix44F

Квадратная матрица четвертого порядка. Данные расположены в порядке row-major.

Optional<T>
ProximityLocationResult

Показание близкого местоположения. x, y и z указаны в метрах. Начало координат — начало map block. y направлена вверх. accuracy указана в метрах. timestamp и validTime указаны в секундах. is2d указывает, не используется ли y.

Unit
Vec2F

Двухмерный вектор float.

Vec2I

Двухмерный вектор int.

Vec3F

Трехмерный вектор float.

Vec4F

Четырехмерный вектор float.

Интерфейсы

IDisplay

Интерфейс устройства отображения.

Перечисления

ARCoreCameraDeviceFocusMode
AREngineCameraDeviceFocusMode
ARKitCameraDeviceFocusMode
ARSession.ARCenterMode

AR center mode.

*Note: There are four center modes in EasyAR Sense Unity Plugin. Similar concepts may not exist in other AR frameworks such as AR Foundation; usually, the relative relationship behavior between objects in those frameworks is consistent with the *SessionOrigin* mode here.*

The relative transform between Camera and some AR components is controlled by session. One of the objects is called CenterObject; it stays still in the scene, and other objects move relative to this CenterObject. This object is selected according to the value of CenterMode.

CenterObject represents the object that does not move in Unity space, or the parent node of that object. It may be Origin, Camera, or a `target`. A `Target` can be an object containing the TargetController component. When using Sparse Spatial Map and EasyAR Mega, the actual center GameObject is the specific localized map or block object under the root node, and CenterObject is the parent node of this object.

In FirstTarget or SpecificTarget mode, when a `target` is not recognized or is lost in a frame, CenterObject may become another `target`. If no `target` can be found in the frame, CenterObject degrades in order to the center of the first available mode among SessionOrigin and Camera.

The relative position relationship between `Target` and Camera is controlled by the current session. The relative position relationship between Origin and Camera is also controlled by the current session when IsCameraUnderControl is true. When IsCameraUnderControl is false, it is not controlled by the current session and is usually controlled by another AR framework such as AR Foundation.

ARSession.ARHorizontalFlipMode

Режим горизонтального зеркального рендеринга.

В состоянии горизонтального отражения изображение камеры отображается зеркально. Чтобы обеспечить корректную работу отслеживания объектов, это также влияет на рендеринг 3D-объектов, поэтому предоставляются два разных способа. Горизонтальное отражение работает только с алгоритмами восприятия объектов, такими как отслеживание изображений или объектов.

ARSession.SessionState

Состояние Session.

ARSessionFactory.ARSessionPreset

ARSession preset.

ARSessionFactory.FrameSourceSortMethod.ARCoreSortMethod

Метод сортировки для frame source ARCore/ARCoreARFoundation.

ARSessionFactory.FrameSourceSortMethod.ARKitSortMethod

Метод сортировки для frame source ARKit/ARKitARFoundation.

ARSessionFactory.FrameSourceSortMethod.MotionTrackerSortMethod

Метод сортировки для EasyAR motion tracker/System SLAM (ARCore, ARKit, AREngine) frame source.

ActiveController.Strategy

Стратегия управления activeSelf.

AndroidCameraApiType
AssembleOptions.FrameFilterSelection

Стратегия выбора FrameFilter.

AssembleOptions.FrameSourceSelection

Стратегия выбора FrameSource.

AxisSystemType

Тип системы осей.

CameraDeviceDisplay.DisplayMode

Режим отображения.

CameraDeviceFocusMode
CameraDeviceFrameSource.CameraDeviceOpenMethod

Способ открытия easyar.CameraDevice.

CameraDevicePreference
CameraDeviceType

Тип устройства камеры.

CameraModelType

Тип модели камеры.

CameraState
CameraTransformType

Тип преобразования камеры.

CloudRecognizationStatus
CloudRecognizerFrameFilter.ServiceAccessSourceType

Тип источника данных доступа к службе.

DiagnosticsController.DeveloperModeSwitchType

Тип переключателя режима разработчика.

DiagnosticsController.MessageOutputMode

Режим вывода сообщений.

DiagnosticsController.SessionDumpOutputMode

Режим вывода дампа состояния сеанса.

DisplayEmulator.RotationMode

Режим поворота.

EasyARSettings.ARCoreType

Конфигурация ARCore SDK.

EasyARSettings.AREngineType

Конфигурация AREngine SDK.

EasyARSettings.LibVariantConfig.AndroidVariant

Вариант библиотеки EasyAR Sense Android.

EasyARSettings.LibVariantConfig.IOSVariant

Вариант библиотеки EasyAR Sense iOS.

EasyARSettings.LibVariantConfig.VisionOSVariant

Вариант библиотеки EasyAR Sense visionOS.

ExternalDeviceFrameSource.DeviceOriginType

Тип origin устройства.

session origin используется для задания опорной точки transform в режиме центра SessionOrigin и для совместного преобразования пары camera-origin в других режимах центра. Если ваш SDK разработан на основе фреймворка Unity XR, вам знаком XR.CoreUtils.XROrigin. Origin - это нечто похожее на XR.CoreUtils.XROrigin, а камера рендеринга является его дочерним узлом. Пользователь может перемещать origin в сцене, не теряя локальную связь движения, определенную парой camera-origin. EasyAR использует пару camera-origin для обработки target center mode. Это особенно полезно при запуске Mega, поскольку Mega определяет реальную систему координат всей Земли, а пара camera-origin обычно определяет систему координат VIO относительно точки запуска.

FrameRecorder.InternalFormat

Внутренний формат данных.

FrameRecorder.RecorderStatus

Состояние записи.

ImageTrackerMode
InertialCameraDeviceFocusMode
LocalizationMode
LogLevel
MegaApiType

Тип MEGA API.

MegaGoTargetLoadStatus

Состояние загрузки target Mega Go.

MegaGoTrackerError

Ошибка MegaGoTracker.

MegaGoTrackerOutputUpdateStatus

Состояние обновления вывода ответом локализации MegaGoTracker.

MegaGoTrackerStatus

Состояние обработки ввода MegaGoTracker.

MegaInputFrameLevel

Эквивалентные степени свободы входного кадра, соответствующие эквивалентному CameraTransformType, при использовании функций Mega.

MegaLandmarkFilterStatus
MegaLocationInputMode

Режим ввода местоположения Mega.

MegaServiceAccessSourceType

Тип источника данных доступа к службе Mega.

MegaTrackerLocalizationStatus
MotionTrackerCameraDeviceFPS
MotionTrackerCameraDeviceFocusMode
MotionTrackerCameraDeviceQualityLevel
MotionTrackerCameraDeviceResolution
MotionTrackerCameraDeviceTrackingMode
MotionTrackingStatus

Описывает качество отслеживания движения устройства.

OptionalTag
PathType

Тип пути.

PermissionStatus
PixelFormat

PixelFormat представляет форматы пикселей изображения. Во всех форматах порядок пикселей идет слева направо и сверху вниз.

SessionReport.AvailabilityReport.AvailabilityStatus

Состояние доступности.

SessionReport.AvailabilityReport.DeviceListDownloadStatus

Состояние списка загрузки.

SessionReport.AvailabilityReport.DeviceListDownloadType

Тип компонента списка загрузки.

SessionReport.SessionBrokenReason

Причина повреждения Session.

SparseSpatialMapWorkerFrameFilter.ServiceAccessSourceType

Тип источника данных доступа к службе.

StorageType

StorageType указывает место хранения изображений, json-файлов, видео или других файлов. StorageType задает корневой каталог хранения файлов. Во всех связанных интерфейсах можно использовать относительные пути от этого корневого каталога.

ThreeDofCameraDeviceFocusMode
VideoRecorder.RecordProfile

Профиль видео.

VideoRecorder.RecordZoomMode

Режим масштабирования видео.

VideoRecorder.VideoOrientation

Ориентация видео записи экрана.

VideoRecorder.VideoSize

Размер видео.

WritablePathType

Тип пути вывода файла.