super-three 0.173.4 → 0.175.0

package/src/nodes/functions/PhysicalLightingModel.js

@@ -352,12 +352,12 @@ class PhysicalLightingModel extends LightingModel {
 	/**
 	 * Constructs a new physical lighting model.
 	 *
-	 * @param {Boolean} [clearcoat=false] - Whether clearcoat is supported or not.
-	 * @param {Boolean} [sheen=false] - Whether sheen is supported or not.
-	 * @param {Boolean} [iridescence=false] - Whether iridescence is supported or not.
-	 * @param {Boolean} [anisotropy=false] - Whether anisotropy is supported or not.
-	 * @param {Boolean} [transmission=false] - Whether transmission is supported or not.
-	 * @param {Boolean} [dispersion=false] - Whether dispersion is supported or not.
+	 * @param {boolean} [clearcoat=false] - Whether clearcoat is supported or not.
+	 * @param {boolean} [sheen=false] - Whether sheen is supported or not.
+	 * @param {boolean} [iridescence=false] - Whether iridescence is supported or not.
+	 * @param {boolean} [anisotropy=false] - Whether anisotropy is supported or not.
+	 * @param {boolean} [transmission=false] - Whether transmission is supported or not.
+	 * @param {boolean} [dispersion=false] - Whether dispersion is supported or not.
 	 */
 	constructor( clearcoat = false, sheen = false, iridescence = false, anisotropy = false, transmission = false, dispersion = false ) {
 
@@ -366,7 +366,7 @@ class PhysicalLightingModel extends LightingModel {
 		/**
 		 * Whether clearcoat is supported or not.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @default false
 		 */
 		this.clearcoat = clearcoat;
@@ -374,7 +374,7 @@ class PhysicalLightingModel extends LightingModel {
 		/**
 		 * Whether sheen is supported or not.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @default false
 		 */
 		this.sheen = sheen;
@@ -382,7 +382,7 @@ class PhysicalLightingModel extends LightingModel {
 		/**
 		 * Whether iridescence is supported or not.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @default false
 		 */
 		this.iridescence = iridescence;
@@ -390,7 +390,7 @@ class PhysicalLightingModel extends LightingModel {
 		/**
 		 * Whether anisotropy is supported or not.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @default false
 		 */
 		this.anisotropy = anisotropy;
@@ -398,7 +398,7 @@ class PhysicalLightingModel extends LightingModel {
 		/**
 		 * Whether transmission is supported or not.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @default false
 		 */
 		this.transmission = transmission;
@@ -406,7 +406,7 @@ class PhysicalLightingModel extends LightingModel {
 		/**
 		 * Whether dispersion is supported or not.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @default false
 		 */
 		this.dispersion = dispersion;
@@ -414,7 +414,7 @@ class PhysicalLightingModel extends LightingModel {
 		/**
 		 * The clear coat radiance.
 		 *
-		 * @type {Node?}
+		 * @type {?Node}
 		 * @default null
 		 */
 		this.clearcoatRadiance = null;
@@ -422,7 +422,7 @@ class PhysicalLightingModel extends LightingModel {
 		/**
 		 * The clear coat specular direct.
 		 *
-		 * @type {Node?}
+		 * @type {?Node}
 		 * @default null
 		 */
 		this.clearcoatSpecularDirect = null;
@@ -430,7 +430,7 @@ class PhysicalLightingModel extends LightingModel {
 		/**
 		 * The clear coat specular indirect.
 		 *
-		 * @type {Node?}
+		 * @type {?Node}
 		 * @default null
 		 */
 		this.clearcoatSpecularIndirect = null;
@@ -438,7 +438,7 @@ class PhysicalLightingModel extends LightingModel {
 		/**
 		 * The sheen specular direct.
 		 *
-		 * @type {Node?}
+		 * @type {?Node}
 		 * @default null
 		 */
 		this.sheenSpecularDirect = null;
@@ -446,7 +446,7 @@ class PhysicalLightingModel extends LightingModel {
 		/**
 		 * The sheen specular indirect.
 		 *
-		 * @type {Node?}
+		 * @type {?Node}
 		 * @default null
 		 */
 		this.sheenSpecularIndirect = null;
@@ -454,7 +454,7 @@ class PhysicalLightingModel extends LightingModel {
 		/**
 		 * The iridescence Fresnel.
 		 *
-		 * @type {Node?}
+		 * @type {?Node}
 		 * @default null
 		 */
 		this.iridescenceFresnel = null;
@@ -462,7 +462,7 @@ class PhysicalLightingModel extends LightingModel {
 		/**
 		 * The iridescence F0.
 		 *
-		 * @type {Node?}
+		 * @type {?Node}
 		 * @default null
 		 */
 		this.iridescenceF0 = null;
@@ -473,9 +473,9 @@ class PhysicalLightingModel extends LightingModel {
 	 * Depending on what features are requested, the method prepares certain node variables
 	 * which are later used for lighting computations.
 	 *
-	 * @param {ContextNode} context - The current node context.
+	 * @param {NodeBuilder} builder - The current node builder.
 	 */
-	start( context ) {
+	start( builder ) {
 
 		if ( this.clearcoat === true ) {
 
@@ -514,6 +514,8 @@ class PhysicalLightingModel extends LightingModel {
 			const v = cameraPosition.sub( positionWorld ).normalize(); // TODO: Create Node for this, same issue in MaterialX
 			const n = transformedNormalWorld;
 
+			const context = builder.context;
+
 			context.backdrop = getIBLVolumeRefraction(
 				n,
 				v,
@@ -538,6 +540,8 @@ class PhysicalLightingModel extends LightingModel {
 
 		}
 
+		super.start( builder );
+
 	}
 
 	// Fdez-Agüera's "Multiple-Scattering Microfacet Model for Real-Time Image Based Lighting"
@@ -568,8 +572,7 @@ class PhysicalLightingModel extends LightingModel {
 	/**
 	 * Implements the direct light.
 	 *
-	 * @param {Object} input - The input data.
-	 * @param {StackNode} stack - The current stack.
+	 * @param {Object} lightData - The light data.
 	 * @param {NodeBuilder} builder - The current node builder.
 	 */
 	direct( { lightDirection, lightColor, reflectedLight } ) {
@@ -603,7 +606,6 @@ class PhysicalLightingModel extends LightingModel {
 	 * rect area light nodes.
 	 *
 	 * @param {Object} input - The input data.
-	 * @param {StackNode} stack - The current stack.
 	 * @param {NodeBuilder} builder - The current node builder.
 	 */
 	directRectArea( { lightColor, lightPosition, halfWidth, halfHeight, reflectedLight, ltc_1, ltc_2 } ) {
@@ -641,26 +643,24 @@ class PhysicalLightingModel extends LightingModel {
 	/**
 	 * Implements the indirect lighting.
 	 *
-	 * @param {ContextNode} context - The current node context.
-	 * @param {StackNode} stack - The current stack.
 	 * @param {NodeBuilder} builder - The current node builder.
 	 */
-	indirect( context, stack, builder ) {
+	indirect( builder ) {
 
-		this.indirectDiffuse( context, stack, builder );
-		this.indirectSpecular( context, stack, builder );
-		this.ambientOcclusion( context, stack, builder );
+		this.indirectDiffuse( builder );
+		this.indirectSpecular( builder );
+		this.ambientOcclusion( builder );
 
 	}
 
 	/**
 	 * Implements the indirect diffuse term.
 	 *
-	 * @param {ContextNode} input - The current node context.
-	 * @param {StackNode} stack - The current stack.
 	 * @param {NodeBuilder} builder - The current node builder.
 	 */
-	indirectDiffuse( { irradiance, reflectedLight } ) {
+	indirectDiffuse( builder ) {
+
+		const { irradiance, reflectedLight } = builder.context;
 
 		reflectedLight.indirectDiffuse.addAssign( irradiance.mul( BRDF_Lambert( { diffuseColor } ) ) );
 
@@ -669,11 +669,11 @@ class PhysicalLightingModel extends LightingModel {
 	/**
 	 * Implements the indirect specular term.
 	 *
-	 * @param {ContextNode} input - The current node context.
-	 * @param {StackNode} stack - The current stack.
 	 * @param {NodeBuilder} builder - The current node builder.
 	 */
-	indirectSpecular( { radiance, iblIrradiance, reflectedLight } ) {
+	indirectSpecular( builder ) {
+
+		const { radiance, iblIrradiance, reflectedLight } = builder.context;
 
 		if ( this.sheen === true ) {
 
@@ -725,11 +725,11 @@ class PhysicalLightingModel extends LightingModel {
 	/**
 	 * Implements the ambient occlusion term.
 	 *
-	 * @param {ContextNode} input - The current node context.
-	 * @param {StackNode} stack - The current stack.
 	 * @param {NodeBuilder} builder - The current node builder.
 	 */
-	ambientOcclusion( { ambientOcclusion, reflectedLight } ) {
+	ambientOcclusion( builder ) {
+
+		const { ambientOcclusion, reflectedLight } = builder.context;
 
 		const dotNV = transformedNormalView.dot( positionViewDirection ).clamp(); // @ TODO: Move to core dotNV
 
@@ -758,11 +758,9 @@ class PhysicalLightingModel extends LightingModel {
 	/**
 	 * Used for final lighting accumulations depending on the requested features.
 	 *
-	 * @param {ContextNode} context - The current node context.
-	 * @param {StackNode} stack - The current stack.
 	 * @param {NodeBuilder} builder - The current node builder.
 	 */
-	finish( context ) {
+	finish( { context } ) {
 
 		const { outgoingLight } = context;
 

package/src/nodes/functions/ShadowMaskModel.js

@@ -30,18 +30,18 @@ class ShadowMaskModel extends LightingModel {
 	 *
 	 * @param {Object} input - The input data.
 	 */
-	direct( { shadowMask } ) {
+	direct( { lightNode } ) {
 
-		this.shadowNode.mulAssign( shadowMask );
+		this.shadowNode.mulAssign( lightNode.shadowNode );
 
 	}
 
 	/**
 	 * Uses the shadow mask to produce the final color.
 	 *
-	 * @param {ContextNode} context - The current node context.
+	 * @param {NodeBuilder} builder - The current node builder.
 	 */
-	finish( context ) {
+	finish( { context } ) {
 
 		diffuseColor.a.mulAssign( this.shadowNode.oneMinus() );
 

package/src/nodes/functions/ToonLightingModel.js

@@ -39,11 +39,10 @@ class ToonLightingModel extends LightingModel {
 	 * Implements the direct lighting. Instead of using a conventional smooth irradiance, the irradiance is
 	 * reduced to a small number of discrete shades to create a comic-like, flat look.
 	 *
-	 * @param {Object} input - The input data.
-	 * @param {StackNode} stack - The current stack.
+	 * @param {Object} lightData - The light data.
 	 * @param {NodeBuilder} builder - The current node builder.
 	 */
-	direct( { lightDirection, lightColor, reflectedLight }, stack, builder ) {
+	direct( { lightDirection, lightColor, reflectedLight }, builder ) {
 
 		const irradiance = getGradientIrradiance( { normal: normalGeometry, lightDirection, builder } ).mul( lightColor );
 
@@ -54,11 +53,11 @@ class ToonLightingModel extends LightingModel {
 	/**
 	 * Implements the indirect lighting.
 	 *
-	 * @param {ContextNode} input - The current node context.
-	 * @param {StackNode} stack - The current stack.
 	 * @param {NodeBuilder} builder - The current node builder.
 	 */
-	indirect( { ambientOcclusion, irradiance, reflectedLight } ) {
+	indirect( builder ) {
+
+		const { ambientOcclusion, irradiance, reflectedLight } = builder.context;
 
 		reflectedLight.indirectDiffuse.addAssign( irradiance.mul( BRDF_Lambert( { diffuseColor } ) ) );
 

package/src/nodes/functions/VolumetricLightingModel.js

@@ -0,0 +1,183 @@
+import LightingModel from '../core/LightingModel.js';
+import { property } from '../core/PropertyNode.js';
+import { float, If, uniform, vec3, vec4 } from '../tsl/TSLBase.js';
+import { positionWorld } from '../accessors/Position.js';
+import { cameraFar, cameraNear, cameraPosition, cameraViewMatrix } from '../accessors/Camera.js';
+import { Loop } from '../utils/LoopNode.js';
+import { linearDepth, viewZToPerspectiveDepth } from '../display/ViewportDepthNode.js';
+import { modelRadius } from '../accessors/ModelNode.js';
+import { LTC_Evaluate_Volume } from './BSDF/LTC.js';
+
+const scatteringDensity = property( 'vec3' );
+const linearDepthRay = property( 'vec3' );
+const outgoingRayLight = property( 'vec3' );
+
+/**
+ * VolumetricLightingModel class extends the LightingModel to implement volumetric lighting effects.
+ * This model calculates the scattering and transmittance of light through a volumetric medium.
+ * It dynamically adjusts the direction of the ray based on the camera and object positions.
+ * The model supports custom scattering and depth nodes to enhance the lighting effects.
+ *
+ * @augments LightingModel
+ */
+class VolumetricLightingModel extends LightingModel {
+
+	constructor() {
+
+		super();
+
+	}
+
+	start( builder ) {
+
+		const { material, context } = builder;
+
+		const startPos = property( 'vec3' );
+		const endPos = property( 'vec3' );
+
+		// This approach dynamically changes the direction of the ray,
+		// prioritizing the ray from the camera to the object if it is inside the mesh, and from the object to the camera if it is far away.
+
+		If( cameraPosition.sub( positionWorld ).length().greaterThan( modelRadius.mul( 2 ) ), () => {
+
+			startPos.assign( cameraPosition );
+			endPos.assign( positionWorld );
+
+		} ).Else( () => {
+
+			startPos.assign( positionWorld );
+			endPos.assign( cameraPosition );
+
+		} );
+
+		//
+
+		const viewVector = endPos.sub( startPos );
+
+		const steps = uniform( 'int' ).onRenderUpdate( ( { material } ) => material.steps );
+		const stepSize = viewVector.length().div( steps ).toVar();
+
+		const rayDir = viewVector.normalize().toVar(); // TODO: toVar() should be automatic here ( in loop )
+
+		const distTravelled = float( 0.0 ).toVar();
+		const transmittance = vec3( 1 ).toVar();
+
+		if ( material.offsetNode ) {
+
+			// reduce banding
+
+			distTravelled.addAssign( material.offsetNode.mul( stepSize ) );
+
+		}
+
+		Loop( steps, () => {
+
+			const positionRay = startPos.add( rayDir.mul( distTravelled ) );
+			const positionViewRay = cameraViewMatrix.mul( vec4( positionRay, 1 ) ).xyz;
+
+			if ( material.depthNode !== null ) {
+
+				linearDepthRay.assign( linearDepth( viewZToPerspectiveDepth( positionViewRay.z, cameraNear, cameraFar ) ) );
+
+				context.sceneDepthNode = linearDepth( material.depthNode ).toVar();
+
+			}
+
+			context.positionWorld = positionRay;
+			context.shadowPositionWorld = positionRay;
+			context.positionView = positionViewRay;
+
+			scatteringDensity.assign( 0 );
+
+			let scatteringNode;
+
+			if ( material.scatteringNode ) {
+
+				scatteringNode = material.scatteringNode( {
+					positionRay
+				} );
+
+			}
+
+			super.start( builder );
+
+			if ( scatteringNode ) {
+
+				scatteringDensity.mulAssign( scatteringNode );
+
+			}
+
+			// beer's law
+
+			const falloff = scatteringDensity.mul( .01 ).negate().mul( stepSize ).exp();
+			transmittance.mulAssign( falloff );
+
+			// move along the ray
+
+			distTravelled.addAssign( stepSize );
+
+		} );
+
+		outgoingRayLight.addAssign( transmittance.saturate().oneMinus() );
+
+	}
+
+	scatteringLight( lightColor, builder ) {
+
+		const sceneDepthNode = builder.context.sceneDepthNode;
+
+		if ( sceneDepthNode ) {
+
+			If( sceneDepthNode.greaterThanEqual( linearDepthRay ), () => {
+
+				scatteringDensity.addAssign( lightColor );
+
+			} );
+
+		} else {
+
+			scatteringDensity.addAssign( lightColor );
+
+		}
+
+	}
+
+	direct( { lightNode, lightColor }, builder ) {
+
+		// Ignore lights with infinite distance
+
+		if ( lightNode.light.distance === undefined ) return;
+
+		// TODO: We need a viewportOpaque*() ( output, depth ) to fit with modern rendering approaches
+
+		const directLight = lightColor.xyz.toVar();
+		directLight.mulAssign( lightNode.shadowNode ); // it no should be necessary if used in the same render pass
+
+		this.scatteringLight( directLight, builder );
+
+	}
+
+	directRectArea( { lightColor, lightPosition, halfWidth, halfHeight }, builder ) {
+
+		const p0 = lightPosition.add( halfWidth ).sub( halfHeight ); // counterclockwise; light shines in local neg z direction
+		const p1 = lightPosition.sub( halfWidth ).sub( halfHeight );
+		const p2 = lightPosition.sub( halfWidth ).add( halfHeight );
+		const p3 = lightPosition.add( halfWidth ).add( halfHeight );
+
+		const P = builder.context.positionView;
+
+		const directLight = lightColor.xyz.mul( LTC_Evaluate_Volume( { P, p0, p1, p2, p3 } ) ).pow( 1.5 );
+
+		this.scatteringLight( directLight, builder );
+
+	}
+
+	finish( builder ) {
+
+		builder.context.outgoingLight.assign( outgoingRayLight );
+
+	}
+
+}
+
+export default VolumetricLightingModel;

package/src/nodes/functions/material/getParallaxCorrectNormal.js

@@ -1,8 +1,6 @@
 import { positionWorld } from '../../accessors/Position.js';
 import { float, Fn, min, normalize, sub, vec3 } from '../../tsl/TSLBase.js';
 
-/** @module getParallaxCorrectNormal **/
-
 /**
  * This computes a parallax corrected normal which is used for box-projected cube mapping (BPCEM).
  *
@@ -12,6 +10,8 @@ import { float, Fn, min, normalize, sub, vec3 } from '../../tsl/TSLBase.js';
  * const uvNode = getParallaxCorrectNormal( reflectVector, vec3( 200, 100, 100 ), vec3( 0, - 50, 0 ) );
  * material.envNode = pmremTexture( renderTarget.texture, uvNode );
  * ```
+ *
+ * @tsl
  * @function
  * @param {Node<vec3>} normal - The normal to correct.
  * @param {Node<vec3>} cubeSize - The cube size should reflect the size of the environment (BPCEM is usually applied in closed environments like rooms).
@@ -20,16 +20,16 @@ import { float, Fn, min, normalize, sub, vec3 } from '../../tsl/TSLBase.js';
  */
 const getParallaxCorrectNormal = /*@__PURE__*/ Fn( ( [ normal, cubeSize, cubePos ] ) => {
 
-	const nDir = normalize( normal ).toVar( 'nDir' );
-	const rbmax = sub( float( 0.5 ).mul( cubeSize.sub( cubePos ) ), positionWorld ).div( nDir ).toVar( 'rbmax' );
-	const rbmin = sub( float( - 0.5 ).mul( cubeSize.sub( cubePos ) ), positionWorld ).div( nDir ).toVar( 'rbmin' );
-	const rbminmax = vec3().toVar( 'rbminmax' );
+	const nDir = normalize( normal ).toVar();
+	const rbmax = sub( float( 0.5 ).mul( cubeSize.sub( cubePos ) ), positionWorld ).div( nDir ).toVar();
+	const rbmin = sub( float( - 0.5 ).mul( cubeSize.sub( cubePos ) ), positionWorld ).div( nDir ).toVar();
+	const rbminmax = vec3().toVar();
 	rbminmax.x = nDir.x.greaterThan( float( 0 ) ).select( rbmax.x, rbmin.x );
 	rbminmax.y = nDir.y.greaterThan( float( 0 ) ).select( rbmax.y, rbmin.y );
 	rbminmax.z = nDir.z.greaterThan( float( 0 ) ).select( rbmax.z, rbmin.z );
 
-	const correction = min( min( rbminmax.x, rbminmax.y ), rbminmax.z ).toVar( 'correction' );
-	const boxIntersection = positionWorld.add( nDir.mul( correction ) ).toVar( 'boxIntersection' );
+	const correction = min( min( rbminmax.x, rbminmax.y ), rbminmax.z ).toVar();
+	const boxIntersection = positionWorld.add( nDir.mul( correction ) ).toVar();
 	return boxIntersection.sub( cubePos );
 
 } );

package/src/nodes/geometry/RangeNode.js

@@ -9,8 +9,6 @@ import { Vector4 } from '../../math/Vector4.js';
 import { MathUtils } from '../../math/MathUtils.js';
 import { InstancedBufferAttribute } from '../../core/InstancedBufferAttribute.js';
 
-/** @module RangeNode **/
-
 let min = null;
 let max = null;
 
@@ -65,7 +63,7 @@ class RangeNode extends Node {
 	 * Returns the vector length which is computed based on the range definition.
 	 *
 	 * @param {NodeBuilder} builder - The current node builder.
-	 * @return {Number} The vector length.
+	 * @return {number} The vector length.
 	 */
 	getVectorLength( builder ) {
 
@@ -80,7 +78,7 @@ class RangeNode extends Node {
 	 * This method is overwritten since the node type is inferred from range definition.
 	 *
 	 * @param {NodeBuilder} builder - The current node builder.
-	 * @return {String} The node type.
+	 * @return {string} The node type.
 	 */
 	getNodeType( builder ) {
 
@@ -165,9 +163,10 @@ export default RangeNode;
 /**
  * TSL function for creating a range node.
  *
+ * @tsl
  * @function
  * @param {Node<any>} [minNode=float()] - A node defining the lower bound of the range.
  * @param {Node<any>} [maxNode=float()] - A node defining the upper bound of the range.
  * @returns {RangeNode}
  */
-export const range = /*@__PURE__*/ nodeProxy( RangeNode );
+export const range = /*@__PURE__*/ nodeProxy( RangeNode ).setParameterLength( 2 );