@types/three 0.157.1 → 0.158.0

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

@@ -1,6 +1,7 @@
 import { IUniform } from '../../../src/Three.js';
 
 export const SSAOShader: {
+    name: string;
     defines: {
         PERSPECTIVE_CAMERA: number;
         KERNEL_SIZE: number;
@@ -24,6 +25,7 @@ export const SSAOShader: {
 };
 
 export const SSAODepthShader: {
+    name: string;
     defines: {
         PERSPECTIVE_CAMERA: number;
     };
@@ -37,6 +39,7 @@ export const SSAODepthShader: {
 };
 
 export const SSAOBlurShader: {
+    name: string;
     uniforms: {
         tDiffuse: IUniform;
         resolution: IUniform;

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

@@ -6,6 +6,7 @@ import { Matrix4, Vector2, Texture, IUniform } from '../../../src/Three.js';
 
 export const SSRShader: SSRShader;
 export interface SSRShader {
+    name: string;
     defines: {
         MAX_STEP: number;
         isPerspectiveCamera: boolean;
@@ -35,6 +36,7 @@ export interface SSRShader {
 
 export const SSRDepthShader: SSRDepthShader;
 export interface SSRDepthShader {
+    name: string;
     defines: {
         PERSPECTIVE_CAMERA: number;
     };
@@ -49,6 +51,7 @@ export interface SSRDepthShader {
 
 export const SSRBlurShader: SSRBlurShader;
 export interface SSRBlurShader {
+    name: string;
     uniforms: {
         tDiffuse: IUniform<Texture | null>;
         resolution: IUniform<Vector2>;

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

@@ -1,6 +1,7 @@
 import { IUniform } from '../../../src/Three.js';
 
 export const SobelOperatorShader: {
+    name: string;
     uniforms: {
         tDiffuse: IUniform;
         resolution: IUniform;

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

@@ -1,6 +1,7 @@
 import { IUniform } from '../../../src/Three.js';
 
 export const SubsurfaceScatteringShader: {
+    name: string;
     uniforms: {
         alphaMap: IUniform;
         ambientLightColor: IUniform;

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

@@ -1,6 +1,7 @@
 import { IUniform } from '../../../src/Three.js';
 
 export const TechnicolorShader: {
+    name: string;
     uniforms: {
         tDiffuse: IUniform;
     };

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

@@ -1,6 +1,7 @@
 import { IUniform } from '../../../src/Three.js';
 
 export const TriangleBlurShader: {
+    name: string;
     uniforms: {
         texture: IUniform;
         delta: IUniform;

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

@@ -1,6 +1,7 @@
 import { IUniform } from '../../../src/Three.js';
 
 export const UnpackDepthRGBAShader: {
+    name: string;
     uniforms: {
         tDiffuse: IUniform;
         opacity: IUniform;

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

@@ -0,0 +1,14 @@
+import { IUniform, UniformsLib } from '../../../src/Three.js';
+
+export const VelocityShader: {
+    name: string;
+    uniforms: (typeof UniformsLib)['common'] &
+        (typeof UniformsLib)['displacementmap'] & {
+            modelMatrixPrev: IUniform;
+            currentProjectionViewMatrix: IUniform;
+            previousProjectionViewMatrix: IUniform;
+        };
+
+    fragmentShader: string;
+    vertexShader: string;
+};

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

@@ -1,6 +1,7 @@
 import { IUniform } from '../../../src/Three.js';
 
 export const VerticalTiltShiftShader: {
+    name: string;
     uniforms: {
         tDiffuse: IUniform;
         v: IUniform;

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

@@ -1,6 +1,7 @@
 import { IUniform } from '../../../src/Three.js';
 
 export const WaterRefractionShader: {
+    name: string;
     uniforms: {
         color: IUniform;
         time: IUniform;

three/examples/jsm/utils/GPUStatsPanel.d.ts

@@ -0,0 +1,12 @@
+import Stats from '../libs/stats.module.js';
+
+export class GPUStatsPanel extends Stats.Panel {
+    context: WebGLRenderingContext | WebGL2RenderingContext;
+    extension: unknown;
+    maxTime: number;
+    activeQueries: number;
+    startQuery: () => void;
+    endQuery: () => void;
+
+    constructor(context: WebGLRenderingContext | WebGL2RenderingContext, name?: string);
+}

three/examples/jsm/utils/GeometryUtils.d.ts

@@ -0,0 +1,25 @@
+import { Vector3 } from '../../../src/Three.js';
+
+export function hilbert2D(
+    center?: Vector3,
+    size?: number,
+    iterations?: number,
+    v0?: number,
+    v1?: number,
+    v2?: number,
+    v3?: number,
+): Vector3[];
+export function hilbert3D(
+    center?: Vector3,
+    size?: number,
+    iterations?: number,
+    v0?: number,
+    v1?: number,
+    v2?: number,
+    v3?: number,
+    v4?: number,
+    v5?: number,
+    v6?: number,
+    v7?: number,
+): Vector3[];
+export function gosper(size?: number): number[];

three/examples/jsm/utils/LDrawUtils.d.ts

@@ -0,0 +1,5 @@
+import { Group, Object3D } from '../../../src/Three.js';
+
+export namespace LDrawUtils {
+    function mergeObject(object: Object3D): Group;
+}

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

@@ -0,0 +1,5 @@
+import { WebGLRenderer } from '../../../src/Three.js';
+
+export namespace VRButton {
+    function createButton(renderer: WebGLRenderer): HTMLElement;
+}

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

@@ -0,0 +1,6 @@
+import { WebGLRenderer } from '../../../src/Three.js';
+
+// tslint:disable-next-line:no-unnecessary-class
+export class XRButton {
+    static createButton(renderer: WebGLRenderer, sessionInit?: XRSessionInit): HTMLElement;
+}

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

@@ -0,0 +1,21 @@
+import { Group, Object3D, Texture } from '../../../src/Three.js';
+
+import { GLTFLoader } from '../loaders/GLTFLoader.js';
+
+export class XRControllerModel extends Object3D {
+    constructor();
+
+    motionController: any;
+
+    envMap: Texture;
+
+    setEnvironmentMap(envMap: Texture): XRControllerModel;
+}
+
+export class XRControllerModelFactory {
+    constructor(gltfLoader?: GLTFLoader);
+    gltfLoader: GLTFLoader | null;
+    path: string;
+
+    createControllerModel(controller: Group): XRControllerModel;
+}

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

@@ -24,14 +24,46 @@ export class SessionLightProbe {
 }
 
 export interface XREstimatedLightEventMap extends Object3DEventMap {
+    /**
+     * Fires when the estimated lighting values start being updated.
+     */
     estimationstart: {};
+    /**
+     * Fires when the estimated lighting values stop being updated.
+     */
     estimationend: {};
 }
 
+/**
+ * XREstimatedLight uses WebXR's light estimation to create a light probe, a directional light, and (optionally) an
+ * environment map that model the user's real-world environment and lighting.
+ * As WebXR updates the light and environment estimation, XREstimatedLight automatically updates the light probe,
+ * directional light, and environment map.
+ *
+ * It's important to specify `light-estimation` as an optional or required feature when creating the WebXR session,
+ * otherwise the light estimation can't work.
+ *
+ * See {@link https://developer.mozilla.org/en-US/docs/Web/API/XRLightProbe#browser_compatibility here} for browser
+ * compatibility information, as this is still an experimental feature in WebXR.
+ *
+ * To use this, as with all files in the /examples directory, you will have to include the file separately in your HTML.
+ */
 export class XREstimatedLight extends Group<XREstimatedLightEventMap> {
     lightProbe: LightProbe;
+
     directionalLight: DirectionalLight;
+
+    /**
+     * The environment map estimated by WebXR. This is only available if environmentEstimation is `true`.
+     *
+     * It can be used as the {@link Scene.environment}, for {@link MeshStandardMaterial.envMap}, or as the
+     * {@link Scene.background}.
+     */
     environment: Texture;
 
+    /**
+     * @param renderer The renderer used to render the Scene. Mainly used to interact with WebXRManager.
+     * @param environmentEstimation If `true`, use WebXR to estimate an environment map.
+     */
     constructor(renderer: WebGLRenderer, environmentEstimation?: boolean);
 }

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

@@ -0,0 +1,11 @@
+import { Object3D } from '../../../src/Three.js';
+
+export class XRHandMeshModel {
+    controller: Object3D;
+    handModel: Object3D;
+    bones: Object3D[];
+
+    constructor(handModel: Object3D, controller: Object3D, path: string, handedness: string);
+
+    updateMesh(): void;
+}

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

@@ -0,0 +1,25 @@
+import { Group, Object3D } from '../../../src/Three.js';
+
+import { XRHandPrimitiveModel, XRHandPrimitiveModelOptions } from './XRHandPrimitiveModel.js';
+import { XRHandMeshModel } from './XRHandMeshModel.js';
+
+export type XRHandModelHandedness = 'left' | 'right';
+
+export class XRHandModel extends Object3D {
+    constructor();
+
+    motionController: XRHandPrimitiveModel | XRHandMeshModel;
+}
+
+export class XRHandModelFactory {
+    constructor();
+    path: string;
+
+    setPath(path: string): XRHandModelFactory;
+
+    createHandModel(
+        controller: Group,
+        profile?: 'spheres' | 'boxes' | 'mesh',
+        options?: XRHandPrimitiveModelOptions,
+    ): XRHandModel;
+}

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

@@ -0,0 +1,24 @@
+import { Group, Texture } from '../../../src/Three.js';
+
+import { XRHandModel, XRHandModelHandedness } from './XRHandModelFactory.js';
+
+export interface XRHandPrimitiveModelOptions {
+    primitive?: 'sphere' | 'box' | undefined;
+}
+
+export class XRHandPrimitiveModel {
+    controller: Group;
+    handModel: XRHandModel;
+    envMap: Texture | null;
+    handMesh: Group;
+
+    constructor(
+        handModel: XRHandModel,
+        controller: Group,
+        path: string,
+        handedness: XRHandModelHandedness,
+        options: XRHandPrimitiveModelOptions,
+    );
+
+    updateMesh: () => void;
+}

three/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/three",
-    "version": "0.157.1",
+    "version": "0.158.0",
     "description": "TypeScript definitions for three",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/three",
     "license": "MIT",
@@ -26,6 +26,7 @@
         },
         "./examples/fonts/*": "./examples/fonts/*",
         "./examples/jsm/*": "./examples/jsm/*",
+        "./addons": "./examples/jsm/Addons.js",
         "./addons/*": "./examples/jsm/*",
         "./src/*": "./src/*",
         "./nodes": "./examples/jsm/nodes/Nodes.js",
@@ -43,6 +44,6 @@
         "fflate": "~0.6.10",
         "meshoptimizer": "~0.18.1"
     },
-    "typesPublisherContentHash": "d9388a18bbcf88aa18fface6fb06534b21e5cbb2b9d6df028f4c585cfc72e00c",
+    "typesPublisherContentHash": "255a6a1803d2017678c3abe305771d2dc7b3a2db590cb731e2a0f99e04dfcc14",
     "typeScriptVersion": "4.5"
 }

three/src/cameras/CubeCamera.d.ts

@@ -1,5 +1,4 @@
 import { WebGLCubeRenderTarget } from '../renderers/WebGLCubeRenderTarget.js';
-import { Scene } from '../scenes/Scene.js';
 import { WebGLRenderer } from '../renderers/WebGLRenderer.js';
 import { Object3D } from '../core/Object3D.js';
 import { CoordinateSystem } from '../constants.js';
@@ -65,5 +64,5 @@ export class CubeCamera extends Object3D {
      * @param renderer The current WebGL renderer
      * @param scene The current scene
      */
-    update(renderer: WebGLRenderer, scene: Scene): void;
+    update(renderer: WebGLRenderer, scene: Object3D): void;
 }

three/src/constants.d.ts

@@ -74,7 +74,7 @@ export type BlendingEquation =
     | typeof MinEquation
     | typeof MaxEquation;
 
-// custom blending destination factors
+// custom blending factors
 export const ZeroFactor: 200;
 export const OneFactor: 201;
 export const SrcColorFactor: 202;
@@ -85,6 +85,11 @@ export const DstAlphaFactor: 206;
 export const OneMinusDstAlphaFactor: 207;
 export const DstColorFactor: 208;
 export const OneMinusDstColorFactor: 209;
+export const SrcAlphaSaturateFactor: 210;
+export const ConstantColorFactor: 211;
+export const OneMinusConstantColorFactor: 212;
+export const ConstantAlphaFactor: 213;
+export const OneMinusConstantAlphaFactor: 214;
 export type BlendingDstFactor =
     | typeof ZeroFactor
     | typeof OneFactor
@@ -95,11 +100,12 @@ export type BlendingDstFactor =
     | typeof DstAlphaFactor
     | typeof OneMinusDstAlphaFactor
     | typeof DstColorFactor
-    | typeof OneMinusDstColorFactor;
-
-// custom blending src factors
-export const SrcAlphaSaturateFactor: 210;
-export type BlendingSrcFactor = typeof SrcAlphaSaturateFactor;
+    | typeof OneMinusDstColorFactor
+    | typeof ConstantColorFactor
+    | typeof OneMinusConstantColorFactor
+    | typeof ConstantAlphaFactor
+    | typeof OneMinusConstantAlphaFactor;
+export type BlendingSrcFactor = BlendingDstFactor | typeof SrcAlphaSaturateFactor;
 
 // depth modes
 export const NeverDepth: 0;
@@ -142,6 +148,11 @@ export type ToneMapping =
     | typeof ACESFilmicToneMapping
     | typeof CustomToneMapping;
 
+// Bind modes
+export const AttachedBindMode: 'attached';
+export const DetachedBindMode: 'detached';
+export type BindMode = typeof AttachedBindMode | typeof DetachedBindMode;
+
 ///////////////////////////////////////////////////////////////////////////////
 ///////////////////////////////////////////////////////////////////////////////
 ///////////////////////////////////////////////////////////////////////////////
@@ -462,11 +473,11 @@ export type WebGL2PixelFormat =
 export type PixelFormat = WebGL1PixelFormat | WebGL2PixelFormat;
 
 /**
- * All Texture Pixel Formats Modes for {@link THREE.DeepTexture}.
+ * All Texture Pixel Formats Modes for {@link THREE.DepthTexture}.
  * @see {@link WebGLRenderingContext.texImage2D} for details.
  * @see {@link https://threejs.org/docs/index.html#api/en/constants/Textures | Texture Constants}
  */
-export type DeepTexturePixelFormat = typeof DepthFormat | typeof DepthStencilFormat;
+export type DepthTexturePixelFormat = typeof DepthFormat | typeof DepthStencilFormat;
 
 ///////////////////////////////////////////////////////////////////////////////
 // Compressed texture formats
@@ -649,10 +660,10 @@ export type CompressedPixelFormat =
  * All Possible Texture Pixel Formats Modes. For any Type or SubType of Textures.
  * @remarks Note that the texture must have the correct {@link THREE.Texture.type} set, as described in {@link TextureDataType}.
  * @see {@link WebGLRenderingContext.texImage2D} for details.
- * @see {@link PixelFormat} and {@link DeepTexturePixelFormat} and {@link CompressedPixelFormat}
+ * @see {@link PixelFormat} and {@link DepthTexturePixelFormat} and {@link CompressedPixelFormat}
  * @see {@link https://threejs.org/docs/index.html#api/en/constants/Textures | Texture Constants}
  */
-export type AnyPixelFormat = PixelFormat | DeepTexturePixelFormat | CompressedPixelFormat;
+export type AnyPixelFormat = PixelFormat | DepthTexturePixelFormat | CompressedPixelFormat;
 
 ///////////////////////////////////////////////////////////////////////////////
 // Loop styles for AnimationAction

three/src/core/Object3D.d.ts

@@ -235,14 +235,14 @@ export class Object3D<TEventMap extends Object3DEventMap = Object3DEventMap> ext
      * are not renderable and thus this callback is not executed for such objects.
      * @defaultValue `() => {}`
      */
-    onBeforeRender: (
+    onBeforeRender(
         renderer: WebGLRenderer,
         scene: Scene,
         camera: Camera,
         geometry: BufferGeometry,
         material: Material,
         group: Group,
-    ) => void;
+    ): void;
 
     /**
      * An optional callback that is executed immediately after a 3D object is rendered.
@@ -254,14 +254,14 @@ export class Object3D<TEventMap extends Object3DEventMap = Object3DEventMap> ext
      * are not renderable and thus this callback is not executed for such objects.
      * @defaultValue `() => {}`
      */
-    onAfterRender: (
+    onAfterRender(
         renderer: WebGLRenderer,
         scene: Scene,
         camera: Camera,
         geometry: BufferGeometry,
         material: Material,
         group: Group,
-    ) => void;
+    ): void;
 
     /**
      * The default {@link up} direction for objects, also used as the default position for {@link THREE.DirectionalLight | DirectionalLight},

three/src/core/Raycaster.d.ts

@@ -31,6 +31,7 @@ export interface Intersection<TIntersected extends Object3D = Object3D> {
     normal?: Vector3;
     /** The index number of the instance where the ray intersects the {@link THREE.InstancedMesh | InstancedMesh } */
     instanceId?: number | undefined;
+    pointOnLine?: Vector3;
 }
 
 export interface RaycasterParameters {

three/src/extras/Earcut.d.ts

@@ -0,0 +1,15 @@
+/**
+ * An implementation of the {@link Earcut} polygon triangulation algorithm
+ * @remarks
+ * The code is a port of {@link https://github.com/mapbox/earcut | mapbox/earcut}.
+ * @see {@link https://threejs.org/docs/index.html#api/en/extras/Earcut | Official Documentation}
+ * @see {@link https://github.com/mrdoob/three.js/blob/master/src/extras/Earcut.js | Source}
+ */
+export const Earcut: {
+    /**
+     * Triangulates the given shape definition by returning an array of triangles
+     * @remarks
+     * A triangle is defined by three consecutive integers representing vertex indices.
+     */
+    triangulate(data: number[], holeIndices?: number[], dim?: number): number[];
+};

three/src/extras/core/Curve.d.ts

@@ -82,7 +82,7 @@ export abstract class Curve<T extends Vector> {
     getLengths(divisions?: number): number[];
 
     /**
-     * Update the cumlative segment distance cache
+     * Update the cumulative segment distance cache
      * @remarks
      * The method must be called every time {@link Curve} parameters are changed
      * If an updated {@link Curve} is part of a composed {@link Curve} like {@link THREE.CurvePath | CurvePath},

three/src/geometries/CapsuleGeometry.d.ts

@@ -20,7 +20,7 @@ export class CapsuleGeometry extends BufferGeometry {
      * Create a new instance of {@link CapsuleGeometry}
      * @param radius Radius of the capsule. Expects a `Float`. Default `1`
      * @param length Length of the middle section. Expects a `Float`. Default `1`
-     * @param capSubdivisions Number of curve segments used to build the caps. Expects a `Integer`. Default `4`
+     * @param capSegments Number of curve segments used to build the caps. Expects a `Integer`. Default `4`
      * @param radialSegments Number of segmented faces around the circumference of the capsule. Expects a `Integer`. Default `8`
      */
     constructor(radius?: number, length?: number, capSegments?: number, radialSegments?: number);

three/src/helpers/AxesHelper.d.ts

@@ -1,4 +1,4 @@
-import { Color } from '../math/Color.js';
+import { ColorRepresentation } from '../math/Color.js';
 import { LineSegments } from './../objects/LineSegments.js';
 
 /**
@@ -39,7 +39,7 @@ export class AxesHelper extends LineSegments {
      * @param yAxisColor
      * @param zAxisColor
      */
-    setColors(xAxisColor: Color, yAxisColor: Color, zAxisColor: Color): this;
+    setColors(xAxisColor: ColorRepresentation, yAxisColor: ColorRepresentation, zAxisColor: ColorRepresentation): this;
 
     /**
      * Frees the GPU-related resources allocated by this instance

three/src/helpers/Box3Helper.d.ts

@@ -1,5 +1,5 @@
 import { Box3 } from './../math/Box3.js';
-import { Color } from './../math/Color.js';
+import { ColorRepresentation } from './../math/Color.js';
 import { LineSegments } from './../objects/LineSegments.js';
 
 /**
@@ -20,7 +20,7 @@ export class Box3Helper extends LineSegments {
      * @param box The Box3 to show.
      * @param color The box's color. Default `0xffff00`
      */
-    constructor(box: Box3, color?: Color);
+    constructor(box: Box3, color?: ColorRepresentation);
 
     /**
      * A Read-only _string_ to check if `this` object type.

three/src/lights/Light.d.ts

@@ -38,8 +38,7 @@ export abstract class Light<TShadowSupport extends LightShadow | undefined = Lig
 
     /**
      * The light's intensity, or strength.
-     * When {@link THREE.WebGLRenderer.useLegacyLights | legacy lighting mode} is disabled, the units of intensity depend on the type of light.
-     * @remarks Expects a `Float`
+     * The units of intensity depend on the type of light.
      * @defaultValue `1`
      */
     intensity: number;

three/src/materials/Material.d.ts

@@ -13,11 +13,14 @@ import {
     StencilOp,
     PixelFormat,
 } from '../constants.js';
+import { Color, ColorRepresentation } from '../math/Color.js';
 
 export interface MaterialParameters {
     alphaHash?: boolean | undefined;
     alphaTest?: number | undefined;
     alphaToCoverage?: boolean | undefined;
+    blendAlpha?: number | undefined;
+    blendColor?: ColorRepresentation | undefined;
     blendDst?: BlendingDstFactor | undefined;
     blendDstAlpha?: number | undefined;
     blendEquation?: BlendingEquation | undefined;
@@ -86,6 +89,20 @@ export class Material extends EventDispatcher<{ dispose: {} }> {
      */
     alphaToCoverage: boolean;
 
+    /**
+     * Represents the alpha value of the constant blend color. This property has only an effect when using custom
+     * blending with {@link ConstantAlphaFactor} or {@link OneMinusConstantAlphaFactor}.
+     * @default 0
+     */
+    blendAlpha: number;
+
+    /**
+     * Represent the RGB values of the constant blend color. This property has only an effect when using custom
+     * blending with {@link ConstantColorFactor} or {@link OneMinusConstantColorFactor}.
+     * @default 0x000000
+     */
+    blendColor: Color;
+
     /**
      * Blending destination. It's one of the blending mode constants defined in Three.js. Default is {@link OneMinusSrcAlphaFactor}.
      * @default THREE.OneMinusSrcAlphaFactor
@@ -141,7 +158,7 @@ export class Material extends EventDispatcher<{ dispose: {} }> {
      * See the WebGL / clipping /intersection example. Default is null.
      * @default null
      */
-    clippingPlanes: Plane[];
+    clippingPlanes: Plane[] | null;
 
     /**
      * Defines whether to clip shadows according to the clipping planes specified on this material. Default is false.
@@ -169,7 +186,8 @@ export class Material extends EventDispatcher<{ dispose: {} }> {
     depthFunc: DepthModes;
 
     /**
-     * Whether to have depth test enabled when rendering this material. Default is true.
+     * Whether to have depth test enabled when rendering this material. When the depth test is disabled, the depth write
+     * will also be implicitly disabled.
      * @default true
      */
     depthTest: boolean;