@types/three 0.148.1 → 0.149.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: Mon, 23 Jan 2023 18:32:36 GMT
+ * Last updated: Mon, 30 Jan 2023 20:02:38 GMT
  * Dependencies: [@types/webxr](https://npmjs.com/package/@types/webxr)
  * Global values: `THREE`
 

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

@@ -0,0 +1,16 @@
+import { Object3D, Vector3, WebGLRenderer } from '../../../src/Three';
+import { Octree } from '../math/Octree';
+
+export class ViewHelper extends Object3D {
+    animating: boolean;
+    center: Vector3;
+
+    readonly isViewHelper: true;
+
+    constructor(camera: Octree, domElement: HTMLElement);
+
+    render(renderer: WebGLRenderer): void;
+    handleClick(event: PointerEvent): boolean;
+    update(delta: number): void;
+    dispose(): void;
+}

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

@@ -13,6 +13,6 @@ export class HDRCubeTextureLoader extends Loader {
         onProgress?: (event: ProgressEvent) => void,
         onError?: (event: ErrorEvent) => void,
     ): CubeTexture;
-    loadAsync(url: string, onProgress?: (event: ProgressEvent) => void): Promise<CubeTexture>;
+    loadAsync(urls: string[], onProgress?: (event: ProgressEvent) => void): Promise<CubeTexture>;
     setDataType(type: TextureDataType): this;
 }

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

@@ -20,6 +20,7 @@ declare class IFCLoader extends Loader {
         onProgress?: (event: ProgressEvent) => void,
         onError?: (event: ErrorEvent) => void,
     ): void;
+    loadAsync(url: string, onProgress?: (event: ProgressEvent) => void): Promise<IFCModel>;
 
     parse(buffer: ArrayBuffer): Promise<IFCModel>;
 }

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

@@ -13,6 +13,7 @@ export class USDZLoader extends Loader {
         onProgress?: (event: ProgressEvent) => void,
         onError?: (event: ErrorEvent) => void,
     ): void;
+    loadAsync(url: string, onProgress?: (event: ProgressEvent) => void): Promise<Mesh>;
 
     parse(buffer: ArrayBuffer | string): THREE.Group;
 }

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

@@ -15,7 +15,7 @@ export class VOXLoader extends Loader {
         onProgress?: (event: ProgressEvent) => void,
         onError?: (event: ErrorEvent) => void,
     ): void;
-    loadAsync(url: string, onProgress?: (event: ProgressEvent) => void): Promise<object[]>;
+    loadAsync(url: string, onProgress?: (event: ProgressEvent) => void): Promise<Chunk[]>;
     parse(data: ArrayBuffer): object[];
 }
 

three/examples/jsm/nodes/loaders/NodeLoader.d.ts

@@ -14,6 +14,7 @@ export default class NodeLoader extends Loader {
         onProgress?: (event: ProgressEvent) => void,
         onError?: (event: ErrorEvent) => void,
     ): void;
+    loadAsync(url: string, onProgress?: (event: ProgressEvent) => void): Promise<NodeLoaderResult>;
 
     parseNodes(json: AnyJson): NodeLoaderResult;
     parse(json: AnyJson): Node;

three/index.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for three 0.148
+// Type definitions for three 0.149
 // Project: https://threejs.org/
 // Definitions by: Josh Ellis <https://github.com/joshuaellis>
 //                 Nathan Bierema <https://github.com/Methuselah96>

three/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/three",
-    "version": "0.148.1",
+    "version": "0.149.0",
     "description": "TypeScript definitions for three",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/three",
     "license": "MIT",
@@ -27,6 +27,6 @@
     "dependencies": {
         "@types/webxr": "*"
     },
-    "typesPublisherContentHash": "ee8fd128bc5ae440fcab56b69067c71262d47937aa1ab8a080442efe025e59e5",
+    "typesPublisherContentHash": "26b43856591e0e71a44773611c3705a12a8926b63542851ba0c85e160758d30b",
     "typeScriptVersion": "4.4"
 }

three/src/Three.d.ts

