ARSystem

Class: ARSystem

AR系统，负责整个场景AR相关对象的管理。

代理自小程序的VKSession。

Hierarchy

• 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.constructor

Events

onAdd

▸ onAdd(parent, data): void

所挂载的element被挂载到场景时触发的回调。

Parameters

Name	Type
parent	Element
data	IARSystemData

Returns

void

Inherited from

Component.onAdd

---

onRelease

▸ onRelease(data): void

从被挂载的element上被移除，或是element被销毁时，触发的回调。 一般用于释放持有的资源。

Parameters

Name	Type
data	IARSystemData

Returns

void

Inherited from

Component.onRelease

---

onRemove

▸ onRemove(parent, data): void

所挂载的element从父节点parent被移除时，或者自己从element上被移除时，触发的回调。 一般用于消除功能的运作。 如果一个组件的元素直接被销毁了，那这个组件就不会经历onRemove而是直接进入onRelease。

Parameters

Name	Type
parent	Element
data	IARSystemData

Returns

void

Inherited from

Component.onRemove

---

onTick

▸ onTick(deltaTime, data): void

渲染每帧触发的回调。

Parameters

Name	Type
deltaTime	number
data	IARSystemData

Returns

void

Inherited from

Component.onTick

---

onUpdate

▸ onUpdate(data, preData): void

数据更新时触发的回调。

Parameters

Name	Type
data	IARSystemData
preData	IARSystemData

Returns

void

Inherited from

Component.onUpdate

Properties

priority

• Readonly priority: number = 110

自定义组件的更新优先级。

Overrides

Component.priority

---

schema

• Readonly schema: IComponentSchema

详见ARSystemSchema。

Overrides

Component.schema

---

EVENTS

▪ Static EVENTS: string[]

Overrides

Component.EVENTS

Accessors

arModes

• get arModes(): TTrackMode[]

当前启动的追踪模式。

Returns

TTrackMode[]

---

arVersion

• get arVersion(): number

当前启动的AR系统版本。

Returns

number

---

el

• get el(): Element

挂载的元素。

Returns

Element

---

posCount

• get posCount(): number

在Face/Body/Hand模式下，当前识别到的姿态数量。

Returns

number

---

ready

• get ready(): boolean

当前是否已经可用。

Returns

boolean

---

scene

• get scene(): Scene

当前场景。

Returns

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
mat	Matrix4

Returns

void

---

getARRawData

▸ getARRawData(): IARRawData

获取AR的追踪的原始数据。

Returns

IARRawData

---

getData

▸ getData<T>(key): IARSystemData[T]

获取一个当前值。

Type parameters

Name	Type
T	extends keyof IARSystemData

Parameters

Name	Type
key	T

Returns

IARSystemData[T]

Inherited from

Component.getData

---

placeHere

▸ placeHere(nodeIdOrElement, switchVisible?): boolean

在Plane模式下，同步某个节点到当前追踪到的和平面的交点。

Parameters

Name	Type	Default value	Description
nodeIdOrElement	string	Element	undefined
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.setData

---

setDataOne

▸ setDataOne<T>(key, value): void

设置一个数据。

Type parameters

Name	Type
T	extends keyof IARSystemData

Parameters

Name	Type
key	T
value	IARSystemData[T]

Returns

void

Inherited from

Component.setDataOne