Class: DirectLight ​

Directional light source. The light of this light source is parallel, for example, sunlight. This light source can generate shadows.

Hierarchy ​

• LightBase

  ↳ DirectLight

Constructors ​

• constructor

Properties ​

• object3D
• isDestroyed
• shadowCamera
• name
• size
• lightData
• dirFix
• bindOnChange
• needUpdateShadow
• realTimeShadow

Accessors ​

• eventDispatcher
• isStart
• transform
• enable
• radius
• indirect
• iesProfiles
• iesProfile
• r
• g
• b
• lightColor
• intensity
• castShadow
• shadowIndex
• castGI
• direction

Methods ​

• stop
• onUpdate
• onLateUpdate
• onBeforeUpdate
• onCompute
• onGraphic
• onParentChange
• cloneTo
• copyComponent
• beforeDestroy
• init
• start
• debug
• onEnable
• onDisable
• destroy

Constructors ​

constructor ​

• new DirectLight()

Overrides ​

LightBase.constructor

Defined in ​

src/components/lights/DirectLight.ts:14

Properties ​

object3D ​

• object3D: Object3D = null

owner object3D

Inherited from ​

LightBase.object3D

Defined in ​

src/components/ComponentBase.ts:17

isDestroyed ​

• Optional isDestroyed: boolean

Inherited from ​

LightBase.isDestroyed

Defined in ​

src/components/ComponentBase.ts:38

shadowCamera ​

• shadowCamera: Camera3D

Defined in ​

src/components/lights/DirectLight.ts:12

name ​

• name: string

light name

Inherited from ​

LightBase.name

Defined in ​

src/components/lights/LightBase.ts:21

size ​

• size: number = 1

light size

Inherited from ​

LightBase.size

Defined in ​

src/components/lights/LightBase.ts:25

lightData ​

• lightData: LightData

light source data

Inherited from ​

LightBase.lightData

Defined in ​

src/components/lights/LightBase.ts:30

dirFix ​

• dirFix: number = 1

fix light direction

Inherited from ​

LightBase.dirFix

Defined in ​

src/components/lights/LightBase.ts:35

bindOnChange ​

• bindOnChange: () => void

Type declaration ​

▸ (): void

Callback function when binding changes

Returns ​

void

Inherited from ​

LightBase.bindOnChange

Defined in ​

src/components/lights/LightBase.ts:40

needUpdateShadow ​

• needUpdateShadow: boolean = true

Inherited from ​

LightBase.needUpdateShadow

Defined in ​

src/components/lights/LightBase.ts:42

realTimeShadow ​

• realTimeShadow: boolean = true

Whether to enable real-time rendering of shadows

Inherited from ​

LightBase.realTimeShadow

Defined in ​

src/components/lights/LightBase.ts:47

Accessors ​

eventDispatcher ​

• get eventDispatcher(): CEventDispatcher

Returns ​

CEventDispatcher

Inherited from ​

LightBase.eventDispatcher

Defined in ​

src/components/ComponentBase.ts:23

• set eventDispatcher(value): void

Parameters ​

Returns ​

void

Inherited from ​

LightBase.eventDispatcher

Defined in ​

src/components/ComponentBase.ts:28

isStart ​

• get isStart(): boolean

Returns ​

boolean

Inherited from ​

LightBase.isStart

Defined in ​

src/components/ComponentBase.ts:40

transform ​

• get transform(): Transform

Return the Transform component attached to the Object3D.

Returns ​

Transform

Inherited from ​

LightBase.transform

Defined in ​

src/components/ComponentBase.ts:47

enable ​

• get enable(): boolean

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

Returns ​

boolean

Inherited from ​

LightBase.enable

Defined in ​

src/components/ComponentBase.ts:68

• set enable(value): void

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

Parameters ​

Returns ​

void

Inherited from ​

LightBase.enable

Defined in ​

src/components/ComponentBase.ts:54

radius ​

• get radius(): number

Get the radius of a directional light source

Returns ​

number

Defined in ​

src/components/lights/DirectLight.ts:38

• set radius(value): void

Set the radius of a directional light source

Parameters ​

Returns ​

void

Defined in ​

src/components/lights/DirectLight.ts:45

indirect ​

• get indirect(): number

Get the radius of a directional light source

Returns ​

number

Defined in ​

src/components/lights/DirectLight.ts:54

• set indirect(value): void

Set the radius of a directional light source

Parameters ​

Returns ​

void

Defined in ​

src/components/lights/DirectLight.ts:61

iesProfiles ​

• set iesProfiles(iesProfiles): void

Parameters ​

Returns ​

void

Inherited from ​

LightBase.iesProfiles

Defined in ​

src/components/lights/LightBase.ts:117

iesProfile ​

• get iesProfile(): IESProfiles

Returns ​

IESProfiles

Inherited from ​

LightBase.iesProfile

Defined in ​

src/components/lights/LightBase.ts:124

r ​

• get r(): number

Get the red component of the lighting color

Returns ​

number

Inherited from ​

LightBase.r

Defined in ​

src/components/lights/LightBase.ts:131

• set r(value): void

Set the red component of the lighting color

Parameters ​

Returns ​

void

Inherited from ​

LightBase.r

Defined in ​

src/components/lights/LightBase.ts:138

g ​

• get g(): number

Get the green component of the lighting color

Returns ​

number

Inherited from ​

LightBase.g

Defined in ​

src/components/lights/LightBase.ts:146

• set g(value): void

Set the green component of the lighting color

Parameters ​

