# Class: Light

灯光组件，一般被代理到[XRLight](XRLight)元素。

注意整个场景只能存在一个`ambient`光源，第一个`directional`光源将会成为主光源，也只有这个光源能够产生阴影。
目前最多支持四个追加光源。

## Hierarchy

- [`Component`](Component)

  ↳ **`Light`**

## Table of contents

### Constructors

- constructor

### Events

- onAdd
- onRelease
- onRemove
- onTick
- onUpdate

### Properties

- priority
- schema
- EVENTS

### Accessors

- castShadow
- color
- el
- innerConeAngle
- intensity
- outerConeAngle
- range
- scene
- shadowBias
- shadowDistance
- type
- version

### Methods

- getData
- setData
- setDataOne

## Constructors

### constructor

• **new Light**()

#### Inherited from

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

## Events

### onAdd

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

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

#### Parameters

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

#### Returns

`void`

#### Inherited from

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

___

### onRelease

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

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

#### Parameters

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

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

#### Returns

`void`

#### Inherited from

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

___

### onTick

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

渲染每帧触发的回调。

#### Parameters

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

#### Returns

`void`

#### Inherited from

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

___

### onUpdate

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

数据更新时触发的回调。

#### Parameters

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

#### Returns

`void`

#### Inherited from

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

## Properties

### priority

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

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

#### Overrides

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

___

### schema

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

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

#### Overrides

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

___

### EVENTS

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

#### Inherited from

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

## Accessors

### castShadow

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

#### Returns

`boolean`

___

### color

• `get` **color**(): `number`[]

#### Returns

`number`[]

___

### el

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

挂载的元素。

#### Returns

[`Element`](Element)

___

### innerConeAngle

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

#### Returns

`number`

___

### intensity

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

#### Returns

`number`

___

### outerConeAngle

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

#### Returns

`number`

___

### range

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

#### Returns

`number`

___

### scene

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

当前场景。

#### Returns

[`Scene`](Scene)

___

### shadowBias

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

#### Returns

`number`

___

### shadowDistance

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

#### Returns

`number`

___

### type

• `get` **type**(): `ELightType`

#### Returns

`ELightType`

___

### version

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

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

#### Returns

`number`

## Methods

### getData

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

获取一个当前值。

#### Type parameters

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

#### Parameters

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

#### Returns

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

#### Parameters

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

#### Returns

`void`

#### Inherited from

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