Class DirectionalLight

Create a directional light, that is emitted in a single direction without any attenuation. A common use case for this type of light is to simulate the sun.

This light can cast DirectionalShadow.

Example

// assuming 'renderer' is a valid Camera renderer

// this directional light will not cast any shadows
const directionalLight = new DirectionalLight(renderer, {
  color: new Vec3(1),
  intensity: 1,
  position: new Vec3(5, 2, 3),
})

// this directional light will cast shadows
const directionalLightWithShadows = new DirectionalLight(renderer, {
  color: new Vec3(1),
  intensity: 1,
  position: new Vec3(-10, 10, -5),
  shadow: {
    intensity: 1
  },
})

// this directional light will ALSO cast shadows!
const anotherDirectionalLightWithShadows = new DirectionalLight(renderer, {
  color: new Vec3(1),
  intensity: 2,
  position: new Vec3(12, 0.5, 5),
  target: new Vec3(3),
  shadow: {}, // that's enough to start casting shadows
})

// this directional light will cast shadows as well...
const lastDirectionalLightWithShadows = new DirectionalLight(renderer, {
  color: new Vec3(1),
  intensity: 1,
  position: new Vec3(10),
})

// ... because we're telling it here to start casting shadows
lastDirectionalLightWithShadows.shadow.cast()

Hierarchy (view full)

Light
- DirectionalLight

Constructors

constructor

new DirectionalLight(renderer, parameters?): DirectionalLight
DirectionalLight constructor
Parameters
- renderer: CameraRenderer
  CameraRenderer used to create this DirectionalLight.
- parameters: DirectionalLightBaseParams = ...
  parameters used to create this DirectionalLight.
Returns DirectionalLight
Overrides Light.constructor
- Defined in src/core/lights/DirectionalLight.ts:85

Properties

target

target: Vec3

The DirectionalLight target.

`Private` #direction

#direction: Vec3

The direction of the DirectionalLight is the target minus the actual position.

options

options: DirectionalLightBaseParams

Options used to create this DirectionalLight.

shadow

shadow: DirectionalShadow

DirectionalShadow associated with this DirectionalLight.

type

type: string

Type of the light.

`Readonly` uuid

uuid: string

The universal unique id of this Light

index

index: number

Index of this Light, i.e. the number of time a Light of this type has been created.

renderer

renderer: CameraRenderer

CameraRenderer used by this Light

color

color: Vec3

Current color of this Light.

`Private` #intensityColor

#intensityColor: Vec3

A Vec3 holding the Light color multiplied by its intensity.

rendererBinding

rendererBinding: BufferBinding

CameraRenderer corresponding BufferBinding that holds all the bindings to send to the shaders.

transforms

transforms: Object3DTransforms

Transformation object of the Object3D

matrices

matrices: Object3DMatrices

Matrices object of the Object3D

children

children: Object3D[]

Children Object3D in the scene graph, used to compute their own world matrix

object3DIndex

object3DIndex: number

Index (order of creation) of this Object3D. Used in the parent / children relation.

matricesNeedUpdate

matricesNeedUpdate: boolean

Whether at least one of this Object3D matrix needs an update.

Accessors

intensity

get intensity(): number
Get this Light intensity.

Returns number
- The Light intensity.
Inherited from Light.intensity
- Defined in src/core/lights/Light.ts:123
set intensity(value): void
Set this Light intensity and update the CameraRenderer corresponding BufferBinding.
Parameters
- value: number
  The new Light intensity.
Returns void
Inherited from Light.intensity
- Defined in src/core/lights/Light.ts:131

parent

get parent(): Object3D
Get the parent of this Object3D if any

Returns Object3D
Inherited from Light.parent
- Defined in src/core/objects3D/Object3D.ts:92
set parent(value): void
Set the parent of this Object3D
Parameters
- value: Object3D
  new parent to set, could be an Object3D or null
Returns void
Inherited from Light.parent
- Defined in src/core/objects3D/Object3D.ts:100

rotation

