super-three 0.173.4 → 0.175.0

package/src/nodes/gpgpu/WorkgroupInfoNode.js

@@ -2,8 +2,6 @@ import ArrayElementNode from '../utils/ArrayElementNode.js';
 import { nodeObject } from '../tsl/TSLCore.js';
 import Node from '../core/Node.js';
 
-/** @module WorkgroupInfoNode **/
-
 /**
  * Represents an element of a 'workgroup' scoped buffer.
  *
@@ -24,7 +22,7 @@ class WorkgroupInfoElementNode extends ArrayElementNode {
 		/**
 		 * This flag can be used for type testing.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @readonly
 		 * @default true
 		 */
@@ -72,9 +70,9 @@ class WorkgroupInfoNode extends Node {
 	/**
 	 * Constructs a new buffer scoped to type scope.
 	 *
-	 * @param {String} scope - TODO.
-	 * @param {String} bufferType - The data type of a 'workgroup' scoped buffer element.
-	 * @param {Number} [bufferCount=0] - The number of elements in the buffer.
+	 * @param {string} scope - TODO.
+	 * @param {string} bufferType - The data type of a 'workgroup' scoped buffer element.
+	 * @param {number} [bufferCount=0] - The number of elements in the buffer.
 	 */
 	constructor( scope, bufferType, bufferCount = 0 ) {
 
@@ -83,14 +81,14 @@ class WorkgroupInfoNode extends Node {
 		/**
 		 * The buffer type.
 		 *
-		 * @type {String}
+		 * @type {string}
 		 */
 		this.bufferType = bufferType;
 
 		/**
 		 * The buffer count.
 		 *
-		 * @type {Number}
+		 * @type {number}
 		 * @default 0
 		 */
 		this.bufferCount = bufferCount;
@@ -98,7 +96,7 @@ class WorkgroupInfoNode extends Node {
 		/**
 		 * This flag can be used for type testing.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @readonly
 		 * @default true
 		 */
@@ -107,14 +105,14 @@ class WorkgroupInfoNode extends Node {
 		/**
 		 * The data type of the array buffer.
 		 *
-		 * @type {String}
+		 * @type {string}
 		 */
 		this.elementType = bufferType;
 
 		/**
 		 * TODO.
 		 *
-		 * @type {String}
+		 * @type {string}
 		 */
 		this.scope = scope;
 
@@ -123,7 +121,7 @@ class WorkgroupInfoNode extends Node {
 	/**
 	 * Sets the name/label of this node.
 	 *
-	 * @param {String} name - The name to set.
+	 * @param {string} name - The name to set.
 	 * @return {WorkgroupInfoNode} A reference to this node.
 	 */
 	label( name ) {
@@ -137,7 +135,7 @@ class WorkgroupInfoNode extends Node {
 	/**
 	 * Sets the scope of this node.
 	 *
-	 * @param {String} scope - The scope to set.
+	 * @param {string} scope - The scope to set.
 	 * @return {WorkgroupInfoNode} A reference to this node.
 	 */
 	setScope( scope ) {
@@ -152,7 +150,7 @@ class WorkgroupInfoNode extends Node {
 	/**
 	 * The data type of the array buffer.
 	 *
-	 * @return {String} The element type.
+	 * @return {string} The element type.
 	 */
 	getElementType() {
 
@@ -165,7 +163,7 @@ class WorkgroupInfoNode extends Node {
 	 * is inferred from the scope.
 	 *
 	 * @param {NodeBuilder} builder - The current node builder.
-	 * @return {String} The input type.
+	 * @return {string} The input type.
 	 */
 	getInputType( /*builder*/ ) {
 
@@ -199,9 +197,10 @@ export default WorkgroupInfoNode;
  * TSL function for creating a workgroup info node.
  * Creates a new 'workgroup' scoped array buffer.
  *
+ * @tsl
  * @function
- * @param {String} type - The data type of a 'workgroup' scoped buffer element.
- * @param {Number} [count=0] - The number of elements in the buffer.
+ * @param {string} type - The data type of a 'workgroup' scoped buffer element.
+ * @param {number} [count=0] - The number of elements in the buffer.
  * @returns {WorkgroupInfoNode}
  */
 export const workgroupArray = ( type, count ) => nodeObject( new WorkgroupInfoNode( 'Workgroup', type, count ) );

package/src/nodes/lighting/AONode.js

@@ -18,7 +18,7 @@ class AONode extends LightingNode {
 	/**
 	 * Constructs a new AO node.
 	 *
-	 * @param {Node<float>?} [aoNode=null] - The ambient occlusion node.
+	 * @param {?Node<float>} [aoNode=null] - The ambient occlusion node.
 	 */
 	constructor( aoNode = null ) {
 
@@ -27,7 +27,7 @@ class AONode extends LightingNode {
 		/**
 		 * The ambient occlusion node.
 		 *
-		 * @type {Node<float>?}
+		 * @type {?Node<float>}
 		 * @default null
 		 */
 		this.aoNode = aoNode;

package/src/nodes/lighting/AmbientLightNode.js

@@ -16,7 +16,7 @@ class AmbientLightNode extends AnalyticLightNode {
 	/**
 	 * Constructs a new ambient light node.
 	 *
-	 * @param {AmbientLight?} [light=null] - The ambient light source.
+	 * @param {?AmbientLight} [light=null] - The ambient light source.
 	 */
 	constructor( light = null ) {
 

package/src/nodes/lighting/AnalyticLightNode.js

@@ -6,6 +6,8 @@ import { renderGroup } from '../core/UniformGroupNode.js';
 import { hash } from '../core/NodeUtils.js';
 import { shadow } from './ShadowNode.js';
 import { nodeObject } from '../tsl/TSLCore.js';
+import { lightViewPosition } from '../accessors/Lights.js';
+import { positionView } from '../accessors/Position.js';
 
 /**
  * Base class for analytic light nodes.
@@ -23,7 +25,7 @@ class AnalyticLightNode extends LightingNode {
 	/**
 	 * Constructs a new analytic light node.
 	 *
-	 * @param {Light?} [light=null] - The light source.
+	 * @param {?Light} [light=null] - The light source.
 	 */
 	constructor( light = null ) {
 
@@ -32,7 +34,7 @@ class AnalyticLightNode extends LightingNode {
 		/**
 		 * The light source.
 		 *
-		 * @type {Light?}
+		 * @type {?Light}
 		 * @default null
 		 */
 		this.light = light;
@@ -56,7 +58,7 @@ class AnalyticLightNode extends LightingNode {
 		 * This property is used to retain a reference to the original value of {@link AnalyticLightNode#colorNode}.
 		 * The final color node is represented by a different node when using shadows.
 		 *
-		 * @type {Node?}
+		 * @type {?Node}
 		 * @default null
 		 */
 		this.baseColorNode = null;
@@ -64,7 +66,7 @@ class AnalyticLightNode extends LightingNode {
 		/**
 		 * Represents the light's shadow.
 		 *
-		 * @type {ShadowNode?}
+		 * @type {?ShadowNode}
    		 * @default null
 		 */
 		this.shadowNode = null;
@@ -72,7 +74,7 @@ class AnalyticLightNode extends LightingNode {
 		/**
 		 * Represents the light's shadow color.
 		 *
-		 * @type {Node?}
+		 * @type {?Node}
    		 * @default null
 		 */
 		this.shadowColorNode = null;
@@ -80,7 +82,7 @@ class AnalyticLightNode extends LightingNode {
 		/**
 		 * This flag can be used for type testing.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @readonly
 		 * @default true
 		 */
@@ -90,7 +92,7 @@ class AnalyticLightNode extends LightingNode {
 		 * Overwritten since analytic light nodes are updated
 		 * once per frame.
 		 *
-		 * @type {String}
+		 * @type {string}
 		 * @default 'frame'
 		 */
 		this.updateType = NodeUpdateType.FRAME;
@@ -101,7 +103,7 @@ class AnalyticLightNode extends LightingNode {
 	 * Overwrites the default {@link Node#customCacheKey} implementation by including the
 	 * `light.id` and `light.castShadow` into the cache key.
 	 *
-	 * @return {Number} The custom cache key.
+	 * @return {number} The custom cache key.
 	 */
 	customCacheKey() {
 
@@ -115,6 +117,30 @@ class AnalyticLightNode extends LightingNode {
 
 	}
 
+	getLightVector( builder ) {
+
+		return lightViewPosition( this.light ).sub( builder.context.positionView || positionView );
+
+	}
+
+	/**
+	 * Sets up the direct lighting for the analytic light node.
+	 *
+	 * @abstract
+	 * @param {NodeBuilder} builder - The builder object used for setting up the light.
+	 * @return {Object|undefined} The direct light data (color and direction).
+	 */
+	setupDirect( /*builder*/ ) { }
+
+	/**
+	 * Sets up the direct rect area lighting for the analytic light node.
+	 *
+	 * @abstract
+	 * @param {NodeBuilder} builder - The builder object used for setting up the light.
+	 * @return {Object|undefined} The direct rect area light data.
+	 */
+	setupDirectRectArea( /*builder*/ ) { }
+
 	/**
 	 * Setups the shadow node for this light. The method exists so concrete light classes
 	 * can setup different types of shadow nodes.
@@ -154,7 +180,7 @@ class AnalyticLightNode extends LightingNode {
 
 			} else {
 
-				shadowNode = this.setupShadowNode( builder );
+				shadowNode = this.setupShadowNode();
 
 			}
 
@@ -199,6 +225,21 @@ class AnalyticLightNode extends LightingNode {
 
 		}
 
+		const directLightData = this.setupDirect( builder );
+		const directRectAreaLightData = this.setupDirectRectArea( builder );
+
+		if ( directLightData ) {
+
+			builder.lightsNode.setupDirectLight( builder, this, directLightData );
+
+		}
+
+		if ( directRectAreaLightData ) {
+
+			builder.lightsNode.setupDirectRectAreaLight( builder, this, directRectAreaLightData );
+
+		}
+
 	}
 
 	/**

package/src/nodes/lighting/BasicLightMapNode.js

@@ -19,7 +19,7 @@ class BasicLightMapNode extends LightingNode {
 	/**
 	 * Constructs a new basic light map node.
 	 *
-	 * @param {Node<vec3>?} [lightMapNode=null] - The light map node.
+	 * @param {?Node<vec3>} [lightMapNode=null] - The light map node.
 	 */
 	constructor( lightMapNode = null ) {
 
@@ -28,7 +28,7 @@ class BasicLightMapNode extends LightingNode {
 		/**
 		 * The light map node.
 		 *
-		 * @type {Node<vec3>?}
+		 * @type {?Node<vec3>}
 		 */
 		this.lightMapNode = lightMapNode;
 

package/src/nodes/lighting/DirectionalLightNode.js

@@ -17,7 +17,7 @@ class DirectionalLightNode extends AnalyticLightNode {
 	/**
 	 * Constructs a new directional light node.
 	 *
-	 * @param {DirectionalLight?} [light=null] - The directional light source.
+	 * @param {?DirectionalLight} [light=null] - The directional light source.
 	 */
 	constructor( light = null ) {
 
@@ -25,21 +25,12 @@ class DirectionalLightNode extends AnalyticLightNode {
 
 	}
 
-	setup( builder ) {
-
-		super.setup( builder );
-
-		const lightingModel = builder.context.lightingModel;
+	setupDirect() {
 
 		const lightColor = this.colorNode;
 		const lightDirection = lightTargetDirection( this.light );
-		const reflectedLight = builder.context.reflectedLight;
 
-		lightingModel.direct( {
-			lightDirection,
-			lightColor,
-			reflectedLight
-		}, builder.stack, builder );
+		return { lightDirection, lightColor };
 
 	}
 

package/src/nodes/lighting/EnvironmentNode.js

@@ -5,9 +5,9 @@ import { cameraViewMatrix } from '../accessors/Camera.js';
 import { transformedClearcoatNormalView, transformedNormalView, transformedNormalWorld } from '../accessors/Normal.js';
 import { positionViewDirection } from '../accessors/Position.js';
 import { float } from '../tsl/TSLBase.js';
-import { reference } from '../accessors/ReferenceNode.js';
 import { transformedBentNormalView } from '../accessors/AccessorsUtils.js';
 import { pmremTexture } from '../pmrem/PMREMNode.js';
+import { materialEnvIntensity } from '../accessors/MaterialProperties.js';
 
 const _envNodeCache = new WeakMap();
 
@@ -38,7 +38,7 @@ class EnvironmentNode extends LightingNode {
 		/**
 		 * A node representing the environment.
 		 *
-		 * @type {Node?}
+		 * @type {?Node}
 		 * @default null
 		 */
 		this.envNode = envNode;
@@ -71,14 +71,11 @@ class EnvironmentNode extends LightingNode {
 
 		//
 
-		const envMap = material.envMap;
-		const intensity = envMap ? reference( 'envMapIntensity', 'float', builder.material ) : reference( 'environmentIntensity', 'float', builder.scene ); // @TODO: Add materialEnvIntensity in MaterialNode
-
 		const useAnisotropy = material.useAnisotropy === true || material.anisotropy > 0;
 		const radianceNormalView = useAnisotropy ? transformedBentNormalView : transformedNormalView;
 
-		const radiance = envNode.context( createRadianceContext( roughness, radianceNormalView ) ).mul( intensity );
-		const irradiance = envNode.context( createIrradianceContext( transformedNormalWorld ) ).mul( Math.PI ).mul( intensity );
+		const radiance = envNode.context( createRadianceContext( roughness, radianceNormalView ) ).mul( materialEnvIntensity );
+		const irradiance = envNode.context( createIrradianceContext( transformedNormalWorld ) ).mul( Math.PI ).mul( materialEnvIntensity );
 
 		const isolateRadiance = cache( radiance );
 		const isolateIrradiance = cache( irradiance );
@@ -95,7 +92,7 @@ class EnvironmentNode extends LightingNode {
 
 		if ( clearcoatRadiance ) {
 
-			const clearcoatRadianceContext = envNode.context( createRadianceContext( clearcoatRoughness, transformedClearcoatNormalView ) ).mul( intensity );
+			const clearcoatRadianceContext = envNode.context( createRadianceContext( clearcoatRoughness, transformedClearcoatNormalView ) ).mul( materialEnvIntensity );
 			const isolateClearcoatRadiance = cache( clearcoatRadianceContext );
 
 			clearcoatRadiance.addAssign( isolateClearcoatRadiance );

package/src/nodes/lighting/HemisphereLightNode.js

@@ -23,7 +23,7 @@ class HemisphereLightNode extends AnalyticLightNode {
 	/**
 	 * Constructs a new hemisphere light node.
 	 *
-	 * @param {HemisphereLight?} [light=null] - The hemisphere light source.
+	 * @param {?HemisphereLight} [light=null] - The hemisphere light source.
 	 */
 	constructor( light = null ) {
 

package/src/nodes/lighting/LightProbeNode.js

@@ -20,7 +20,7 @@ class LightProbeNode extends AnalyticLightNode {
 	/**
 	 * Constructs a new light probe node.
 	 *
-	 * @param {LightProbe?} [light=null] - The light probe.
+	 * @param {?LightProbe} [light=null] - The light probe.
 	 */
 	constructor( light = null ) {
 

package/src/nodes/lighting/LightUtils.js

@@ -1,7 +1,5 @@
 import { Fn } from '../tsl/TSLBase.js';
 
-/** @module LightUtils **/
-
 /**
  * Represents a `discard` shader operation in TSL.
  *
@@ -12,9 +10,7 @@ import { Fn } from '../tsl/TSLBase.js';
  * @param {Node<float>} inputs.decayExponent - The light's decay exponent.
  * @return {Node<float>} The distance falloff.
  */
-export const getDistanceAttenuation = /*@__PURE__*/ Fn( ( inputs ) => {
-
-	const { lightDistance, cutoffDistance, decayExponent } = inputs;
+export const getDistanceAttenuation = /*@__PURE__*/ Fn( ( { lightDistance, cutoffDistance, decayExponent } ) => {
 
 	// based upon Frostbite 3 Moving to Physically-based Rendering
 	// page 32, equation 26: E[window1]

package/src/nodes/lighting/LightingContextNode.js

@@ -2,7 +2,7 @@ import ContextNode from '../core/ContextNode.js';
 import { nodeProxy, float, vec3 } from '../tsl/TSLBase.js';
 
 /**
- * `LightingContextNode` represents an extension of the {@link module:ContextNode~ContextNode} module
+ * `LightingContextNode` represents an extension of the {@link ContextNode} module
  * by adding lighting specific context data. It represents the runtime context of
  * {@link LightsNode}.
  *
@@ -19,19 +19,19 @@ class LightingContextNode extends ContextNode {
 	/**
 	 * Constructs a new lighting context node.
 	 *
-	 * @param {LightsNode} node - The lights node.
-	 * @param {LightingModel?} [lightingModel=null] - The current lighting model.
-	 * @param {Node<vec3>?} [backdropNode=null] - A backdrop node.
-	 * @param {Node<float>?} [backdropAlphaNode=null] - A backdrop alpha node.
+	 * @param {LightsNode} lightsNode - The lights node.
+	 * @param {?LightingModel} [lightingModel=null] - The current lighting model.
+	 * @param {?Node<vec3>} [backdropNode=null] - A backdrop node.
+	 * @param {?Node<float>} [backdropAlphaNode=null] - A backdrop alpha node.
 	 */
-	constructor( node, lightingModel = null, backdropNode = null, backdropAlphaNode = null ) {
+	constructor( lightsNode, lightingModel = null, backdropNode = null, backdropAlphaNode = null ) {
 
-		super( node );
+		super( lightsNode );
 
 		/**
 		 * The current lighting model.
 		 *
-		 * @type {LightingModel?}
+		 * @type {?LightingModel}
 		 * @default null
 		 */
 		this.lightingModel = lightingModel;
@@ -39,7 +39,7 @@ class LightingContextNode extends ContextNode {
 		/**
 		 * A backdrop node.
 		 *
-		 * @type {Node<vec3>?}
+		 * @type {?Node<vec3>}
 		 * @default null
 		 */
 		this.backdropNode = backdropNode;
@@ -47,7 +47,7 @@ class LightingContextNode extends ContextNode {
 		/**
 		 * A backdrop alpha node.
 		 *
-		 * @type {Node<float>?}
+		 * @type {?Node<float>}
 		 * @default null
 		 */
 		this.backdropAlphaNode = backdropAlphaNode;

package/src/nodes/lighting/LightingNode.js

@@ -23,7 +23,7 @@ class LightingNode extends Node {
 		/**
 		 * This flag can be used for type testing.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @readonly
 		 * @default true
 		 */