@orillusion/core

---

Class: SpotLight

Defined in: src/components/lights/SpotLight.ts:17

Spotlight source. Light shines from a point in one direction, and as the light shines further away, the size of the light cone gradually increases. Similar to a desk lamp, chandelier, or flashlight, this light source can produce shadows.

Constructors

Constructor

new SpotLight(): SpotLight

Defined in: src/components/lights/SpotLight.ts:53

Returns

SpotLight

Overrides

LightBase.constructor

Properties

object3D

object3D: Object3D = null

Defined in: src/components/ComponentBase.ts:29

owner object3D

Inherited from

LightBase.object3D

---

isDestroyed

isDestroyed: boolean = false

Defined in: src/components/ComponentBase.ts:77

Inherited from

LightBase.isDestroyed

---

name

name: string

Defined in: src/components/lights/LightBase.ts:22

light name

Inherited from

LightBase.name

---

size

size: number = 1

Defined in: src/components/lights/LightBase.ts:26

light size

Inherited from

LightBase.size

---

shadowMapWidth

shadowMapWidth: number = 0

Defined in: src/components/lights/LightBase.ts:41

light shadow map size

Inherited from

LightBase.shadowMapWidth

---

shadowMapHeight

shadowMapHeight: number = 0

Defined in: src/components/lights/LightBase.ts:42

Inherited from

LightBase.shadowMapHeight

---

lightData

lightData: LightData

Defined in: src/components/lights/LightBase.ts:47

light source data

Inherited from

LightBase.lightData

---

dirFix

dirFix: number = 1

Defined in: src/components/lights/LightBase.ts:52

fix light direction

Inherited from

LightBase.dirFix

---

bindOnChange

bindOnChange: () => void

Defined in: src/components/lights/LightBase.ts:57

Callback function when binding changes

Returns

void

Inherited from

LightBase.bindOnChange

---

needUpdateShadow

needUpdateShadow: boolean = true

Defined in: src/components/lights/LightBase.ts:59

Inherited from

LightBase.needUpdateShadow

---

realTimeShadow

realTimeShadow: boolean = true

Defined in: src/components/lights/LightBase.ts:64

Whether to enable real-time rendering of shadows

Inherited from

LightBase.realTimeShadow

---

debugShadowRange

debugShadowRange: boolean = false

Defined in: src/components/lights/SpotLight.ts:25

---

shadowCameraNear

shadowCameraNear: number = 0.01

Defined in: src/components/lights/SpotLight.ts:28

---

shadowCameraFar

shadowCameraFar: number = 0

Defined in: src/components/lights/SpotLight.ts:29

Accessors

visibleLayer

Get Signature

get visibleLayer(): number

Defined in: src/components/ComponentBase.ts:46

Composition-layer membership bitmask. The pass / camera / collector filters via

(component.visibleLayer & pass.layerMask & camera.cullingMask) !== 0

Defaults to VisibleLayer.Default (bit 0) so a fresh subclass is visible to passes whose layerMask is VisibleLayer.All (which includes bit 0). Application code can assign project-specific bits (1..31) to organise the scene into composition layers.

Returns

number

Set Signature

set visibleLayer(value): void

Defined in: src/components/ComponentBase.ts:50

Parameters

value

number

Returns

void

Inherited from

LightBase.visibleLayer

---

eventDispatcher

Get Signature

get eventDispatcher(): CEventDispatcher

Defined in: src/components/ComponentBase.ts:63

Returns

CEventDispatcher

Set Signature

set eventDispatcher(value): void

Defined in: src/components/ComponentBase.ts:68

Parameters

value

CEventDispatcher

Returns

void

Inherited from

LightBase.eventDispatcher

---

isStart

Get Signature

get isStart(): boolean

Defined in: src/components/ComponentBase.ts:79

Returns

boolean

Inherited from

LightBase.isStart

---

transform

Get Signature

get transform(): Transform

Defined in: src/components/ComponentBase.ts:89

Return the Transform component attached to the Object3D. Null before the component is attached — addComponent assigns object3D only after construction — so constructor-time callers can probe safely via this.transform?..

Returns

Transform

Inherited from

LightBase.transform

---

enable

Get Signature

get enable(): boolean

Defined in: src/components/ComponentBase.ts:113

Enable/disable components. The enabled components can be updated, while the disabled components cannot be updated.

Returns

boolean

Set Signature

set enable(value): void

Defined in: src/components/ComponentBase.ts:96

Enable/disable components. The enabled components can be updated, while the disabled components cannot be updated.

Parameters

value

boolean

Returns

void

Inherited from

LightBase.enable

---

softness

Get Signature

get softness(): number

Defined in: src/components/lights/LightBase.ts:34

