# Class: ARSystem AR系统，负责整个场景AR相关对象的管理。 代理自小程序的`VKSession`。 ## Hierarchy - [`Component`](Component) ↳ **`ARSystem`** ## Table of contents ### Constructors - constructor ### Events - onAdd - onRelease - onRemove - onTick - onUpdate ### Properties - priority - schema - EVENTS ### Accessors - arModes - arVersion - el - posCount - ready - scene - supported - version ### Methods - forceSetViewMatrix - getARRawData - getData - placeHere - resetPlane - setData - setDataOne ## Constructors ### constructor • **new ARSystem**() #### Inherited from [Component](Component).[constructor](Component#constructor) ## Events ### onAdd ▸ **onAdd**(`parent`, `data`): `void` 所挂载的`element`被挂载到场景时触发的回调。 #### Parameters | Name | Type | | :------ | :------ | | `parent` | [`Element`](Element) | | `data` | [`IARSystemData`](/miniprogram/dev/reference/xr-frame/api/interfaces/IARSystemData) | #### Returns `void` #### Inherited from [Component](Component).[onAdd](Component#onAdd) ___ ### onRelease ▸ **onRelease**(`data`): `void` 从被挂载的`element`上被移除，或是`element`被销毁时，触发的回调。 一般用于释放持有的资源。 #### Parameters | Name | Type | | :------ | :------ | | `data` | [`IARSystemData`](/miniprogram/dev/reference/xr-frame/api/interfaces/IARSystemData) | #### Returns `void` #### Inherited from [Component](Component).[onRelease](Component#onRelease) ___ ### onRemove ▸ **onRemove**(`parent`, `data`): `void` 所挂载的`element`从父节点`parent`被移除时，或者自己从`element`上被移除时，触发的回调。 一般用于消除功能的运作。 **如果一个组件的元素直接被销毁了，那这个组件就不会经历onRemove而是直接进入onRelease。** #### Parameters | Name | Type | | :------ | :------ | | `parent` | [`Element`](Element) | | `data` | [`IARSystemData`](/miniprogram/dev/reference/xr-frame/api/interfaces/IARSystemData) | #### Returns `void` #### Inherited from [Component](Component).[onRemove](Component#onRemove) ___ ### onTick ▸ **onTick**(`deltaTime`, `data`): `void` 渲染每帧触发的回调。 #### Parameters | Name | Type | | :------ | :------ | | `deltaTime` | `number` | | `data` | [`IARSystemData`](/miniprogram/dev/reference/xr-frame/api/interfaces/IARSystemData) | #### Returns `void` #### Inherited from [Component](Component).[onTick](Component#onTick) ___ ### onUpdate ▸ **onUpdate**(`data`, `preData`): `void` 数据更新时触发的回调。 #### Parameters | Name | Type | | :------ | :------ | | `data` | [`IARSystemData`](/miniprogram/dev/reference/xr-frame/api/interfaces/IARSystemData) | | `preData` | [`IARSystemData`](/miniprogram/dev/reference/xr-frame/api/interfaces/IARSystemData) | #### Returns `void` #### Inherited from [Component](Component).[onUpdate](Component#onUpdate) ## Properties ### priority • `Readonly` **priority**: `number` = `110` 自定义组件的更新优先级。 #### Overrides [Component](Component).[priority](Component#priority) ___ ### schema • `Readonly` **schema**: [`IComponentSchema`](/miniprogram/dev/reference/xr-frame/api/interfaces/IComponentSchema) 详见[ARSystemSchema](../modules#ARSystemSchema)。 #### Overrides [Component](Component).[schema](Component#schema) ___ ### EVENTS ▪ `Static` **EVENTS**: `string`[] #### Overrides [Component](Component).[EVENTS](Component#EVENTS) ## Accessors ### arModes • `get` **arModes**(): [`TTrackMode`](../modules#TTrackMode)[] 当前启动的追踪模式。 #### Returns [`TTrackMode`](../modules#TTrackMode)[] ___ ### arVersion • `get` **arVersion**(): `number` 当前启动的AR系统版本。 #### Returns `number` ___ ### el • `get` **el**(): [`Element`](Element) 挂载的元素。 #### Returns [`Element`](Element) ___ ### posCount • `get` **posCount**(): `number` 在`Face`/`Body`/`Hand`模式下，当前识别到的姿态数量。 #### Returns `number` ___ ### ready • `get` **ready**(): `boolean` 当前是否已经可用。 #### Returns `boolean` ___ ### scene • `get` **scene**(): [`Scene`](Scene) 当前场景。 #### Returns [`Scene`](Scene) ___ ### supported • `get` **supported**(): `boolean` 当前设备是否启动成功。 #### Returns `boolean` ___ ### version • `get` **version**(): `number` 当前版本，每次有数据更新都会增加，可以用作和其他组件合作的依据。 #### Returns `number` ## Methods ### forceSetViewMatrix ▸ **forceSetViewMatrix**(`camera`, `mat`): `void` 提供一个修改某个设置为`isARCamera`的相机的试图矩阵的手段。 #### Parameters | Name | Type | | :------ | :------ | | `camera` | [`Camera`](Camera) | | `mat` | [`Matrix4`](Matrix4) | #### Returns `void` ___ ### getARRawData ▸ **getARRawData**(): [`IARRawData`](/miniprogram/dev/reference/xr-frame/api/interfaces/IARRawData) 获取AR的追踪的原始数据。 #### Returns [`IARRawData`](/miniprogram/dev/reference/xr-frame/api/interfaces/IARRawData) ___ ### getData ▸ **getData**(`key`): [`IARSystemData`](/miniprogram/dev/reference/xr-frame/api/interfaces/IARSystemData)[`T`] 获取一个当前值。 #### Type parameters | Name | Type | | :------ | :------ | | `T` | extends keyof [`IARSystemData`](/miniprogram/dev/reference/xr-frame/api/interfaces/IARSystemData) | #### Parameters | Name | Type | | :------ | :------ | | `key` | `T` | #### Returns [`IARSystemData`](/miniprogram/dev/reference/xr-frame/api/interfaces/IARSystemData)[`T`] #### Inherited from [Component](Component).[getData](Component#getData) ___ ### placeHere ▸ **placeHere**(`nodeIdOrElement`, `switchVisible?`): `boolean` 在`Plane`模式下，同步某个节点到当前追踪到的和平面的交点。 #### Parameters | Name | Type | Default value | Description | | :------ | :------ | :------ | :------ | | `nodeIdOrElement` | `string` \| [`Element`](Element) | `undefined` | 节点的`nodeId`或是`element`引用。 | | `switchVisible` | `boolean` | `true` | 是否要自动切换显示或隐藏。 | #### Returns `boolean` 是否放置成功 ___ ### resetPlane ▸ **resetPlane**(): `void` 在`Plane`模式下，重置平面。 #### Returns `void` ___ ### setData ▸ **setData**(`data`): `void` 不通过`xml`而是直接设置`data`，注意值的类型需要和`schema`中一致。 #### Parameters | Name | Type | | :------ | :------ | | `data` | `Partial` | #### Returns `void` #### Inherited from [Component](Component).[setData](Component#setData) ___ ### setDataOne ▸ **setDataOne**(`key`, `value`): `void` 设置一个数据。 #### Type parameters | Name | Type | | :------ | :------ | | `T` | extends keyof [`IARSystemData`](/miniprogram/dev/reference/xr-frame/api/interfaces/IARSystemData) | #### Parameters | Name | Type | | :------ | :------ | | `key` | `T` | | `value` | [`IARSystemData`](/miniprogram/dev/reference/xr-frame/api/interfaces/IARSystemData)[`T`] | #### Returns `void` #### Inherited from [Component](Component).[setDataOne](Component#setDataOne)