Class: SpotLight ​

聚光灯光源。
光线从一个点沿一个方向射出，随着光线照射的变远，光线圆锥体的尺寸也逐渐增大。 类似于台灯、吊灯或者手电筒，该光源可以产生阴影。

Hierarchy ​

• LightBase

  ↳ SpotLight

Properties ​

• object3D
• serializeTag
• name
• size
• lightData
• dirFix
• bindOnChange
• needUpdataShadow
• realTimeShadow

Accessors ​

• transform
• enable
• iesPofile
• r
• g
• b
• lightColor
• intensity
• shadowIndex
• castGI
• direction
• innerAngle
• outerAngle
• radius
• range
• at
• castShadow

Methods ​

• onVisible
• cloneTo
• onUpdate
• onLateUpdate
• onBeforeUpdate
• destroy
• serialization
• update
• debug
• debugDraw
• unSerialization

Constructors ​

• constructor

Properties ​

object3D ​

• object3D: Object3D = null

此组件附加到的Object3D对象。

Inherited from ​

LightBase.object3D

Defined in ​

src/engine/components/ComponentBase.ts:14

serializeTag ​

• Optional serializeTag: SerializeTag

Inherited from ​

LightBase.serializeTag

Defined in ​

src/engine/components/ComponentBase.ts:30

name ​

• name: string

名称

Inherited from ​

LightBase.name

Defined in ​

src/engine/components/lights/LightBase.ts:28

size ​

• size: number = 1

大小

Inherited from ​

LightBase.size

Defined in ​

src/engine/components/lights/LightBase.ts:32

lightData ​

• lightData: LightData

光照数据

Inherited from ​

LightBase.lightData

Defined in ​

src/engine/components/lights/LightBase.ts:36

dirFix ​

• dirFix: number = 1

修复光面背面或正面

Inherited from ​

LightBase.dirFix

Defined in ​

src/engine/components/lights/LightBase.ts:40

bindOnChange ​

• bindOnChange: () => void

Type declaration ​

▸ (): void

绑定变化时的回调函数

Returns ​

void

Inherited from ​

LightBase.bindOnChange

Defined in ​

src/engine/components/lights/LightBase.ts:53

needUpdataShadow ​

• needUpdataShadow: boolean = true

是否需要更新阴影

Inherited from ​

LightBase.needUpdataShadow

Defined in ​

src/engine/components/lights/LightBase.ts:61

realTimeShadow ​

• realTimeShadow: boolean = false

是否开启实时渲染阴影

Inherited from ​

LightBase.realTimeShadow

Defined in ​

src/engine/components/lights/LightBase.ts:66

Accessors ​

transform ​

• get transform(): Transform

附加到此 Object3D对象 的 Transform组件。

Returns ​

Transform

Inherited from ​

LightBase.transform

Defined in ​

src/engine/components/ComponentBase.ts:39

enable ​

• get enable(): boolean

启用/禁用 组件。启用的组件可更新，禁用的组件不可更新。

Returns ​

boolean

Inherited from ​

LightBase.enable

Defined in ​

src/engine/components/ComponentBase.ts:62

• set enable(value): void

Parameters ​

Returns ​

void

Inherited from ​

LightBase.enable

Defined in ​

src/engine/components/ComponentBase.ts:43

iesPofile ​

• get iesPofile(): IESProfiles

Returns ​

IESProfiles

Inherited from ​

LightBase.iesPofile

Defined in ​

src/engine/components/lights/LightBase.ts:97

• set iesPofile(iesPofiles): void

Parameters ​

Returns ​

void

Inherited from ​

LightBase.iesPofile

Defined in ​

src/engine/components/lights/LightBase.ts:90

r ​

• get r(): number

获取光照颜色红色分量

Returns ​

number

Inherited from ​

LightBase.r

Defined in ​

src/engine/components/lights/LightBase.ts:160

• set r(value): void

设置光照颜色红色分量

Parameters ​

Returns ​

void

Inherited from ​

LightBase.r

Defined in ​

src/engine/components/lights/LightBase.ts:166

g ​

• get g(): number

获取光照颜色绿色分量

Returns ​

number

Inherited from ​

LightBase.g

Defined in ​

src/engine/components/lights/LightBase.ts:174

• set g(value): void

设置光照颜色绿色分量

Parameters ​

Returns ​

void

Inherited from ​

LightBase.g

Defined in ​

src/engine/components/lights/LightBase.ts:180

b ​

• get b(): number

获取光照颜色蓝色分量

Returns ​

number

Inherited from ​

LightBase.b

Defined in ​

src/engine/components/lights/LightBase.ts:188

• set b(value): void

获取光照颜色蓝色分量

Parameters ​

Returns ​

void

Inherited from ​

LightBase.b

Defined in ​

src/engine/components/lights/LightBase.ts:194

lightColor ​

• get lightColor(): Color

光源颜色

Returns ​

Color

Color

Inherited from ​

LightBase.lightColor

Defined in ​

src/engine/components/lights/LightBase.ts:202

• set lightColor(value): void

光源颜色

Parameters ​

Returns ​

void

Inherited from ​

LightBase.lightColor

Defined in ​

src/engine/components/lights/LightBase.ts:209

intensity ​

• get intensity(): number

光源的照射强度

Returns ​

number

number

Inherited from ​

LightBase.intensity

Defined in ​

