@needle-tools/three 0.169.12 → 0.169.13

package/types/src/materials/MeshBasicMaterial.d.ts

@@ -0,0 +1,139 @@
+import { Combine } from "../constants.js";
+import { Color, ColorRepresentation } from "../math/Color.js";
+import { Euler } from "../math/Euler.js";
+import { Texture } from "../textures/Texture.js";
+import { Material, MaterialParameters } from "./Material.js";
+
+/**
+ * parameters is an object with one or more properties defining the material's appearance.
+ */
+export interface MeshBasicMaterialParameters extends MaterialParameters {
+    color?: ColorRepresentation | undefined;
+    opacity?: number | undefined;
+    map?: Texture | null | undefined;
+    lightMap?: Texture | null;
+    lightMapIntensity?: number | undefined;
+    aoMap?: Texture | null | undefined;
+    aoMapIntensity?: number | undefined;
+    specularMap?: Texture | null | undefined;
+    alphaMap?: Texture | null | undefined;
+    fog?: boolean | undefined;
+    envMap?: Texture | null | undefined;
+    envMapRotation?: Euler | undefined;
+    combine?: Combine | undefined;
+    reflectivity?: number | undefined;
+    refractionRatio?: number | undefined;
+    wireframe?: boolean | undefined;
+    wireframeLinewidth?: number | undefined;
+    wireframeLinecap?: string | undefined;
+    wireframeLinejoin?: string | undefined;
+}
+
+export class MeshBasicMaterial extends Material {
+    constructor(parameters?: MeshBasicMaterialParameters);
+
+    /**
+     * Read-only flag to check if a given object is of type {@link MeshBasicMaterial}.
+     * @remarks This is a _constant_ value
+     * @defaultValue `true`
+     */
+    readonly isMeshBasicMaterial: true;
+
+    /**
+     * @default 'MeshBasicMaterial'
+     */
+    type: string;
+
+    /**
+     * @default new THREE.Color( 0xffffff )
+     */
+    color: Color;
+
+    /**
+     * @default null
+     */
+    map: Texture | null;
+
+    /**
+     * @default null
+     */
+    lightMap: Texture | null;
+
+    /**
+     * @default 1
+     */
+    lightMapIntensity: number;
+
+    /**
+     * @default null
+     */
+    aoMap: Texture | null;
+
+    /**
+     * @default 1
+     */
+    aoMapIntensity: number;
+
+    /**
+     * @default null
+     */
+    specularMap: Texture | null;
+
+    /**
+     * @default null
+     */
+    alphaMap: Texture | null;
+
+    /**
+     * @default null
+     */
+    envMap: Texture | null;
+
+    /**
+     * The rotation of the environment map in radians. Default is `(0,0,0)`.
+     */
+    envMapRotation: Euler;
+
+    /**
+     * @default THREE.MultiplyOperation
+     */
+    combine: Combine;
+
+    /**
+     * @default 1
+     */
+    reflectivity: number;
+
+    /**
+     * @default 0.98
+     */
+    refractionRatio: number;
+
+    /**
+     * @default false
+     */
+    wireframe: boolean;
+
+    /**
+     * @default 1
+     */
+    wireframeLinewidth: number;
+
+    /**
+     * @default 'round'
+     */
+    wireframeLinecap: string;
+
+    /**
+     * @default 'round'
+     */
+    wireframeLinejoin: string;
+
+    /**
+     * Whether the material is affected by fog. Default is true.
+     * @default fog
+     */
+    fog: boolean;
+
+    setValues(parameters: MeshBasicMaterialParameters): void;
+}

package/types/src/materials/MeshDepthMaterial.d.ts

