super-three 0.171.0 → 0.173.0

package/src/materials/nodes/MeshStandardNodeMaterial.js

@@ -11,6 +11,11 @@ import { MeshStandardMaterial } from '../MeshStandardMaterial.js';
 
 const _defaultValues = /*@__PURE__*/ new MeshStandardMaterial();
 
+/**
+ * Node material version of `MeshStandardMaterial`.
+ *
+ * @augments NodeMaterial
+ */
 class MeshStandardNodeMaterial extends NodeMaterial {
 
 	static get type() {
@@ -19,17 +24,69 @@ class MeshStandardNodeMaterial extends NodeMaterial {
 
 	}
 
+	/**
+	 * Constructs a new mesh standard node material.
+	 *
+	 * @param {Object?} parameters - The configuration parameter.
+	 */
 	constructor( parameters ) {
 
 		super();
 
+		/**
+		 * This flag can be used for type testing.
+		 *
+		 * @type {Boolean}
+		 * @readonly
+		 * @default true
+		 */
 		this.isMeshStandardNodeMaterial = true;
 
+		/**
+		 * Set to `true` because standard materials react on lights.
+		 *
+		 * @type {Boolean}
+		 * @default true
+		 */
 		this.lights = true;
 
+		/**
+		 * The emissive color of standard materials is by default inferred from the `emissive`,
+		 * `emissiveIntensity` and `emissiveMap` properties. This node property allows to
+		 * 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}.
+		 *
+		 * @type {Node<vec3>?}
+		 * @default null
+		 */
 		this.emissiveNode = null;
 
+		/**
+		 * The metalness of standard materials is by default inferred from the `metalness`,
+		 * and `metalnessMap` properties. This node property allows to
+		 * 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}.
+		 *
+		 * @type {Node<float>?}
+		 * @default null
+		 */
 		this.metalnessNode = null;
+
+		/**
+		 * The roughness of standard materials is by default inferred from the `roughness`,
+		 * and `roughnessMap` properties. This node property allows to
+		 * 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}.
+		 *
+		 * @type {Node<float>?}
+		 * @default null
+		 */
 		this.roughnessNode = null;
 
 		this.setDefaultValues( _defaultValues );
@@ -38,6 +95,14 @@ class MeshStandardNodeMaterial extends NodeMaterial {
 
 	}
 
+	/**
+	 * Overwritten since this type of material uses {@link EnvironmentNode}
+	 * to implement the PBR (PMREM based) environment mapping. Besides, the
+	 * method honors `Scene.environment`.
+	 *
+	 * @param {NodeBuilder} builder - The current node builder.
+	 * @return {EnvironmentNode<vec3>?} The environment node.
+	 */
 	setupEnvironment( builder ) {
 
 		let envNode = super.setupEnvironment( builder );
@@ -52,12 +117,20 @@ class MeshStandardNodeMaterial extends NodeMaterial {
 
 	}
 
+	/**
+	 * Setups the lighting model.
+	 *
+	 * @return {PhysicalLightingModel} The lighting model.
+	 */
 	setupLightingModel( /*builder*/ ) {
 
 		return new PhysicalLightingModel();
 
 	}
 
+	/**
+	 * Setups the specular related node variables.
+	 */
 	setupSpecular() {
 
 		const specularColorNode = mix( vec3( 0.04 ), diffuseColor.rgb, metalness );
@@ -67,6 +140,11 @@ class MeshStandardNodeMaterial extends NodeMaterial {
 
 	}
 
+	/**
+	 * Setups the standard specific node variables.
+	 *
+	 * @param {NodeBuilder} builder - The current node builder.
+	 */
 	setupVariants() {
 
 		// METALNESS

package/src/materials/nodes/MeshToonNodeMaterial.js

@@ -5,6 +5,11 @@ import { MeshToonMaterial } from '../MeshToonMaterial.js';
 
 const _defaultValues = /*@__PURE__*/ new MeshToonMaterial();
 
+/**
+ * Node material version of `MeshToonMaterial`.
+ *
+ * @augments NodeMaterial
+ */
 class MeshToonNodeMaterial extends NodeMaterial {
 
 	static get type() {
@@ -13,12 +18,30 @@ class MeshToonNodeMaterial extends NodeMaterial {
 
 	}
 
+	/**
+	 * Constructs a new mesh toon node material.
+	 *
+	 * @param {Object?} parameters - The configuration parameter.
+	 */
 	constructor( parameters ) {
 
 		super();
 
+		/**
+		 * This flag can be used for type testing.
+		 *
+		 * @type {Boolean}
+		 * @readonly
+		 * @default true
+		 */
 		this.isMeshToonNodeMaterial = true;
 
+		/**
+		 * Set to `true` because toon materials react on lights.
+		 *
+		 * @type {Boolean}
+		 * @default true
+		 */
 		this.lights = true;
 
 		this.setDefaultValues( _defaultValues );
@@ -27,6 +50,11 @@ class MeshToonNodeMaterial extends NodeMaterial {
 
 	}
 
+	/**
+	 * Setups the lighting model.
+	 *
+	 * @return {ToonLightingModel} The lighting model.
+	 */
 	setupLightingModel( /*builder*/ ) {
 
 		return new ToonLightingModel();