src/engine/components/lights/LightBase.ts:217

• set intensity(value): void

光源的照射强度，默认为1

Parameters ​

Returns ​

void

Inherited from ​

LightBase.intensity

Defined in ​

src/engine/components/lights/LightBase.ts:224

shadowIndex ​

• get shadowIndex(): number

获取投影下标

Returns ​

number

Inherited from ​

LightBase.shadowIndex

Defined in ​

src/engine/components/lights/LightBase.ts:239

castGI ​

• get castGI(): boolean

投影

Returns ​

boolean

boolean

Inherited from ​

LightBase.castGI

Defined in ​

src/engine/components/lights/LightBase.ts:254

• set castGI(value): void

产生GI

Parameters ​

Returns ​

void

Inherited from ​

LightBase.castGI

Defined in ​

src/engine/components/lights/LightBase.ts:261

direction ​

• get direction(): Vector3

平行光的方向

Returns ​

Vector3

Vector3

Inherited from ​

LightBase.direction

Defined in ​

src/engine/components/lights/LightBase.ts:275

innerAngle ​

• get innerAngle(): number

获取光源内锥角(相对外锥角的百分比)

Returns ​

number

Defined in ​

src/engine/components/lights/SpotLight.ts:51

• set innerAngle(value): void

设置光源内锥角(相对外锥角的百分比)

Parameters ​

Returns ​

void

Defined in ​

src/engine/components/lights/SpotLight.ts:60

outerAngle ​

• get outerAngle(): number

获取光源外锥角

Returns ​

number

number

Defined in ​

src/engine/components/lights/SpotLight.ts:69

• set outerAngle(value): void

设置光源外锥角

Parameters ​

Returns ​

void

Defined in ​

src/engine/components/lights/SpotLight.ts:77

radius ​

• get radius(): number

获取光源的半径

Returns ​

number

number

Defined in ​

src/engine/components/lights/SpotLight.ts:87

• set radius(value): void

设置光源的半径

Parameters ​

Returns ​

void

Defined in ​

src/engine/components/lights/SpotLight.ts:96

range ​

• get range(): number

获取光源的范围

Returns ​

number

Defined in ​

src/engine/components/lights/SpotLight.ts:104

• set range(value): void

设置光源的范围

Parameters ​

Returns ​

void

Defined in ​

src/engine/components/lights/SpotLight.ts:113

at ​

• get at(): number

获取光源照射距离

Returns ​

number

Defined in ​

src/engine/components/lights/SpotLight.ts:121

• set at(value): void

设置光源照射距离

Parameters ​

Returns ​

void

Defined in ​

src/engine/components/lights/SpotLight.ts:128

castShadow ​

• set castShadow(value): void

投影

Parameters ​

Returns ​

void

Overrides ​

LightBase.castShadow

Defined in ​

src/engine/components/lights/SpotLight.ts:137

Methods ​

onVisible ​

▸ onVisible(value): void

Parameters ​

Returns ​

void

Inherited from ​

LightBase.onVisible

Defined in ​

src/engine/components/ComponentBase.ts:66

cloneTo ​

▸ cloneTo(obj): void

创建新的组件，复制当前组件的属性，并添加到目标对象上。

Parameters ​

Returns ​

void

Inherited from ​

LightBase.cloneTo

Defined in ​

src/engine/components/ComponentBase.ts:114

onUpdate ​

▸ onUpdate(call): void

添加更新函数。会在每帧更新时执行。

Parameters ​

Returns ​

void

Inherited from ​

LightBase.onUpdate

Defined in ​

src/engine/components/ComponentBase.ts:135

onLateUpdate ​

▸ onLateUpdate(call): void

添加延迟更新函数。

Parameters ​

Returns ​

void

Inherited from ​

LightBase.onLateUpdate

Defined in ​

src/engine/components/ComponentBase.ts:148

onBeforeUpdate ​

▸ onBeforeUpdate(call): void

添加帧更新前执行的函数。

Parameters ​

Returns ​

void

Inherited from ​

LightBase.onBeforeUpdate

Defined in ​

src/engine/components/ComponentBase.ts:161

destroy ​

▸ destroy(): void

Returns ​

void

Inherited from ​

LightBase.destroy

Defined in ​

src/engine/components/lights/LightBase.ts:279

serialization ​

▸ serialization(assets): SerializeComponentBase

Parameters ​

Returns ​

SerializeComponentBase

Inherited from ​

LightBase.serialization

Defined in ​

src/engine/components/lights/LightBase.ts:287

update ​

▸ update(): void

Returns ​

void

Overrides ​

LightBase.update

Defined in ​

src/engine/components/lights/SpotLight.ts:44

debug ​

▸ debug(): void

启用GUI调试

Returns ​

void

Defined in ​

src/engine/components/lights/SpotLight.ts:156

debugDraw ​

▸ debugDraw(show): void

Parameters ​

Returns ​

void

Defined in ​

src/engine/components/lights/SpotLight.ts:176

unSerialization ​

▸ unSerialization(componentData, data): void

Parameters ​

Returns ​

void

Overrides ​

LightBase.unSerialization

Defined in ​

src/engine/components/lights/SpotLight.ts:220

Constructors ​

constructor ​

• new SpotLight()

Overrides ​

LightBase.constructor

Defined in ​

src/engine/components/lights/SpotLight.ts:26