@types/three 0.139.0 → 0.142.0

three/examples/jsm/webxr/XREstimatedLight.d.ts

@@ -1,24 +1,24 @@
-import { DirectionalLight, Group, LightProbe, XRFrame, WebGLRenderer, Texture } from '../../../src/Three';
+import { DirectionalLight, Group, LightProbe, Texture, WebGLRenderer } from '../../../src/Three';
 
 export class SessionLightProbe {
     xrLight: XREstimatedLight;
     renderer: WebGLRenderer;
-    lightProbe: unknown;
-    xrWebGLBinding: unknown | null;
+    lightProbe: LightProbe;
+    xrWebGLBinding: XRWebGLBinding | null;
     estimationStartCallback: () => void;
     frameCallback: (this: SessionLightProbe, time: number, xrFrame: XRFrame) => void;
 
     constructor(
         xrLight: XREstimatedLight,
         renderer: WebGLRenderer,
-        lightProbe: unknown,
+        lightProbe: LightProbe,
         environmentEstimation: boolean,
         estimationStartCallback: () => void,
     );
 
     updateReflection: () => void;
 
-    onXRFrame: (time: number, xrFrame: XRFrame) => void;
+    onXRFrame: XRFrameRequestCallback;
 
     dispose: () => void;
 }

three/examples/jsm/webxr/XRHandModelFactory.d.ts

@@ -19,7 +19,7 @@ export class XRHandModelFactory {
 
     createHandModel(
         controller: Group,
-        profile?: 'spheres' | 'boxes' | 'oculus',
+        profile?: 'spheres' | 'boxes' | 'mesh',
         options?: XRHandPrimitiveModelOptions,
     ): XRHandModel;
 }

three/index.d.ts

@@ -1,14 +1,15 @@
-// Type definitions for three 0.139
+// Type definitions for three 0.142
 // Project: https://threejs.org/
 // Definitions by: Josh Ellis <https://github.com/joshuaellis>
 //                 Nathan Bierema <https://github.com/Methuselah96>
 // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
 // Minimum TypeScript Version: 3.6
 
+// To update three.js type definition, please make changes to the repository at:
+// https://github.com/three-types/three-ts-types.
+// Periodically, the updates from the repository are pushed to DefinitelyTyped
+// and released in the @types/three npm package.
+
 export * from './src/Three';
 
-/*~ If this module is a UMD module that exposes a global variable 'myLib' when
- *~ loaded outside a module loader environment, declare that global here.
- *~ Otherwise, delete this declaration.
- */
 export as namespace THREE;

three/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/three",
-    "version": "0.139.0",
+    "version": "0.142.0",
     "description": "TypeScript definitions for three",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/three",
     "license": "MIT",
@@ -24,7 +24,9 @@
         "directory": "types/three"
     },
     "scripts": {},
-    "dependencies": {},
-    "typesPublisherContentHash": "3d3b533eda48e6d4aad35b8b2177550c7d54d7f9eef4a9c679730a92b75d3551",
-    "typeScriptVersion": "3.9"
+    "dependencies": {
+        "@types/webxr": "*"
+    },
+    "typesPublisherContentHash": "d187945f6b769add03311f684cc4c99011ebd1d56bd6d32f2636d9dac50f5052",
+    "typeScriptVersion": "4.0"
 }

three/src/Three.d.ts

@@ -65,6 +65,7 @@ export * from './extras/core/ShapePath';
 export * from './extras/core/CurvePath';
 export * from './extras/core/Curve';
 export * from './extras/DataUtils';
+export * from './extras/Earcut';
 export * from './extras/ImageUtils';
 export * from './extras/ShapeUtils';
 export * from './extras/PMREMGenerator';
@@ -206,7 +207,6 @@ export * from './renderers/webgl/WebGLShadowMap';
 export * from './renderers/webgl/WebGLState';
 export * from './renderers/webgl/WebGLTextures';
 export * from './renderers/webgl/WebGLUniforms';
-export * from './renderers/webxr/WebXR';
 export * from './renderers/webxr/WebXRController';
 export * from './renderers/webxr/WebXRManager';
 export { WebGLUtils } from './renderers/webgl/WebGLUtils.js';

three/src/audio/AudioContext.d.ts

@@ -4,5 +4,5 @@
 export namespace AudioContext {
     function getContext(): AudioContext;
 
-    function setContext(): void;
+    function setContext(context: AudioContext): void;
 }

three/src/constants.d.ts

