@types/three 0.177.0 → 0.178.0

three/src/materials/nodes/MeshSSSNodeMaterial.d.ts

@@ -1,16 +1,112 @@
 import InputNode from "../../nodes/core/InputNode.js";
+import { LightingModelDirectInput } from "../../nodes/core/LightingModel.js";
 import Node from "../../nodes/core/Node.js";
-import MeshPhysicalNodeMaterial, { MeshPhysicalNodeMaterialParameters } from "./MeshPhysicalNodeMaterial.js";
+import NodeBuilder from "../../nodes/core/NodeBuilder.js";
+import PhysicalLightingModel from "../../nodes/functions/PhysicalLightingModel.js";
+import { MapColorPropertiesToColorRepresentations } from "../Material.js";
+import { MeshPhysicalMaterialParameters, MeshPhysicalMaterialProperties } from "../MeshPhysicalMaterial.js";
+import MeshPhysicalNodeMaterial, { MeshPhysicalNodeMaterialNodeProperties } from "./MeshPhysicalNodeMaterial.js";
 
-export default class MeshSSSNodeMaterial extends MeshPhysicalNodeMaterial {
+/**
+ * Represents the lighting model for {@link MeshSSSNodeMaterial}.
+ */
+declare 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.
+     */
+    constructor(
+        clearcoat?: boolean,
+        sheen?: boolean,
+        iridescence?: boolean,
+        anisotropy?: boolean,
+        transmission?: boolean,
+        dispersion?: boolean,
+        sss?: boolean,
+    );
+    /**
+     * Whether the lighting model should use SSS or not.
+     *
+     * @default false
+     */
+    useSSS: boolean;
+    /**
+     * Extends the default implementation with a SSS term.
+     *
+     * 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 {NodeBuilder} builder - The current node builder.
+     */
+    direct(input: LightingModelDirectInput, builder: NodeBuilder): void;
+}
+
+export interface MeshSSSNodeMaterialNodeProperties extends MeshPhysicalNodeMaterialNodeProperties {
+    /**
+     * Represents the thickness color.
+     *
+     * @default null
+     */
     thicknessColorNode: Node | null;
+    /**
+     * Represents the distortion factor.
+     */
     thicknessDistortionNode: InputNode<number>;
+    /**
+     * Represents the thickness ambient factor.
+     */
     thicknessAmbientNode: InputNode<number>;
+    /**
+     * Represents the thickness attenuation.
+     */
     thicknessAttenuationNode: InputNode<number>;
+    /**
+     * Represents the thickness power.
+     */
     thicknessPowerNode: InputNode<number>;
+    /**
+     * Represents the thickness scale.
+     */
     thicknessScaleNode: InputNode<number>;
+}
 
-    constructor(parameters?: MeshPhysicalNodeMaterialParameters);
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface MeshSSSNodeMaterialParameters
+    extends
+        Partial<MapColorPropertiesToColorRepresentations<MeshSSSNodeMaterialNodeProperties>>,
+        MeshPhysicalMaterialParameters
+{}
 
+/**
+ * This node material is an experimental extension of {@link MeshPhysicalNodeMaterial}
+ * that implements a Subsurface scattering (SSS) term.
+ *
+ * @augments MeshPhysicalNodeMaterial
+ */
+declare class MeshSSSNodeMaterial extends MeshPhysicalNodeMaterial {
+    constructor(parameters?: MeshSSSNodeMaterialParameters);
+    /**
+     * Whether the lighting model should use SSS or not.
+     *
+     * @default true
+     */
     get useSSS(): boolean;
+    /**
+     * Setups the lighting model.
+     *
+     * @return {SSSLightingModel} The lighting model.
+     */
+    setupLightingModel(): SSSLightingModel;
 }
+
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+interface MeshSSSNodeMaterial extends MeshSSSNodeMaterialNodeProperties, MeshPhysicalMaterialProperties {}
+
+export default MeshSSSNodeMaterial;

three/src/materials/nodes/MeshStandardNodeMaterial.d.ts

@@ -1,56 +1,92 @@
-import { NormalMapTypes } from "../../constants.js";
-import { Color } from "../../math/Color.js";
-import { Euler } from "../../math/Euler.js";
-import { Vector2 } from "../../math/Vector2.js";
 import Node from "../../nodes/core/Node.js";
-import { Texture } from "../../textures/Texture.js";
-import { MeshStandardMaterialParameters } from "../MeshStandardMaterial.js";
-import NodeMaterial, { NodeMaterialParameters } from "./NodeMaterial.js";
-
-export interface MeshStandardNodeMaterialParameters extends NodeMaterialParameters, MeshStandardMaterialParameters {
-}
-
-export default class MeshStandardNodeMaterial extends NodeMaterial {
-    readonly isMeshStandardNodeMaterial: true;
+import NodeBuilder from "../../nodes/core/NodeBuilder.js";
+import PhysicalLightingModel from "../../nodes/functions/PhysicalLightingModel.js";
+import EnvironmentNode from "../../nodes/lighting/EnvironmentNode.js";
+import { MapColorPropertiesToColorRepresentations } from "../Material.js";
+import { MeshStandardMaterialParameters, MeshStandardMaterialProperties } from "../MeshStandardMaterial.js";
+import NodeMaterial, { NodeMaterialNodeProperties } from "./NodeMaterial.js";
 
+export interface MeshStandardNodeMaterialNodeProperties extends NodeMaterialNodeProperties {
+    /**
+     * 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 materialEmissive}.
+     *
+     * @default null
+     */
     emissiveNode: Node | 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 materialMetalness}.
+     *
+     * @default null
+     */
     metalnessNode: Node | 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 materialRoughness}.
+     *
+     * @default null
+     */
     roughnessNode: Node | null;
