# Class: ARTracker AR追踪组件，配合[ARSystem](ARSystem)和[Camera](Camera)的`isARCamera`属性一起使用。 一般被代理到[XRARTracker](XRARTracker)元素。 其提供了追踪的能力，节点将会自动同步识别到的追踪目标的位置和旋转， ## Hierarchy - [`Component`](Component) ↳ **`ARTracker`** ## Table of contents ### Constructors - constructor ### Events - onAdd - onRelease - onRemove - onTick - onUpdate ### Properties - priority - schema - EVENTS ### Accessors - arActive - el - errorMessage - gesture - mode - scene - score - state - version ### Methods - getData - getPosition - setData - setDataOne ## Constructors ### constructor • **new ARTracker**() #### Inherited from [Component](Component).[constructor](Component#constructor) ## Events ### onAdd ▸ **onAdd**(`parent`, `data`): `void` 所挂载的`element`被挂载到场景时触发的回调。 #### Parameters | Name | Type | | :------ | :------ | | `parent` | [`Element`](Element) | | `data` | [`IARTrackerData`](/miniprogram/dev/reference/xr-frame/api/interfaces/IARTrackerData) | #### Returns `void` #### Inherited from [Component](Component).[onAdd](Component#onAdd) ___ ### onRelease ▸ **onRelease**(`data`): `void` 从被挂载的`element`上被移除，或是`element`被销毁时，触发的回调。 一般用于释放持有的资源。 #### Parameters | Name | Type | | :------ | :------ | | `data` | [`IARTrackerData`](/miniprogram/dev/reference/xr-frame/api/interfaces/IARTrackerData) | #### 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` | [`IARTrackerData`](/miniprogram/dev/reference/xr-frame/api/interfaces/IARTrackerData) | #### Returns `void` #### Inherited from [Component](Component).[onRemove](Component#onRemove) ___ ### onTick ▸ **onTick**(`deltaTime`, `data`): `void` 渲染每帧触发的回调。 #### Parameters | Name | Type | Description | | :------ | :------ | :------ | | `deltaTime` | `number` | 单位为毫秒(ms)。 | | `data` | [`IARTrackerData`](/miniprogram/dev/reference/xr-frame/api/interfaces/IARTrackerData) | - | #### Returns `void` #### Inherited from [Component](Component).[onTick](Component#onTick) ___ ### onUpdate ▸ **onUpdate**(`data`, `preData`): `void` 数据更新时触发的回调。 #### Parameters | Name | Type | | :------ | :------ | | `data` | [`IARTrackerData`](/miniprogram/dev/reference/xr-frame/api/interfaces/IARTrackerData) | | `preData` | [`IARTrackerData`](/miniprogram/dev/reference/xr-frame/api/interfaces/IARTrackerData) | #### Returns `void` #### Inherited from [Component](Component).[onUpdate](Component#onUpdate) ## Properties ### priority • `Readonly` **priority**: `number` 自定义组件的更新优先级。 #### Inherited from [Component](Component).[priority](Component#priority) ___ ### schema • `Readonly` **schema**: [`IComponentSchema`](/miniprogram/dev/reference/xr-frame/api/interfaces/IComponentSchema) 详见[ARTrackSchema](../modules#ARTrackSchema)。 #### Overrides [Component](Component).[schema](Component#schema) ___ ### EVENTS ▪ `Static` **EVENTS**: `string`[] #### Overrides [Component](Component).[EVENTS](Component#EVENTS) ## Accessors ### arActive • `get` **arActive**(): `boolean` 是否已经检测到了目标。 #### Returns `boolean` ___ ### el • `get` **el**(): [`Element`](Element) 挂载的元素。 #### Returns [`Element`](Element) ___ ### errorMessage • `get` **errorMessage**(): `string` 如果为错误状态，错误信息。 **`version`** v2.29.1 #### Returns `string` ___ ### gesture • `get` **gesture**(): `number` 在`Hand`模式下，手势分类，正常`0~18`，无效为`-1`。 #### Returns `number` ___ ### mode • `get` **mode**(): [`TTrackMode`](../modules#TTrackMode) 跟踪模式。 #### Returns [`TTrackMode`](../modules#TTrackMode) ___ ### scene • `get` **scene**(): [`Scene`](Scene) 当前场景。 #### Returns [`Scene`](Scene) ___ ### score • `get` **score**(): `number` `Body`/`Hand`模式下，获取当前的置信度。 一般为`0~1`。 #### Returns `number` ___ ### state • `get` **state**(): [`EARTrackerState`](/miniprogram/dev/reference/xr-frame/api/enums/EARTrackerState) 当前识别状态。 **`version`** v2.29.1 #### Returns [`EARTrackerState`](/miniprogram/dev/reference/xr-frame/api/enums/EARTrackerState) ___ ### version • `get` **version**(): `number` 当前版本，每次有数据更新都会增加，可以用作和其他组件合作的依据。 #### Returns `number` ## Methods ### getData ▸ **getData**(`key`): [`IARTrackerData`](/miniprogram/dev/reference/xr-frame/api/interfaces/IARTrackerData)[`T`] 获取一个当前值。 #### Type parameters | Name | Type | | :------ | :------ | | `T` | extends keyof [`IARTrackerData`](/miniprogram/dev/reference/xr-frame/api/interfaces/IARTrackerData) | #### Parameters | Name | Type | | :------ | :------ | | `key` | `T` | #### Returns [`IARTrackerData`](/miniprogram/dev/reference/xr-frame/api/interfaces/IARTrackerData)[`T`] #### Inherited from [Component](Component).[getData](Component#getData) ___ ### getPosition ▸ **getPosition**(`point`, `output?`, `relativeToTracker?`): [`Vector3`](Vector3) 在`Face`/`Body`/`Hand`模式下，获取某个特征点的位置。 #### Parameters | Name | Type | Default value | Description | | :------ | :------ | :------ | :------ | | `point` | `number` | `undefined` | 特征点索引，需要在`0~105`，否则返回`undefined`。 | | `output?` | [`Vector3`](Vector3) | `undefined` | - | | `relativeToTracker` | `boolean` | `true` | 仅在`ar-system`的`pose3d`属性为`false`时生效。是否相对于`ARTracker`本身，默认为`true`，否则返回世界空间坐标。 | #### Returns [`Vector3`](Vector3) 只有在`arActive`时才有值，否则返回`undefined`。 ___ ### 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 [`IARTrackerData`](/miniprogram/dev/reference/xr-frame/api/interfaces/IARTrackerData) | #### Parameters | Name | Type | | :------ | :------ | | `key` | `T` | | `value` | [`IARTrackerData`](/miniprogram/dev/reference/xr-frame/api/interfaces/IARTrackerData)[`T`] | #### Returns `void` #### Inherited from [Component](Component).[setDataOne](Component#setDataOne)