Per-light PCSS penumbra multiplier. Default -1 means "fall back to the global engine.setting.shadow.shadowSoft". Set a positive value to override on this light only (e.g. a large area light casts a wider penumbra than a small spotlight). Live-tunable — the value is republished to the GPU each frame via LightEntries.

Returns

number

Set Signature

set softness(value): void

Defined in: src/components/lights/LightBase.ts:35

Parameters

value

number

Returns

void

Inherited from

LightBase.softness

---

iesProfiles

Set Signature

set iesProfiles(iesProfiles): void

Defined in: src/components/lights/LightBase.ts:163

Parameters

iesProfiles

IESProfiles

Returns

void

Inherited from

LightBase.iesProfiles

---

iesProfile

Get Signature

get iesProfile(): IESProfiles

Defined in: src/components/lights/LightBase.ts:173

Returns

IESProfiles

Inherited from

LightBase.iesProfile

---

r

Get Signature

get r(): number

Defined in: src/components/lights/LightBase.ts:180

Get the red component of the lighting color

Returns

number

Set Signature

set r(value): void

Defined in: src/components/lights/LightBase.ts:187

Set the red component of the lighting color

Parameters

value

number

Returns

void

Inherited from

LightBase.r

---

g

Get Signature

get g(): number

Defined in: src/components/lights/LightBase.ts:195

Get the green component of the lighting color

Returns

number

Set Signature

set g(value): void

Defined in: src/components/lights/LightBase.ts:202

Set the green component of the lighting color

Parameters

value

number

Returns

void

Inherited from

LightBase.g

---

b

Get Signature

get b(): number

Defined in: src/components/lights/LightBase.ts:210

Get the blue component of the lighting color

Returns

number

Set Signature

set b(value): void

Defined in: src/components/lights/LightBase.ts:216

Set the blue component of the lighting color

Parameters

value

number

Returns

void

Inherited from

LightBase.b

---

lightColor

Get Signature

get lightColor(): Color

Defined in: src/components/lights/LightBase.ts:224

Get light source color

Returns

Color

Color

Set Signature

set lightColor(value): void

Defined in: src/components/lights/LightBase.ts:231

Set light source color

Parameters

value

Color

Returns

void

Inherited from

Light.lightColor

---

color

Get Signature

get color(): Color

Defined in: src/components/lights/LightBase.ts:240

Get light source color

Returns

Color

Color

Set Signature

set color(value): void

Defined in: src/components/lights/LightBase.ts:248

Set light source color

Parameters

value

Color

Returns

void

Inherited from

LightBase.color

---

intensity

Get Signature

get intensity(): number

Defined in: src/components/lights/LightBase.ts:257

Get Illumination intensity of light source

Returns

number

number

Set Signature

set intensity(value): void

Defined in: src/components/lights/LightBase.ts:265

Set Illumination intensity of light source

Parameters

value

number

Returns

void

Inherited from

Light.intensity

---

castShadow

Get Signature

get castShadow(): boolean

Defined in: src/components/lights/LightBase.ts:281

Returns

boolean

Set Signature

set castShadow(value): void

Defined in: src/components/lights/LightBase.ts:274

Cast Light Shadow

Parameters

value

boolean

Returns

void

Inherited from

Light.castShadow

---

shadowIndex

Get Signature

get shadowIndex(): number

Defined in: src/components/lights/LightBase.ts:288

get shadow index at shadow map list

Returns

number

Inherited from

LightBase.shadowIndex

---

castGI

Get Signature

get castGI(): boolean

Defined in: src/components/lights/LightBase.ts:297

get gi is enable

Returns

boolean

boolean

Set Signature

set castGI(value): void

Defined in: src/components/lights/LightBase.ts:304

set gi is enable

Parameters

value

boolean

Returns

void

Inherited from

Light.castGI

---

direction

Get Signature

get direction(): Vector3

Defined in: src/components/lights/LightBase.ts:318

light source direction

Returns

Vector3

Vector3

Inherited from

LightBase.direction

---

shadowBias

Get Signature

get shadowBias(): number | "auto"

Defined in: src/components/lights/SpotLight.ts:31

Returns

number | "auto"

Set Signature

set shadowBias(value): void

Defined in: src/components/lights/SpotLight.ts:35

Parameters

value

number | "auto"

Returns

void

---

normalBias

Get Signature

get normalBias(): number | "auto"

Defined in: src/components/lights/SpotLight.ts:42

Returns

number | "auto"

Set Signature

set normalBias(value): void

Defined in: src/components/lights/SpotLight.ts:46

Parameters

value

number | "auto"

Returns

void

---

innerAngle

Get Signature

get innerAngle(): number

Defined in: src/components/lights/SpotLight.ts:70

Get the inner cone angle of the light source (as a percentage relative to the outer cone angle)

Returns

number

Set Signature

set innerAngle(value): void

Defined in: src/components/lights/SpotLight.ts:79

Set the inner cone angle of the light source (as a percentage relative to the outer cone angle)

