super-three 0.173.4 → 0.175.0

package/src/materials/nodes/MeshPhysicalNodeMaterial.js

@@ -12,7 +12,7 @@ import { MeshPhysicalMaterial } from '../MeshPhysicalMaterial.js';
 const _defaultValues = /*@__PURE__*/ new MeshPhysicalMaterial();
 
 /**
- * Node material version of `MeshPhysicalMaterial`.
+ * Node material version of {@link MeshPhysicalMaterial}.
  *
  * @augments MeshStandardNodeMaterial
  */
@@ -27,7 +27,7 @@ class MeshPhysicalNodeMaterial extends MeshStandardNodeMaterial {
 	/**
 	 * Constructs a new mesh physical node material.
 	 *
-	 * @param {Object?} parameters - The configuration parameter.
+	 * @param {Object} [parameters] - The configuration parameter.
 	 */
 	constructor( parameters ) {
 
@@ -36,7 +36,7 @@ class MeshPhysicalNodeMaterial extends MeshStandardNodeMaterial {
 		/**
 		 * This flag can be used for type testing.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @readonly
 		 * @default true
 		 */
@@ -48,9 +48,9 @@ class MeshPhysicalNodeMaterial extends MeshStandardNodeMaterial {
 		 * and define the clearcoat with a node instead.
 		 *
 		 * If you don't want to overwrite the clearcoat but modify the existing
-		 * value instead, use {@link module:MaterialNode.materialClearcoat}.
+		 * value instead, use {@link materialClearcoat}.
 		 *
-		 * @type {Node<float>?}
+		 * @type {?Node<float>}
 		 * @default null
 		 */
 		this.clearcoatNode = null;
@@ -61,9 +61,9 @@ class MeshPhysicalNodeMaterial extends MeshStandardNodeMaterial {
 		 * and define the clearcoat roughness with a node instead.
 		 *
 		 * If you don't want to overwrite the clearcoat roughness but modify the existing
-		 * value instead, use {@link module:MaterialNode.materialClearcoatRoughness}.
+		 * value instead, use {@link materialClearcoatRoughness}.
 		 *
-		 * @type {Node<float>?}
+		 * @type {?Node<float>}
 		 * @default null
 		 */
 		this.clearcoatRoughnessNode = null;
@@ -74,9 +74,9 @@ class MeshPhysicalNodeMaterial extends MeshStandardNodeMaterial {
 		 * and define the clearcoat normal with a node instead.
 		 *
 		 * If you don't want to overwrite the clearcoat normal but modify the existing
-		 * value instead, use {@link module:MaterialNode.materialClearcoatNormal}.
+		 * value instead, use {@link materialClearcoatNormal}.
 		 *
-		 * @type {Node<vec3>?}
+		 * @type {?Node<vec3>}
 		 * @default null
 		 */
 		this.clearcoatNormalNode = null;
@@ -87,9 +87,9 @@ class MeshPhysicalNodeMaterial extends MeshStandardNodeMaterial {
 		 * and define the sheen with a node instead.
 		 *
 		 * If you don't want to overwrite the sheen but modify the existing
-		 * value instead, use {@link module:MaterialNode.materialSheen}.
+		 * value instead, use {@link materialSheen}.
 		 *
-		 * @type {Node<vec3>?}
+		 * @type {?Node<vec3>}
 		 * @default null
 		 */
 		this.sheenNode = null;
@@ -100,9 +100,9 @@ class MeshPhysicalNodeMaterial extends MeshStandardNodeMaterial {
 		 * and define the sheen roughness with a node instead.
 		 *
 		 * If you don't want to overwrite the sheen roughness but modify the existing
-		 * value instead, use {@link module:MaterialNode.materialSheenRoughness}.
+		 * value instead, use {@link materialSheenRoughness}.
 		 *
-		 * @type {Node<float>?}
+		 * @type {?Node<float>}
 		 * @default null
 		 */
 		this.sheenRoughnessNode = null;
@@ -113,9 +113,9 @@ class MeshPhysicalNodeMaterial extends MeshStandardNodeMaterial {
 		 * and define the iridescence with a node instead.
 		 *
 		 * If you don't want to overwrite the iridescence but modify the existing
-		 * value instead, use {@link module:MaterialNode.materialIridescence}.
+		 * value instead, use {@link materialIridescence}.
 		 *
-		 * @type {Node<float>?}
+		 * @type {?Node<float>}
 		 * @default null
 		 */
 		this.iridescenceNode = null;
@@ -126,9 +126,9 @@ class MeshPhysicalNodeMaterial extends MeshStandardNodeMaterial {
 		 * and define the iridescence IOR with a node instead.
 		 *
 		 * If you don't want to overwrite the iridescence IOR but modify the existing
-		 * value instead, use {@link module:MaterialNode.materialIridescenceIOR}.
+		 * value instead, use {@link materialIridescenceIOR}.
 		 *
-		 * @type {Node<float>?}
+		 * @type {?Node<float>}
 		 * @default null
 		 */
 		this.iridescenceIORNode = null;
@@ -139,9 +139,9 @@ class MeshPhysicalNodeMaterial extends MeshStandardNodeMaterial {
 		 * and define the iridescence thickness with a node instead.
 		 *
 		 * If you don't want to overwrite the iridescence thickness but modify the existing
-		 * value instead, use {@link module:MaterialNode.materialIridescenceThickness}.
+		 * value instead, use {@link materialIridescenceThickness}.
 		 *
-		 * @type {Node<float>?}
+		 * @type {?Node<float>}
 		 * @default null
 		 */
 		this.iridescenceThicknessNode = null;
@@ -152,9 +152,9 @@ class MeshPhysicalNodeMaterial extends MeshStandardNodeMaterial {
 		 * and define the specular intensity with a node instead.
 		 *
 		 * If you don't want to overwrite the specular intensity but modify the existing
-		 * value instead, use {@link module:MaterialNode.materialSpecularIntensity}.
+		 * value instead, use {@link materialSpecularIntensity}.
 		 *
-		 * @type {Node<float>?}
+		 * @type {?Node<float>}
 		 * @default null
 		 */
 		this.specularIntensityNode = null;
@@ -165,9 +165,9 @@ class MeshPhysicalNodeMaterial extends MeshStandardNodeMaterial {
 		 * and define the specular color with a node instead.
 		 *
 		 * If you don't want to overwrite the specular color but modify the existing
-		 * value instead, use {@link module:MaterialNode.materialSpecularColor}.
+		 * value instead, use {@link materialSpecularColor}.
 		 *
-		 * @type {Node<vec3>?}
+		 * @type {?Node<vec3>}
 		 * @default null
 		 */
 		this.specularColorNode = null;
@@ -178,9 +178,9 @@ class MeshPhysicalNodeMaterial extends MeshStandardNodeMaterial {
 		 * and define the ior with a node instead.
 		 *
 		 * If you don't want to overwrite the ior but modify the existing
-		 * value instead, use {@link module:MaterialNode.materialIOR}.
+		 * value instead, use {@link materialIOR}.
 		 *
-		 * @type {Node<float>?}
+		 * @type {?Node<float>}
 		 * @default null
 		 */
 		this.iorNode = null;
@@ -191,9 +191,9 @@ class MeshPhysicalNodeMaterial extends MeshStandardNodeMaterial {
 		 * and define the transmission with a node instead.
 		 *
 		 * If you don't want to overwrite the transmission but modify the existing
-		 * value instead, use {@link module:MaterialNode.materialTransmission}.
+		 * value instead, use {@link materialTransmission}.
 		 *
-		 * @type {Node<float>?}
+		 * @type {?Node<float>}
 		 * @default null
 		 */
 		this.transmissionNode = null;
@@ -204,9 +204,9 @@ class MeshPhysicalNodeMaterial extends MeshStandardNodeMaterial {
 		 * and define the thickness with a node instead.
 		 *
 		 * If you don't want to overwrite the thickness but modify the existing
-		 * value instead, use {@link module:MaterialNode.materialThickness}.
+		 * value instead, use {@link materialThickness}.
 		 *
-		 * @type {Node<float>?}
+		 * @type {?Node<float>}
 		 * @default null
 		 */
 		this.thicknessNode = null;
@@ -217,9 +217,9 @@ class MeshPhysicalNodeMaterial extends MeshStandardNodeMaterial {
 		 * and define the attenuation distance with a node instead.
 		 *
 		 * If you don't want to overwrite the attenuation distance but modify the existing
-		 * value instead, use {@link module:MaterialNode.materialAttenuationDistance}.
+		 * value instead, use {@link materialAttenuationDistance}.
 		 *
-		 * @type {Node<float>?}
+		 * @type {?Node<float>}
 		 * @default null
 		 */
 		this.attenuationDistanceNode = null;
@@ -230,9 +230,9 @@ class MeshPhysicalNodeMaterial extends MeshStandardNodeMaterial {
 		 * and define the attenuation color with a node instead.
 		 *
 		 * If you don't want to overwrite the attenuation color but modify the existing
-		 * value instead, use {@link module:MaterialNode.materialAttenuationColor}.
+		 * value instead, use {@link materialAttenuationColor}.
 		 *
-		 * @type {Node<vec3>?}
+		 * @type {?Node<vec3>}
 		 * @default null
 		 */
 		this.attenuationColorNode = null;
@@ -243,9 +243,9 @@ class MeshPhysicalNodeMaterial extends MeshStandardNodeMaterial {
 		 * and define the dispersion with a node instead.
 		 *
 		 * If you don't want to overwrite the dispersion but modify the existing
-		 * value instead, use {@link module:MaterialNode.materialDispersion}.
+		 * value instead, use {@link materialDispersion}.
 		 *
-		 * @type {Node<float>?}
+		 * @type {?Node<float>}
 		 * @default null
 		 */
 		this.dispersionNode = null;
@@ -256,9 +256,9 @@ class MeshPhysicalNodeMaterial extends MeshStandardNodeMaterial {
 		 * and define the anisotropy with a node instead.
 		 *
 		 * If you don't want to overwrite the anisotropy but modify the existing
-		 * value instead, use {@link module:MaterialNode.materialAnisotropy}.
+		 * value instead, use {@link materialAnisotropy}.
 		 *
-		 * @type {Node<float>?}
+		 * @type {?Node<float>}
 		 * @default null
 		 */
 		this.anisotropyNode = null;
@@ -272,7 +272,7 @@ class MeshPhysicalNodeMaterial extends MeshStandardNodeMaterial {
 	/**
 	 * Whether the lighting model should use clearcoat or not.
 	 *
-	 * @type {Boolean}
+	 * @type {boolean}
 	 * @default true
 	 */
 	get useClearcoat() {
@@ -284,7 +284,7 @@ class MeshPhysicalNodeMaterial extends MeshStandardNodeMaterial {
 	/**
 	 * Whether the lighting model should use iridescence or not.
 	 *
-	 * @type {Boolean}
+	 * @type {boolean}
 	 * @default true
 	 */
 	get useIridescence() {
@@ -296,7 +296,7 @@ class MeshPhysicalNodeMaterial extends MeshStandardNodeMaterial {
 	/**
 	 * Whether the lighting model should use sheen or not.
 	 *
-	 * @type {Boolean}
+	 * @type {boolean}
 	 * @default true
 	 */
 	get useSheen() {
@@ -308,7 +308,7 @@ class MeshPhysicalNodeMaterial extends MeshStandardNodeMaterial {
 	/**
 	 * Whether the lighting model should use anisotropy or not.
 	 *
-	 * @type {Boolean}
+	 * @type {boolean}
 	 * @default true
 	 */
 	get useAnisotropy() {
@@ -320,7 +320,7 @@ class MeshPhysicalNodeMaterial extends MeshStandardNodeMaterial {
 	/**
 	 * Whether the lighting model should use transmission or not.
 	 *
-	 * @type {Boolean}
+	 * @type {boolean}
 	 * @default true
 	 */
 	get useTransmission() {
@@ -332,7 +332,7 @@ class MeshPhysicalNodeMaterial extends MeshStandardNodeMaterial {
 	/**
 	 * Whether the lighting model should use dispersion or not.
 	 *
-	 * @type {Boolean}
+	 * @type {boolean}
 	 * @default true
 	 */
 	get useDispersion() {

package/src/materials/nodes/MeshSSSNodeMaterial.js

@@ -4,8 +4,6 @@ import { transformedNormalView } from '../../nodes/accessors/Normal.js';
 import { positionViewDirection } from '../../nodes/accessors/Position.js';
 import { float, vec3 } from '../../nodes/tsl/TSLBase.js';
 
-/** @module MeshSSSNodeMaterial **/
-
 /**
  * Represents the lighting model for {@link MeshSSSNodeMaterial}.
  *
@@ -16,13 +14,13 @@ class SSSLightingModel extends PhysicalLightingModel {
 	/**
 	 * 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} [sss=false] - Whether SSS 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.
+	 * @param {boolean} [sss=false] - Whether SSS is supported or not.
 	 */
 	constructor( clearcoat = false, sheen = false, iridescence = false, anisotropy = false, transmission = false, dispersion = false, sss = false ) {
 
@@ -31,7 +29,7 @@ class SSSLightingModel extends PhysicalLightingModel {
 		/**
 		 * Whether the lighting model should use SSS or not.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @default false
 		 */
 		this.useSSS = sss;
@@ -44,10 +42,9 @@ class SSSLightingModel extends PhysicalLightingModel {
 	 * Reference: [Approximating Translucency for a Fast, Cheap and Convincing Subsurface Scattering Look]{@link https://colinbarrebrisebois.com/2011/03/07/gdc-2011-approximating-translucency-for-a-fast-cheap-and-convincing-subsurface-scattering-look/}
 	 *
 	 * @param {Object} input - The input data.
-	 * @param {StackNode} stack - The current stack.
 	 * @param {NodeBuilder} builder - The current node builder.
 	 */
-	direct( { lightDirection, lightColor, reflectedLight }, stack, builder ) {
+	direct( { lightDirection, lightColor, reflectedLight }, builder ) {
 
 		if ( this.useSSS === true ) {
 
@@ -63,7 +60,7 @@ class SSSLightingModel extends PhysicalLightingModel {
 
 		}
 
-		super.direct( { lightDirection, lightColor, reflectedLight }, stack, builder );
+		super.direct( { lightDirection, lightColor, reflectedLight }, builder );
 
 	}
 
@@ -86,7 +83,7 @@ class MeshSSSNodeMaterial extends MeshPhysicalNodeMaterial {
 	/**
 	 * Constructs a new mesh SSS node material.
 	 *
-	 * @param {Object?} parameters - The configuration parameter.
+	 * @param {Object} [parameters] - The configuration parameter.
 	 */
 	constructor( parameters ) {
 
@@ -95,7 +92,7 @@ class MeshSSSNodeMaterial extends MeshPhysicalNodeMaterial {
 		/**
 		 * Represents the thickness color.
 		 *
-		 * @type {Node<vec3>?}
+		 * @type {?Node<vec3>}
 		 * @default null
 		 */
 		this.thicknessColorNode = null;
@@ -103,35 +100,35 @@ class MeshSSSNodeMaterial extends MeshPhysicalNodeMaterial {
 		/**
 		 * Represents the distortion factor.
 		 *
-		 * @type {Node<float>?}
+		 * @type {?Node<float>}
 		 */
 		this.thicknessDistortionNode = float( 0.1 );
 
 		/**
 		 * Represents the thickness ambient factor.
 		 *
-		 * @type {Node<float>?}
+		 * @type {?Node<float>}
 		 */
 		this.thicknessAmbientNode = float( 0.0 );
 
 		/**
 		 * Represents the thickness attenuation.
 		 *
-		 * @type {Node<float>?}
+		 * @type {?Node<float>}
 		 */
 		this.thicknessAttenuationNode = float( .1 );
 
 		/**
 		 * Represents the thickness power.
 		 *
-		 * @type {Node<float>?}
+		 * @type {?Node<float>}
 		 */
 		this.thicknessPowerNode = float( 2.0 );
 
 		/**
 		 * Represents the thickness scale.
 		 *
-		 * @type {Node<float>?}
+		 * @type {?Node<float>}
 		 */
 		this.thicknessScaleNode = float( 10.0 );
 
@@ -140,7 +137,7 @@ class MeshSSSNodeMaterial extends MeshPhysicalNodeMaterial {
 	/**
 	 * Whether the lighting model should use SSS or not.
 	 *
-	 * @type {Boolean}
+	 * @type {boolean}
 	 * @default true
 	 */
 	get useSSS() {

package/src/materials/nodes/MeshStandardNodeMaterial.js

@@ -12,7 +12,7 @@ import { MeshStandardMaterial } from '../MeshStandardMaterial.js';
 const _defaultValues = /*@__PURE__*/ new MeshStandardMaterial();
 
 /**
- * Node material version of `MeshStandardMaterial`.
+ * Node material version of {@link MeshStandardMaterial}.
  *
  * @augments NodeMaterial
  */
@@ -27,7 +27,7 @@ class MeshStandardNodeMaterial extends NodeMaterial {
 	/**
 	 * Constructs a new mesh standard node material.
 	 *
-	 * @param {Object?} parameters - The configuration parameter.
+	 * @param {Object} [parameters] - The configuration parameter.
 	 */
 	constructor( parameters ) {
 
@@ -36,7 +36,7 @@ class MeshStandardNodeMaterial extends NodeMaterial {
 		/**
 		 * This flag can be used for type testing.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @readonly
 		 * @default true
 		 */
@@ -45,7 +45,7 @@ class MeshStandardNodeMaterial extends NodeMaterial {
 		/**
 		 * Set to `true` because standard materials react on lights.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @default true
 		 */
 		this.lights = true;
@@ -56,9 +56,9 @@ class MeshStandardNodeMaterial extends NodeMaterial {
 		 * overwrite the default and define the emissive color with a node instead.
 		 *
 		 * If you don't want to overwrite the emissive color but modify the existing
-		 * value instead, use {@link module:MaterialNode.materialEmissive}.
+		 * value instead, use {@link materialEmissive}.
 		 *
-		 * @type {Node<vec3>?}
+		 * @type {?Node<vec3>}
 		 * @default null
 		 */
 		this.emissiveNode = null;
@@ -69,9 +69,9 @@ class MeshStandardNodeMaterial extends NodeMaterial {
 		 * overwrite the default and define the metalness with a node instead.
 		 *
 		 * If you don't want to overwrite the metalness but modify the existing
-		 * value instead, use {@link module:MaterialNode.materialMetalness}.
+		 * value instead, use {@link materialMetalness}.
 		 *
-		 * @type {Node<float>?}
+		 * @type {?Node<float>}
 		 * @default null
 		 */
 		this.metalnessNode = null;
@@ -82,9 +82,9 @@ class MeshStandardNodeMaterial extends NodeMaterial {
 		 * overwrite the default and define the roughness with a node instead.
 		 *
 		 * If you don't want to overwrite the roughness but modify the existing
-		 * value instead, use {@link module:MaterialNode.materialRoughness}.
+		 * value instead, use {@link materialRoughness}.
 		 *
-		 * @type {Node<float>?}
+		 * @type {?Node<float>}
 		 * @default null
 		 */
 		this.roughnessNode = null;
@@ -101,7 +101,7 @@ class MeshStandardNodeMaterial extends NodeMaterial {
 	 * method honors `Scene.environment`.
 	 *
 	 * @param {NodeBuilder} builder - The current node builder.
-	 * @return {EnvironmentNode<vec3>?} The environment node.
+	 * @return {?EnvironmentNode<vec3>} The environment node.
 	 */
 	setupEnvironment( builder ) {
 

package/src/materials/nodes/MeshToonNodeMaterial.js

@@ -6,7 +6,7 @@ import { MeshToonMaterial } from '../MeshToonMaterial.js';
 const _defaultValues = /*@__PURE__*/ new MeshToonMaterial();
 
 /**
- * Node material version of `MeshToonMaterial`.
+ * Node material version of {@link MeshToonMaterial}.
  *
  * @augments NodeMaterial
  */
@@ -21,7 +21,7 @@ class MeshToonNodeMaterial extends NodeMaterial {
 	/**
 	 * Constructs a new mesh toon node material.
 	 *
-	 * @param {Object?} parameters - The configuration parameter.
+	 * @param {Object} [parameters] - The configuration parameter.
 	 */
 	constructor( parameters ) {
 
@@ -30,7 +30,7 @@ class MeshToonNodeMaterial extends NodeMaterial {
 		/**
 		 * This flag can be used for type testing.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @readonly
 		 * @default true
 		 */
@@ -39,7 +39,7 @@ class MeshToonNodeMaterial extends NodeMaterial {
 		/**
 		 * Set to `true` because toon materials react on lights.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @default true
 		 */
 		this.lights = true;