@types/three 0.155.1 → 0.157.0

three/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/three",
-    "version": "0.155.1",
+    "version": "0.157.0",
     "description": "TypeScript definitions for three",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/three",
     "license": "MIT",
@@ -25,15 +25,13 @@
     },
     "scripts": {},
     "dependencies": {
-        "@tweenjs/tween.js": "~18.6.4",
         "@types/stats.js": "*",
         "@types/webxr": "*",
-        "fflate": "~0.6.9",
-        "lil-gui": "~0.17.0",
+        "fflate": "~0.6.10",
         "meshoptimizer": "~0.18.1"
     },
-    "typesPublisherContentHash": "e95ca925c70bfdbc8f8ae36c5d54552fba9db84a9fa72acb7f66e8234540c623",
-    "typeScriptVersion": "4.4",
+    "typesPublisherContentHash": "63c77dccf70738b5366bf087bb39ca6274f45193346ed998ac0605d8e560fe57",
+    "typeScriptVersion": "4.5",
     "exports": {
         ".": {
             "import": "./build/three.module.js",

three/src/Three.d.ts

@@ -105,8 +105,6 @@ export * from './lights/DirectionalLight.js';
 export * from './lights/AmbientLight.js';
 export * from './lights/LightShadow.js';
 export * from './lights/Light.js';
-export * from './lights/AmbientLightProbe.js';
-export * from './lights/HemisphereLightProbe.js';
 export * from './lights/LightProbe.js';
 /**
  * Loaders
@@ -158,7 +156,7 @@ export * from './math/Vector2.js';
 export * from './math/Quaternion.js';
 export * from './math/Color.js';
 export * from './math/SphericalHarmonics3.js';
-export { ColorManagement } from './math/ColorManagement.js';
+export { ColorManagement, WorkingColorSpace, DefinedColorSpace } from './math/ColorManagement.js';
 import * as MathUtils from './math/MathUtils.js';
 export { MathUtils };
 /**
@@ -234,3 +232,7 @@ export * from './textures/DepthTexture.js';
 export * from './textures/FramebufferTexture.js';
 export * from './textures/Source.js';
 export * from './textures/Texture.js';
+/**
+ * Utils
+ */
+export { createCanvasElement } from './utils.js';

three/src/animation/AnimationMixer.d.ts

@@ -5,7 +5,12 @@ import { EventDispatcher } from './../core/EventDispatcher.js';
 import { Object3D } from '../core/Object3D.js';
 import { AnimationObjectGroup } from './AnimationObjectGroup.js';
 
-export class AnimationMixer extends EventDispatcher {
+export interface AnimationMixerEventMap {
+    loop: { action: AnimationAction; loopDelta: number };
+    finished: { action: AnimationAction; direction: number };
+}
+
+export class AnimationMixer extends EventDispatcher<AnimationMixerEventMap> {
     constructor(root: Object3D | AnimationObjectGroup);
 
     /**

three/src/animation/AnimationUtils.d.ts

@@ -1,6 +1,5 @@
 import { AnimationClip } from './AnimationClip.js';
 
-export function arraySlice(array: any, from: number, to: number): any;
 export function convertArray(array: any, type: any, forceClone: boolean): any;
 export function isTypedArray(object: any): boolean;
 export function getKeyframeOrder(times: number[]): number[];

three/src/cameras/CubeCamera.d.ts

@@ -1,7 +1,7 @@
-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 { 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';
 
 /**
@@ -56,6 +56,8 @@ export class CubeCamera extends Object3D {
 
     coordinateSystem: CoordinateSystem;
 
+    activeMipmapLevel: number;
+
     updateCoordinateSystem(): void;
 
     /**

three/src/constants.d.ts

@@ -596,6 +596,8 @@ export const RGBA_ASTC_12x12_Format: 37821;
  * @remarks Require support for the _EXT_texture_compression_bptc_ WebGL extension.
  */
 export const RGBA_BPTC_Format: 36492;
+export const RGB_BPTC_SIGNED_Format = 36494;
+export const RGB_BPTC_UNSIGNED_Format = 36495;
 
 // RGTC compressed texture formats
 export const RED_RGTC1_Format: 36283;
@@ -634,6 +636,8 @@ export type CompressedPixelFormat =
     | typeof RGBA_ASTC_12x10_Format
     | typeof RGBA_ASTC_12x12_Format
     | typeof RGBA_BPTC_Format
+    | typeof RGB_BPTC_SIGNED_Format
+    | typeof RGB_BPTC_UNSIGNED_Format
     | typeof RED_RGTC1_Format
     | typeof SIGNED_RED_RGTC1_Format
     | typeof RED_GREEN_RGTC2_Format
@@ -712,11 +716,21 @@ export const NoColorSpace: '';
 export const SRGBColorSpace: 'srgb';
 export const LinearSRGBColorSpace: 'srgb-linear';
 export const DisplayP3ColorSpace: 'display-p3';
+export const LinearDisplayP3ColorSpace = 'display-p3-linear';
 export type ColorSpace =
     | typeof NoColorSpace
     | typeof SRGBColorSpace
     | typeof LinearSRGBColorSpace
-    | typeof DisplayP3ColorSpace;
+    | typeof DisplayP3ColorSpace
+    | typeof LinearDisplayP3ColorSpace;
+
+export const LinearTransfer: 'linear';
+export const SRGBTransfer: 'srgb';
+export type ColorSpaceTransfer = typeof LinearTransfer | typeof SRGBTransfer;
+
+export const Rec709Primaries: 'rec709';
+export const P3Primaries: 'p3';
+export type ColorSpacePrimaries = typeof Rec709Primaries | typeof P3Primaries;
 
 // Stencil Op types
 export const ZeroStencilOp: 0;

three/src/core/BufferGeometry.d.ts

@@ -75,7 +75,7 @@ export type NormalOrGLBufferAttributes = Record<
  */
 export class BufferGeometry<
     Attributes extends NormalOrGLBufferAttributes = NormalBufferAttributes,
-> extends EventDispatcher {
+> extends EventDispatcher<{ dispose: {} }> {
     /**
      * This creates a new {@link THREE.BufferGeometry | BufferGeometry} object.
      */

three/src/core/EventDispatcher.d.ts

@@ -1,15 +1,21 @@
-export interface BaseEvent {
-    type: string;
+/**
+ * The minimal basic Event that can be dispatched by a {@link EventDispatcher<>}.
+ */
+export interface BaseEvent<TEventType extends string = string> {
+    readonly type: TEventType;
 }
 
 /**
- * Event object.
+ * The minimal expected contract of a fired Event that was dispatched by a {@link EventDispatcher<>}.
  */
-export interface Event extends BaseEvent {
-    target?: any;
-    [attachment: string]: any;
+export interface Event<TEventType extends string = string, TTarget = unknown> {
+    readonly type: TEventType;
+    readonly target: TTarget;
 }
-export type EventListener<E, T, U> = (event: E & { type: T } & { target: U }) => void;
+
+export type EventListener<TEventData, TEventType extends string, TTarget> = (
+    event: TEventData & Event<TEventType, TTarget>,
+) => void;
 
 /**
  * JavaScript events for custom objects
@@ -32,7 +38,7 @@ export type EventListener<E, T, U> = (event: E & { type: T } & { target: U }) =>
  * @see {@link https://threejs.org/docs/index.html#api/en/core/EventDispatcher | Official Documentation}
  * @see {@link https://github.com/mrdoob/three.js/blob/master/src/core/EventDispatcher.js | Source}
  */
-export class EventDispatcher<E extends BaseEvent = Event> {
+export class EventDispatcher<TEventMap extends {} = {}> {
     /**
      * Creates {@link THREE.EventDispatcher | EventDispatcher} object.
      */
@@ -43,25 +49,37 @@ export class EventDispatcher<E extends BaseEvent = Event> {
      * @param type The type of event to listen to.
      * @param listener The function that gets called when the event is fired.
      */
-    addEventListener<T extends E['type']>(type: T, listener: EventListener<E, T, this>): void;
+    addEventListener<T extends Extract<keyof TEventMap, string>>(
+        type: T,
+        listener: EventListener<TEventMap[T], T, this>,
+    ): void;
+    addEventListener<T extends string>(type: T, listener: EventListener<{}, T, this>): void;
 
     /**
      * Checks if listener is added to an event type.
      * @param type The type of event to listen to.
      * @param listener The function that gets called when the event is fired.
      */
-    hasEventListener<T extends E['type']>(type: T, listener: EventListener<E, T, this>): boolean;
+    hasEventListener<T extends Extract<keyof TEventMap, string>>(
+        type: T,
+        listener: EventListener<TEventMap[T], T, this>,
+    ): boolean;
+    hasEventListener<T extends string>(type: T, listener: EventListener<{}, T, this>): boolean;
 
     /**
      * Removes a listener from an event type.
      * @param type The type of the listener that gets removed.
      * @param listener The listener function that gets removed.
      */
-    removeEventListener<T extends E['type']>(type: T, listener: EventListener<E, T, this>): void;
+    removeEventListener<T extends Extract<keyof TEventMap, string>>(
+        type: T,
+        listener: EventListener<TEventMap[T], T, this>,
+    ): void;
+    removeEventListener<T extends string>(type: T, listener: EventListener<{}, T, this>): void;
 
     /**
      * Fire an event type.
      * @param event The event that gets fired.
      */
-    dispatchEvent(event: E): void;
+    dispatchEvent<T extends Extract<keyof TEventMap, string>>(event: BaseEvent<T> & TEventMap[T]): void;
 }

three/src/core/Object3D.d.ts

@@ -1,19 +1,24 @@
-import { Vector3 } from './../math/Vector3.js';
-import { Euler } from './../math/Euler.js';
-import { Quaternion } from './../math/Quaternion.js';
-import { Matrix4 } from './../math/Matrix4.js';
-import { Matrix3 } from './../math/Matrix3.js';
+import { Vector3 } from '../math/Vector3.js';
+import { Euler } from '../math/Euler.js';
+import { Quaternion } from '../math/Quaternion.js';
+import { Matrix4 } from '../math/Matrix4.js';
+import { Matrix3 } from '../math/Matrix3.js';
 import { Layers } from './Layers.js';
-import { WebGLRenderer } from './../renderers/WebGLRenderer.js';
-import { Scene } from './../scenes/Scene.js';
-import { Camera } from './../cameras/Camera.js';
-import { Material } from './../materials/Material.js';
-import { Group } from './../objects/Group.js';
+import { WebGLRenderer } from '../renderers/WebGLRenderer.js';
+import { Scene } from '../scenes/Scene.js';
+import { Camera } from '../cameras/Camera.js';
+import { Material } from '../materials/Material.js';
+import { Group } from '../objects/Group.js';
 import { Intersection, Raycaster } from './Raycaster.js';
-import { EventDispatcher, BaseEvent, Event } from './EventDispatcher.js';
+import { EventDispatcher } from './EventDispatcher.js';
 import { BufferGeometry } from './BufferGeometry.js';
 import { AnimationClip } from '../animation/AnimationClip.js';
 
+export interface Object3DEventMap {
+    added: {};
+    removed: {};
+}
+
 /**
  * This is the base class for most objects in three.js and provides a set of properties and methods for manipulating objects in 3D space.
  * @remarks Note that this can be used for grouping objects via the {@link THREE.Object3D.add | .add()} method which adds the object as a child,
@@ -21,7 +26,7 @@ import { AnimationClip } from '../animation/AnimationClip.js';
  * @see {@link https://threejs.org/docs/index.html#api/en/core/Object3D | Official Documentation}
  * @see {@link https://github.com/mrdoob/three.js/blob/master/src/core/Object3D.js | Source}
  */
-export class Object3D<E extends BaseEvent = Event> extends EventDispatcher<E> {
+export class Object3D<TEventMap extends Object3DEventMap = Object3DEventMap> extends EventDispatcher<TEventMap> {
     /**
      * This creates a new {@link Object3D} object.
      */

three/src/core/Raycaster.d.ts

@@ -1,8 +1,8 @@
-import { Vector3 } from './../math/Vector3.js';
+import { Vector3 } from '../math/Vector3.js';
 import { Object3D } from './Object3D.js';
-import { Vector2 } from './../math/Vector2.js';
-import { Ray } from './../math/Ray.js';
-import { Camera } from './../cameras/Camera.js';
+import { Vector2 } from '../math/Vector2.js';
+import { Ray } from '../math/Ray.js';
+import { Camera } from '../cameras/Camera.js';
 import { Layers } from './Layers.js';
 
 export interface Face {
@@ -34,12 +34,12 @@ export interface Intersection<TIntersected extends Object3D = Object3D> {
 }
 
 export interface RaycasterParameters {
-    Mesh?: any;
-    Line?: { threshold: number } | undefined;
-    Line2?: { threshold: number } | undefined;
-    LOD?: any;
-    Points?: { threshold: number } | undefined;
-    Sprite?: any;
+    Mesh: any;
+    Line: { threshold: number };
+    Line2?: { threshold: number };
+    LOD: any;
+    Points: { threshold: number };
+    Sprite: any;
 }
 
 /**

three/src/core/RenderTarget.d.ts

@@ -9,6 +9,7 @@ import {
     MinificationTextureFilter,
     MagnificationTextureFilter,
     ColorSpace,
+    PixelFormatGPU,
 } from '../constants.js';
 
 export interface RenderTargetOptions {
@@ -21,6 +22,7 @@ export interface RenderTargetOptions {
     type?: TextureDataType | undefined; // UnsignedByteType;
     anisotropy?: number | undefined; // 1;
     colorSpace?: ColorSpace | undefined;
+    internalFormat?: PixelFormatGPU | null | undefined;
     depthBuffer?: boolean | undefined; // true;
     stencilBuffer?: boolean | undefined; // false;
     depthTexture?: DepthTexture | undefined;
@@ -33,7 +35,7 @@ export interface RenderTargetOptions {
     encoding?: TextureEncoding | undefined;
 }
 
-export class RenderTarget<TTexture extends Texture | Texture[] = Texture> extends EventDispatcher {
+export class RenderTarget<TTexture extends Texture | Texture[] = Texture> extends EventDispatcher<{ dispose: {} }> {
     constructor(width?: number, height?: number, options?: RenderTargetOptions);
 
     readonly isRenderTarget: true;

three/src/core/UniformsGroup.d.ts

@@ -6,7 +6,7 @@ import { Usage } from '../constants.js';
  * @see Example: {@link https://threejs.org/examples/#webgl2_ubo | WebGL2 / UBO}
  * @see {@link https://github.com/mrdoob/three.js/blob/master/src/core/UniformsGroup.js | Source}
  */
-export class UniformsGroup extends EventDispatcher {
+export class UniformsGroup extends EventDispatcher<{ dispose: {} }> {
     constructor();
 
     readonly isUniformsGroup: true;

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

@@ -1,5 +1,5 @@
 import { Curve } from './Curve.js';
-import { Vector } from './../../math/Vector2.js';
+import { Vector } from '../../math/Vector2.js';
 
 /**
  * Curved Path - a curve path is simply a array of connected curves, but retains the api of a curve.
@@ -41,7 +41,7 @@ export class CurvePath<T extends Vector> extends Curve<T> {
     /**
      * Adds a {@link LineCurve | lineCurve} to close the path.
      */
-    closePath(): void;
+    closePath(): this;
 
     getPoint(t: number, optionalTarget?: T): T;
 

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

@@ -52,9 +52,9 @@ export class Path extends CurvePath<Vector2> {
      * @param radius The radius of the arc. Expects a `Float`
      * @param startAngle The start angle in radians. Expects a `Float`
      * @param endAngle The end angle in radians. Expects a `Float`
-     * @param clockwise Sweep the arc clockwise. . Default `false`
+     * @param clockwise Sweep the arc clockwise. Default `false`
      */
-    absarc(aX: number, aY: number, aRadius: number, aStartAngle: number, aEndAngle: number, aClockwise: boolean): this;
+    absarc(aX: number, aY: number, aRadius: number, aStartAngle: number, aEndAngle: number, aClockwise?: boolean): this;
 
     /**
      * Adds an absolutely positioned {@link THREE.EllipseCurve | EllipseCurve} to the path.
@@ -64,7 +64,7 @@ export class Path extends CurvePath<Vector2> {
      * @param yRadius The radius of the ellipse in the y axis. Expects a `Float`
      * @param startAngle The start angle in radians. Expects a `Float`
      * @param endAngle The end angle in radians. Expects a `Float`
-     * @param clockwise Sweep the ellipse clockwise. . Default `false`
+     * @param clockwise Sweep the ellipse clockwise. Default `false`
      * @param rotation The rotation angle of the ellipse in radians, counterclockwise from the positive X axis. Optional, Expects a `Float`. Default `0`
      */
     absellipse(
@@ -74,8 +74,8 @@ export class Path extends CurvePath<Vector2> {
         yRadius: number,
         aStartAngle: number,
         aEndAngle: number,
-        aClockwise: boolean,
-        aRotation: number,
+        aClockwise?: boolean,
+        aRotation?: number,
     ): this;
 
     /**
@@ -85,9 +85,9 @@ export class Path extends CurvePath<Vector2> {
      * @param radius The radius of the arc. Expects a `Float`
      * @param startAngle The start angle in radians. Expects a `Float`
      * @param endAngle The end angle in radians. Expects a `Float`
-     * @param clockwise Sweep the arc clockwise. . Default `false`
+     * @param clockwise Sweep the arc clockwise. Default `false`
      */
-    arc(aX: number, aY: number, aRadius: number, aStartAngle: number, aEndAngle: number, aClockwise: boolean): this;
+    arc(aX: number, aY: number, aRadius: number, aStartAngle: number, aEndAngle: number, aClockwise?: boolean): this;
 
     /**
      * This creates a bezier curve from {@link .currentPoint} with (cp1X, cp1Y) and (cp2X, cp2Y) as control points and updates {@link .currentPoint} to x and y.
@@ -108,7 +108,7 @@ export class Path extends CurvePath<Vector2> {
      * @param yRadius The radius of the ellipse in the y axis. Expects a `Float`
      * @param startAngle The start angle in radians. Expects a `Float`
      * @param endAngle The end angle in radians. Expects a `Float`
-     * @param clockwise Sweep the ellipse clockwise. . Default `false`
+     * @param clockwise Sweep the ellipse clockwise. Default `false`
      * @param rotation The rotation angle of the ellipse in radians, counterclockwise from the positive X axis. Optional, Expects a `Float`. Default `0`
      */
     ellipse(
@@ -118,8 +118,8 @@ export class Path extends CurvePath<Vector2> {
         yRadius: number,
         aStartAngle: number,
         aEndAngle: number,
-        aClockwise: boolean,
-        aRotation: number,
+        aClockwise?: boolean,
+        aRotation?: number,
     ): this;
 
     /**