get rotation(): Vec3
Get our rotation vector

Returns Vec3
Inherited from Light.rotation
- Defined in src/core/objects3D/Object3D.ts:145
set rotation(value): void
Set our rotation vector
Parameters
- value: Vec3
  new rotation vector
Returns void
Inherited from Light.rotation
- Defined in src/core/objects3D/Object3D.ts:153

quaternion

get quaternion(): Quat
Get our quaternion

Returns Quat
Inherited from Light.quaternion
- Defined in src/core/objects3D/Object3D.ts:161
set quaternion(value): void
Set our quaternion
Parameters
- value: Quat
  new quaternion
Returns void
Inherited from Light.quaternion
- Defined in src/core/objects3D/Object3D.ts:169

position

get position(): Vec3
Get our position vector

Returns Vec3
Inherited from Light.position
- Defined in src/core/objects3D/Object3D.ts:176
set position(value): void
Set our position vector
Parameters
- value: Vec3
  new position vector
Returns void
Inherited from Light.position
- Defined in src/core/objects3D/Object3D.ts:184

scale

get scale(): Vec3
Get our scale vector

Returns Vec3
Inherited from Light.scale
- Defined in src/core/objects3D/Object3D.ts:191
set scale(value): void
Set our scale vector
Parameters
- value: Vec3
  new scale vector
Returns void
Inherited from Light.scale
- Defined in src/core/objects3D/Object3D.ts:199

transformOrigin

get transformOrigin(): Vec3
Get our transform origin vector

Returns Vec3
Inherited from Light.transformOrigin
- Defined in src/core/objects3D/Object3D.ts:208
set transformOrigin(value): void
Set our transform origin vector
Parameters
- value: Vec3
  new transform origin vector
Returns void
Inherited from Light.transformOrigin
- Defined in src/core/objects3D/Object3D.ts:216

modelMatrix

get modelMatrix(): Mat4
Get our model matrix

Returns Mat4
Inherited from Light.modelMatrix
- Defined in src/core/objects3D/Object3D.ts:273
set modelMatrix(value): void
Set our model matrix
Parameters
- value: Mat4
  new model matrix
Returns void
Inherited from Light.modelMatrix
- Defined in src/core/objects3D/Object3D.ts:281

worldMatrix

get worldMatrix(): Mat4
Get our world matrix

Returns Mat4
Inherited from Light.worldMatrix
- Defined in src/core/objects3D/Object3D.ts:297
set worldMatrix(value): void
Set our world matrix
Parameters
- value: Mat4
  new world matrix
Returns void
Inherited from Light.worldMatrix
- Defined in src/core/objects3D/Object3D.ts:305

Methods

reset

reset(): void
Resend all properties to the CameraRenderer corresponding BufferBinding. Called when the maximum number of DirectionalLight has been overflowed.

Returns void
Overrides Light.reset
- Defined in src/core/lights/DirectionalLight.ts:134

setDirection

setDirection(): void
Set the DirectionalLight direction based on the target and the worldMatrix translation and update the DirectionalShadow view matrix.

Returns void
- Defined in src/core/lights/DirectionalLight.ts:144

updateMatrixStack

updateMatrixStack(): void
If the model matrix has been updated, set the new direction from the worldMatrix translation.

Returns void
Overrides Light.updateMatrixStack
- Defined in src/core/lights/DirectionalLight.ts:162

onMaxLightOverflow

onMaxLightOverflow(lightsType): void
Tell the renderer that the maximum number of DirectionalLight has been overflown.
Parameters
- lightsType: LightsType
  type of this light.
Returns void
Overrides Light.onMaxLightOverflow
- Defined in src/core/lights/DirectionalLight.ts:174

destroy

destroy(): void
Destroy this DirectionalLight and associated DirectionalShadow.

Returns void
Overrides Light.destroy
- Defined in src/core/lights/DirectionalLight.ts:182

setRendererBinding

setRendererBinding(): void
Set or reset this Light CameraRenderer corresponding BufferBinding.

