# Class: Transform

3D变换组件，作为场景中3D节点的根基，一般被代理到[XRNode](XRNode)元素。

## Hierarchy

- [`Component`](Component)

  ↳ **`Transform`**

## Table of contents

### Constructors

- constructor

### Events

- onAdd
- onRelease
- onRemove
- onTick
- onUpdate

### Properties

- priority
- schema
- EVENTS

### Accessors

- el
- layer
- node
- position
- quaternion
- rotation
- scale
- scene
- version
- visible
- worldForward
- worldMatrix
- worldPosition
- worldQuaternion
- worldRight
- worldScale
- worldUp

### Methods

- getData
- setData
- setDataOne
- setLocalMatrix

## Constructors

### constructor

• **new Transform**()

#### Inherited from

[Component](Component).[constructor](Component#constructor)

## Events

### onAdd

▸ **onAdd**(`parent`, `data`): `void`

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

#### Parameters

| Name | Type |
| :------ | :------ |
| `parent` | [`Element`](Element) |
| `data` | [`ITransformData`](/miniprogram/dev/reference/xr-frame/api/interfaces/ITransformData) |

#### Returns

`void`

#### Inherited from

[Component](Component).[onAdd](Component#onAdd)

___

### onRelease

▸ **onRelease**(`data`): `void`

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

#### Parameters

| Name | Type |
| :------ | :------ |
| `data` | [`ITransformData`](/miniprogram/dev/reference/xr-frame/api/interfaces/ITransformData) |

#### 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` | [`ITransformData`](/miniprogram/dev/reference/xr-frame/api/interfaces/ITransformData) |

#### Returns

`void`

#### Inherited from

[Component](Component).[onRemove](Component#onRemove)

___

### onTick

▸ **onTick**(`deltaTime`, `data`): `void`

渲染每帧触发的回调。

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `deltaTime` | `number` | 单位为毫秒(ms)。 |
| `data` | [`ITransformData`](/miniprogram/dev/reference/xr-frame/api/interfaces/ITransformData) | - |

#### Returns

`void`

#### Inherited from

[Component](Component).[onTick](Component#onTick)

___

### onUpdate

▸ **onUpdate**(`data`, `preData`): `void`

数据更新时触发的回调。

#### Parameters

| Name | Type |
| :------ | :------ |
| `data` | [`ITransformData`](/miniprogram/dev/reference/xr-frame/api/interfaces/ITransformData) |
| `preData` | [`ITransformData`](/miniprogram/dev/reference/xr-frame/api/interfaces/ITransformData) |

#### Returns

`void`

#### Inherited from

[Component](Component).[onUpdate](Component#onUpdate)

## Properties

### priority

• `Readonly` **priority**: `number` = `100`

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

#### Overrides

[Component](Component).[priority](Component#priority)

___

### schema

• `Readonly` **schema**: [`IComponentSchema`](/miniprogram/dev/reference/xr-frame/api/interfaces/IComponentSchema)

详见[TransformSchema](../modules#TransformSchema)。

#### Overrides

[Component](Component).[schema](Component#schema)

___

### EVENTS

▪ `Static` **EVENTS**: `string`[] = `[]`

#### Inherited from

[Component](Component).[EVENTS](Component#EVENTS)

## Accessors

### el

• `get` **el**(): [`Element`](Element)

挂载的元素。

#### Returns

[`Element`](Element)

___

### layer

• `get` **layer**(): `number`

#### Returns

`number`

• `set` **layer**(`value`): `void`

#### Parameters

| Name | Type |
| :------ | :------ |
| `value` | `number` |

#### Returns

`void`

___

### node

• `get` **node**(): `default`

#### Returns

`default`

___

### position

• `get` **position**(): [`Vector3`](Vector3)

#### Returns

[`Vector3`](Vector3)

___

### quaternion

• `get` **quaternion**(): [`Quaternion`](Quaternion)

#### Returns

[`Quaternion`](Quaternion)

___

### rotation

• `get` **rotation**(): [`Vector3`](Vector3)

注意如果这里直接修改，使用**弧度**。

#### Returns

[`Vector3`](Vector3)

___

### scale

• `get` **scale**(): [`Vector3`](Vector3)

#### Returns

[`Vector3`](Vector3)

___

### scene

• `get` **scene**(): [`Scene`](Scene)

当前场景。

#### Returns

[`Scene`](Scene)

___

### version

• `get` **version**(): `number`

当前版本，每次有数据更新都会增加，可以用作和其他组件合作的依据。

#### Returns

`number`

___

### visible

• `get` **visible**(): `boolean`

#### Returns

`boolean`

• `set` **visible**(`value`): `void`

#### Parameters

| Name | Type |
| :------ | :------ |
| `value` | `boolean` |

#### Returns

`void`

___

### worldForward

• `get` **worldForward**(): [`Vector3`](Vector3)

获取世界前向向量，**注意不可修改**。

#### Returns

[`Vector3`](Vector3)

___

### worldMatrix

• `get` **worldMatrix**(): [`Matrix4`](Matrix4)

获取世界矩阵，**注意不可修改**。

#### Returns

[`Matrix4`](Matrix4)

___

### worldPosition

• `get` **worldPosition**(): [`Vector3`](Vector3)

获取世界绝对位移，**注意不可修改**。

#### Returns

[`Vector3`](Vector3)

___

### worldQuaternion

• `get` **worldQuaternion**(): [`Quaternion`](Quaternion)

获取世界绝对旋转，**注意不可修改**。

#### Returns

[`Quaternion`](Quaternion)

___

### worldRight

• `get` **worldRight**(): [`Vector3`](Vector3)

获取世界右向向量，**注意不可修改**。

#### Returns

[`Vector3`](Vector3)

___

### worldScale

• `get` **worldScale**(): [`Vector3`](Vector3)

获取世界绝对缩放，**注意不可修改**。

#### Returns

[`Vector3`](Vector3)

___

### worldUp

• `get` **worldUp**(): [`Vector3`](Vector3)

获取世界上向向量，**注意不可修改**。

#### Returns

[`Vector3`](Vector3)

## Methods

### getData

▸ **getData**(`key`): [`ITransformData`](/miniprogram/dev/reference/xr-frame/api/interfaces/ITransformData)[`T`]

获取一个当前值。

#### Type parameters

| Name | Type |
| :------ | :------ |
| `T` | extends keyof [`ITransformData`](/miniprogram/dev/reference/xr-frame/api/interfaces/ITransformData) |

#### Parameters

| Name | Type |
| :------ | :------ |
| `key` | `T` |

#### Returns

[`ITransformData`](/miniprogram/dev/reference/xr-frame/api/interfaces/ITransformData)[`T`]

#### Inherited from

[Component](Component).[getData](Component#getData)

___

### 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 [`ITransformData`](/miniprogram/dev/reference/xr-frame/api/interfaces/ITransformData) |

#### Parameters

| Name | Type |
| :------ | :------ |
| `key` | `T` |
| `value` | [`ITransformData`](/miniprogram/dev/reference/xr-frame/api/interfaces/ITransformData)[`T`] |

#### Returns

`void`

#### Inherited from

[Component](Component).[setDataOne](Component#setDataOne)

___

### setLocalMatrix

▸ **setLocalMatrix**(`mat`): `void`

直接设置本地矩阵。

#### Parameters

| Name | Type |
| :------ | :------ |
| `mat` | [`Matrix4`](Matrix4) |

#### Returns

`void`