@@ -301,7 +301,6 @@ export const TriangleFanDrawMode: TrianglesDrawModes;
 export enum TextureEncoding {}
 export const LinearEncoding: TextureEncoding;
 export const sRGBEncoding: TextureEncoding;
-export const LogLuvEncoding: TextureEncoding;
 
 // Depth packing strategies
 export enum DepthPackingStrategies {}

three/src/extras/DataUtils.d.ts

@@ -1,4 +1,2 @@
-export namespace DataUtils {
-    function toHalfFloat(val: number): number;
-    function fromHalfFloat(val: number): number;
-}
+export function toHalfFloat(val: number): number;
+export function fromHalfFloat(val: number): number;

three/src/extras/Earcut.d.ts

@@ -0,0 +1,4 @@
+import { Triangle } from '../Three';
+export namespace Earcut {
+    function triangulate(data: number[], holeIndices: number[], dim: number): Triangle[];
+}

three/src/materials/Material.d.ts

@@ -13,9 +13,6 @@ import {
     StencilOp,
     PixelFormat,
 } from '../constants';
-import { ColorRepresentation } from '../utils';
-import { Color } from '../math/Color';
-import { Texture } from '../textures/Texture';
 
 export interface MaterialParameters {
     alphaTest?: number | undefined;
@@ -35,7 +32,6 @@ export interface MaterialParameters {
     depthFunc?: DepthModes | undefined;
     depthTest?: boolean | undefined;
     depthWrite?: boolean | undefined;
-    fog?: boolean | undefined;
     name?: string | undefined;
     opacity?: number | undefined;
     polygonOffset?: boolean | undefined;
@@ -175,12 +171,6 @@ export class Material extends EventDispatcher {
      */
     depthWrite: boolean;
 
-    /**
-     * Whether the material is affected by fog. Default is true.
-     * @default fog
-     */
-    fog: boolean;
-
     /**
      * Unique number of this material instance.
      */

three/src/materials/MeshBasicMaterial.d.ts

@@ -16,6 +16,7 @@ export interface MeshBasicMaterialParameters extends MaterialParameters {
     aoMapIntensity?: number | undefined;
     specularMap?: Texture | null | undefined;
     alphaMap?: Texture | null | undefined;
+    fog?: boolean | undefined;
     envMap?: Texture | null | undefined;
     combine?: Combine | undefined;
     reflectivity?: number | undefined;
@@ -114,5 +115,11 @@ export class MeshBasicMaterial extends Material {
      */
     wireframeLinejoin: string;
 
+    /**
+     * Whether the material is affected by fog. Default is true.
+     * @default fog
+     */
+    fog: boolean;
+
     setValues(parameters: MeshBasicMaterialParameters): void;
 }

three/src/materials/MeshLambertMaterial.d.ts

@@ -24,6 +24,7 @@ export interface MeshLambertMaterialParameters extends MaterialParameters {
     wireframeLinewidth?: number | undefined;
     wireframeLinecap?: string | undefined;
     wireframeLinejoin?: string | undefined;
+    fog?: boolean | undefined;
 }
 
 export class MeshLambertMaterial extends Material {
@@ -129,5 +130,11 @@ export class MeshLambertMaterial extends Material {
      */
     wireframeLinejoin: string;
 
+    /**
+     * Whether the material is affected by fog. Default is true.
+     * @default fog
+     */
+    fog: boolean;
+
     setValues(parameters: MeshLambertMaterialParameters): void;
 }

three/src/materials/MeshMatcapMaterial.d.ts

@@ -18,7 +18,7 @@ export interface MeshMatcapMaterialParameters extends MaterialParameters {
     displacementScale?: number | undefined;
     displacementBias?: number | undefined;
     alphaMap?: Texture | null | undefined;
-
+    fog?: boolean | undefined;
     flatShading?: boolean | undefined;
 }
 
@@ -101,5 +101,11 @@ export class MeshMatcapMaterial extends Material {
      */
     flatShading: boolean;
 
+    /**
+     * Whether the material is affected by fog. Default is true.
+     * @default fog
+     */
+    fog: boolean;
+
     setValues(parameters: MeshMatcapMaterialParameters): void;
 }

three/src/materials/MeshPhongMaterial.d.ts

@@ -37,7 +37,7 @@ export interface MeshPhongMaterialParameters extends MaterialParameters {
     wireframeLinewidth?: number | undefined;
     wireframeLinecap?: string | undefined;
     wireframeLinejoin?: string | undefined;
-
+    fog?: boolean | undefined;
     flatShading?: boolean | undefined;
 }
 
@@ -205,5 +205,11 @@ export class MeshPhongMaterial extends Material {
      */
     metal: boolean;
 
+    /**
+     * Whether the material is affected by fog. Default is true.
+     * @default fog
+     */
+    fog: boolean;
+
     setValues(parameters: MeshPhongMaterialParameters): void;
 }

three/src/materials/MeshPhysicalMaterial.d.ts

@@ -156,4 +156,24 @@ export class MeshPhysicalMaterial extends MeshStandardMaterial {
      * @default null
      */
     specularColorMap: Texture | null;
+
+    /**
+     * @default null
+     */
+    iridescenceMap: Texture | null;
+
+    /**
+     * @default 1.3
+     */
+    iridescenceIOR: number;
+
+    /**
+     * @default [100, 400]
+     */
+    iridescenceThicknessRange: number[];
+
+    /**
+     * @default null
+     */
+    iridescenceThicknessMap: Texture | null;
 }

three/src/materials/MeshStandardMaterial.d.ts

@@ -32,7 +32,7 @@ export interface MeshStandardMaterialParameters extends MaterialParameters {
     envMapIntensity?: number | undefined;
     wireframe?: boolean | undefined;
     wireframeLinewidth?: number | undefined;
-
+    fog?: boolean | undefined;
     flatShading?: boolean | undefined;
 }
 
@@ -195,6 +195,12 @@ export class MeshStandardMaterial extends Material {
      */
     flatShading: boolean;
 
+    /**
+     * Whether the material is affected by fog. Default is true.
+     * @default fog
+     */
+    fog: boolean;
+
     isMeshStandardMaterial: boolean;
 
     setValues(parameters: MeshStandardMaterialParameters): void;

three/src/materials/MeshToonMaterial.d.ts

@@ -31,6 +31,7 @@ export interface MeshToonMaterialParameters extends MaterialParameters {
     wireframeLinewidth?: number | undefined;
     wireframeLinecap?: string | undefined;
     wireframeLinejoin?: string | undefined;
+    fog?: boolean | undefined;
 }
 
 export class MeshToonMaterial extends Material {
@@ -161,5 +162,11 @@ export class MeshToonMaterial extends Material {
      */
     wireframeLinejoin: string;
 
+    /**
+     * Whether the material is affected by fog. Default is true.
+     * @default fog
+     */
+    fog: boolean;
+
     setValues(parameters: MeshToonMaterialParameters): void;
 }

three/src/materials/PointsMaterial.d.ts

@@ -9,6 +9,7 @@ export interface PointsMaterialParameters extends MaterialParameters {
     alphaMap?: Texture | null | undefined;
     size?: number | undefined;
     sizeAttenuation?: boolean | undefined;
+    fog?: boolean | undefined;
 }
 
 export class PointsMaterial extends Material {
@@ -44,5 +45,11 @@ export class PointsMaterial extends Material {
      */
     sizeAttenuation: boolean;
 
+    /**
+     * Whether the material is affected by fog. Default is true.
+     * @default fog
+     */
+    fog: boolean;
+
     setValues(parameters: PointsMaterialParameters): void;
 }

three/src/materials/ShadowMaterial.d.ts

@@ -4,6 +4,7 @@ import { MaterialParameters, Material } from './Material';
 
 export interface ShadowMaterialParameters extends MaterialParameters {
     color?: ColorRepresentation | undefined;
+    fog?: boolean | undefined;
 }
 
 export class ShadowMaterial extends Material {
@@ -23,4 +24,10 @@ export class ShadowMaterial extends Material {
      * @default true
      */
     transparent: boolean;
+
+    /**
+     * Whether the material is affected by fog. Default is true.
+     * @default fog
+     */
+    fog: boolean;
 }

three/src/materials/SpriteMaterial.d.ts

@@ -9,6 +9,7 @@ export interface SpriteMaterialParameters extends MaterialParameters {
     alphaMap?: Texture | null | undefined;
     rotation?: number | undefined;
     sizeAttenuation?: boolean | undefined;
+    fog?: boolean | undefined;
 }
 
 export class SpriteMaterial extends Material {
@@ -48,6 +49,12 @@ export class SpriteMaterial extends Material {
      */
     transparent: boolean;
 
+    /**
+     * Whether the material is affected by fog. Default is true.
+     * @default fog
+     */
+    fog: boolean;
+
     readonly isSpriteMaterial: true;
 
     setValues(parameters: SpriteMaterialParameters): void;

three/src/math/Color.d.ts

@@ -175,6 +175,8 @@ export class Color {
 
     fromBufferAttribute(attribute: BufferAttribute, index: number): this;
 
+    [Symbol.iterator](): Generator<number, void>;
+
     /**
      * List of X11 color names.
      */

three/src/math/Euler.d.ts

@@ -42,4 +42,6 @@ export class Euler {
 
     static RotationOrders: string[];
     static DefaultOrder: string;
+
+    [Symbol.iterator](): Generator<string | number, void>;
 }

three/src/math/Quaternion.d.ts

@@ -174,4 +174,6 @@ export class Quaternion {
     inverse(): Quaternion;
 
     random(): Quaternion;
+
+    [Symbol.iterator](): Generator<number, void>;
 }

three/src/renderers/WebGLRenderTarget.d.ts

@@ -17,6 +17,12 @@ export interface WebGLRenderTargetOptions {
     generateMipmaps?: boolean | undefined; // true;
     depthTexture?: DepthTexture | undefined;
     encoding?: TextureEncoding | undefined;
+
+    /**
+     * Defines the count of MSAA samples. Can only be used with WebGL 2. Default is **0**.
+     * @default 0
+     */
+    samples?: number;
 }
 
 export class WebGLRenderTarget extends EventDispatcher {

three/src/renderers/WebGLRenderer.d.ts

@@ -19,7 +19,6 @@ import { WebXRManager } from '../renderers/webxr/WebXRManager';
 import { BufferGeometry } from './../core/BufferGeometry';
 import { Texture } from '../textures/Texture';
 import { Data3DTexture } from '../textures/Data3DTexture';
-import { XRAnimationLoopCallback } from './webxr/WebXR';
 import { Vector3 } from '../math/Vector3';
 import { Box3 } from '../math/Box3';
 import { DataArrayTexture } from '../textures/DataArrayTexture';
@@ -128,11 +127,6 @@ export class WebGLRenderer implements Renderer {
      */
     domElement: HTMLCanvasElement;
 
-    /**
-     * The HTML5 Canvas's 'webgl' context obtained from the canvas where the renderer will draw.
-     */
-    context: WebGLRenderingContext;
-
     /**
      * Defines whether the renderer should automatically clear its output before rendering.
      * @default true
@@ -336,7 +330,7 @@ export class WebGLRenderer implements Renderer {
      * A build in function that can be used instead of requestAnimationFrame. For WebXR projects this function must be used.
      * @param callback The function will be called every available frame. If `null` is passed it will stop any already ongoing animation.
      */
-    setAnimationLoop(callback: XRAnimationLoopCallback | null): void;
+    setAnimationLoop(callback: XRFrameRequestCallback | null): void;
 
     /**
      * @deprecated Use {@link WebGLRenderer#setAnimationLoop .setAnimationLoop()} instead.

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

@@ -1,14 +1,40 @@
 import { Group } from '../../objects/Group';
-import { XREventType, XRFrame, XRInputSource, XRReferenceSpace } from './WebXR';
+import { Vector3 } from '../../math/Vector3';
 
-export type XRControllerEventType = XREventType | 'disconnected' | 'connected';
+export type XRControllerEventType = XRSessionEventType | XRInputSourceEventType | 'disconnected' | 'connected';
+
+export type XRHandJoints = Record<XRHandJoint, number>;
+
+export interface XRHandInputState {
+    pinching: boolean;
+}
+
+export class XRHandSpace extends Group {
+    readonly joints: Partial<XRHandJoints>;
+    readonly inputState: XRHandInputState;
+}
+
+export class XRTargetRaySpace extends Group {
+    hasLinearVelocity: boolean;
+    readonly linearVelocity: Vector3;
+    hasAngularVelocity: boolean;
+    readonly angularVelocity: Vector3;
+}
+
+export class XRGripSpace extends Group {
+    hasLinearVelocity: boolean;
+    readonly linearVelocity: Vector3;
+    hasAngularVelocity: boolean;
+    readonly angularVelocity: Vector3;
+}
 
 export class WebXRController {
     constructor();
 
-    getTargetRaySpace(): Group;
-    getGripSpace(): Group;
-    dispatchEvent(event: { type: XRControllerEventType; data?: XRInputSource | undefined }): this;
+    getHandSpace(): XRHandSpace;
+    getTargetRaySpace(): XRTargetRaySpace;
+    getGripSpace(): XRGripSpace;
+    dispatchEvent(event: { type: XRControllerEventType; data?: XRInputSource }): this;
     disconnect(inputSource: XRInputSource): this;
     update(inputSource: XRInputSource, frame: XRFrame, referenceSpace: XRReferenceSpace): this;
 }

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

@@ -1,7 +1,13 @@
-import { Group } from '../../objects/Group';
-import { Camera } from '../../cameras/Camera';
+/// <reference types="webxr" />
+
+import { Vector4 } from '../../math/Vector4';
+import { ArrayCamera } from '../../cameras/ArrayCamera';
+import { PerspectiveCamera } from '../../cameras/PerspectiveCamera';
 import { EventDispatcher } from '../../core/EventDispatcher';
-import { XRFrameRequestCallback, XRReferenceSpace, XRReferenceSpaceType, XRSession } from './WebXR';
+import { XRTargetRaySpace, XRGripSpace, XRHandSpace } from './WebXRController';
+
+export type WebXRCamera = PerspectiveCamera & { viewport: Vector4 };
+export type WebXRArrayCamera = Omit<ArrayCamera, 'cameras'> & { cameras: [WebXRCamera, WebXRCamera] };
 
 export class WebXRManager extends EventDispatcher {
     constructor(renderer: any, gl: WebGLRenderingContext);
@@ -16,15 +22,25 @@ export class WebXRManager extends EventDispatcher {
      */
     isPresenting: boolean;
 
-    getController(index: number): Group;
-    getControllerGrip(index: number): Group;
-    getHand(index: number): Group;
+    /**
+     * @default true
+     */
+    cameraAutoUpdate: boolean;
+
+    getController(index: number): XRTargetRaySpace;
+    getControllerGrip(index: number): XRGripSpace;
+    getHand(index: number): XRHandSpace;
     setFramebufferScaleFactor(value: number): void;
     setReferenceSpaceType(value: XRReferenceSpaceType): void;
     getReferenceSpace(): XRReferenceSpace | null;
+    setReferenceSpace(value: XRReferenceSpace): void;
+    getBaseLayer(): XRWebGLLayer | XRProjectionLayer;
+    getBinding(): XRWebGLBinding;
+    getFrame(): XRFrame;
     getSession(): XRSession | null;
     setSession(value: XRSession): Promise<void>;
-    getCamera(camera: Camera): Camera;
+    getCamera(): WebXRArrayCamera;
+    updateCamera(camera: PerspectiveCamera): void;
     setAnimationLoop(callback: XRFrameRequestCallback | null): void;
     getFoveation(): number | undefined;
     setFoveation(foveation: number): void;

three/examples/jsm/shaders/SSRrShader.d.ts

@@ -1,48 +0,0 @@
-import { Matrix4, Vector2, IUniform, Texture } from '../../../src/Three';
-
-export interface SSRrShader {
-    defines: {
-        MAX_STEP: number;
-        PERSPECTIVE_CAMERA: boolean;
-        SPECULAR: boolean;
-        FILL_HOLE: boolean;
-        INFINITE_THICK: boolean;
-    };
-
-    uniforms: {
-        tDiffuse: IUniform<Texture | null>;
-        tSpecular: IUniform<Texture | null>;
-        tNormalSelects: IUniform<Texture | null>;
-        tRefractive: IUniform<Texture | null>;
-        tDepthSelects: IUniform<Texture | null>;
-        cameraNear: IUniform<number | null>;
-        cameraFar: IUniform<number | null>;
-        resolution: IUniform<Vector2>;
-        cameraProjectionMatrix: IUniform<Matrix4>;
-        cameraInverseProjectionMatrix: IUniform<Matrix4>;
-        ior: IUniform<number>;
-        cameraRange: IUniform<number>;
-        maxDistance: IUniform<number>;
-        surfDist: IUniform<number>;
-    };
-
-    vertexShader: string;
-
-    fragmentShader: string;
-}
-
-export interface SSRrDepthShader {
-    defines: {
-        PERSPECTIVE_CAMERA: number;
-    };
-
-    uniforms: {
-        tDepth: IUniform<Texture | null>;
-        cameraNear: IUniform<number | null>;
-        cameraFar: IUniform<number | null>;
-    };
-
-    vertexShader: string;
-
-    fragmentShader: string;
-}