Returns void
Inherited from Light.setRendererBinding
- Defined in src/core/lights/Light.ts:105

onPropertyChanged

onPropertyChanged(propertyKey, value): void
Update the CameraRenderer corresponding BufferBinding input value and tell the renderer camera, lights and shadows bind group to update.
Parameters
- propertyKey: string
  name of the property to update.
- value: number | Vec3
  new value of the property.
Returns void
Inherited from Light.onPropertyChanged
- Defined in src/core/lights/Light.ts:141

remove

remove(): void
Remove this Light from the renderer.

Returns void
Inherited from Light.remove
- Defined in src/core/lights/Light.ts:170

setTransforms

setTransforms(): void
Set our transforms properties and vectors onChange callbacks

Returns void
Inherited from Light.setTransforms
- Defined in src/core/objects3D/Object3D.ts:123

applyRotation

applyRotation(): void
Apply our rotation and tell our model matrix to update

Returns void
Inherited from Light.applyRotation
- Defined in src/core/objects3D/Object3D.ts:223

applyPosition

applyPosition(): void
Tell our model matrix to update

Returns void
Inherited from Light.applyPosition
- Defined in src/core/objects3D/Object3D.ts:232

setMatrices

setMatrices(): void
Set our model matrix and world matrix

Returns void
Inherited from Light.setMatrices
- Defined in src/core/objects3D/Object3D.ts:255

shouldUpdateModelMatrix

shouldUpdateModelMatrix(): void
Set our model matrix shouldUpdate flag to true (tell it to update)

Returns void
Inherited from Light.shouldUpdateModelMatrix
- Defined in src/core/objects3D/Object3D.ts:289

shouldUpdateWorldMatrix

shouldUpdateWorldMatrix(): void
Set our world matrix shouldUpdate flag to true (tell it to update)

Returns void
Inherited from Light.shouldUpdateWorldMatrix
- Defined in src/core/objects3D/Object3D.ts:313

lookAt

lookAt(target?, position?, up?): void
Rotate this Object3D so it looks at the target
Parameters
- target: Vec3 = ...
  target to look at
- position: Vec3 = ...
  postion from which to look at
- up: Vec3 = ...
Returns void
Inherited from Light.lookAt
- Defined in src/core/objects3D/Object3D.ts:322

updateModelMatrix

updateModelMatrix(): void
Update our model matrix

Returns void
Inherited from Light.updateModelMatrix
- Defined in src/core/objects3D/Object3D.ts:331

updateWorldMatrix

updateWorldMatrix(): void
Update our model matrix

Returns void
Inherited from Light.updateWorldMatrix
- Defined in src/core/objects3D/Object3D.ts:347

shouldUpdateMatrices

shouldUpdateMatrices(): void
Check whether at least one of the matrix should be updated

Returns void
Inherited from Light.shouldUpdateMatrices
- Defined in src/core/objects3D/Object3D.ts:363

Class DirectionalLight

Example

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

renderer: CameraRenderer

parameters: DirectionalLightBaseParams = ...

Returns DirectionalLight

Properties

target

Private #direction

options

shadow

type

Readonly uuid

index

renderer

color

Private #intensityColor

rendererBinding

transforms

matrices

children

object3DIndex

matricesNeedUpdate

Accessors

intensity

Returns number

Parameters

value: number

Returns void

parent

Returns Object3D

Parameters

value: Object3D

Returns void

rotation

Returns Vec3

Parameters

value: Vec3

Returns void

quaternion

Returns Quat

Parameters

value: Quat

Returns void

position

Returns Vec3

Parameters

value: Vec3

Returns void

scale

Returns Vec3

Parameters

value: Vec3

Returns void

transformOrigin

Returns Vec3

Parameters

value: Vec3

Returns void

modelMatrix

Returns Mat4

Parameters

value: Mat4

Returns void

worldMatrix

Returns Mat4

Parameters

value: Mat4

Returns void

Methods

reset

Returns void

`Private` #direction

`Readonly` uuid

`Private` #intensityColor