Accueil / npm / three@0.186.1 / src / renderers / common / Lighting.js
Lighting.js
import { LightsNode } from '../../nodes/Nodes.js';
const _defaultLights = /*@__PURE__*/ new LightsNode();
/**
* This renderer module manages the lights nodes which are unique
* per scene + camera + lighting combination.
*
* The lights node itself is later configured in the render list
* with the actual lights from the scene.
*
* @private
*/
class Lighting {
/**
* Constructs a new lighting manager.
*/
constructor() {
/**
* Whether this lighting manager is enabled or not.
*
* @type {boolean}
* @default true
*/
this.enabled = true;
/**
* A stack of light arrays saved per render via {@link Lighting#beginRender}.
*
* @private
* @type {Array<Array<Light>>}
*/
this._cache = [];
/**
* A map of lights nodes per scene.
*
* @private
* @type {WeakMap<Scene, LightsNode>}
*/
this._lightsNodeMap = new WeakMap();
}
/**
* Creates a new lights node for the given array of lights.
*
* @param {Array<Light>} lights - The render object.
* @return {LightsNode} The lights node.
*/
createNode( lights = [] ) {
return new LightsNode().setLights( lights );
}
/**
* Returns a lights node for the given scene.
*
* @param {Scene} scene - The scene.
* @return {LightsNode} The lights node.
*/
getNode( scene ) {
// Ignore renderable objects, e.g: Mesh, Sprite, etc.
if ( scene.isScene !== true && scene.isGroup !== true ) return _defaultLights;
let node = this._lightsNodeMap.get( scene );
if ( node === undefined ) {
node = this.createNode();
this._lightsNodeMap.set( scene, node );
}
return node;
}
/**
* Saves the current lights of the scene's lights node so they can be restored
* in {@link Lighting#finishRender}. Must be paired with a `finishRender()` call
* to avoid memory leaks.
*
* Nested render calls might mutate the lights array so a save/restore is required
* for each render call.
*
* @param {Scene} scene - The scene.
*/
beginRender( scene ) {
this._cache.push( this.getNode( scene ).getLights() );
}
/**
* Restores the lights saved by the matching {@link Lighting#beginRender} call.
*
* @param {Scene} scene - The scene.
*/
finishRender( scene ) {
this.getNode( scene ).setLights( this._cache.pop() );
}
}
export default Lighting;