@@ -0,0 +1,76 @@
+import { DepthPackingStrategies } from "../constants.js";
+import { Texture } from "../textures/Texture.js";
+import { Material, MaterialParameters } from "./Material.js";
+
+export interface MeshDepthMaterialParameters extends MaterialParameters {
+    map?: Texture | null | undefined;
+    alphaMap?: Texture | null | undefined;
+    depthPacking?: DepthPackingStrategies | undefined;
+    displacementMap?: Texture | null | undefined;
+    displacementScale?: number | undefined;
+    displacementBias?: number | undefined;
+    wireframe?: boolean | undefined;
+    wireframeLinewidth?: number | undefined;
+}
+
+export class MeshDepthMaterial extends Material {
+    constructor(parameters?: MeshDepthMaterialParameters);
+    /**
+     * Read-only flag to check if a given object is of type {@link MeshDepthMaterial}.
+     * @remarks This is a _constant_ value
+     * @defaultValue `true`
+     */
+    readonly isMeshDepthMaterial: true;
+
+    /**
+     * @default 'MeshDepthMaterial'
+     */
+    type: string;
+
+    /**
+     * @default null
+     */
+    map: Texture | null;
+
+    /**
+     * @default null
+     */
+    alphaMap: Texture | null;
+
+    /**
+     * @default THREE.BasicDepthPacking
+     */
+    depthPacking: DepthPackingStrategies;
+
+    /**
+     * @default null
+     */
+    displacementMap: Texture | null;
+
+    /**
+     * @default 1
+     */
+    displacementScale: number;
+
+    /**
+     * @default 0
+     */
+    displacementBias: number;
+
+    /**
+     * @default false
+     */
+    wireframe: boolean;
+
+    /**
+     * @default 1
+     */
+    wireframeLinewidth: number;
+
+    /**
+     * @default false
+     */
+    fog: boolean;
+
+    setValues(parameters: MeshDepthMaterialParameters): void;
+}

package/types/src/materials/MeshDistanceMaterial.d.ts

@@ -0,0 +1,62 @@
+import { Vector3 } from "../math/Vector3.js";
+import { Texture } from "../textures/Texture.js";
+import { Material, MaterialParameters } from "./Material.js";
+
+export interface MeshDistanceMaterialParameters extends MaterialParameters {
+    map?: Texture | null | undefined;
+    alphaMap?: Texture | null | undefined;
+    displacementMap?: Texture | null | undefined;
+    displacementScale?: number | undefined;
+    displacementBias?: number | undefined;
+    farDistance?: number | undefined;
+    nearDistance?: number | undefined;
+    referencePosition?: Vector3 | undefined;
+}
+
+export class MeshDistanceMaterial extends Material {
+    constructor(parameters?: MeshDistanceMaterialParameters);
+
+    /**
+     * Read-only flag to check if a given object is of type {@link MeshDistanceMaterial}.
+     * @remarks This is a _constant_ value
+     * @defaultValue `true`
+     */
+    readonly isMeshDistanceMaterial: true;
+
+    /**
+     * @default 'MeshDistanceMaterial'
+     */
+    type: string;
+
+    /**
+     * @default null
+     */
+    map: Texture | null;
+
+    /**
+     * @default null
+     */
+    alphaMap: Texture | null;
+
+    /**
+     * @default null
+     */
+    displacementMap: Texture | null;
+
+    /**
+     * @default 1
+     */
+    displacementScale: number;
+
+    /**
+     * @default 0
+     */
+    displacementBias: number;
+
+    /**
+     * @default false
+     */
+    fog: boolean;
+
+    setValues(parameters: MeshDistanceMaterialParameters): void;
+}

package/types/src/materials/MeshLambertMaterial.d.ts

