super-three 0.173.5 → 0.175.0

package/src/nodes/lighting/LightsNode.js

@@ -2,8 +2,6 @@ import Node from '../core/Node.js';
 import { nodeObject, vec3 } from '../tsl/TSLBase.js';
 import { hashArray } from '../core/NodeUtils.js';
 
-/** @module LightsNode **/
-
 const sortLights = ( lights ) => {
 
 	return lights.sort( ( a, b ) => a.id - b.id );
@@ -55,21 +53,21 @@ class LightsNode extends Node {
 		 *
 		 * @type {Node<vec3>}
 		 */
-		this.totalDiffuseNode = vec3().toVar( 'totalDiffuse' );
+		this.totalDiffuseNode = vec3().toVar();
 
 		/**
 		 * A node representing the total specular light.
 		 *
 		 * @type {Node<vec3>}
 		 */
-		this.totalSpecularNode = vec3().toVar( 'totalSpecular' );
+		this.totalSpecularNode = vec3().toVar();
 
 		/**
 		 * A node representing the outgoing light.
 		 *
 		 * @type {Node<vec3>}
 		 */
-		this.outgoingLightNode = vec3().toVar( 'outgoingLight' );
+		this.outgoingLightNode = vec3().toVar();
 
 		/**
 		 * An array representing the lights in the scene.
@@ -84,7 +82,7 @@ class LightsNode extends Node {
 		 * corresponding light node.
 		 *
 		 * @private
-		 * @type {Array<LightingNode>?}
+		 * @type {?Array<LightingNode>}
 		 * @default null
 		 */
 		this._lightNodes = null;
@@ -93,7 +91,7 @@ class LightsNode extends Node {
 		 * A hash for identifying the current light nodes setup.
 		 *
 		 * @private
-		 * @type {String?}
+		 * @type {?string}
 		 * @default null
 		 */
 		this._lightNodesHash = null;
@@ -101,7 +99,7 @@ class LightsNode extends Node {
 		/**
 		 * `LightsNode` sets this property to `true` by default.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @default true
 		 */
 		this.global = true;
@@ -112,7 +110,7 @@ class LightsNode extends Node {
 	 * Overwrites the default {@link Node#customCacheKey} implementation by including the
 	 * light IDs into the cache key.
 	 *
-	 * @return {Number} The custom cache key.
+	 * @return {number} The custom cache key.
 	 */
 	customCacheKey() {
 
@@ -133,7 +131,7 @@ class LightsNode extends Node {
 	 * Computes a hash value for identifying the current light nodes setup.
 	 *
 	 * @param {NodeBuilder} builder - A reference to the current node builder.
-	 * @return {String} The computed hash.
+	 * @return {string} The computed hash.
 	 */
 	getHash( builder ) {
 
@@ -238,6 +236,37 @@ class LightsNode extends Node {
 
 	}
 
+	/**
+	 * Sets up a direct light in the lighting model.
+	 *
+	 * @param {Object} builder - The builder object containing the context and stack.
+	 * @param {Object} lightNode - The light node.
+	 * @param {Object} lightData - The light object containing color and direction properties.
+	 */
+	setupDirectLight( builder, lightNode, lightData ) {
+
+		const { lightingModel, reflectedLight } = builder.context;
+
+		lightingModel.direct( {
+			...lightData,
+			lightNode,
+			reflectedLight
+		}, builder );
+
+	}
+
+	setupDirectRectAreaLight( builder, lightNode, lightData ) {
+
+		const { lightingModel, reflectedLight } = builder.context;
+
+		lightingModel.directRectArea( {
+			...lightData,
+			lightNode,
+			reflectedLight
+		}, builder );
+
+	}
+
 	/**
 	 * Setups the internal lights by building all respective
 	 * light nodes.
@@ -255,6 +284,14 @@ class LightsNode extends Node {
 
 	}
 
+	getLightNodes( builder ) {
+
+		if ( this._lightNodes === null ) this.setupLightsNode( builder );
+
+		return this._lightNodes;
+
+	}
+
 	/**
 	 * The implementation makes sure that for each light in the scene
 	 * there is a corresponding light node. By building the light nodes
@@ -265,16 +302,22 @@ class LightsNode extends Node {
 	 */
 	setup( builder ) {
 
-		if ( this._lightNodes === null ) this.setupLightsNode( builder );
+		const currentLightsNode = builder.lightsNode;
+
+		builder.lightsNode = this;
+
+		//
+
+		let outgoingLightNode = this.outgoingLightNode;
 
 		const context = builder.context;
 		const lightingModel = context.lightingModel;
 
-		let outgoingLightNode = this.outgoingLightNode;
+		const properties = builder.getDataFromNode( this );
 
 		if ( lightingModel ) {
 
-			const { _lightNodes, totalDiffuseNode, totalSpecularNode } = this;
+			const { totalDiffuseNode, totalSpecularNode } = this;
 
 			context.outgoingLight = outgoingLightNode;
 
@@ -282,20 +325,11 @@ class LightsNode extends Node {
 
 			//
 
-			const properties = builder.getDataFromNode( this );
 			properties.nodes = stack.nodes;
 
 			//
 
-			lightingModel.start( context, stack, builder );
-
-			// lights
-
-			this.setupLights( builder, _lightNodes );
-
-			//
-
-			lightingModel.indirect( context, stack, builder );
+			lightingModel.start( builder );
 
 			//
 
@@ -327,14 +361,22 @@ class LightsNode extends Node {
 
 			//
 
-			lightingModel.finish( context, stack, builder );
+			lightingModel.finish( builder );
 
 			//
 
 			outgoingLightNode = outgoingLightNode.bypass( builder.removeStack() );
 
+		} else {
+
+			properties.nodes = [];
+
 		}
 
+		//
+
+		builder.lightsNode = currentLightsNode;
+
 		return outgoingLightNode;
 
 	}
@@ -370,7 +412,7 @@ class LightsNode extends Node {
 	/**
 	 * Whether the scene has lights or not.
 	 *
-	 * @type {Boolean}
+	 * @type {boolean}
 	 */
 	get hasLights() {
 
@@ -386,6 +428,7 @@ export default LightsNode;
  * TSL function for creating an instance of `LightsNode` and configuring
  * it with the given array of lights.
  *
+ * @tsl
  * @function
  * @param {Array<Light>} lights - An array of lights.
  * @return {LightsNode} The created lights node.

package/src/nodes/lighting/PointLightNode.js

@@ -1,38 +1,25 @@
 import AnalyticLightNode from './AnalyticLightNode.js';
 import { getDistanceAttenuation } from './LightUtils.js';
 import { uniform } from '../core/UniformNode.js';
-import { lightViewPosition } from '../accessors/Lights.js';
-import { positionView } from '../accessors/Position.js';
-import { Fn } from '../tsl/TSLBase.js';
 import { renderGroup } from '../core/UniformGroupNode.js';
 import { pointShadow } from './PointShadowNode.js';
 
-export const directPointLight = Fn( ( { color, lightViewPosition, cutoffDistance, decayExponent }, builder ) => {
+export const directPointLight = ( { color, lightVector, cutoffDistance, decayExponent } ) => {
 
-	const lightingModel = builder.context.lightingModel;
+	const lightDirection = lightVector.normalize();
+	const lightDistance = lightVector.length();
 
-	const lVector = lightViewPosition.sub( positionView ); // @TODO: Add it into LightNode
-
-	const lightDirection = lVector.normalize();
-	const lightDistance = lVector.length();
-
-	const lightAttenuation = getDistanceAttenuation( {
+	const attenuation = getDistanceAttenuation( {
 		lightDistance,
 		cutoffDistance,
 		decayExponent
 	} );
 
-	const lightColor = color.mul( lightAttenuation );
+	const lightColor = color.mul( attenuation );
 
-	const reflectedLight = builder.context.reflectedLight;
+	return { lightDirection, lightColor };
 
-	lightingModel.direct( {
-		lightDirection,
-		lightColor,
-		reflectedLight
-	}, builder.stack, builder );
-
-} );
+};
 
 /**
  * Module for representing point lights as nodes.
@@ -50,7 +37,7 @@ class PointLightNode extends AnalyticLightNode {
 	/**
 	 * Constructs a new point light node.
 	 *
-	 * @param {PointLight?} [light=null] - The point light source.
+	 * @param {?PointLight} [light=null] - The point light source.
 	 */
 	constructor( light = null ) {
 
@@ -99,16 +86,14 @@ class PointLightNode extends AnalyticLightNode {
 
 	}
 
-	setup( builder ) {
-
-		super.setup( builder );
+	setupDirect( builder ) {
 
-		directPointLight( {
+		return directPointLight( {
 			color: this.colorNode,
-			lightViewPosition: lightViewPosition( this.light ),
+			lightVector: this.getLightVector( builder ),
 			cutoffDistance: this.cutoffDistanceNode,
 			decayExponent: this.decayExponentNode
-		} ).append();
+		} );
 
 	}
 

package/src/nodes/lighting/PointShadowNode.js

@@ -11,8 +11,6 @@ import { Vector4 } from '../../math/Vector4.js';
 import { Color } from '../../math/Color.js';
 import { BasicShadowMap } from '../../constants.js';
 
-/** @module PointShadowNode **/
-
 const _clearColor = /*@__PURE__*/ new Color();
 
 // cubeToUV() maps a 3D direction vector suitable for cube texture mapping to a 2D
@@ -163,7 +161,7 @@ const _shadowMapSize = /*@__PURE__*/ new Vector2();
 /**
  * Represents the shadow implementation for point light nodes.
  *
- * @augments module:ShadowNode~ShadowNode
+ * @augments ShadowNode
  */
 class PointShadowNode extends ShadowNode {
 
@@ -177,7 +175,7 @@ class PointShadowNode extends ShadowNode {
 	 * Constructs a new point shadow node.
 	 *
 	 * @param {PointLight} light - The shadow casting point light.
-	 * @param {PointLightShadow?} [shadow=null] - An optional point light shadow.
+	 * @param {?PointLightShadow} [shadow=null] - An optional point light shadow.
 	 */
 	constructor( light, shadow = null ) {
 
@@ -189,7 +187,7 @@ class PointShadowNode extends ShadowNode {
 	 * Overwrites the default implementation to return point light shadow specific
 	 * filtering functions.
 	 *
-	 * @param {Number} type - The shadow type.
+	 * @param {number} type - The shadow type.
 	 * @return {Function} The filtering function.
 	 */
 	getShadowFilterFn( type ) {
@@ -299,9 +297,10 @@ export default PointShadowNode;
 /**
  * TSL function for creating an instance of `PointShadowNode`.
  *
+ * @tsl
  * @function
  * @param {PointLight} light - The shadow casting point light.
- * @param {PointLightShadow?} [shadow=null] - An optional point light shadow.
+ * @param {?PointLightShadow} [shadow=null] - An optional point light shadow.
  * @return {PointShadowNode} The created point shadow node.
  */
 export const pointShadow = ( light, shadow ) => nodeObject( new PointShadowNode( light, shadow ) );

package/src/nodes/lighting/RectAreaLightNode.js

@@ -29,7 +29,7 @@ class RectAreaLightNode extends AnalyticLightNode {
 	/**
 	 * Constructs a new rect area light node.
 	 *
-	 * @param {RectAreaLight?} [light=null] - The rect area light source.
+	 * @param {?RectAreaLight} [light=null] - The rect area light source.
 	 */
 	constructor( light = null ) {
 
@@ -53,7 +53,7 @@ class RectAreaLightNode extends AnalyticLightNode {
 		 * The `updateType` is set to `NodeUpdateType.RENDER` since the light
 		 * relies on `viewMatrix` which might vary per render call.
 		 *
-		 * @type {String}
+		 * @type {string}
 		 * @default 'render'
 		 */
 		this.updateType = NodeUpdateType.RENDER;
@@ -86,9 +86,7 @@ class RectAreaLightNode extends AnalyticLightNode {
 
 	}
 
-	setup( builder ) {
-
-		super.setup( builder );
+	setupDirectRectArea( builder ) {
 
 		let ltc_1, ltc_2;
 
@@ -105,20 +103,17 @@ class RectAreaLightNode extends AnalyticLightNode {
 		}
 
 		const { colorNode, light } = this;
-		const lightingModel = builder.context.lightingModel;
 
 		const lightPosition = lightViewPosition( light );
-		const reflectedLight = builder.context.reflectedLight;
 
-		lightingModel.directRectArea( {
+		return {
 			lightColor: colorNode,
 			lightPosition,
 			halfWidth: this.halfWidth,
 			halfHeight: this.halfHeight,
-			reflectedLight,
 			ltc_1,
 			ltc_2
-		}, builder.stack, builder );
+		};
 
 	}
 

package/src/nodes/lighting/ShadowBaseNode.js

@@ -1,10 +1,8 @@
 import Node from '../core/Node.js';
 import { NodeUpdateType } from '../core/constants.js';
-import { vec3 } from '../tsl/TSLBase.js';
+import { property } from '../tsl/TSLBase.js';
 import { positionWorld } from '../accessors/Position.js';
 
-/** @module ShadowBaseNode **/
-
 /**
  * Base class for all shadow nodes.
  *
@@ -41,7 +39,7 @@ class ShadowBaseNode extends Node {
 		/**
 		 * Overwritten since shadows are updated by default per render.
 		 *
-		 * @type {String}
+		 * @type {string}
 		 * @default 'render'
 		 */
 		this.updateBeforeType = NodeUpdateType.RENDER;
@@ -49,7 +47,7 @@ class ShadowBaseNode extends Node {
 		/**
 		 * This flag can be used for type testing.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @readonly
 		 * @default true
 		 */
@@ -60,13 +58,13 @@ class ShadowBaseNode extends Node {
 	/**
 	 * Setups the shadow position node which is by default the predefined TSL node object `shadowPositionWorld`.
 	 *
-	 * @param {(NodeBuilder|{Material})} object - A configuration object that must at least hold a material reference.
+	 * @param {NodeBuilder} object - A configuration object that must at least hold a material reference.
 	 */
-	setupShadowPosition( { material } ) {
+	setupShadowPosition( { context, material } ) {
 
 		// Use assign inside an Fn()
 
-		shadowPositionWorld.assign( material.shadowPositionNode || positionWorld );
+		shadowPositionWorld.assign( material.shadowPositionNode || context.shadowPositionWorld || positionWorld );
 
 	}
 
@@ -86,8 +84,9 @@ class ShadowBaseNode extends Node {
 /**
  * TSL object that represents the vertex position in world space during the shadow pass.
  *
+ * @tsl
  * @type {Node<vec3>}
  */
-export const shadowPositionWorld = /*@__PURE__*/ vec3().toVar( 'shadowPositionWorld' );
+export const shadowPositionWorld = /*@__PURE__*/ property( 'vec3', 'shadowPositionWorld' );
 
 export default ShadowBaseNode;

package/src/nodes/lighting/ShadowNode.js

@@ -19,8 +19,6 @@ import { lightShadowMatrix } from '../accessors/Lights.js';
 import { resetRendererAndSceneState, restoreRendererAndSceneState } from '../../renderers/common/RendererUtils.js';
 import { getDataFromObject } from '../core/NodeUtils.js';
 
-/** @module ShadowNode **/
-
 const shadowMaterialLib = /*@__PURE__*/ new WeakMap();
 const linearDistance = /*@__PURE__*/ Fn( ( [ position, cameraNear, cameraFar ] ) => {
 
@@ -314,7 +312,7 @@ const _quadMesh = /*@__PURE__*/ new QuadMesh();
 /**
  * Represents the default shadow implementation for lighting nodes.
  *
- * @augments module:ShadowBaseNode~ShadowBaseNode
+ * @augments ShadowBaseNode
  */
 class ShadowNode extends ShadowBaseNode {
 
@@ -328,7 +326,7 @@ class ShadowNode extends ShadowBaseNode {
 	 * Constructs a new shadow node.
 	 *
 	 * @param {Light} light - The shadow casting light.
-	 * @param {LightShadow?} [shadow=null] - An optional light shadow.
+	 * @param {?LightShadow} [shadow=null] - An optional light shadow.
 	 */
 	constructor( light, shadow = null ) {
 
@@ -338,7 +336,7 @@ class ShadowNode extends ShadowBaseNode {
 		 * The light shadow which defines the properties light's
 		 * shadow.
 		 *
-		 * @type {LightShadow?}
+		 * @type {?LightShadow}
 		 * @default null
 		 */
 		this.shadow = shadow || light.shadow;
@@ -346,7 +344,7 @@ class ShadowNode extends ShadowBaseNode {
 		/**
 		 * A reference to the shadow map which is a render target.
 		 *
-		 * @type {RenderTarget?}
+		 * @type {?RenderTarget}
 		 * @default null
 		 */
 		this.shadowMap = null;
@@ -355,7 +353,7 @@ class ShadowNode extends ShadowBaseNode {
 		 * Only relevant for VSM shadows. Render target for the
 		 * first VSM render pass.
 		 *
-		 * @type {RenderTarget?}
+		 * @type {?RenderTarget}
 		 * @default null
 		 */
 		this.vsmShadowMapVertical = null;
@@ -364,7 +362,7 @@ class ShadowNode extends ShadowBaseNode {
 		 * Only relevant for VSM shadows. Render target for the
 		 * second VSM render pass.
 		 *
-		 * @type {RenderTarget?}
+		 * @type {?RenderTarget}
 		 * @default null
 		 */
 		this.vsmShadowMapHorizontal = null;
@@ -373,7 +371,7 @@ class ShadowNode extends ShadowBaseNode {
 		 * Only relevant for VSM shadows. Node material which
 		 * is used to render the first VSM pass.
 		 *
-		 * @type {NodeMaterial?}
+		 * @type {?NodeMaterial}
 		 * @default null
 		 */
 		this.vsmMaterialVertical = null;
@@ -382,7 +380,7 @@ class ShadowNode extends ShadowBaseNode {
 		 * Only relevant for VSM shadows. Node material which
 		 * is used to render the second VSM pass.
 		 *
-		 * @type {NodeMaterial?}
+		 * @type {?NodeMaterial}
 		 * @default null
 		 */
 		this.vsmMaterialHorizontal = null;
@@ -391,16 +389,18 @@ class ShadowNode extends ShadowBaseNode {
 		 * A reference to the output node which defines the
 		 * final result of this shadow node.
 		 *
-		 * @type {Node?}
+		 * @type {?Node}
 		 * @private
 		 * @default null
 		 */
 		this._node = null;
 
+		this._cameraFrameId = new WeakMap();
+
 		/**
 		 * This flag can be used for type testing.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @readonly
 		 * @default true
 		 */
@@ -490,7 +490,7 @@ class ShadowNode extends ShadowBaseNode {
 	/**
 	 * Returns the shadow filtering function for the given shadow type.
 	 *
-	 * @param {Number} type - The shadow type.
+	 * @param {number} type - The shadow type.
 	 * @return {Function} The filtering function.
 	 */
 	getShadowFilterFn( type ) {
@@ -768,7 +768,19 @@ class ShadowNode extends ShadowBaseNode {
 
 		const { shadow } = this;
 
-		const needsUpdate = shadow.needsUpdate || shadow.autoUpdate;
+		let needsUpdate = shadow.needsUpdate || shadow.autoUpdate;
+
+		if ( needsUpdate ) {
+
+			if ( this._cameraFrameId[ frame.camera ] === frame.frameId ) {
+
+				needsUpdate = false;
+
+			}
+
+			this._cameraFrameId[ frame.camera ] = frame.frameId;
+
+		}
 
 		if ( needsUpdate ) {
 
@@ -791,9 +803,10 @@ export default ShadowNode;
 /**
  * TSL function for creating an instance of `ShadowNode`.
  *
+ * @tsl
  * @function
  * @param {Light} light - The shadow casting light.
- * @param {LightShadow} shadow - The light shadow.
+ * @param {?LightShadow} [shadow] - The light shadow.
  * @return {ShadowNode} The created shadow node.
  */
 export const shadow = ( light, shadow ) => nodeObject( new ShadowNode( light, shadow ) );

package/src/nodes/lighting/SpotLightNode.js

@@ -2,9 +2,8 @@ import AnalyticLightNode from './AnalyticLightNode.js';
 import { getDistanceAttenuation } from './LightUtils.js';
 import { uniform } from '../core/UniformNode.js';
 import { smoothstep } from '../math/MathNode.js';
-import { positionView } from '../accessors/Position.js';
 import { renderGroup } from '../core/UniformGroupNode.js';
-import { lightViewPosition, lightTargetDirection, lightProjectionUV } from '../accessors/Lights.js';
+import { lightTargetDirection, lightProjectionUV } from '../accessors/Lights.js';
 import { texture } from '../accessors/TextureNode.js';
 
 /**
@@ -23,7 +22,7 @@ class SpotLightNode extends AnalyticLightNode {
 	/**
 	 * Constructs a new spot light node.
 	 *
-	 * @param {SpotLight?} [light=null] - The spot light source.
+	 * @param {?SpotLight} [light=null] - The spot light source.
 	 */
 	constructor( light = null ) {
 
@@ -92,21 +91,17 @@ class SpotLightNode extends AnalyticLightNode {
 
 	}
 
-	setup( builder ) {
-
-		super.setup( builder );
-
-		const lightingModel = builder.context.lightingModel;
+	setupDirect( builder ) {
 
 		const { colorNode, cutoffDistanceNode, decayExponentNode, light } = this;
 
-		const lVector = lightViewPosition( light ).sub( positionView ); // @TODO: Add it into LightNode
+		const lightVector = this.getLightVector( builder );
 
-		const lightDirection = lVector.normalize();
+		const lightDirection = lightVector.normalize();
 		const angleCos = lightDirection.dot( lightTargetDirection( light ) );
 		const spotAttenuation = this.getSpotAttenuation( angleCos );
 
-		const lightDistance = lVector.length();
+		const lightDistance = lightVector.length();
 
 		const lightAttenuation = getDistanceAttenuation( {
 			lightDistance,
@@ -118,7 +113,7 @@ class SpotLightNode extends AnalyticLightNode {
 
 		if ( light.map ) {
 
-			const spotLightCoord = lightProjectionUV( light );
+			const spotLightCoord = lightProjectionUV( light, builder.context.positionWorld );
 			const projectedTexture = texture( light.map, spotLightCoord.xy ).onRenderUpdate( () => light.map );
 
 			const inSpotLightMap = spotLightCoord.mul( 2. ).sub( 1. ).abs().lessThan( 1. ).all();
@@ -127,13 +122,7 @@ class SpotLightNode extends AnalyticLightNode {
 
 		}
 
-		const reflectedLight = builder.context.reflectedLight;
-
-		lightingModel.direct( {
-			lightDirection,
-			lightColor,
-			reflectedLight
-		}, builder.stack, builder );
+		return { lightColor, lightDirection };
 
 	}