TSL Docs

ReflectorNode

Last modified: Jun 30, 2024

This node can be used to implement mirror-like flat reflective surfaces.

const groundReflector = reflector();
material.colorNode = groundReflector;

const plane = new Mesh( geometry, material );
plane.add( groundReflector.target );
export {}

Constructor

new ReflectorNode(parameters?)

Parameter	Type	Default Value
parameters?	`{ target?: Object3D \| undefined; resolutionScale?: number \| undefined; generateMipmaps?: boolean \| undefined; bounces?: boolean \| undefined; depth?: boolean \| undefined; samples?: number \| undefined; defaultTexture?: TextureNode \| undefined; reflector?: ReflectorBaseNode \| undefined; }`	`{}`

Constructs a new reflector node.

Accessor	Type
get type	`string`
Modifiers `static`
get reflector	`ReflectorBaseNode`
A reference to the internal reflector node.
get target	`Object3D`
A reference to 3D object the reflector is linked to.

Properties

Property	Type	Default Value
_reflectorBaseNode	`ReflectorBaseNode`		—
_depthNode	`null \| Node`		—

Method Type

getDepthNode () => Node

Returns a node representing the mirror’s depth. That can be used to implement more advanced reflection effects like distance attenuation.

Returns

Node

setup (builder: any) => void

Parameter	Type	Default Value
builder	`any`	—

Returns

void

clone () => any

Returns

any

dispose () => void

Frees internal resources. Should be called when the node is no longer in use.

Returns

void

Extends

TextureNode

reflector

TSL function for creating a reflector node.

Parameter	Type	Default Value
parameters?	`{ target?: Object3D \| undefined; resolution?: number \| undefined; generateMipmaps?: boolean \| undefined; bounces?: boolean \| undefined; depth?: boolean \| undefined; samples?: number \| undefined; defaultTexture?: TextureNode \| undefined; reflector?: ReflectorBaseNode \| undefined; }`	`{}`

Returns

ReflectorNode