@@ -66,7 +66,7 @@ export * from './extras/core/Path';
 export * from './extras/core/ShapePath';
 export * from './extras/core/CurvePath';
 export * from './extras/core/Curve';
-export * from './extras/DataUtils';
+export * as DataUtils from './extras/DataUtils';
 export * from './extras/Earcut';
 export * from './extras/ImageUtils';
 export * from './extras/ShapeUtils';
@@ -179,7 +179,6 @@ export * from './objects/Group';
 /**
  * Renderers
  */
-export * from './renderers/WebGLMultisampleRenderTarget';
 export * from './renderers/WebGLCubeRenderTarget';
 export * from './renderers/WebGLMultipleRenderTargets';
 export * from './renderers/WebGLRenderTarget';
@@ -226,8 +225,6 @@ export * from './scenes/Scene';
 export * from './textures/VideoTexture';
 export * from './textures/CompressedArrayTexture';
 export * from './textures/DataTexture';
-export * from './textures/DataTexture2DArray';
-export * from './textures/DataTexture3D';
 export * from './textures/CompressedTexture';
 export * from './textures/CubeTexture';
 export * from './textures/Data3DTexture';

three/src/constants.d.ts

@@ -36,15 +36,12 @@ export const VSMShadowMap: ShadowMapType;
 // side
 /**
  * Defines which side of faces will be rendered - front, back or both.
- * Default is FrontSide.
- *
- * TwoPassDoubleSide will renderer double-sided transparent materials in two passes in back-front order to mitigate transparency artifacts.
+ * Default is {@link FrontSide}.
  */
 export enum Side {}
 export const FrontSide: Side;
 export const BackSide: Side;
 export const DoubleSide: Side;
-export const TwoPassDoubleSide: Side;
 
 // blending modes
 export enum Blending {}
@@ -154,7 +151,6 @@ export const UnsignedInt248Type: TextureDataType;
 // Pixel formats
 export enum PixelFormat {}
 export const AlphaFormat: PixelFormat;
-export const RGBFormat: PixelFormat;
 export const RGBAFormat: PixelFormat;
 export const LuminanceFormat: PixelFormat;
 export const LuminanceAlphaFormat: PixelFormat;
@@ -270,6 +266,12 @@ export const RGBA_ASTC_12x12_Format: CompressedPixelFormat;
 // BPTC compressed texture formats
 export const RGBA_BPTC_Format: CompressedPixelFormat;
 
+// RGTC compressed texture formats
+export const RED_RGTC1_Format: CompressedPixelFormat;
+export const SIGNED_RED_RGTC1_Format: CompressedPixelFormat;
+export const RED_GREEN_RGTC2_Format: CompressedPixelFormat;
+export const SIGNED_RED_GREEN_RGTC2_Format: CompressedPixelFormat;
+
 // Loop styles for AnimationAction
 export enum AnimationActionLoopStyles {}
 export const LoopOnce: AnimationActionLoopStyles;

three/src/core/BufferGeometry.d.ts

@@ -1,4 +1,6 @@
 import { BufferAttribute } from './BufferAttribute';
+import { InterleavedBufferAttribute } from './InterleavedBufferAttribute';
+import { GLBufferAttribute } from './GLBufferAttribute';
 import { Box3 } from './../math/Box3';
 import { Sphere } from './../math/Sphere';
 import { Matrix4 } from './../math/Matrix4';
@@ -6,7 +8,6 @@ import { Quaternion } from './../math/Quaternion';
 import { Vector2 } from './../math/Vector2';
 import { Vector3 } from './../math/Vector3';
 import { EventDispatcher } from './EventDispatcher';