+}
 
-    // Properties from MeshStandardMaterial
-    readonly isMeshStandardMaterial: true;
-    color: Color;
-    roughness: number;
-    metalness: number;
-    map: Texture | null;
-    lightMap: Texture | null;
-    lightMapIntensity: number;
-    aoMap: Texture | null;
-    aoMapIntensity: number;
-    emissive: Color;
-    emissiveIntensity: number;
-    emissiveMap: Texture | null;
-    bumpMap: Texture | null;
-    bumpScale: number;
-    normalMap: Texture | null;
-    normalMapType: NormalMapTypes;
-    normalScale: Vector2;
-    displacementMap: Texture | null;
-    displacementScale: number;
-    displacementBias: number;
-    roughnessMap: Texture | null;
-    metalnessMap: Texture | null;
-    alphaMap: Texture | null;
-    envMap: Texture | null;
-    envMapRotation: Euler;
-    envMapIntensity: number;
-    wireframe: boolean;
-    wireframeLinewidth: number;
-    wireframeLinecap: string;
-    wireframeLinejoin: string;
-    flatShading: boolean;
-    fog: boolean;
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface MeshStandardNodeMaterialParameters
+    extends
+        Partial<MapColorPropertiesToColorRepresentations<MeshStandardNodeMaterialNodeProperties>>,
+        MeshStandardMaterialParameters
+{}
 
+/**
+ * Node material version of {@link MeshStandardMaterial}.
+ */
+declare class MeshStandardNodeMaterial extends NodeMaterial {
+    /**
+     * Constructs a new mesh standard node material.
+     *
+     * @param {Object} [parameters] - The configuration parameter.
+     */
     constructor(parameters?: MeshStandardNodeMaterialParameters);
+    /**
+     * This flag can be used for type testing.
+     *
+     * @default true
+     */
+    readonly isMeshStandardNodeMaterial: boolean;
+    /**
+     * 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: NodeBuilder): EnvironmentNode | null;
+    /**
+     * Setups the lighting model.
+     *
+     * @return {PhysicalLightingModel} The lighting model.
+     */
+    setupLightingModel(): PhysicalLightingModel;
+    /**
+     * Setups the specular related node variables.
+     */
+    setupSpecular(): void;
 }
+
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+interface MeshStandardNodeMaterial extends MeshStandardNodeMaterialNodeProperties, MeshStandardMaterialProperties {}
+
+export default MeshStandardNodeMaterial;

three/src/materials/nodes/MeshToonNodeMaterial.d.ts

@@ -1,42 +1,48 @@
-import { NormalMapTypes } from "../../constants.js";
-import { Color } from "../../math/Color.js";
-import { Vector2 } from "../../math/Vector2.js";
-import { Texture } from "../../textures/Texture.js";
-import { MeshToonMaterialParameters } from "../MeshToonMaterial.js";
-import NodeMaterial, { NodeMaterialParameters } from "./NodeMaterial.js";
+import ToonLightingModel from "../../nodes/functions/ToonLightingModel.js";
+import { MapColorPropertiesToColorRepresentations } from "../Material.js";
+import { MeshToonMaterialParameters, MeshToonMaterialProperties } from "../MeshToonMaterial.js";
+import NodeMaterial, { NodeMaterialNodeProperties } from "./NodeMaterial.js";
 
-export interface MeshToonNodeMaterialParameters extends NodeMaterialParameters, MeshToonMaterialParameters {
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface MeshToonNodeMaterialNodeProperties extends NodeMaterialNodeProperties {
 }
 
-export default class MeshToonNodeMaterial extends NodeMaterial {
-    readonly isMeshToonNodeMaterial: true;
-
-    // Properties from MeshToonMaterial
-    readonly isMeshToonMaterial: true;
-    color: Color;
-    gradientMap: Texture | null;
-    map: Texture | null;
-    lightMap: Texture | null;
-    lightMapIntensity: number;
-    aoMap: Texture | null;
-    aoMapIntensity: number;
-    emissive: Color;
-    emissiveIntensity: number;
-    emissiveMap: Texture | null;
-    bumpMap: Texture | null;
-    bumpScale: number;
-    normalMap: Texture | null;
-    normalMapType: NormalMapTypes;
-    normalScale: Vector2;
-    displacementMap: Texture | null;
-    displacementScale: number;
-    displacementBias: number;
-    alphaMap: Texture | null;
-    wireframe: boolean;
-    wireframeLinewidth: number;
-    wireframeLinecap: string;
-    wireframeLinejoin: string;
-    fog: boolean;
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface MeshToonNodeMaterialParameters
+    extends
+        Partial<MapColorPropertiesToColorRepresentations<MeshToonNodeMaterialNodeProperties>>,
+        MeshToonMaterialParameters
+{}
 
+/**
+ * Node material version of {@link MeshToonMaterial}.
+ *
+ * @augments NodeMaterial
+ */
+declare class MeshToonNodeMaterial extends NodeMaterial {
+    /**
+     * Constructs a new mesh toon node material.
+     *
+     * @param {Object} [parameters] - The configuration parameter.
+     */
     constructor(parameters?: MeshToonNodeMaterialParameters);
+    /**
+     * This flag can be used for type testing.
+     *
+     * @type {boolean}
+     * @readonly
+     * @default true
+     */
+    readonly isMeshToonNodeMaterial: boolean;
+    /**
+     * Setups the lighting model.
+     *
+     * @return {ToonLightingModel} The lighting model.
+     */
+    setupLightingModel(): ToonLightingModel;
 }
+
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+interface MeshToonNodeMaterial extends MeshToonNodeMaterialNodeProperties, MeshToonMaterialProperties {}
+
+export default MeshToonNodeMaterial;