LightingWorld
Defined in: lighting/src/LightingWorld.ts:21
Per-scene light state.
levelAt(x, y) reports a continuous value from 0 to 1. The ambient level
and every radial source contribution are added, then clamped.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new LightingWorld(
scene,ambient?,errorBoundary?):LightingWorld
Defined in: lighting/src/LightingWorld.ts:33
Parameters
Section titled “Parameters”Scene
ambient?
Section titled “ambient?”AmbientLightOptions = {}
errorBoundary?
Section titled “errorBoundary?”ErrorBoundary
Returns
Section titled “Returns”LightingWorld
Properties
Section titled “Properties”
readonlyscene:Scene
Defined in: lighting/src/LightingWorld.ts:23
Accessors
Section titled “Accessors”ambientColor
Section titled “ambientColor”Get Signature
Section titled “Get Signature”get ambientColor():
number
Defined in: lighting/src/LightingWorld.ts:65
RGB ambient tint used by visual renderers.
Returns
Section titled “Returns”number
ambientLevel
Section titled “ambientLevel”Get Signature
Section titled “Get Signature”get ambientLevel():
number
Defined in: lighting/src/LightingWorld.ts:60
Scalar light present where no source reaches.
Returns
Section titled “Returns”number
occluders
Section titled “occluders”Get Signature
Section titled “Get Signature”get occluders():
ReadonlySet<LightOccluder>
Defined in: lighting/src/LightingWorld.ts:55
Every effectively enabled occluder in this scene.
Returns
Section titled “Returns”ReadonlySet<LightOccluder>
sources
Section titled “sources”Get Signature
Section titled “Get Signature”get sources():
ReadonlySet<LightSource>
Defined in: lighting/src/LightingWorld.ts:50
Every effectively enabled light source in this scene.
Returns
Section titled “Returns”ReadonlySet<LightSource>
Methods
Section titled “Methods”_attachRenderer()
Section titled “_attachRenderer()”_attachRenderer(
renderer):void
Defined in: lighting/src/LightingWorld.ts:118
Internal
Parameters
Section titled “Parameters”renderer
Section titled “renderer”Returns
Section titled “Returns”void
_render()
Section titled “_render()”_render(
frame):void
Defined in: lighting/src/LightingWorld.ts:128
Internal
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void
destroy()
Section titled “destroy()”destroy():
void
Defined in: lighting/src/LightingWorld.ts:142
Release the renderer and clear registered scene state.
Returns
Section titled “Returns”void
levelAt()
Section titled “levelAt()”levelAt(
x,y):number
Defined in: lighting/src/LightingWorld.ts:79
Return the combined light level at a world-space point.
Parameters
Section titled “Parameters”number
number
Returns
Section titled “Returns”number
registerOccluder()
Section titled “registerOccluder()”registerOccluder(
occluder):void
Defined in: lighting/src/LightingWorld.ts:107
Register renderer-neutral shadow geometry.
Parameters
Section titled “Parameters”occluder
Section titled “occluder”Returns
Section titled “Returns”void
registerSource()
Section titled “registerSource()”registerSource(
source):void
Defined in: lighting/src/LightingWorld.ts:96
Register a source. Components call this while effectively enabled.
Parameters
Section titled “Parameters”source
Section titled “source”Returns
Section titled “Returns”void
setAmbient()
Section titled “setAmbient()”setAmbient(
level,color?):void
Defined in: lighting/src/LightingWorld.ts:70
Set the ambient light level and optionally its RGB tint.
Parameters
Section titled “Parameters”number
color?
Section titled “color?”number = ...
Returns
Section titled “Returns”void
unregisterOccluder()
Section titled “unregisterOccluder()”unregisterOccluder(
occluder):void
Defined in: lighting/src/LightingWorld.ts:113
Remove renderer-neutral shadow geometry without destroying it.
Parameters
Section titled “Parameters”occluder
Section titled “occluder”Returns
Section titled “Returns”void
unregisterSource()
Section titled “unregisterSource()”unregisterSource(
source):void
Defined in: lighting/src/LightingWorld.ts:102
Remove a source without destroying it.
Parameters
Section titled “Parameters”source
Section titled “source”Returns
Section titled “Returns”void