Class SpotLight

Create a spot light, that is emitted from a single point in one direction, along a cone that increases in size the further from the light it gets.

This light can cast SpotShadow.

Example

// assuming 'renderer' is a valid Camera renderer

// this spot light will not cast any shadows
const spotLight = new SpotLight(renderer, {
  color: new Vec3(1),
  intensity: 1,
  position: new Vec3(5, 2, 3),
  penumbra: 0.5,
})

// this spot light will cast shadows
const spotLightWithShadows = new SpotLight(renderer, {
  color: new Vec3(1),
  intensity: 1,
  position: new Vec3(-10, 10, -5),
  target: new Vec3(0, 0.5, 0),
  shadow: {
    intensity: 1,
  },
})

// this spot light will ALSO cast shadows!
const anotherSpotLightWithShadows = new SpotLight(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 spot light will cast shadows as well...
const lastSpotLightWithShadows = new SpotLight(renderer, {
  color: new Vec3(1),
  intensity: 1,
  position: new Vec3(10),
})

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

Hierarchy (View Summary)

Light
- SpotLight

Constructors

constructor

new SpotLight(
renderer: GPUCurtains | CameraRenderer,
parameters?: SpotLightBaseParams,
): SpotLight
SpotLight constructor
Parameters
- renderer: GPUCurtains | CameraRenderer
  CameraRenderer or GPUCurtains used to create this SpotLight.
- parameters: SpotLightBaseParams = ...
  SpotLightBaseParams used to create this SpotLight.
Returns SpotLight
Overrides Light.constructor
- Defined in src/core/lights/SpotLight.ts:100

Properties

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.

rendererBinding

rendererBinding: BufferBinding

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

userData

userData: Record<string, unknown>

Empty object to store any additional data or custom properties into your Light.

_onBeforeRenderCallback

_onBeforeRenderCallback: () => void

function assigned to the onBeforeRender callback

target

target: Vec3

The SpotLight target.

options

options: SpotLightBaseParams

Options used to create this SpotLight.

shadow

shadow: SpotShadow

SpotShadow associated with this SpotLight.

Vec3 used by the lookAt method, to determine the orientation of the result. Default to new Vec3(0, 1, 0).

actualPosition

actualPosition: Vec3

Vec3 holding the actual position of this Object3D from its worldMatrix.

children

children: Object3D[]

Children Object3D in the scene graph, used to compute their own worldMatrix.

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

actualColor

get actualColor(): Vec3
Get the actual Vec3 color used in the shader: convert color to linear space, then multiply by intensity.

Returns Vec3
- Actual Vec3 color used in the shader.
Inherited from Light.actualColor
- Defined in src/core/lights/Light.ts:181

intensity

get intensity(): number
Get this SpotLight intensity.

Returns number
- The SpotLight intensity.
Overrides Light.intensity
- Defined in src/core/lights/SpotLight.ts:195
set intensity(value: number): void
Set this SpotLight intensity and clear shadow if intensity is 0.
Parameters
- value: number
  The new SpotLight intensity.
Returns void
Overrides Light.intensity
- Defined in src/core/lights/SpotLight.ts:203

angle

get angle(): number
Get this SpotLight angle.

Returns number
- The SpotLight angle.
- Defined in src/core/lights/SpotLight.ts:229
set angle(value: number): void
Set this SpotLight angle and update the CameraRenderer corresponding BufferBinding.
Parameters
- value: number
  The new SpotLight angle in the [0, PI / 2] range.
Returns void
- Defined in src/core/lights/SpotLight.ts:237

penumbra

get penumbra(): number
Get this SpotLight penumbra.

Returns number
- The SpotLight penumbra.
- Defined in src/core/lights/SpotLight.ts:249
set penumbra(value: number): void
Set this SpotLight penumbra and update the CameraRenderer corresponding BufferBinding.
Parameters
- value: number
  The new SpotLight penumbra in the [0, 1] range.
Returns void
- Defined in src/core/lights/SpotLight.ts:257

range

get range(): number
Get this SpotLight range.

Returns number
- The SpotLight range.
- Defined in src/core/lights/SpotLight.ts:266
set range(value: number): void
Set this SpotLight range and update the CameraRenderer corresponding BufferBinding.
Parameters
- value: number
  The new SpotLight range.
Returns void
- Defined in src/core/lights/SpotLight.ts:274

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:101
set parent(value: Object3D): 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:109

rotation

get rotation(): Vec3
Get our rotation vector

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

quaternion

get quaternion(): Quat
Get our quaternion

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

position

get position(): Vec3
Get our position vector

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

scale

get scale(): Vec3
Get our scale vector

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

transformOrigin

get transformOrigin(): Vec3
Get our transform origin vector

Returns Vec3
Inherited from Light.transformOrigin
- Defined in src/core/objects3D/Object3D.ts:217
set transformOrigin(value: Vec3): 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:225

modelMatrix

get modelMatrix(): Mat4
Get our model matrix

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

worldMatrix

get worldMatrix(): Mat4
Get our world matrix

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

Methods

setRendererBinding

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

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

onPropertyChanged

onPropertyChanged(propertyKey: string, value: number | Vec3): 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:190

onBeforeRenderScene

onBeforeRenderScene(): void
Called by the Scene before updating the matrix stack.

Returns void
Inherited from Light.onBeforeRenderScene
- Defined in src/core/lights/Light.ts:231

onBeforeRender

onBeforeRender(callback: () => void): this
Callback to execute before updating the Scene matrix stack. This means it is called early and allows to update transformations values before actually setting the Light matrices. The callback won't be called if the renderer is not ready.
Parameters
- callback: () => void
  callback to run just before updating the Scene matrix stack.
Returns this
- our Light
Inherited from Light.onBeforeRender
- Defined in src/core/lights/Light.ts:240

remove

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

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

setRenderer

setRenderer(renderer: GPUCurtains | CameraRenderer): void
Set or reset this SpotLight CameraRenderer.
Parameters
- renderer: GPUCurtains | CameraRenderer
  New CameraRenderer or GPUCurtains instance to use.
Returns void
Overrides Light.setRenderer
- Defined in src/core/lights/SpotLight.ts:165

reset

reset(resetShadow?: boolean): void
Resend all properties to the CameraRenderer corresponding BufferBinding. Called when the maximum number of SpotLight has been overflowed or when updating the SpotLight renderer.
Parameters
- resetShadow: boolean = true
  Whether to reset the SpotLight shadow if any. Set to true when the renderer number of SpotLight has been overflown, false when the renderer has been changed (since the shadow will reset itself).
Returns void
Overrides Light.reset
- Defined in src/core/lights/SpotLight.ts:178

setPositionDirection

setPositionDirection(): void
Set the SpotLight position and direction based on the target and the worldMatrix translation.

Returns void
- Defined in src/core/lights/SpotLight.ts:214

lookAt

lookAt(target?: Vec3): void
Rotate this SpotLight so it looks at the target.
Parameters
- target: Vec3 = ...
  Vec3 to look at. Default to new Vec3().
Returns void
Overrides Light.lookAt
- Defined in src/core/lights/SpotLight.ts:287

updateMatrixStack

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

Returns void
Overrides Light.updateMatrixStack
- Defined in src/core/lights/SpotLight.ts:304

onMaxLightOverflow

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

destroy

destroy(): void
Destroy this SpotLight and associated SpotShadow.

Returns void
Overrides Light.destroy
- Defined in src/core/lights/SpotLight.ts:324

setTransforms

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

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

applyPosition

applyPosition(): void
Tell our model matrix to update

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

setMatrices

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

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

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:297

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:321

applyLookAt

applyLookAt(target: Vec3, position: Vec3): void
Apply a look at rotation based on a target, a position and our up vectors.
Parameters
- target: Vec3
  Vec3 target to look at.
- position: Vec3
  Vec3 position from which to look at.
Returns void
Inherited from Light.applyLookAt
- Defined in src/core/objects3D/Object3D.ts:347

updateModelMatrix

updateModelMatrix(): void
Update our model matrix

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

updateWorldMatrix

updateWorldMatrix(updateParents?: boolean, updateChildren?: boolean): void
Update our model matrix.
Parameters
- updateParents: boolean = false
  Whether to update the parent worldMatrix beforehand. Default to false.
- updateChildren: boolean = true
  Whether to update the children worldMatrix afterward. Default to true.
Returns void
Inherited from Light.updateWorldMatrix
- Defined in src/core/objects3D/Object3D.ts:374

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:398

Class SpotLight

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns SpotLight

Properties

type

Readonlyuuid

index

renderer

color

rendererBinding

userData

_onBeforeRenderCallback

target

options

shadow

transforms

matrices

up

actualPosition

children

object3DIndex

matricesNeedUpdate

Accessors

actualColor

Returns Vec3

intensity

Returns number

Parameters

Returns void

angle

Returns number

Parameters

Returns void

penumbra

Returns number

Parameters

Returns void

range

Returns number

Parameters

Returns void

parent

Returns Object3D

Parameters

Returns void

rotation

Returns Vec3

Parameters

Returns void

quaternion

Returns Quat

Parameters

Returns void

position

Returns Vec3

Parameters

Returns void

scale

Returns Vec3

Parameters

Returns void

transformOrigin

Returns Vec3

Parameters

Returns void

modelMatrix

Returns Mat4

Parameters

Returns void

worldMatrix

Returns Mat4

`Readonly`uuid