@types/three 0.177.0 → 0.178.0

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

@@ -1,32 +1,44 @@
-import { NormalMapTypes } from "../../constants.js";
-import { Color } from "../../math/Color.js";
-import { Vector2 } from "../../math/Vector2.js";
-import { Texture } from "../../textures/Texture.js";
-import { MeshMatcapMaterialParameters } from "../MeshMatcapMaterial.js";
-import NodeMaterial, { NodeMaterialParameters } from "./NodeMaterial.js";
+import NodeBuilder from "../../nodes/core/NodeBuilder.js";
+import { MapColorPropertiesToColorRepresentations } from "../Material.js";
+import { MeshMatcapMaterialParameters, MeshMatcapMaterialProperties } from "../MeshMatcapMaterial.js";
+import NodeMaterial, { NodeMaterialNodeProperties } from "./NodeMaterial.js";
 
-export interface MeshMatcapNodeMaterialParameters extends NodeMaterialParameters, MeshMatcapMaterialParameters {
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface MeshMatcapNodeMaterialNodeProperties extends NodeMaterialNodeProperties {
 }
 
-export default class MeshMatcapNodeMaterial extends NodeMaterial {
-    readonly isMeshMatcapNodeMaterial: true;
-
-    // Properties from MeshMatcapMaterial
-    readonly isMeshMatcapMaterial: true;
-    color: Color;
-    matcap: Texture | null;
-    map: Texture | null;
-    bumpMap: Texture | null;
-    bumpScale: number;
-    normalMap: Texture | null;
-    normalMapType: NormalMapTypes;
-    normalScale: Vector2;
-    displacementMap: Texture | null;
-    displacementScale: number;
-    displacementBias: number;
-    alphaMap: Texture | null;
-    flatShading: boolean;
-    fog: boolean;
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface MeshMatcapNodeMaterialParameters
+    extends
+        Partial<MapColorPropertiesToColorRepresentations<MeshMatcapNodeMaterialNodeProperties>>,
+        MeshMatcapMaterialParameters
+{}
 
+/**
+ * Node material version of {@link MeshMatcapMaterial}.
+ */
+declare class MeshMatcapNodeMaterial extends NodeMaterial {
+    /**
+     * Constructs a new mesh normal node material.
+     *
+     * @param {Object} [parameters] - The configuration parameter.
+     */
     constructor(parameters?: MeshMatcapNodeMaterialParameters);
+    /**
+     * This flag can be used for type testing.
+     *
+     * @default true
+     */
+    readonly isMeshMatcapNodeMaterial: boolean;
+    /**
+     * Setups the matcap specific node variables.
+     *
+     * @param {NodeBuilder} builder - The current node builder.
+     */
+    setupVariants(builder: NodeBuilder): void;
 }
+
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+interface MeshMatcapNodeMaterial extends MeshMatcapNodeMaterialNodeProperties, MeshMatcapMaterialProperties {}
+
+export default MeshMatcapNodeMaterial;

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

@@ -1,28 +1,42 @@
-import { NormalMapTypes } from "../../constants.js";
-import { Vector2 } from "../../math/Vector2.js";
-import { Texture } from "../../textures/Texture.js";
-import { MeshNormalMaterialParameters } from "../MeshNormalMaterial.js";
-import NodeMaterial, { NodeMaterialParameters } from "./NodeMaterial.js";
+import { MapColorPropertiesToColorRepresentations } from "../Material.js";
+import { MeshNormalMaterialParameters, MeshNormalMaterialProperties } from "../MeshNormalMaterial.js";
+import NodeMaterial, { NodeMaterialNodeProperties } from "./NodeMaterial.js";
 
-export interface MeshNormalNodeMaterialParameters extends NodeMaterialParameters, MeshNormalMaterialParameters {
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface MeshNormalNodeMaterialNodeProperties extends NodeMaterialNodeProperties {
 }
 
-export default class MeshNormalNodeMaterial extends NodeMaterial {
-    readonly isMeshNormalNodeMaterial: true;
-
-    // Properties from MeshNormalMaterial
-    readonly isMeshNormalMaterial: true;
-    bumpMap: Texture | null;
-    bumpScale: number;
-    normalMap: Texture | null;
-    normalMapType: NormalMapTypes;
-    normalScale: Vector2;
-    displacementMap: Texture | null;
-    displacementScale: number;
-    displacementBias: number;
-    wireframe: boolean;
-    wireframeLinewidth: number;
-    flatShading: boolean;
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface MeshNormalNodeMaterialParameters
+    extends
+        Partial<MapColorPropertiesToColorRepresentations<MeshNormalNodeMaterialNodeProperties>>,
+        MeshNormalMaterialParameters
+{}
 
+/**
+ * Node material version of {@link MeshNormalMaterial}.
+ */
+declare class MeshNormalNodeMaterial extends NodeMaterial {
+    /**
+     * Constructs a new mesh normal node material.
+     *
+     * @param {Object} [parameters] - The configuration parameter.
+     */
     constructor(parameters?: MeshNormalNodeMaterialParameters);
+    /**
+     * This flag can be used for type testing.
+     *
+     * @type {boolean}
+     */
+    readonly isMeshNormalNodeMaterial: boolean;
+    /**
+     * Overwrites the default implementation by computing the diffuse color
+     * based on the normal data.
+     */
+    setupDiffuseColor(): void;
 }
+
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+interface MeshNormalNodeMaterial extends MeshNormalNodeMaterialNodeProperties, MeshNormalMaterialProperties {}
+
+export default MeshNormalNodeMaterial;

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

@@ -1,56 +1,76 @@
-import { Combine, 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 { MeshPhongMaterialParameters } from "../MeshPhongMaterial.js";
-import NodeMaterial, { NodeMaterialParameters } from "./NodeMaterial.js";
-
-export interface MeshPhongNodeMaterialParameters extends NodeMaterialParameters, MeshPhongMaterialParameters {
-}
-
-export default class MeshPhongNodeMaterial extends NodeMaterial {
-    readonly isMeshPhongNodeMaterial: true;
+import NodeBuilder from "../../nodes/core/NodeBuilder.js";
+import PhongLightingModel from "../../nodes/functions/PhongLightingModel.js";
+import BasicEnvironmentNode from "../../nodes/lighting/BasicEnvironmentNode.js";
+import { MapColorPropertiesToColorRepresentations } from "../Material.js";
+import { MeshPhongMaterialParameters, MeshPhongMaterialProperties } from "../MeshPhongMaterial.js";
+import NodeMaterial, { NodeMaterialNodeProperties } from "./NodeMaterial.js";
 
+export interface MeshPhongNodeMaterialNodeProperties extends NodeMaterialNodeProperties {
+    /**
+     * The shininess of phong materials is by default inferred from the `shininess`
+     * property. This node property allows to overwrite the default
+     * and define the shininess with a node instead.
+     *
+     * If you don't want to overwrite the shininess but modify the existing
+     * value instead, use {@link materialShininess}.
+     *
+     * @default null
+     */
     shininessNode: Node | null;
+    /**
+     * The specular color of phong materials is by default inferred from the
+     * `specular` property. This node property allows to overwrite the default
+     * 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 materialSpecular}.
+     *
+     * @default null
+     */
     specularNode: Node | null;
+}
 
-    // Properties from MeshPhongMaterial
-    readonly isMeshPhongMaterial: true;
-    color: Color;
-    specular: Color;
-    shininess: 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;
-    specularMap: Texture | null;
-    alphaMap: Texture | null;
-    envMap: Texture | null;
-    envMapRotation: Euler;
-    combine: Combine;
-    reflectivity: number;
-    refractionRatio: number;
-    wireframe: boolean;
-    wireframeLinewidth: number;
-    wireframeLinecap: string;
-    wireframeLinejoin: string;
-    flatShading: boolean;
-    metal: boolean;
-    fog: boolean;
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface MeshPhongNodeMaterialParameters
+    extends
+        Partial<MapColorPropertiesToColorRepresentations<MeshPhongNodeMaterialNodeProperties>>,
+        MeshPhongMaterialParameters
+{}
 
+/**
+ * Node material version of {@link MeshPhongMaterial}.
+ */
+declare class MeshPhongNodeMaterial extends NodeMaterial {
+    /**
+     * Constructs a new mesh lambert node material.
+     *
+     * @param {Object} [parameters] - The configuration parameter.
+     */
     constructor(parameters?: MeshPhongNodeMaterialParameters);
+    /**
+     * This flag can be used for type testing.
+     *
+     * @default true
+     */
+    readonly isMeshPhongNodeMaterial: boolean;
+    /**
+     * Overwritten since this type of material uses {@link BasicEnvironmentNode}
+     * to implement the default environment mapping.
+     *
+     * @param {NodeBuilder} builder - The current node builder.
+     * @return {?BasicEnvironmentNode<vec3>} The environment node.
+     */
+    setupEnvironment(builder: NodeBuilder): BasicEnvironmentNode | null;
+    /**
+     * Setups the lighting model.
+     *
+     * @return {PhongLightingModel} The lighting model.
+     */
+    setupLightingModel(): PhongLightingModel;
 }
+
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+interface MeshPhongNodeMaterial extends MeshPhongNodeMaterialNodeProperties, MeshPhongMaterialProperties {}
+
+export default MeshPhongNodeMaterial;

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

@@ -1,93 +1,268 @@
-import { Color } from "../../math/Color.js";
-import { Vector2 } from "../../math/Vector2.js";
 import Node from "../../nodes/core/Node.js";
-import { ShaderNodeObject } from "../../nodes/tsl/TSLCore.js";
-import { Texture } from "../../textures/Texture.js";
-import { MeshPhysicalMaterialParameters } from "../MeshPhysicalMaterial.js";
-import MeshStandardNodeMaterial, { MeshStandardNodeMaterialParameters } from "./MeshStandardNodeMaterial.js";
-
-export interface MeshPhysicalNodeMaterialParameters
-    extends MeshStandardNodeMaterialParameters, MeshPhysicalMaterialParameters
-{
-}
-
-export default class MeshPhysicalNodeMaterial extends MeshStandardNodeMaterial {
-    readonly isMeshPhysicalNodeMaterial: true;
+import NodeBuilder from "../../nodes/core/NodeBuilder.js";
+import { MapColorPropertiesToColorRepresentations } from "../Material.js";
+import { MeshPhysicalMaterialParameters, MeshPhysicalMaterialProperties } from "../MeshPhysicalMaterial.js";
+import MeshStandardNodeMaterial, { MeshStandardNodeMaterialNodeProperties } from "./MeshStandardNodeMaterial.js";
 
+export interface MeshPhysicalNodeMaterialNodeProperties extends MeshStandardNodeMaterialNodeProperties {
+    /**
+     * The clearcoat of physical materials is by default inferred from the `clearcoat`
+     * and `clearcoatMap` properties. This node property allows to overwrite the default
+     * 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 materialClearcoat}.
+     *
+     * @default null
+     */
     clearcoatNode: Node | null;
+    /**
+     * The clearcoat roughness of physical materials is by default inferred from the `clearcoatRoughness`
+     * and `clearcoatRoughnessMap` properties. This node property allows to overwrite the default
+     * 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 materialClearcoatRoughness}.
+     *
+     * @default null
+     */
     clearcoatRoughnessNode: Node | null;
+    /**
+     * The clearcoat normal of physical materials is by default inferred from the `clearcoatNormalMap`
+     * property. This node property allows to overwrite the default
+     * 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 materialClearcoatNormal}.
+     *
+     * @default null
+     */
     clearcoatNormalNode: Node | null;
-
+    /**
+     * The sheen of physical materials is by default inferred from the `sheen`, `sheenColor`
+     * and `sheenColorMap` properties. This node property allows to overwrite the default
+     * 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 materialSheen}.
+     *
+     * @default null
+     */
     sheenNode: Node | null;
+    /**
+     * The sheen roughness of physical materials is by default inferred from the `sheenRoughness` and
+     * `sheenRoughnessMap` properties. This node property allows to overwrite the default
+     * 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 materialSheenRoughness}.
+     *
+     * @default null
+     */
     sheenRoughnessNode: Node | null;
-
+    /**
+     * The iridescence of physical materials is by default inferred from the `iridescence`
+     * property. This node property allows to overwrite the default
+     * 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 materialIridescence}.
+     *
+     * @default null
+     */
     iridescenceNode: Node | null;
+    /**
+     * The iridescence IOR of physical materials is by default inferred from the `iridescenceIOR`
+     * property. This node property allows to overwrite the default
+     * 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 materialIridescenceIOR}.
+     *
+     * @default null
+     */
     iridescenceIORNode: Node | null;
+    /**
+     * The iridescence thickness of physical materials is by default inferred from the `iridescenceThicknessRange`
+     * and `iridescenceThicknessMap` properties. This node property allows to overwrite the default
+     * 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 materialIridescenceThickness}.
+     *
+     * @default null
+     */
     iridescenceThicknessNode: Node | null;
-
-    iorNode: Node | null;
-
+    /**
+     * The specular intensity of physical materials is by default inferred from the `specularIntensity`
+     * and `specularIntensityMap` properties. This node property allows to overwrite the default
+     * 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 materialSpecularIntensity}.
+     *
+     * @default null
+     */
     specularIntensityNode: Node | null;
+    /**
+     * The specular color of physical materials is by default inferred from the `specularColor`
+     * and `specularColorMap` properties. This node property allows to overwrite the default
+     * 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 materialSpecularColor}.
+     *
+     * @default null
+     */
     specularColorNode: Node | null;
-
+    /**
+     * The ior of physical materials is by default inferred from the `ior`
+     * property. This node property allows to overwrite the default
+     * 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 materialIOR}.
+     *
+     * @default null
+     */
+    iorNode: Node | null;
+    /**
+     * The transmission of physical materials is by default inferred from the `transmission` and
+     * `transmissionMap` properties. This node property allows to overwrite the default
+     * 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 materialTransmission}.
+     *
+     * @default null
+     */
     transmissionNode: Node | null;
+    /**
+     * The thickness of physical materials is by default inferred from the `thickness` and
+     * `thicknessMap` properties. This node property allows to overwrite the default
+     * 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 materialThickness}.
+     *
+     * @default null
+     */
     thicknessNode: Node | null;
+    /**
+     * The attenuation distance of physical materials is by default inferred from the
+     * `attenuationDistance` property. This node property allows to overwrite the default
+     * 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 materialAttenuationDistance}.
+     *
+     * @default null
+     */
     attenuationDistanceNode: Node | null;
+    /**
+     * The attenuation color of physical materials is by default inferred from the
+     * `attenuationColor` property. This node property allows to overwrite the default
+     * 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 materialAttenuationColor}.
+     *
+     * @default null
+     */
     attenuationColorNode: Node | null;
+    /**
+     * The dispersion of physical materials is by default inferred from the
+     * `dispersion` property. This node property allows to overwrite the default
+     * 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 materialDispersion}.
+     *
+     * @default null
+     */
     dispersionNode: Node | null;
-
+    /**
+     * The anisotropy of physical materials is by default inferred from the
+     * `anisotropy` property. This node property allows to overwrite the default
+     * 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 materialAnisotropy}.
+     *
+     * @default null
+     */
     anisotropyNode: Node | null;
+}
 
-    // Properties from MeshPhysicalMaterial
-    readonly isMeshPhysicalMaterial: true;
-    anisotropyRotation: number;
-    anisotropyMap: Texture | null;
-    clearcoatMap: Texture | null;
-    clearcoatRoughness: number;
-    clearcoatRoughnessMap: Texture | null;
-    clearcoatNormalScale: Vector2;
-    clearcoatNormalMap: Texture | null;
-    ior: number;
-    get reflectivity(): number;
-    set reflectivity(reflectivity: number);
-    iridescenceMap: Texture | null;
-    iridescenceIOR: number;
-    iridescenceThicknessRange: [number, number];
-    iridescenceThicknessMap: Texture | null;
-    sheenColor: Color;
-    sheenColorMap: Texture | null;
-    sheenRoughness: number;
-    sheenRoughnessMap: Texture | null;
-    transmissionMap: Texture | null;
-    thickness: number;
-    thicknessMap: Texture | null;
-    attenuationDistance: number;
-    attenuationColor: Color;
-    specularIntensity: number;
-    specularIntensityMap: Texture | null;
-    specularColor: Color;
-    specularColorMap: Texture | null;
-    get anisotropy(): number;
-    set anisotropy(value: number);
-    get clearcoat(): number;
-    set clearcoat(value: number);
-    get iridescence(): number;
-    set iridescence(value: number);
-    get dispersion(): number;
-    set dispersion(value: number);
-    get sheen(): number;
-    set sheen(value: number);
-    get transmission(): number;
-    set transmission(value: number);
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface MeshPhysicalNodeMaterialParameters
+    extends
+        Partial<MapColorPropertiesToColorRepresentations<MeshPhysicalNodeMaterialNodeProperties>>,
+        MeshPhysicalMaterialParameters
+{}
 
+/**
+ * Node material version of {@link MeshPhysicalMaterial}.
+ */
+declare class MeshPhysicalNodeMaterial extends MeshStandardNodeMaterial {
     constructor(parameters?: MeshPhysicalNodeMaterialParameters);
-
+    /**
+     * This flag can be used for type testing.
+     *
+     * @default true
+     */
+    readonly isMeshPhysicalNodeMaterial: boolean;
+    /**
+     * Whether the lighting model should use clearcoat or not.
+     *
+     * @default true
+     */
     get useClearcoat(): boolean;
+    /**
+     * Whether the lighting model should use iridescence or not.
+     *
+     * @default true
+     */
     get useIridescence(): boolean;
+    /**
+     * Whether the lighting model should use sheen or not.
+     *
+     * @default true
+     */
     get useSheen(): boolean;
+    /**
+     * Whether the lighting model should use anisotropy or not.
+     *
+     * @default true
+     */
     get useAnisotropy(): boolean;
+    /**
+     * Whether the lighting model should use transmission or not.
+     *
+     * @default true
+     */
     get useTransmission(): boolean;
+    /**
+     * Whether the lighting model should use dispersion or not.
+     *
+     * @default true
+     */
     get useDispersion(): boolean;
-
-    setupClearcoatNormal(): ShaderNodeObject<Node>;
+    /**
+     * Setups the physical specific node variables.
+     *
+     * @param {NodeBuilder} builder - The current node builder.
+     */
+    setupVariants(builder: NodeBuilder): void;
+    /**
+     * Setups the clearcoat normal node.
+     *
+     * @return {Node<vec3>} The clearcoat normal.
+     */
+    setupClearcoatNormal(): Node;
 }
+
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+interface MeshPhysicalNodeMaterial extends MeshPhysicalNodeMaterialNodeProperties, MeshPhysicalMaterialProperties {}
+
+export default MeshPhysicalNodeMaterial;