@types/three 0.169.0 → 0.171.0

three/README.md

@@ -8,7 +8,7 @@ This package contains type definitions for three (https://threejs.org/).
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/three.
 
 ### Additional Details
- * Last updated: Thu, 26 Sep 2024 17:08:07 GMT
+ * Last updated: Sun, 15 Dec 2024 01:30:13 GMT
  * Dependencies: [@tweenjs/tween.js](https://npmjs.com/package/@tweenjs/tween.js), [@types/stats.js](https://npmjs.com/package/@types/stats.js), [@types/webxr](https://npmjs.com/package/@types/webxr), [@webgpu/types](https://npmjs.com/package/@webgpu/types), [fflate](https://npmjs.com/package/fflate), [meshoptimizer](https://npmjs.com/package/meshoptimizer)
 
 # Credits

three/build/three.core.d.ts

@@ -0,0 +1 @@
+export * from "../src/Three.Core.js";

three/build/three.core.min.d.ts

@@ -0,0 +1 @@
+export * from "../src/Three.Core.js";

three/build/three.tsl.d.ts

@@ -0,0 +1 @@
+export * from "../src/Three.TSL.js";

three/build/three.tsl.min.d.ts

@@ -0,0 +1 @@
+export * from "../src/Three.TSL.js";

three/examples/jsm/Addons.d.ts

@@ -3,8 +3,6 @@ export * from "./animation/CCDIKSolver.js";
 export * from "./animation/MMDAnimationHelper.js";
 export * from "./animation/MMDPhysics.js";
 
-export * from "./cameras/CinematicCamera.js";
-
 export { default as WebGL } from "./capabilities/WebGL.js";
 
 export * from "./controls/ArcballControls.js";
@@ -129,7 +127,9 @@ export * from "./loaders/VRMLLoader.js";
 export * from "./loaders/VTKLoader.js";
 export * from "./loaders/XYZLoader.js";
 
+export * from "./materials/LDrawConditionalLineMaterial.js";
 export * from "./materials/MeshGouraudMaterial.js";
+export * from "./materials/MeshPostProcessingMaterial.js";
 
 export * from "./math/Capsule.js";
 export * from "./math/ColorConverter.js";
@@ -274,8 +274,8 @@ export * as SceneUtils from "./utils/SceneUtils.js";
 export * from "./utils/ShadowMapViewer.js";
 export * as SkeletonUtils from "./utils/SkeletonUtils.js";
 export * as SortUtils from "./utils/SortUtils.js";
-export * from "./utils/TextureUtils.js";
 export * from "./utils/UVsDebug.js";
+export * from "./utils/WebGLTextureUtils.js";
 export * from "./utils/WorkerPool.js";
 
 export * from "./webxr/ARButton.js";

three/examples/jsm/animation/MMDAnimationHelper.d.ts

@@ -35,6 +35,10 @@ export interface MMDAnimationHelperMixer {
     duration?: number | undefined;
 }
 
+/**
+ * @deprecated The module has been deprecated and will be removed with r172. Please migrate to
+ * https://github.com/takahirox/three-mmd-loader instead.
+ */
 export class MMDAnimationHelper {
     constructor(params?: MMDAnimationHelperParameter);
     meshes: SkinnedMesh[];

three/examples/jsm/animation/MMDPhysics.d.ts

@@ -6,6 +6,10 @@ export interface MMDPhysicsParameter {
     gravity?: Vector3 | undefined;
 }
 
+/**
+ * @deprecated The module has been deprecated and will be removed with r172. Please migrate to
+ * https://github.com/takahirox/three-mmd-loader instead.
+ */
 export class MMDPhysics {
     constructor(
         mesh: SkinnedMesh,

three/examples/jsm/controls/ArcballControls.d.ts

@@ -44,7 +44,7 @@ declare class ArcballControls extends Controls<ArcballControlsEventMap> {
     focusAnimationTime: number;
 
     /**
-     * If true, camera's near and far values will be adjusted every time zoom is performed trying to mantain the same
+     * If true, camera's near and far values will be adjusted every time zoom is performed trying to maintain the same
      * visible portion given by initial near and far values ( {@link PerspectiveCamera} only ). Default is false.
      */
     adjustNearFar: boolean;
@@ -69,6 +69,11 @@ declare class ArcballControls extends Controls<ArcballControlsEventMap> {
      */
     enableAnimations: boolean;
 
+    /**
+     * Enable or disable camera focusing on double-tap (or click) operations. Default is true.
+     */
+    enableFocus: boolean;
+
     /**
      * When set to true, a grid will appear when panning operation is being performed (desktop interaction only). Default is false.
      */

three/examples/jsm/controls/TransformControls.d.ts

@@ -1,6 +1,6 @@
 import { Camera, Controls, Mesh, Object3D, Quaternion, Raycaster, Vector3 } from "three";
 
-type TransformControlsMode = "translate" | "rotate" | "scale";
+export type TransformControlsMode = "translate" | "rotate" | "scale";
 
 export interface TransformControlsEventMap {
     /**
@@ -38,6 +38,12 @@ export interface TransformControlsEventMap {
     "showX-changed": { value: unknown };
     "showY-changed": { value: unknown };
     "showZ-changed": { value: unknown };
+    "minX-changed": { value: unknown };
+    "maxX-changed": { value: unknown };
+    "minY-changed": { value: unknown };
+    "maxY-changed": { value: unknown };
+    "minZ-changed": { value: unknown };
+    "maxZ-changed": { value: unknown };
     "worldPosition-changed": { value: unknown };
     "worldPositionStart-changed": { value: unknown };
     "worldQuaternion-changed": { value: unknown };
@@ -85,6 +91,12 @@ declare class TransformControls extends Controls<TransformControlsEventMap> {
      */
     rotationSnap: number | null;
 
+    /**
+     * By default, 3D objects are continuously scaled. If you set this property to a numeric value, you can define in
+     * which steps the 3D object should be scaled. Default is `null`.
+     */
+    scaleSnap: number | null;
+
     /**
      * Defines in which coordinate space transformations should be performed. Possible values are "world" and "local".
      * Default is `world`.
@@ -116,6 +128,36 @@ declare class TransformControls extends Controls<TransformControlsEventMap> {
      */
     showZ: boolean;
 
+    /**
+     * The minimum allowed X position during translation. Default is `-Infinity`.
+     */
+    minx: number;
+
+    /**
+     * The maximum allowed X position during translation. Default is `Infinity`.
+     */
+    maxX: number;
+
+    /**
+     * The minimum allowed Y position during translation. Default is `-Infinity`.
+     */
+    minY: number;
+
+    /**
+     * The maximum allowed Y position during translation. Default is `Infinity`.
+     */
+    maxY: number;
+
+    /**
+     * The minimum allowed Z position during translation. Default is `-Infinity`.
+     */
+    minZ: number;
+
+    /**
+     * The maximum allowed Z position during translation. Default is `Infinity`.
+     */
+    maxZ: number;
+
     /**
      * Creates a new instance of TransformControls.
      * @param camera The camera of the rendered scene.
@@ -206,6 +248,8 @@ declare class TransformControlsRoot extends Object3D {
     controls: TransformControls;
 
     constructor(controls: TransformControls);
+
+    dispose(): void;
 }
 
 declare class TransformControlsGizmo extends Object3D {

three/examples/jsm/csm/CSMFrustum.d.ts

@@ -6,14 +6,20 @@ export interface CSMFrustumVerticies {
 }
 
 export interface CSMFrustumParameters {
+    webGL?: boolean;
     projectionMatrix?: Matrix4;
     maxFar?: number;
 }
 
-export class CSMFrustum {
-    constructor(data?: CSMFrustumParameters);
+declare class CSMFrustum {
+    zNear: number;
     vertices: CSMFrustumVerticies;
+
+    constructor(data?: CSMFrustumParameters);
+
     setFromProjectionMatrix(projectionMatrix: Matrix4, maxFar: number): CSMFrustumVerticies;
     split(breaks: number[], target: CSMFrustum[]): void;
     toSpace(cameraMatrix: Matrix4, target: CSMFrustum): void;
 }
+
+export { CSMFrustum };

three/examples/jsm/csm/CSMHelper.d.ts

@@ -10,8 +10,9 @@ import {
 } from "three";
 
 import { CSM } from "./CSM.js";
+import { CSMShadowNode } from "./CSMShadowNode.js";
 
-export class CSMHelper<TCSM extends CSM = CSM> extends Group {
+export class CSMHelper<TCSM extends CSM | CSMShadowNode = CSM | CSMShadowNode> extends Group {
     constructor(csm: TCSM);
     csm: TCSM;
     displayFrustum: boolean;

three/examples/jsm/csm/CSMShadowNode.d.ts

@@ -0,0 +1,45 @@
+import { Camera, DirectionalLightShadow, Light, Node, Object3D } from "three/webgpu";
+import { CSMFrustum } from "./CSMFrustum.js";
+
+export type CSMShadowNodeMode = "uniform" | "logarithmic" | "practical" | "custom";
+
+export interface CSMShadowNodeData {
+    cascades?: number | undefined;
+    maxFar?: number | undefined;
+    mode?: CSMShadowNodeMode | undefined;
+    lightMargin?: number | undefined;
+    customSplitsCallback?:
+        | ((cascades: number, cameraNear: number, cameraFar: number, breaks: number[]) => void)
+        | undefined;
+}
+
+declare class LwLight extends Object3D {
+    target: Object3D;
+    shadow?: DirectionalLightShadow;
+
+    constructor();
+}
+
+declare class CSMShadowNode extends Node {
+    light: Light;
+    camera: Camera | null;
+    cascades: number;
+    maxFar: number;
+    mode: CSMShadowNodeMode;
+    lightMargin: number;
+    customSplitsCallback: (cascades: number, cameraNear: number, cameraFar: number, breaks: number[]) => void;
+
+    fade: boolean;
+
+    breaks: number[];
+    mainFrustum: CSMFrustum | null;
+    frustums: CSMFrustum[];
+
+    lights: LwLight[];
+
+    constructor(light: Light, data?: CSMShadowNodeData);
+
+    updateFrustums(): void;
+}
+
+export { CSMShadowNode };

three/examples/jsm/curves/NURBSCurve.d.ts

@@ -1,4 +1,12 @@
-import { Curve, Vector2, Vector3, Vector4 } from "three";
+import { Curve, CurveJSON, Vector2, Vector3, Vector4 } from "three";
+
+export interface NURBSCurveJSON extends CurveJSON {
+    degree: number;
+    knots: number[];
+    controlPoints: number[][];
+    startKnot: number;
+    endKnot: number;
+}
 
 export class NURBSCurve extends Curve<Vector3> {
     degree: number;
@@ -14,4 +22,7 @@ export class NURBSCurve extends Curve<Vector3> {
         startKnot?: number,
         endKnot?: number,
     );
+
+    toJSON(): NURBSCurveJSON;
+    fromJSON(json: NURBSCurveJSON): this;
 }

three/examples/jsm/exporters/GLTFExporter.d.ts

@@ -47,12 +47,22 @@ export interface GLTFExporterOptions {
     includeCustomExtensions?: boolean;
 }
 
-export class GLTFExporter {
+type TextureUtils = {
+    decompress:
+        | ((texture: Texture, maxTextureSize?: number) => Promise<void>)
+        | ((texture: Texture, maxTextureSize?: number) => void);
+};
+
+declare class GLTFExporter {
+    textureUtils: TextureUtils | null;
+
     constructor();
 
     register(callback: (writer: GLTFWriter) => GLTFExporterPlugin): this;
     unregister(callback: (writer: GLTFWriter) => GLTFExporterPlugin): this;
 
+    setTextureUtils(utils: TextureUtils | null): this;
+
     /**
      * Generates a .gltf (JSON) or .glb (binary) output from the input (Scenes or Objects)
      *
@@ -77,7 +87,7 @@ export class GLTFExporter {
      */
     parse(
         input: Object3D | Object3D[],
-        onDone: (gltf: ArrayBuffer | { [key: string]: any }) => void,
+        onDone: (gltf: ArrayBuffer | { [key: string]: unknown }) => void,
         onError: (error: ErrorEvent) => void,
         options?: GLTFExporterOptions,
     ): void;
@@ -91,14 +101,34 @@ export class GLTFExporter {
     parseAsync(
         input: Object3D | Object3D[],
         options?: GLTFExporterOptions,
-    ): Promise<ArrayBuffer | { [key: string]: any }>;
+    ): Promise<ArrayBuffer | { [key: string]: unknown }>;
 }
 
-export class GLTFWriter {
+declare class GLTFWriter {
+    textureUtils: TextureUtils | null;
+
+    extensionsUsed: { [name: string]: boolean };
+    extensionsRequired: { [name: string]: boolean };
+
     constructor();
 
     setPlugins(plugins: GLTFExporterPlugin[]): void;
 
+    setTextureUtils(utils: TextureUtils | null): this;
+
+    /**
+     * Process texture
+     * @param map Map to process
+     * @return Index of the processed texture in the "textures" array
+     */
+    processTextureAsync(map: Texture): Promise<number>;
+
+    /**
+     * Applies a texture transform, if present, to the map definition. Requires
+     * the KHR_texture_transform extension.
+     */
+    applyTextureTransform(mapDef: { [key: string]: unknown }, texture: Texture): void;
+
     /**
      * Parse scenes and generate GLTF output
      *
@@ -106,18 +136,21 @@ export class GLTFWriter {
      * @param onDone Callback on completed
      * @param options options
      */
-    write(
+    writeAsync(
         input: Object3D | Object3D[],
-        onDone: (gltf: ArrayBuffer | { [key: string]: any }) => void,
+        onDone: (gltf: ArrayBuffer | { [key: string]: unknown }) => void,
         options?: GLTFExporterOptions,
     ): Promise<void>;
 }
 
 export interface GLTFExporterPlugin {
-    writeTexture?: (map: Texture, textureDef: { [key: string]: any }) => void;
-    writeMaterial?: (material: Material, materialDef: { [key: string]: any }) => void;
-    writeMesh?: (mesh: Mesh, meshDef: { [key: string]: any }) => void;
-    writeNode?: (object: Object3D, nodeDef: { [key: string]: any }) => void;
+    writeTexture?: (map: Texture, textureDef: { [key: string]: unknown }) => void;
+    writeMaterialAsync?: (material: Material, materialDef: { [key: string]: unknown }) => Promise<void>;
+    writeMesh?: (mesh: Mesh, meshDef: { [key: string]: unknown }) => void;
+    writeNode?: (object: Object3D, nodeDef: { [key: string]: unknown }) => void;
     beforeParse?: (input: Object3D | Object3D[]) => void;
     afterParse?: (input: Object3D | Object3D[]) => void;
 }
+
+export { GLTFExporter };
+export type { GLTFWriter };

three/examples/jsm/exporters/MMDExporter.d.ts

@@ -1,5 +1,9 @@
 import { Object3D } from "three";
 
+/**
+ * @deprecated The module has been deprecated and will be removed with r172. Please migrate to
+ * https://github.com/takahirox/three-mmd-loader instead.
+ */
 export class MMDExporter {
     constructor();
 

three/examples/jsm/exporters/USDZExporter.d.ts

@@ -1,4 +1,6 @@
 import { Object3D } from "three";
+import * as WebGLTextureUtils from "../utils/WebGLTextureUtils.js";
+import * as WebGPUTextureUtils from "../utils/WebGPUTextureUtils.js";
 
 export interface USDZExporterOptions {
     ar?: { anchoring: { type: "plane" }; planeAnchoring: { alignment: "horizontal" | "vertical" | "any" } } | undefined;
@@ -8,6 +10,8 @@ export interface USDZExporterOptions {
 }
 
 export class USDZExporter {
+    textureUtils: typeof WebGLTextureUtils | typeof WebGPUTextureUtils | null;
+
     constructor();
 
     parse(

three/examples/jsm/geometries/DecalGeometry.d.ts

@@ -1,10 +1,16 @@
 import { BufferGeometry, Euler, Mesh, Vector3 } from "three";
 
-export class DecalGeometry extends BufferGeometry {
-    constructor(mesh: Mesh, position: Vector3, orientation: Euler, size: Vector3);
+declare class DecalGeometry extends BufferGeometry {
+    constructor(mesh?: Mesh, position?: Vector3, orientation?: Euler, size?: Vector3);
 }
 
-export class DecalVertex {
-    constructor(position: Vector3, normal: Vector3);
+declare class DecalVertex {
+    position: Vector3;
+    normal: Vector3 | null;
+
+    constructor(position: Vector3, normal?: Vector3 | null);
+
     clone(): this;
 }
+
+export { DecalGeometry, DecalVertex };

three/examples/jsm/geometries/TeapotGeometry.d.ts

@@ -1,9 +1,9 @@
 import { BufferGeometry } from "three";
 
 /**
- * {@link TeapotGeometry} tesselates the famous Utah teapot database by Martin Newell.
+ * TeapotGeometry tessellates the famous Utah teapot database by Martin Newell.
  *
- * {@link TeapotGeometry} is an add-on, and must be imported explicitly. See
+ * TeapotGeometry is an add-on, and must be imported explicitly. See
  * [Installation / Addons]{@link https://threejs.org/docs/#manual/en/introduction/Installation}.
  *
  * @example

three/examples/jsm/helpers/TextureHelperGPU.d.ts

@@ -0,0 +1,10 @@
+import { Mesh, Texture } from "three";
+
+export class TextureHelper extends Mesh {
+    texture: Texture;
+    type: "TextureHelper";
+
+    constructor(texture: Texture, width?: number, height?: number, depth?: number);
+
+    dispose(): void;
+}

three/examples/jsm/lighting/TiledLighting.d.ts

@@ -0,0 +1,10 @@
+import { ShaderNodeObject } from "three/tsl";
+import { Lighting } from "three/webgpu";
+import { Light } from "../../../src/lights/Light.js";
+import TiledLightsNode from "../tsl/lighting/TiledLightsNode.js";
+
+export class TiledLighting extends Lighting {
+    constructor();
+
+    createNode(lights?: Light[]): ShaderNodeObject<TiledLightsNode>;
+}

three/examples/jsm/lines/Wireframe.d.ts

@@ -3,9 +3,12 @@ import { Mesh } from "three";
 import { LineMaterial } from "./LineMaterial.js";
 import { LineSegmentsGeometry } from "./LineSegmentsGeometry.js";
 
-export class Wireframe extends Mesh {
-    constructor(geometry?: LineSegmentsGeometry, material?: LineMaterial);
+declare class Wireframe extends Mesh {
     readonly isWireframe: true;
 
+    constructor(geometry?: LineSegmentsGeometry, material?: LineMaterial);
+
     computeLineDistances(): this;
 }
+
+export { Wireframe };

three/examples/jsm/lines/WireframeGeometry2.d.ts

@@ -4,5 +4,5 @@ import { LineSegmentsGeometry } from "./LineSegmentsGeometry.js";
 
 export class WireframeGeometry2 extends LineSegmentsGeometry {
     constructor(geometry: BufferGeometry);
-    readonly sWireframeGeometry2: boolean;
+    readonly isWireframeGeometry2: boolean;
 }

three/examples/jsm/lines/webgpu/Wireframe.d.ts

@@ -0,0 +1,13 @@
+import { Line2NodeMaterial, Mesh } from "three/webgpu";
+
+import { WireframeGeometry2 } from "../WireframeGeometry2.js";
+
+declare class Wireframe extends Mesh {
+    readonly isWireframe: true;
+
+    constructor(geometry?: WireframeGeometry2, material?: Line2NodeMaterial);
+
+    computeLineDistances(): this;
+}
+
+export { Wireframe };

three/examples/jsm/loaders/EXRLoader.d.ts

@@ -1,4 +1,4 @@
-import { ColorSpace, DataTextureLoader, LoadingManager, PixelFormat, TextureDataType } from "three";
+import { DataTextureLoader, LoadingManager, PixelFormat, TextureDataType } from "three";
 
 export interface EXR {
     header: object;
@@ -6,7 +6,7 @@ export interface EXR {
     height: number;
     data: Float32Array | Uint16Array;
     format: PixelFormat;
-    colorSpace: ColorSpace;
+    colorSpace: string;
     type: TextureDataType;
 }
 

three/examples/jsm/loaders/GLTFLoader.d.ts

@@ -3,7 +3,6 @@ import {
     BufferAttribute,
     BufferGeometry,
     Camera,
-    ColorSpace,
     FileLoader,
     Group,
     ImageBitmapLoader,
@@ -113,7 +112,7 @@ export class GLTFParser {
             texCoord?: number | undefined;
             extensions?: any;
         },
-        colorSpace?: ColorSpace | undefined,
+        colorSpace?: string | undefined,
     ) => Promise<Texture | null>;
     assignFinalMaterial: (object: Mesh) => void;
     getMaterialType: () => typeof MeshStandardMaterial;

three/examples/jsm/loaders/KTX2Loader.d.ts

@@ -4,6 +4,7 @@ import { WorkerPool } from "../utils/WorkerPool.js";
 
 export interface KTX2LoaderWorkerConfig {
     astcSupported: boolean;
+    astcHDRSupported: boolean;
     etc1Supported: boolean;
     etc2Supported: boolean;
     dxtSupported: boolean;

three/examples/jsm/loaders/LDrawLoader.d.ts

@@ -1,13 +1,23 @@
 import { Group, Loader, LoadingManager, Material } from "three";
+import { LDrawConditionalLineMaterial } from "../materials/LDrawConditionalLineMaterial.js";
+import { LDrawConditionalLineMaterial as LDrawConditionalLineNodeMaterial } from "../materials/LDrawConditionalLineNodeMaterial.js";
 
 export class LDrawLoader extends Loader<Group> {
     materials: Material[];
     materialsLibrary: Record<string, Material>;
+
     fileMap: Record<string, string>;
+
     smoothNormals: boolean;
 
+    ConditionalLineMaterial: typeof LDrawConditionalLineMaterial | typeof LDrawConditionalLineNodeMaterial | null;
+
     constructor(manager?: LoadingManager);
 
+    setConditionalLineMaterial(
+        type: typeof LDrawConditionalLineMaterial | typeof LDrawConditionalLineNodeMaterial,
+    ): this;
+
     preloadMaterials(url: string): Promise<void>;
     setFileMap(fileMap: Record<string, string>): void;
     setMaterials(materials: Material[]): void;

three/examples/jsm/loaders/MMDLoader.d.ts

@@ -5,6 +5,10 @@ export interface MMDLoaderAnimationObject {
     mesh: SkinnedMesh;
 }
 
+/**
+ * @deprecated The module has been deprecated and will be removed with r172. Please migrate to
+ * https://github.com/takahirox/three-mmd-loader instead.
+ */
 export class MMDLoader extends Loader<SkinnedMesh> {
     constructor(manager?: LoadingManager);
     animationBuilder: object;

three/examples/jsm/materials/LDrawConditionalLineMaterial.d.ts

@@ -0,0 +1,9 @@
+import { ShaderMaterial, ShaderMaterialParameters } from "three";
+
+declare class LDrawConditionalLineMaterial extends ShaderMaterial {
+    readonly isLDrawConditionalLineMaterial: true;
+
+    constructor(parameters?: ShaderMaterialParameters);
+}
+
+export { LDrawConditionalLineMaterial };

three/examples/jsm/materials/LDrawConditionalLineNodeMaterial.d.ts

@@ -0,0 +1,9 @@
+import { NodeMaterial, NodeMaterialParameters } from "three/webgpu";
+
+declare class LDrawConditionalLineMaterial extends NodeMaterial {
+    readonly isLDrawConditionalLineMaterial: true;
+
+    constructor(parameters?: NodeMaterialParameters);
+}
+
+export { LDrawConditionalLineMaterial };

three/examples/jsm/materials/MeshGouraudMaterial.d.ts

@@ -8,7 +8,6 @@ import { ShaderMaterial, ShaderMaterialParameters } from "three";
 
 export class MeshGouraudMaterial extends ShaderMaterial {
     isMeshGouraudMaterial: true;
-    type: "MeshGouraudMaterial";
 
     constructor(parameters?: ShaderMaterialParameters);
 

three/examples/jsm/math/ColorSpaces.d.ts

@@ -0,0 +1,11 @@
+import { ColorSpaceDefinition } from "three";
+
+export const DisplayP3ColorSpace: "display-p3";
+export const LinearDisplayP3ColorSpace: "display-p3-linear";
+
+export const DisplayP3ColorSpaceImpl: ColorSpaceDefinition;
+export const LinearDisplayP3ColorSpaceImpl: ColorSpaceDefinition;
+
+export const LinearRec2020ColorSpace: "rec2020-linear";
+
+export const LinearRec2020ColorSpaceImpl: ColorSpaceDefinition;