@@ -0,0 +1,204 @@
+import { Combine, NormalMapTypes } from "../constants.js";
+import { Color, ColorRepresentation } from "../math/Color.js";
+import { Euler } from "../math/Euler.js";
+import { Vector2 } from "../math/Vector2.js";
+import { Texture } from "../textures/Texture.js";
+import { Material, MaterialParameters } from "./Material.js";
+
+export interface MeshLambertMaterialParameters extends MaterialParameters {
+    bumpMap?: Texture | undefined;
+    bumpScale?: number | undefined;
+    color?: ColorRepresentation | undefined;
+    displacementMap?: Texture | undefined;
+    displacementScale?: number | undefined;
+    displacementBias?: number | undefined;
+    emissive?: ColorRepresentation | undefined;
+    emissiveIntensity?: number | undefined;
+    emissiveMap?: Texture | null | undefined;
+    flatShading?: boolean | undefined;
+    map?: Texture | null | undefined;
+    lightMap?: Texture | null | undefined;
+    lightMapIntensity?: number | undefined;
+    normalMap?: Texture | undefined;
+    normalScale?: Vector2 | undefined;
+    aoMap?: Texture | null | undefined;
+    aoMapIntensity?: number | undefined;
+    specularMap?: Texture | null | undefined;
+    alphaMap?: Texture | null | undefined;
+    envMap?: Texture | null | undefined;
+    envMapRotation?: Euler | undefined;
+    combine?: Combine | undefined;
+    reflectivity?: number | undefined;
+    refractionRatio?: number | undefined;
+    wireframe?: boolean | undefined;
+    wireframeLinewidth?: number | undefined;
+    wireframeLinecap?: string | undefined;
+    wireframeLinejoin?: string | undefined;
+    fog?: boolean | undefined;
+}
+
+export class MeshLambertMaterial extends Material {
+    constructor(parameters?: MeshLambertMaterialParameters);
+
+    /**
+     * Read-only flag to check if a given object is of type {@link MeshLambertMaterial}.
+     * @remarks This is a _constant_ value
+     * @defaultValue `true`
+     */
+    readonly isMeshLambertMaterial: true;
+
+    /**
+     * @default 'MeshLambertMaterial'
+     */
+    type: string;
+
+    /**
+     * @default new THREE.Color( 0xffffff )
+     */
+    color: Color;
+
+    /**
+     * @default null
+     */
+    bumpMap: Texture | null;
+
+    /**
+     * @default 1
+     */
+    bumpScale: number;
+
+    /**
+     * @default null
+     */
+    displacementMap: Texture | null;
+
+    /**
+     * @default 1
+     */
+    displacementScale: number;
+
+    /**
+     * @default 0
+     */
+    displacementBias: number;
+
+    /**
+     * @default new THREE.Color( 0x000000 )
+     */
+    emissive: Color;
+
+    /**
+     * @default 1
+     */
+    emissiveIntensity: number;
+
+    /**
+     * @default null
+     */
+    emissiveMap: Texture | null;
+
+    /**
+     * @default false
+     */
+    flatShading: boolean;
+
+    /**
+     * @default null
+     */
+    map: Texture | null;
+
+    /**
+     * @default null
+     */
+    lightMap: Texture | null;
+
+    /**
+     * @default 1
+     */
+    lightMapIntensity: number;
+
+    /**
+     * @default null
+     */
+    normalMap: Texture | null;
+
+    normalMapType: NormalMapTypes;
+
+    /**
+     * @default new THREE.Vector2( 1, 1 )
+     */
+    normalScale: Vector2;
+
+    /**
+     * @default null
+     */
+    aoMap: Texture | null;
+
+    /**
+     * @default 1
+     */
+    aoMapIntensity: number;
+
+    /**
+     * @default null
+     */
+    specularMap: Texture | null;
+
+    /**
+     * @default null
+     */
+    alphaMap: Texture | null;
+
+    /**
+     * @default null
+     */
+    envMap: Texture | null;
+
+    /**
+     * The rotation of the environment map in radians. Default is `(0,0,0)`.
+     */
+    envMapRotation: Euler;
+
+    /**
+     * @default THREE.MultiplyOperation
+     */
+    combine: Combine;
+
+    /**
+     * @default 1
+     */
+    reflectivity: number;
+
+    /**
+     * @default 0.98
+     */
+    refractionRatio: number;
+
+    /**
+     * @default false
+     */
+    wireframe: boolean;
+
+    /**
+     * @default 1
+     */
+    wireframeLinewidth: number;
+
+    /**
+     * @default 'round'
+     */
+    wireframeLinecap: string;
+
+    /**
+     * @default 'round'
+     */
+    wireframeLinejoin: string;
+
+    /**
+     * Whether the material is affected by fog. Default is true.
+     * @default fog
+     */
+    fog: boolean;
+
+    setValues(parameters: MeshLambertMaterialParameters): void;
+}

package/types/src/materials/MeshMatcapMaterial.d.ts