-import { InterleavedBufferAttribute } from './InterleavedBufferAttribute';
 import { BuiltinShaderAttributeName } from '../constants';
 
 /**
@@ -47,7 +48,7 @@ export class BufferGeometry extends EventDispatcher {
      * @default {}
      */
     attributes: {
-        [name: string]: BufferAttribute | InterleavedBufferAttribute;
+        [name: string]: BufferAttribute | InterleavedBufferAttribute | GLBufferAttribute;
     };
 
     /**
@@ -93,9 +94,11 @@ export class BufferGeometry extends EventDispatcher {
 
     setAttribute(
         name: BuiltinShaderAttributeName | (string & {}),
-        attribute: BufferAttribute | InterleavedBufferAttribute,
+        attribute: BufferAttribute | InterleavedBufferAttribute | GLBufferAttribute,
     ): BufferGeometry;
-    getAttribute(name: BuiltinShaderAttributeName | (string & {})): BufferAttribute | InterleavedBufferAttribute;
+    getAttribute(
+        name: BuiltinShaderAttributeName | (string & {}),
+    ): BufferAttribute | InterleavedBufferAttribute | GLBufferAttribute;
     deleteAttribute(name: BuiltinShaderAttributeName | (string & {})): BufferGeometry;
     hasAttribute(name: BuiltinShaderAttributeName | (string & {})): boolean;
 

three/src/core/GLBufferAttribute.d.ts

@@ -5,6 +5,10 @@
 export class GLBufferAttribute {
     constructor(buffer: WebGLBuffer, type: number, itemSize: number, elementSize: 1 | 2 | 4, count: number);
 
+    /**
+     * @default ''
+     */
+    name: string;
     buffer: WebGLBuffer;
     type: number;
     itemSize: number;

three/src/core/Object3D.d.ts

