@types/three 0.155.1 → 0.157.0

three/README.md

@@ -8,8 +8,8 @@ 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: Tue, 22 Aug 2023 18:04:44 GMT
- * Dependencies: [@types/fflate](https://npmjs.com/package/@types/fflate), [@types/lil-gui](https://npmjs.com/package/@types/lil-gui), [@types/meshoptimizer](https://npmjs.com/package/@types/meshoptimizer), [@types/stats.js](https://npmjs.com/package/@types/stats.js), [@types/tweenjs__tween.js](https://npmjs.com/package/@types/tweenjs__tween.js), [@types/webxr](https://npmjs.com/package/@types/webxr)
+ * Last updated: Tue, 10 Oct 2023 07:05:53 GMT
+ * Dependencies: [@types/fflate](https://npmjs.com/package/@types/fflate), [@types/meshoptimizer](https://npmjs.com/package/@types/meshoptimizer), [@types/stats.js](https://npmjs.com/package/@types/stats.js), [@types/webxr](https://npmjs.com/package/@types/webxr)
  * Global values: `THREE`
 
 # Credits

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

@@ -3,16 +3,16 @@ import { Object3D, SkinnedMesh, Vector3 } from '../../../src/Three.js';
 // tslint:disable-next-line:interface-name
 export interface IKS {
     effector: number;
-    iteration: number;
+    iteration?: number | undefined;
     links: Array<{
-        enabled: boolean;
+        enabled?: boolean | undefined;
         index: number;
-        limitation?: Vector3;
-        rotationMin?: Vector3;
-        rotationMax?: Vector3;
+        limitation?: Vector3 | undefined;
+        rotationMin?: Vector3 | undefined;
+        rotationMax?: Vector3 | undefined;
     }>;
-    minAngle: number;
-    maxAngle: number;
+    minAngle?: number | undefined;
+    maxAngle?: number | undefined;
     target: number;
 }
 

three/examples/jsm/capabilities/WebGL.d.ts

@@ -2,6 +2,7 @@
 export default class WebGL {
     static isWebGLAvailable(): boolean;
     static isWebGL2Available(): boolean;
+    static isColorSpaceAvailable(colorSpace: PredefinedColorSpace): boolean;
     static getWebGLErrorMessage(): HTMLElement;
     static getWebGL2ErrorMessage(): HTMLElement;
     static getErrorMessage(version: number): HTMLElement;

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

@@ -14,7 +14,13 @@ export enum ArcballControlsMouseActionKeys {
     CTRL = 'CTRL',
 }
 
-export class ArcballControls extends EventDispatcher {
+export interface ArcballControlsEventMap {
+    change: {};
+    start: {};
+    end: {};
+}
+
+export class ArcballControls extends EventDispatcher<ArcballControlsEventMap> {
     camera: Camera | null;
     domElement: HTMLElement;
     scene?: Scene | null | undefined;

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

@@ -1,6 +1,14 @@
 import { Camera, EventDispatcher, Object3D, Raycaster } from '../../../src/Three.js';
 
-export class DragControls extends EventDispatcher {
+export interface DragControlsEventMap {
+    hoveron: { object: Object3D };
+    hoveroff: { object: Object3D };
+    dragstart: { object: Object3D };
+    drag: { object: Object3D };
+    dragend: { object: Object3D };
+}
+
+export class DragControls extends EventDispatcher<DragControlsEventMap> {
     constructor(objects: Object3D[], camera: Camera, domElement?: HTMLElement);
 
     object: Camera;
@@ -8,6 +16,7 @@ export class DragControls extends EventDispatcher {
     // API
 
     enabled: boolean;
+    recursive: boolean;
     transformGroup: boolean;
 
     activate(): void;

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

@@ -1,6 +1,10 @@
 import { Camera, EventDispatcher } from '../../../src/Three.js';
 
-export class FlyControls extends EventDispatcher {
+export interface FlyControlsEventMap {
+    change: {};
+}
+
+export class FlyControls extends EventDispatcher<FlyControlsEventMap> {
     constructor(object: Camera, domElement?: HTMLElement);
 
     autoForward: boolean;

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

@@ -1,4 +1,10 @@
-import { Camera, MOUSE, TOUCH, Vector3 } from '../../../src/Three.js';
+import { Camera, EventDispatcher, MOUSE, TOUCH, Vector3 } from '../../../src/Three.js';
+
+export interface OrbitControlsEventMap {
+    change: {};
+    start: {};
+    end: {};
+}
 
 /**
  * Orbit controls allow the camera to orbit around a target.
@@ -7,7 +13,7 @@ import { Camera, MOUSE, TOUCH, Vector3 } from '../../../src/Three.js';
  * @param domElement - The HTML element used for
  * event listeners.
  */
-export class OrbitControls {
+export class OrbitControls extends EventDispatcher<OrbitControlsEventMap> {
     constructor(object: Camera, domElement?: HTMLElement);
 
     /**
@@ -175,8 +181,9 @@ export class OrbitControls {
 
     /**
      * Set to true to automatically rotate around the target.
-     * Note that if this is enabled, you must call
-     * .update () in your animation loop.
+     * Note that if this is enabled, you must call .update() in your animation loop. If you want the auto-rotate speed
+     * to be independent of the frame rate (the refresh rate of the display), you must pass the time `deltaTime`, in
+     * seconds, to .update().
      */
     autoRotate: boolean;
 
@@ -199,13 +206,17 @@ export class OrbitControls {
      * This object contains references to the mouse actions used
      * by the controls.
      */
-    mouseButtons: Partial<{ LEFT: MOUSE; MIDDLE: MOUSE; RIGHT: MOUSE }>;
+    mouseButtons: {
+        LEFT?: MOUSE | null | undefined;
+        MIDDLE?: MOUSE | null | undefined;
+        RIGHT?: MOUSE | null | undefined;
+    };
 
     /**
      * This object contains references to the touch actions used by
      * the controls.
      */
-    touches: Partial<{ ONE: TOUCH; TWO: TOUCH }>;
+    touches: { ONE?: TOUCH | null | undefined; TWO?: TOUCH | null | undefined };
 
     /**
      * Used internally by the .saveState and .reset methods.
@@ -223,11 +234,11 @@ export class OrbitControls {
     zoom0: number;
 
     /**
-     * Update the controls. Must be called after any manual changes
-     * to the camera's transform, or in the update loop if .autoRotate
-     * or .enableDamping are set.
+     * Update the controls. Must be called after any manual changes to the camera's transform, or in the update loop if
+     * .autoRotate or .enableDamping are set. `deltaTime`, in seconds, is optional, and is only required if you want the
+     * auto-rotate speed to be independent of the frame rate (the refresh rate of the display).
      */
-    update(): boolean;
+    update(deltaTime?: number): boolean;
 
     /**
      * Adds key event listeners to the given DOM element. `window`
@@ -272,13 +283,4 @@ export class OrbitControls {
      * Returns the distance from the camera to the target.
      */
     getDistance(): number;
-
-    // EventDispatcher mixins
-    addEventListener(type: string, listener: (event: any) => void): void;
-
-    hasEventListener(type: string, listener: (event: any) => void): boolean;
-
-    removeEventListener(type: string, listener: (event: any) => void): void;
-
-    dispatchEvent(event: { type: string; target: any }): void;
 }

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

@@ -1,6 +1,12 @@
 import { Camera, EventDispatcher, MOUSE, Vector3 } from '../../../src/Three.js';
 
-export class TrackballControls extends EventDispatcher {
+export interface TrackballControlsEventMap {
+    change: {};
+    start: {};
+    end: {};
+}
+
+export class TrackballControls extends EventDispatcher<TrackballControlsEventMap> {
     constructor(object: Camera, domElement?: HTMLElement);
 
     object: Camera;
@@ -23,7 +29,11 @@ export class TrackballControls extends EventDispatcher {
     minZoom: number;
     maxZoom: number;
     keys: string[];
-    mouseButtons: { LEFT: MOUSE; MIDDLE: MOUSE; RIGHT: MOUSE };
+    mouseButtons: {
+        LEFT?: MOUSE | null | undefined;
+        MIDDLE?: MOUSE | null | undefined;
+        RIGHT?: MOUSE | null | undefined;
+    };
 
     target: Vector3;
     position0: Vector3;

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

@@ -1,6 +1,38 @@
-import { Object3D, Camera, MOUSE, Raycaster, Mesh, Vector3, Quaternion } from '../../../src/Three.js';
+import { Object3D, Camera, MOUSE, Raycaster, Mesh, Vector3, Quaternion, Object3DEventMap } from '../../../src/Three.js';
 
-export class TransformControls extends Object3D {
+export interface TransformControlsEventMap extends Object3DEventMap {
+    change: {};
+    mouseDown: {};
+    mouseUp: {};
+    objectChange: {};
+    'camera-changed': { value: unknown };
+    'object-changed': { value: unknown };
+    'enabled-changed': { value: unknown };
+    'axis-changed': { value: unknown };
+    'mode-changed': { value: unknown };
+    'translationSnap-changed': { value: unknown };
+    'rotationSnap-changed': { value: unknown };
+    'scaleSnap-changed': { value: unknown };
+    'space-changed': { value: unknown };
+    'size-changed': { value: unknown };
+    'dragging-changed': { value: unknown };
+    'showX-changed': { value: unknown };
+    'showY-changed': { value: unknown };
+    'showZ-changed': { value: unknown };
+    'worldPosition-changed': { value: unknown };
+    'worldPositionStart-changed': { value: unknown };
+    'worldQuaternion-changed': { value: unknown };
+    'worldQuaternionStart-changed': { value: unknown };
+    'cameraPosition-changed': { value: unknown };
+    'cameraQuaternion-changed': { value: unknown };
+    'pointStart-changed': { value: unknown };
+    'pointEnd-changed': { value: unknown };
+    'rotationAxis-changed': { value: unknown };
+    'rotationAngle-changed': { value: unknown };
+    'eye-changed': { value: unknown };
+}
+
+export class TransformControls extends Object3D<TransformControlsEventMap> {
     constructor(object: Camera, domElement?: HTMLElement);
 
     domElement: HTMLElement;
@@ -20,8 +52,13 @@ export class TransformControls extends Object3D {
     showX: boolean;
     showY: boolean;
     showZ: boolean;
+
     readonly isTransformControls: true;
-    mouseButtons: { LEFT: MOUSE; MIDDLE: MOUSE; RIGHT: MOUSE };
+    mouseButtons: {
+        LEFT?: MOUSE | null | undefined;
+        MIDDLE?: MOUSE | null | undefined;
+        RIGHT?: MOUSE | null | undefined;
+    };
 
     attach(object: Object3D): this;
     detach(): this;

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

@@ -1,11 +1,17 @@
 import { Curve, Vector2, Vector3, Vector4 } from '../../../src/Three.js';
 
 export class NURBSCurve extends Curve<Vector3> {
+    degree: number;
+    knots: number[];
+    controlPoints: Vector2[] | Vector3[] | Vector4[];
+    startKnot: number;
+    endKnot: number;
+
     constructor(
         degree: number,
         knots: number[],
         controlPoints: Vector2[] | Vector3[] | Vector4[],
-        startKnot: number,
-        endKnot: number,
+        startKnot?: number,
+        endKnot?: number,
     );
 }

three/examples/jsm/environments/DebugEnvironment.d.ts

@@ -0,0 +1,5 @@
+import { Scene } from '../../../src/Three.js';
+
+export class DebugEnvironment extends Scene {
+    constructor();
+}

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

@@ -5,7 +5,7 @@
  * https://www.openexr.com/documentation/openexrfilelayout.pdf
  */
 
-import { WebGLRenderer, WebGLRenderTarget, TextureDataType } from '../../../src/Three.js';
+import { DataTexture, TextureDataType, WebGLRenderer, WebGLRenderTarget } from '../../../src/Three.js';
 
 export const NO_COMPRESSION: 0;
 export const ZIPS_COMPRESSION: 2;
@@ -18,4 +18,5 @@ export interface EXRExporterParseOptions {
 
 export class EXRExporter {
     parse(renderer: WebGLRenderer, renderTarget: WebGLRenderTarget, options?: EXRExporterParseOptions): Uint8Array;
+    parse(dataTexture: DataTexture, options?: EXRExporterParseOptions): Uint8Array;
 }

three/examples/jsm/interactive/InteractiveGroup.d.ts

@@ -1,4 +1,17 @@
-import { WebGLRenderer, Camera, Group } from 'three';
+import { Camera, Group, Object3D, Object3DEventMap, Vector2, WebGLRenderer } from '../../../src/Three.js';
+
+export interface InteractiveObject3DEventMap extends Object3DEventMap {
+    hoveron: { data: Vector2 };
+    pointerdown: { data: Vector2 };
+    pointerup: { data: Vector2 };
+    pointermove: { data: Vector2 };
+    mousedown: { data: Vector2 };
+    mouseup: { data: Vector2 };
+    mousemove: { data: Vector2 };
+    click: { data: Vector2 };
+}
+
+export class InteractiveObject3D extends Object3D<InteractiveObject3DEventMap> {}
 
 export class InteractiveGroup extends Group {
     constructor(renderer: WebGLRenderer, camera: Camera);

three/examples/jsm/interactive/SelectionHelper.d.ts

@@ -4,6 +4,7 @@ export class SelectionHelper {
     constructor(renderer: WebGLRenderer, cssClassName: string);
     element: HTMLElement;
     isDown: boolean;
+    enabled: boolean;
     pointBottomRight: Vector2;
     pointTopLeft: Vector2;
     renderer: WebGLRenderer;