Table of Contents

Namespace easyar

Namespaces

easyar.ema

Namespace easyar.ema

Classes

APIKeyAccessData

APIKeyAccessData Authentication data for EasyAR cloud services using the API Key. For this data, please visit the EasyAR Development Center at https://www.easyar.cn to obtain.

BlockController

BlockController controls the Mega block component in the scene.

BlockHolder

BlockHolder is the component that holds and manages Blocks in the scene.

EasyARMegaComponent

EasyARMegaComponent is a Mega component defined in the xrframe framework. Components are the basic logical units of an xrframe scene, and their lifecycle is controlled by xrframe. For more details, please refer to the XrFramework official documentation: <https://developers.weixin.qq.com/miniprogram/dev/component/xr-frame/core/component.html>.

EasyARSession

EasyARSession controls AR sessions in the scene, managing the data flow throughout the lifecycle. This component is the entry point for AR. Multiple active instances are not allowed at the same time. All features of EasyAR components can only be used after the Session initialization is complete.

ExplicitAddressAccessData

ExplicitAddressAccessData EasyAR cloud service authentication data that needs to fill in the access address.

MegaLandmarkFilter

MegaLandmarkFilter provides location query for MegaLandmark.

MegaTracker

MegaTracker provides cloud positioning functionality.

ServiceAccessData

ServiceAccessData EasyAR cloud service authentication data.

TokenAccessData

TokenAccessData Authentication data for EasyAR cloud services using tokens. For related data, please visit the EasyAR Developer Center (https://www.easyar.cn) to obtain.

getMegaSystem

Interfaces

BlockInfo

BlockInfo Block information, can be obtained through components.

EasyARWechatMiniprogramPlugin

EasyARWechatMiniprogramPlugin After depending on the WeChat Mini Program plugin, you can directly call the method to get the plugin object via requirePlugin("easyar-wechat-miniprogram").

GeoLocation

GeoLocation GPS data.

IEasyARMegaData

IEasyARMegaDatamountedonthe<xrefuid="w:easyar.EasyARMegaComponent:class"data-throw-if-not-resolved="false">EasyARMegaComponent.

IMegaSystem
LocalTransform

LocalTransform Local transform data.

MegaLandmarkFilterResult

MegaLandmarkFilterResult MegaLandmarkFilter Filter result.

MegaLocalizationResult

MegaLocalizationResult Localization Result.

MegaRequestTimeParameters

MegaRequestTimeParameters Mega Request Time Parameters.

MegaResultPoseTypeParameters

MegaResultPoseTypeParameters Result Pose Type Parameters.

MegaTrackerConfigs

MegaTrackerConfigs Parameters required for creating MegaTracker.

MegaTrackerSensorOptions

MegaTrackerSensorOptions Sensor options in MegaTracker.

SessionConfigs

SessionConfigs used for creating the required parameters for EasyARSession.

SessionStartOptions

SessionStartOptions Optional parameters when starting a session.

Enums

BlockVisibleStrategy

{string} Control strategy for Block Element.visible.

DeviceOrientation

{number} Device Orientation

MegaApiType

{number} Mega API Type

MegaLandmarkFilterStatus

{number} MegaLandmarkFilter query result status.

MegaLocalizationStatus

MegaLocalizationStatus Positioning Status Enumeration.

SessionEvent

SessionEvent Events dispatched by the XRFrame Element proxy. Non-immediately triggered events will be dispatched before the current frame component lifecycle is driven. See details at: <https://developers.weixin.qq.com/miniprogram/dev/component/xr-frame/core/event.html>

SessionState

SessionState Session's state.

GeoLocationInputMode

{("Onsite" | "Simulator")} GeoLocationInputMode

  • "Onsite" The input mode for on-site usage scenarios. Location data is obtained from the mini-program interface and input to Mega.
  • "Simulator" The input mode for remote usage scenarios. Location data needs to be simulated as on-site data and input to Mega through the corresponding interface.