@@ -51,8 +51,11 @@ export class Object3D<E extends BaseEvent = Event> extends EventDispatcher<E> {
     children: Object3D[];
 
     /**
-     * Up direction.
-     * @default THREE.Object3D.DefaultUp.clone()
+     * This is used by the {@link lookAt} method, for example, to determine the orientation of the result.
+     *
+     * Default is {@link Object3D.DEFAULT_UP} - that is, `( 0, 1, 0 )`.
+     *
+     * @default {@link Object3D.DEFAULT_UP}
      */
     up: Vector3;
 
@@ -103,16 +106,15 @@ export class Object3D<E extends BaseEvent = Event> extends EventDispatcher<E> {
     matrixWorld: Matrix4;
 
     /**
-     * When this is set, it calculates the matrix of position, (rotation or quaternion) and scale every frame and also
-     * recalculates the matrixWorld property.
-     * @default THREE.Object3D.DefaultMatrixAutoUpdate
+     * When this is set, it calculates the matrix of position, (rotation or quaternion) and
+     * scale every frame and also recalculates the matrixWorld property. Default is {@link Object3D.DEFAULT_MATRIX_AUTO_UPDATE} (true).
      */
     matrixAutoUpdate: boolean;
 
     /**
-     * When this is set, the renderer checks every frame if the object and its children need matrix updates.
-     * Otherwise, you have to maintain all matrices in the object and its children yourself.
-     * @default THREE.Object3D.DefaultMatrixWorldAutoUpdate
+     * If set, then the renderer checks every frame if the object and its children need matrix updates.
+     * When it isn't, then you have to maintain all matrices in the object and its children yourself.
+     * Default is {@link Object3D.DEFAULT_MATRIX_WORLD_AUTO_UPDATE} (true).
      */
     matrixWorldAutoUpdate: boolean;
 
@@ -215,9 +217,23 @@ export class Object3D<E extends BaseEvent = Event> extends EventDispatcher<E> {
         group: Group,
     ) => void;
 
-    static DefaultUp: Vector3;
-    static DefaultMatrixAutoUpdate: boolean;
-    static DefaultMatrixWorldAutoUpdate: boolean;
+    /**
+     * The default {@link up} direction for objects, also used as the default position for {@link DirectionalLight},
+     * {@link HemisphereLight} and {@link Spotlight} (which creates lights shining from the top down).
+     *
+     * Set to ( 0, 1, 0 ) by default.
+     */
+    static DEFAULT_UP: Vector3;
+
+    /**
+     * The default setting for {@link matrixAutoUpdate} for newly created Object3Ds.
+     */
+    static DEFAULT_MATRIX_AUTO_UPDATE: boolean;
+
+    /**
+     * The default setting for {@link matrixWorldAutoUpdate} for newly created Object3Ds.
+     */
+    static DEFAULT_MATRIX_WORLD_AUTO_UPDATE: boolean;
 
     /**
      * Applies the matrix transform to the object and updates the object's position, rotation and scale.

three/src/core/Uniform.d.ts

@@ -1,14 +1,14 @@
-export class Uniform {
-    constructor(value: any);
+export class Uniform<T = any> {
+    constructor(value: T);
     /**
      * @deprecated
      */
-    constructor(type: string, value: any);
+    constructor(type: string, value: T);
     /**
      * @deprecated
      */
     type: string;
-    value: any;
+    value: T;
     /**
      * @deprecated Use {@link Object3D#onBeforeRender object.onBeforeRender()} instead.
      */
@@ -17,5 +17,5 @@ export class Uniform {
     /**
      * @deprecated Use {@link Object3D#onBeforeRender object.onBeforeRender()} instead.
      */
-    onUpdate(callback: () => void): Uniform;
+    onUpdate(callback: () => void): Uniform<T>;
 }

three/src/helpers/CameraHelper.d.ts

@@ -1,18 +1,61 @@
+import { Color } from '../math/Color';
+import { Matrix4 } from '../math/Matrix4';
 import { Camera } from './../cameras/Camera';
 import { LineSegments } from './../objects/LineSegments';
 
+/**
+ * This helps with visualizing what a camera contains in its frustum.
+ * It visualizes the frustum of a camera using a {@link LineSegments}.
+ *
+ * CameraHelper must be a child of the scene.
+ */
 export class CameraHelper extends LineSegments {
+    /**
+     * This create a new CameraHelper for the specified camera.
+     *
+     * @param camera - The camera to visualize.
+     */
     constructor(camera: Camera);
 
+    /**
+     * The camera being visualized.
+     */
     camera: Camera;
+
+    /**
+     * This contains the points used to visualize the camera.
+     */
     pointMap: { [id: string]: number[] };
 
+    /**
+     * Reference to the {@link Camera.matrixWorld}.
+     */
+    matrix: Matrix4;
+
+    /**
+     * See {@link Object3D.matrixAutoUpdate}.
+     * Set to `false` here as the helper is using the camera's {@link Camera.matrixWorld}.
+     */
+    matrixAutoUpdate: boolean;
+
     /**
      * @default 'CameraHelper'
      */
     type: string;
 
+    /**
+     * Updates the helper based on the projectionMatrix of the camera.
+     */
     update(): void;
 
+    /**
+     * Frees the GPU-related resources allocated by this instance.
+     * Call this method whenever this instance is no longer used in your app.
+     */
     dispose(): void;
+
+    /**
+     * Defines the colors of the helper.
+     */
+    setColors(frustum: Color, cone: Color, up: Color, target: Color, cross: Color): this;
 }

three/src/lights/DirectionalLight.d.ts

@@ -22,7 +22,9 @@ export class DirectionalLight extends Light {
     type: string;
 
     /**
-     * @default THREE.Object3D.DefaultUp
+     * This is set equal to {@link Object3D.DEFAULT_UP} (0, 1, 0), so that the light shines from the top down.
+     *
+     * @default {@link Object3D.DEFAULT_UP}
      */
     readonly position: Vector3;
 

three/src/lights/HemisphereLight.d.ts

@@ -17,7 +17,9 @@ export class HemisphereLight extends Light {
     type: string;
 
     /**
-     * @default THREE.Object3D.DefaultUp
+     * This is set equal to {@link Object3D.DEFAULT_UP} (0, 1, 0), so that the light shines from the top down.
+     *
+     * @default {@link Object3D.DEFAULT_UP}
      */
     position: Vector3;
 

three/src/lights/SpotLight.d.ts

@@ -25,7 +25,9 @@ export class SpotLight extends Light {
     type: string;
 
     /**
-     * @default THREE.Object3D.DefaultUp
+     * This is set equal to {@link Object3D.DEFAULT_UP} (0, 1, 0), so that the light shines from the top down.
+     *
+     * @default {@link Object3D.DEFAULT_UP}
      */
     position: Vector3;
 

three/src/loaders/CubeTextureLoader.d.ts

@@ -12,5 +12,5 @@ export class CubeTextureLoader extends Loader {
         onError?: (event: ErrorEvent) => void,
     ): CubeTexture;
 
-    loadAsync(url: string, onProgress?: (event: ProgressEvent) => void): Promise<CubeTexture>;
+    loadAsync(urls: string[], onProgress?: (event: ProgressEvent) => void): Promise<CubeTexture>;
 }

three/src/loaders/Loader.d.ts

@@ -34,11 +34,10 @@ export class Loader {
 
     /*
 	load(): void;
+    loadAsync(): Promise<unknown>;
 	parse(): void;
 	*/
 
-    loadAsync(url: string, onProgress?: (event: ProgressEvent) => void): Promise<any>;
-
     setCrossOrigin(crossOrigin: string): this;
     setWithCredentials(value: boolean): this;
     setPath(path: string): this;

three/src/materials/Material.d.ts

@@ -39,6 +39,7 @@ export interface MaterialParameters {
     polygonOffsetUnits?: number | undefined;
     precision?: 'highp' | 'mediump' | 'lowp' | null | undefined;
     premultipliedAlpha?: boolean | undefined;
+    forceSinglePass?: boolean | undefined;
     dithering?: boolean | undefined;
     side?: Side | undefined;
     shadowSide?: Side | undefined;
@@ -283,6 +284,11 @@ export class Material extends EventDispatcher {
      */
     premultipliedAlpha: boolean;
 
+    /**
+     * @default false
+     */
+    forceSinglePass: boolean;
+
     /**
      * Whether to apply dithering to the color to remove the appearance of banding. Default is false.
      * @default false
@@ -291,8 +297,9 @@ export class Material extends EventDispatcher {
 
     /**
      * Defines which of the face sides will be rendered - front, back or both.
-     * Default is THREE.FrontSide. Other options are THREE.BackSide and THREE.DoubleSide.
-     * @default THREE.FrontSide
+     * Default is {@link THREE.FrontSide}. Other options are {@link THREE.BackSide} and {@link THREE.DoubleSide}.
+     *
+     * @default {@link THREE.FrontSide}
      */
     side: Side;
 

three/src/math/Euler.d.ts

@@ -23,7 +23,7 @@ export class Euler {
     z: number;
 
     /**
-     * @default THREE.Euler.DefaultOrder
+     * @default THREE.Euler.DEFAULT_ORDER
      */
     order: EulerOrder;
     readonly isEuler: true;
@@ -42,8 +42,7 @@ export class Euler {
     toArray(array?: Array<number | string | undefined>, offset?: number): Array<number | string | undefined>;
     _onChange(callback: () => void): this;
 
-    static RotationOrders: EulerOrder[];
-    static DefaultOrder: 'XYZ';
+    static DEFAULT_ORDER: 'XYZ';
 
     [Symbol.iterator](): Generator<string | number, void>;
 }

three/src/objects/Mesh.d.ts

@@ -21,10 +21,10 @@ export class Mesh<
     updateMorphTargets(): void;
 
     /**
-     * Get the current position of the indicated vertex in local space,
+     * Get the local-space position of the vertex at the given index,
      * taking into account the current animation state of both morph targets and skinning.
      */
-    getVertexPosition(vert: number, target: Vector3): Vector3;
+    getVertexPosition(index: number, target: Vector3): Vector3;
 
     raycast(raycaster: Raycaster, intersects: Intersection[]): void;
 }

three/src/renderers/webgl/WebGLAttributes.d.ts

@@ -1,18 +1,19 @@
 import { WebGLCapabilities } from './WebGLCapabilities';
 import { BufferAttribute } from '../../core/BufferAttribute';
 import { InterleavedBufferAttribute } from '../../core/InterleavedBufferAttribute';
+import { GLBufferAttribute } from '../../core/GLBufferAttribute';
 
 export class WebGLAttributes {
     constructor(gl: WebGLRenderingContext | WebGL2RenderingContext, capabilities: WebGLCapabilities);
 
-    get(attribute: BufferAttribute | InterleavedBufferAttribute): {
+    get(attribute: BufferAttribute | InterleavedBufferAttribute | GLBufferAttribute): {
         buffer: WebGLBuffer;
         type: number;
         bytesPerElement: number;
         version: number;
     };
 
-    remove(attribute: BufferAttribute | InterleavedBufferAttribute): void;
+    remove(attribute: BufferAttribute | InterleavedBufferAttribute | GLBufferAttribute): void;
 
-    update(attribute: BufferAttribute | InterleavedBufferAttribute, bufferType: number): void;
+    update(attribute: BufferAttribute | InterleavedBufferAttribute | GLBufferAttribute, bufferType: number): void;
 }

three/src/renderers/webgl/WebGLClipping.d.ts

@@ -1,5 +1,6 @@
 import { Camera } from './../../cameras/Camera';
 import { Material } from './../../materials/Material';
+import { Plane } from '../../math/Plane';
 import { WebGLProperties } from './WebGLProperties';
 
 export class WebGLClipping {
@@ -17,8 +18,9 @@ export class WebGLClipping {
      */
     numIntersection: number;
 
-    init(planes: any[], enableLocalClipping: boolean, camera: Camera): boolean;
+    init(planes: any[], enableLocalClipping: boolean): boolean;
     beginShadows(): void;
     endShadows(): void;
+    setGlobalState(planes: Plane[], camera: Camera): void;
     setState(material: Material, camera: Camera, useCache: boolean): void;
 }

three/src/renderers/webxr/WebXRManager.d.ts

@@ -40,12 +40,12 @@ export class WebXRManager extends EventDispatcher {
     getBinding(): XRWebGLBinding;
     getFrame(): XRFrame;
     getSession(): XRSession | null;
-    setSession(value: XRSession): Promise<void>;
+    setSession(value: XRSession | null): Promise<void>;
     getCamera(): WebXRArrayCamera;
     updateCamera(camera: PerspectiveCamera): void;
     setAnimationLoop(callback: XRFrameRequestCallback | null): void;
     getFoveation(): number | undefined;
-    setFoveation(foveation: number): void;
+    setFoveation(value: number): void;
 
     /**
      * Returns the set of planes detected by WebXR's plane detection API.

three/src/textures/Data3DTexture.d.ts

@@ -1,5 +1,5 @@
 import { Texture } from './Texture';
-import { TextureFilter } from '../constants';
+import { TextureFilter, Wrapping } from '../constants';
 
 export class Data3DTexture extends Texture {
     constructor(data: BufferSource, width: number, height: number, depth: number);
@@ -17,7 +17,7 @@ export class Data3DTexture extends Texture {
     /**
      * @default THREE.ClampToEdgeWrapping
      */
-    wrapR: boolean;
+    wrapR: Wrapping;
 
     /**
      * @default false

three/src/renderers/WebGLMultisampleRenderTarget.d.ts

@@ -1,6 +0,0 @@
-import { WebGLRenderTarget } from './WebGLRenderTarget';
-
-/**
- * @deprecated THREE.WebGLMultisampleRenderTarget has been removed. Use a normal {@link WebGLRenderTarget render target} and set the "samples" property to greater 0 to enable multisampling.
- */
-export class WebGLMultisampleRenderTarget extends WebGLRenderTarget {}

three/src/textures/DataTexture2DArray.d.ts

@@ -1,6 +0,0 @@
-import { DataArrayTexture } from './DataArrayTexture';
-
-/**
- * @deprecated THREE.DataTexture2DArray has been renamed to DataArrayTexture.
- */
-export class DataTexture2DArray extends DataArrayTexture {}

three/src/textures/DataTexture3D.d.ts

@@ -1,6 +0,0 @@
-import { Data3DTexture } from './Data3DTexture';
-
-/**
- * @deprecated THREE.DataTexture3D has been renamed to Data3DTexture.
- */
-export class DataTexture3D extends Data3DTexture {}