Parameters

value

number

Returns

void

---

outerAngle

Get Signature

get outerAngle(): number

Defined in: src/components/lights/SpotLight.ts:88

Get the outer cone angle of the light source

Returns

number

number

Set Signature

set outerAngle(value): void

Defined in: src/components/lights/SpotLight.ts:96

Set the outer cone angle of the light source

Parameters

value

number

Returns

void

---

radius

Get Signature

get radius(): number

Defined in: src/components/lights/SpotLight.ts:106

Get the radius of the light source

Returns

number

number

Set Signature

set radius(value): void

Defined in: src/components/lights/SpotLight.ts:115

Set the radius of the light source

Parameters

value

number

Returns

void

---

range

Get Signature

get range(): number

Defined in: src/components/lights/SpotLight.ts:123

Get the range of the light source

Returns

number

Set Signature

set range(value): void

Defined in: src/components/lights/SpotLight.ts:132

Set the range of the light source

Parameters

value

number

Returns

void

---

at

Get Signature

get at(): number

Defined in: src/components/lights/SpotLight.ts:140

Get the illumination distance of the light source

Returns

number

Set Signature

set at(value): void

Defined in: src/components/lights/SpotLight.ts:147

Set the illumination distance of the light source

Parameters

value

number

Returns

void

Methods

stop()

stop(): void

Defined in: src/components/ComponentBase.ts:163

Returns

void

Inherited from

LightBase.stop

---

onLateUpdate()?

optional onLateUpdate(view?): any

Defined in: src/components/ComponentBase.ts:167

Parameters

view?

View3D

Returns

any

Inherited from

LightBase.onLateUpdate

---

onBeforeUpdate()?

optional onBeforeUpdate(view?): any

Defined in: src/components/ComponentBase.ts:168

Parameters

view?

View3D

Returns

any

Inherited from

LightBase.onBeforeUpdate

---

onCompute()?

optional onCompute(view?, command?): any

Defined in: src/components/ComponentBase.ts:169

Parameters

view?

View3D

command?

GPUCommandEncoder

Returns

any

Inherited from

LightBase.onCompute

---

onParentChange()?

optional onParentChange(lastParent?, currentParent?): any

Defined in: src/components/ComponentBase.ts:171

Parameters

lastParent?

Object3D

currentParent?

Object3D

Returns

any

Inherited from

LightBase.onParentChange

---

onAddChild()?

optional onAddChild(child): any

Defined in: src/components/ComponentBase.ts:172

Parameters

child

Object3D

Returns

any

Inherited from

LightBase.onAddChild

---

onRemoveChild()?

optional onRemoveChild(child): any

Defined in: src/components/ComponentBase.ts:173

Parameters

child

Object3D

Returns

any

Inherited from

LightBase.onRemoveChild

---

cloneTo()

cloneTo(obj): void

Defined in: src/components/ComponentBase.ts:180

clone component data to target object3D

Parameters

obj

Object3D

target object3D

Returns

void

Inherited from

LightBase.cloneTo

---

copyComponent()

copyComponent(from): this

Defined in: src/components/ComponentBase.ts:182

Parameters

from

this

Returns

this

Inherited from

LightBase.copyComponent

---

beforeDestroy()

beforeDestroy(force?): void

Defined in: src/components/ComponentBase.ts:249

before release this component, object refrences are not be set null now.

Parameters

force?

boolean

Returns

void

Inherited from

LightBase.beforeDestroy

---

onEnable()

onEnable(): void

Defined in: src/components/lights/LightBase.ts:152

Returns

void

Inherited from

LightBase.onEnable

---

onDisable()

onDisable(): void

Defined in: src/components/lights/LightBase.ts:157

Returns

void

Inherited from

LightBase.onDisable

---

destroy()

destroy(force?): void

Defined in: src/components/lights/LightBase.ts:322

release this component

Parameters

force?

boolean

Returns

void

Inherited from

LightBase.destroy

---

init()

init(): void

Defined in: src/components/lights/SpotLight.ts:57

Returns

void

Overrides

LightBase.init

---

start()

start(): void

Defined in: src/components/lights/SpotLight.ts:152

Returns

void

Overrides

LightBase.start

---

onUpdate()

onUpdate(): void

Defined in: src/components/lights/SpotLight.ts:157

Returns

void

Overrides

LightBase.onUpdate

---

onGraphic()

onGraphic(view): void

Defined in: src/components/lights/SpotLight.ts:161

Parameters

view

View3D

Returns

void

Overrides

LightBase.onGraphic

---

debug()

debug(): void

Defined in: src/components/lights/SpotLight.ts:193

enable GUI debug

Returns

void

---

debugDraw()

debugDraw(show): void

Defined in: src/components/lights/SpotLight.ts:196

Parameters

show

boolean

Returns

void