@@ -0,0 +1,117 @@
+import { NormalMapTypes } from "../constants.js";
+import { Color, ColorRepresentation } from "../math/Color.js";
+import { Vector2 } from "../math/Vector2.js";
+import { Texture } from "../textures/Texture.js";
+import { Material, MaterialParameters } from "./Material.js";
+
+export interface MeshMatcapMaterialParameters extends MaterialParameters {
+    color?: ColorRepresentation | undefined;
+    matcap?: Texture | null | undefined;
+    map?: Texture | null | undefined;
+    bumpMap?: Texture | null | undefined;
+    bumpScale?: number | undefined;
+    normalMap?: Texture | null | undefined;
+    normalMapType?: NormalMapTypes | undefined;
+    normalScale?: Vector2 | undefined;
+    displacementMap?: Texture | null | undefined;
+    displacementScale?: number | undefined;
+    displacementBias?: number | undefined;
+    alphaMap?: Texture | null | undefined;
+    fog?: boolean | undefined;
+    flatShading?: boolean | undefined;
+}
+
+export class MeshMatcapMaterial extends Material {
+    constructor(parameters?: MeshMatcapMaterialParameters);
+
+    /**
+     * Read-only flag to check if a given object is of type {@link MeshMatcapMaterial}.
+     * @remarks This is a _constant_ value
+     * @defaultValue `true`
+     */
+    readonly isMeshMatcapMaterial: true;
+
+    /**
+     * @default 'MeshMatcapMaterial'
+     */
+    type: string;
+
+    /**
+     * @default { 'MATCAP': '' }
+     */
+    defines: { [key: string]: any };
+
+    /**
+     * @default new THREE.Color( 0xffffff )
+     */
+    color: Color;
+
+    /**
+     * @default null
+     */
+    matcap: Texture | null;
+
+    /**
+     * @default null
+     */
+    map: Texture | null;
+
+    /**
+     * @default null
+     */
+    bumpMap: Texture | null;
+
+    /**
+     * @default 1
+     */
+    bumpScale: number;
+
+    /**
+     * @default null
+     */
+    normalMap: Texture | null;
+
+    /**
+     * @default THREE.TangentSpaceNormalMap
+     */
+    normalMapType: NormalMapTypes;
+
+    /**
+     * @default new Vector2( 1, 1 )
+     */
+    normalScale: Vector2;
+
+    /**
+     * @default null
+     */
+    displacementMap: Texture | null;
+
+    /**
+     * @default 1
+     */
+    displacementScale: number;
+
+    /**
+     * @default 0
+     */
+    displacementBias: number;
+
+    /**
+     * @default null
+     */
+    alphaMap: Texture | null;
+
+    /**
+     * Define whether the material is rendered with flat shading. Default is false.
+     * @default false
+     */
+    flatShading: boolean;
+
+    /**
+     * Whether the material is affected by fog. Default is true.
+     * @default fog
+     */
+    fog: boolean;
+
+    setValues(parameters: MeshMatcapMaterialParameters): void;
+}

package/types/src/materials/MeshNormalMaterial.d.ts

@@ -0,0 +1,93 @@
+import { NormalMapTypes } from "../constants.js";
+import { Vector2 } from "../math/Vector2.js";
+import { Texture } from "../textures/Texture.js";
+import { Material, MaterialParameters } from "./Material.js";
+
+export interface MeshNormalMaterialParameters extends MaterialParameters {
+    bumpMap?: Texture | null | undefined;
+    bumpScale?: number | undefined;
+    normalMap?: Texture | null | undefined;
+    normalMapType?: NormalMapTypes | undefined;
+    normalScale?: Vector2 | undefined;
+    displacementMap?: Texture | null | undefined;
+    displacementScale?: number | undefined;
+    displacementBias?: number | undefined;
+    wireframe?: boolean | undefined;
+    wireframeLinewidth?: number | undefined;
+
+    flatShading?: boolean | undefined;
+}
+
+export class MeshNormalMaterial extends Material {
+    constructor(parameters?: MeshNormalMaterialParameters);
+
+    /**
+     * Read-only flag to check if a given object is of type {@link MeshNormalMaterial}.
+     * @remarks This is a _constant_ value
+     * @defaultValue `true`
+     */
+    readonly isMeshNormalMaterial: true;
+
+    /**
+     * @default 'MeshNormalMaterial'
+     */
+    type: string;
+
+    /**
+     * @default null
+     */
+    bumpMap: Texture | null;
+
+    /**
+     * @default 1
+     */
+    bumpScale: number;
+
+    /**
+     * @default null
+     */
+    normalMap: Texture | null;
+
+    /**
+     * @default THREE.TangentSpaceNormalMap
+     */
+    normalMapType: NormalMapTypes;
+
+    /**
+     * @default new THREE.Vector2( 1, 1 )
+     */
+    normalScale: Vector2;
+
+    /**
+     * @default null
+     */
+    displacementMap: Texture | null;
+
+    /**
+     * @default 1
+     */
+    displacementScale: number;
+
+    /**
+     * @default 0
+     */
+    displacementBias: number;
+
+    /**
+     * @default false
+     */
+    wireframe: boolean;
+
+    /**
+     * @default 1
+     */
+    wireframeLinewidth: number;
+
+    /**
+     * Define whether the material is rendered with flat shading. Default is false.
+     * @default false
+     */
+    flatShading: boolean;
+
+    setValues(parameters: MeshNormalMaterialParameters): void;
+}