Returns ​

void

Inherited from ​

LightBase.g

Defined in ​

src/components/lights/LightBase.ts:153

b ​

• get b(): number

Get the blue component of the lighting color

Returns ​

number

Inherited from ​

LightBase.b

Defined in ​

src/components/lights/LightBase.ts:161

• set b(value): void

Set the blue component of the lighting color

Parameters ​

Returns ​

void

Inherited from ​

LightBase.b

Defined in ​

src/components/lights/LightBase.ts:167

lightColor ​

• get lightColor(): Color

Get light source color

Returns ​

Color

Color

Inherited from ​

LightBase.lightColor

Defined in ​

src/components/lights/LightBase.ts:175

• set lightColor(value): void

Set light source color

Parameters ​

Returns ​

void

Inherited from ​

LightBase.lightColor

Defined in ​

src/components/lights/LightBase.ts:182

intensity ​

• get intensity(): number

Get Illumination intensity of light source

Returns ​

number

number

Inherited from ​

LightBase.intensity

Defined in ​

src/components/lights/LightBase.ts:190

• set intensity(value): void

Set Illumination intensity of light source

Parameters ​

Returns ​

void

Inherited from ​

LightBase.intensity

Defined in ​

src/components/lights/LightBase.ts:197

castShadow ​

• get castShadow(): boolean

Returns ​

boolean

Inherited from ​

LightBase.castShadow

Defined in ​

src/components/lights/LightBase.ts:213

• set castShadow(value): void

Cast Light Shadow

Parameters ​

Returns ​

void

Inherited from ​

LightBase.castShadow

Defined in ​

src/components/lights/LightBase.ts:206

shadowIndex ​

• get shadowIndex(): number

get shadow index at shadow map list

Returns ​

number

Inherited from ​

LightBase.shadowIndex

Defined in ​

src/components/lights/LightBase.ts:220

castGI ​

• get castGI(): boolean

get gi is enable

Returns ​

boolean

boolean

Inherited from ​

LightBase.castGI

Defined in ​

src/components/lights/LightBase.ts:229

• set castGI(value): void

set gi is enable

Parameters ​

Returns ​

void

Inherited from ​

LightBase.castGI

Defined in ​

src/components/lights/LightBase.ts:236

direction ​

• get direction(): Vector3

light source direction

Returns ​

Vector3

Vector3

Inherited from ​

LightBase.direction

Defined in ​

src/components/lights/LightBase.ts:250

Methods ​

stop ​

▸ stop(): void

Returns ​

void

Inherited from ​

LightBase.stop

Defined in ​

src/components/ComponentBase.ts:114

onUpdate ​

▸ Optional onUpdate(view?): any

Parameters ​

Returns ​

any

Inherited from ​

LightBase.onUpdate

Defined in ​

src/components/ComponentBase.ts:117

onLateUpdate ​

▸ Optional onLateUpdate(view?): any

Parameters ​

Returns ​

any

Inherited from ​

LightBase.onLateUpdate

Defined in ​

src/components/ComponentBase.ts:118

onBeforeUpdate ​

▸ Optional onBeforeUpdate(view?): any

Parameters ​

Returns ​

any

Inherited from ​

LightBase.onBeforeUpdate

Defined in ​

src/components/ComponentBase.ts:119

onCompute ​

▸ Optional onCompute(view?, command?): any

Parameters ​

Returns ​

any

Inherited from ​

LightBase.onCompute

Defined in ​

src/components/ComponentBase.ts:120

onGraphic ​

▸ Optional onGraphic(view?): any

Parameters ​

Returns ​

any

Inherited from ​

LightBase.onGraphic

Defined in ​

src/components/ComponentBase.ts:121

onParentChange ​

▸ Optional onParentChange(lastParent?, currentParent?): any

Parameters ​

Returns ​

any

Inherited from ​

LightBase.onParentChange

Defined in ​

src/components/ComponentBase.ts:122

cloneTo ​

▸ cloneTo(obj): void

clone component data to target object3D

Parameters ​

Returns ​

void

Inherited from ​

LightBase.cloneTo

Defined in ​

src/components/ComponentBase.ts:129

copyComponent ​

▸ copyComponent(from): DirectLight

Parameters ​

Returns ​

DirectLight

Inherited from ​

LightBase.copyComponent

Defined in ​

src/components/ComponentBase.ts:131

beforeDestroy ​

▸ beforeDestroy(force?): void

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

Parameters ​

Returns ​

void

Inherited from ​

LightBase.beforeDestroy

Defined in ​

src/components/ComponentBase.ts:198

init ​

▸ init(): void

Returns ​

void

Overrides ​

LightBase.init

Defined in ​

src/components/lights/DirectLight.ts:18

start ​

▸ start(): void

Returns ​

void

Overrides ​

LightBase.start

Defined in ​

src/components/lights/DirectLight.ts:29

debug ​

▸ debug(): void

enable light debug gui

Returns ​

void

Defined in ​

src/components/lights/DirectLight.ts:88

onEnable ​

▸ onEnable(): void

Returns ​

void

Inherited from ​

LightBase.onEnable

Defined in ​

src/components/lights/LightBase.ts:106

onDisable ​

▸ onDisable(): void

Returns ​

void

Inherited from ​

LightBase.onDisable

Defined in ​

src/components/lights/LightBase.ts:111

destroy ​

▸ destroy(force?): void

Parameters ​

Returns ​

void

Inherited from ​

LightBase.destroy

Defined in ​

src/components/lights/LightBase.ts:254