TSL Docs

AnalyticLightNode

Last modified: Jun 30, 2024

Base class for analytic light nodes.

Constructor

new AnalyticLightNode(light?)

Parameter	Type	Default Value
light?	`any`	`null`

Constructs a new analytic light node.

Accessor	Type
get type	`string`
Modifiers `static`

Properties

Property	Type
light	`any`	—
color	`Color`	—
colorNode	`Node`	—
baseColorNode	`null \| Node`	—
shadowNode	`any`	—
shadowColorNode	`null \| Node`	—
isAnalyticLightNode	`boolean`	—
_shadowDisposeListener	`() => void`	—

Method Type

dispose () => void

Returns

void

disposeShadow () => void

Frees internal resources related to shadows.

Returns

void

getHash () => any

Returns

any

getLightVector (builder: NodeBuilder) => any

Returns a node representing a direction vector which points from the current position in view space to the light’s position in view space.

Parameter	Type	Default Value
builder	`NodeBuilder`	—

Returns

any

setupDirect () => undefined | Object

Sets up the direct lighting for the analytic light node.

Returns

undefined | Object

setupDirectRectArea () => undefined | Object

Sets up the direct rect area lighting for the analytic light node.

Returns

undefined | Object

setupShadowNode () => ShadowNode

Setups the shadow node for this light. The method exists so concrete light classes can setup different types of shadow nodes.

Returns

ShadowNode

setupShadow (builder: NodeBuilder) => void

Setups the shadow for this light. This method is only executed if the light cast shadows and the current build object receives shadows. It incorporates shadows into the lighting computation.

Parameter	Type	Default Value
builder	`NodeBuilder`	—

Returns

void

setup (builder: NodeBuilder) => void

Unlike most other nodes, lighting nodes do not return a output node in Node#setup. The main purpose of lighting nodes is to configure the current LightingModel and/or invocate the respective interface methods.

Parameter	Type	Default Value
builder	`NodeBuilder`	—

Returns

void

update () => void

The update method is used to update light uniforms per frame. Potentially overwritten in concrete light nodes to update light specific uniforms.

Returns

void

Extends

LightingNode