@types/three 0.132.2 → 0.135.0

three/examples/jsm/renderers/CSS2DRenderer.d.ts

@@ -8,8 +8,12 @@ export class CSS2DObject extends Object3D {
     onAfterRender: (renderer: unknown, scene: Scene, camera: Camera) => void;
 }
 
+export type CSS2DParameters = {
+    element?: HTMLElement;
+};
+
 export class CSS2DRenderer {
-    constructor();
+    constructor(parameters?: CSS2DParameters);
     domElement: HTMLElement;
 
     getSize(): { width: number; height: number };

three/examples/jsm/renderers/CSS3DRenderer.d.ts

@@ -12,8 +12,12 @@ export class CSS3DSprite extends CSS3DObject {
     constructor(element: HTMLElement);
 }
 
+export type CSS3DParameters = {
+    element?: HTMLElement;
+};
+
 export class CSS3DRenderer {
-    constructor();
+    constructor(parameters?: CSS3DParameters);
     domElement: HTMLElement;
 
     getSize(): { width: number; height: number };

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

@@ -53,11 +53,11 @@ export class OculusHandPointerModel extends Object3D {
 
     public isAttached(): boolean;
 
-    public intersectObject(object: Object3D): Intersection[] | void;
+    public intersectObject(object: Object3D, recursive?: boolean): Intersection[] | void;
 
-    public intersectObjects(objects: Object3D[]): Intersection[] | void;
+    public intersectObjects(objects: Object3D[], recursive?: boolean): Intersection[] | void;
 
-    public checkIntersections(objects: Object3D[]): void;
+    public checkIntersections(objects: Object3D[], recursive?: boolean): void;
 
     public setCursor(distance: number): void;
 }

three/index.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for three 0.132
+// Type definitions for three 0.135
 // 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.132.2",
+    "version": "0.135.0",
     "description": "TypeScript definitions for three",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/three",
     "license": "MIT",
@@ -25,6 +25,6 @@
     },
     "scripts": {},
     "dependencies": {},
-    "typesPublisherContentHash": "688c86261a68868c7e44ee0974f12fca38a721ba8b285b2e5ac7d48169235371",
-    "typeScriptVersion": "3.7"
+    "typesPublisherContentHash": "d0154c4f95513cc2c40c0bf65e56ad0b1bd41ffca75f306c6e9bf6c0c8e6dd84",
+    "typeScriptVersion": "3.8"
 }

three/src/Three.d.ts

@@ -58,12 +58,10 @@ export * from './core/Clock';
 /**
  * Extras
  */
-export * from './extras/objects/ImmediateRenderObject';
 export * from './extras/curves/Curves';
 export * from './extras/core/Shape';
 export * from './extras/core/Path';
 export * from './extras/core/ShapePath';
-export * from './extras/core/Font';
 export * from './extras/core/CurvePath';
 export * from './extras/core/Curve';
 export * from './extras/DataUtils';
@@ -121,7 +119,6 @@ export * from './loaders/BufferGeometryLoader';
 export * from './loaders/LoadingManager';
 export * from './loaders/ImageLoader';
 export * from './loaders/ImageBitmapLoader';
-export * from './loaders/FontLoader';
 export * from './loaders/FileLoader';
 export * from './loaders/Loader';
 export * from './loaders/LoaderUtils';

three/src/cameras/OrthographicCamera.d.ts

@@ -18,7 +18,7 @@ export class OrthographicCamera extends Camera {
      * @param [near=0.1] Camera frustum near plane.
      * @param [far=2000] Camera frustum far plane.
      */
-    constructor(left: number, right: number, top: number, bottom: number, near?: number, far?: number);
+    constructor(left?: number, right?: number, top?: number, bottom?: number, near?: number, far?: number);
 
     type: 'OrthographicCamera';
 

three/src/core/Layers.d.ts

@@ -13,4 +13,5 @@ export class Layers {
     disable(channel: number): void;
     disableAll(): void;
     test(layers: Layers): boolean;
+    isEnabled(channel: number): boolean;
 }

three/src/core/Object3D.d.ts

@@ -119,6 +119,7 @@ export class Object3D<E extends BaseEvent = Event> extends EventDispatcher<E> {
      * @default new THREE.Layers()
      */
     layers: Layers;
+
     /**
      * Object gets rendered if true.
      * @default true
@@ -211,18 +212,41 @@ export class Object3D<E extends BaseEvent = Event> extends EventDispatcher<E> {
     static DefaultMatrixAutoUpdate: boolean;
 
     /**
-     * This updates the position, rotation and scale with the matrix.
+     * Applies the matrix transform to the object and updates the object's position, rotation and scale.
      */
     applyMatrix4(matrix: Matrix4): void;
 
+    /**
+     * Applies the rotation represented by the quaternion to the object.
+     */
     applyQuaternion(quaternion: Quaternion): this;
 
+    /**
+     * axis -- A normalized vector in object space.
+     * angle -- angle in radians
+     * @param axis A normalized vector in object space.
+     * @param angle angle in radians
+     */
     setRotationFromAxisAngle(axis: Vector3, angle: number): void;
 
+    /**
+     * Calls setRotationFromEuler(euler) on the .quaternion.
+     * @param euler Euler angle specifying rotation amount.
+     */
     setRotationFromEuler(euler: Euler): void;
 
+    /**
+     * Calls setFromRotationMatrix(m) on the .quaternion.
+     *
+     * Note that this assumes that the upper 3x3 of m is a pure rotation matrix (i.e, unscaled).
+     * @param m rotate the quaternion by the rotation component of the matrix.
+     */
     setRotationFromMatrix(m: Matrix4): void;
 
+    /**
+     * Copy the given quaternion into .quaternion.
+     * @param q normalized Quaternion
+     */
     setRotationFromQuaternion(q: Quaternion): void;
 
     /**
@@ -240,24 +264,25 @@ export class Object3D<E extends BaseEvent = Event> extends EventDispatcher<E> {
     rotateOnWorldAxis(axis: Vector3, angle: number): this;
 
     /**
-     *
-     * @param angle
+     * Rotates the object around x axis in local space.
+     * @param angle the angle to rotate in radians.
      */
     rotateX(angle: number): this;
 
     /**
-     *
-     * @param angle
+     * Rotates the object around y axis in local space.
+     * @param angle the angle to rotate in radians.
      */
     rotateY(angle: number): this;
 
     /**
-     *
-     * @param angle
+     * Rotates the object around z axis in local space.
+     * @param angle the angle to rotate in radians.
      */
     rotateZ(angle: number): this;
 
     /**
+     * Translate an object by distance along an axis in object space. The axis is assumed to be normalized.
      * @param axis	A normalized vector in object space.
      * @param distance	The distance to translate.
      */
@@ -294,7 +319,9 @@ export class Object3D<E extends BaseEvent = Event> extends EventDispatcher<E> {
     worldToLocal(vector: Vector3): Vector3;
 
     /**
-     * Rotates object to face point in space.
+     * Optionally, the x, y and z components of the world space position.
+     * Rotates the object to face a point in world space.
+     * This method does not support objects having non-uniformly-scaled parent(s).
      * @param vector A world vector to look at.
      */
     lookAt(vector: Vector3 | number, y?: number, z?: number): void;
@@ -361,6 +388,11 @@ export class Object3D<E extends BaseEvent = Event> extends EventDispatcher<E> {
      */
     updateMatrixWorld(force?: boolean): void;
 
+    /**
+     * Updates the global transform of the object.
+     * @param updateParents recursively updates global transform of ancestors.
+     * @param updateChildren recursively updates global transform of descendants.
+     */
     updateWorldMatrix(updateParents: boolean, updateChildren: boolean): void;
 
     toJSON(meta?: { geometries: any; materials: any; textures: any; images: any }): any;

three/src/core/Raycaster.d.ts

@@ -13,14 +13,14 @@ export interface Face {
     materialIndex: number;
 }
 
-export interface Intersection {
+export interface Intersection<TIntersected extends Object3D = Object3D> {
     distance: number;
     distanceToRay?: number | undefined;
     point: Vector3;
     index?: number | undefined;
     face?: Face | null | undefined;
     faceIndex?: number | undefined;
-    object: Object3D;
+    object: TIntersected;
     uv?: Vector2 | undefined;
     instanceId?: number | undefined;
 }
@@ -97,7 +97,11 @@ export class Raycaster {
      * @param recursive If true, it also checks all descendants. Otherwise it only checks intersecton with the object. Default is false.
      * @param optionalTarget (optional) target to set the result. Otherwise a new Array is instantiated. If set, you must clear this array prior to each call (i.e., array.length = 0;).
      */
-    intersectObject(object: Object3D, recursive?: boolean, optionalTarget?: Intersection[]): Intersection[];
+    intersectObject<TIntersected extends Object3D>(
+        object: Object3D,
+        recursive?: boolean,
+        optionalTarget?: Array<Intersection<TIntersected>>,
+    ): Array<Intersection<TIntersected>>;
 
     /**
      * Checks all intersection between the ray and the objects with or without the descendants.
@@ -107,5 +111,9 @@ export class Raycaster {
      * @param recursive If true, it also checks all descendants of the objects. Otherwise it only checks intersecton with the objects. Default is false.
      * @param optionalTarget (optional) target to set the result. Otherwise a new Array is instantiated. If set, you must clear this array prior to each call (i.e., array.length = 0;).
      */
-    intersectObjects(objects: Object3D[], recursive?: boolean, optionalTarget?: Intersection[]): Intersection[];
+    intersectObjects<TIntersected extends Object3D>(
+        objects: Object3D[],
+        recursive?: boolean,
+        optionalTarget?: Array<Intersection<TIntersected>>,
+    ): Array<Intersection<TIntersected>>;
 }

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

@@ -21,6 +21,6 @@ export class CurvePath<T extends Vector> extends Curve<T> {
 
     add(curve: Curve<T>): void;
     closePath(): void;
-    getPoint(t: number): T;
+    getPoint(t: number, optionalTarget?: T): T;
     getCurveLengths(): number[];
 }

three/src/geometries/EdgesGeometry.d.ts

@@ -1,11 +1,11 @@
 import { BufferGeometry } from '../core/BufferGeometry';
 
-export class EdgesGeometry extends BufferGeometry {
+export class EdgesGeometry<TBufferGeometry extends BufferGeometry = BufferGeometry> extends BufferGeometry {
     /**
      * @param geometry
      * @param [thresholdAngle=1]
      */
-    constructor(geometry: BufferGeometry, thresholdAngle?: number);
+    constructor(geometry?: TBufferGeometry, thresholdAngle?: number);
 
     /**
      * @default 'EdgesGeometry'
@@ -13,6 +13,7 @@ export class EdgesGeometry extends BufferGeometry {
     type: string;
 
     parameters: {
+        geometry: TBufferGeometry;
         thresholdAngle: number;
     };
 }

three/src/geometries/ExtrudeGeometry.d.ts

@@ -57,7 +57,7 @@ export interface UVGenerator {
 }
 
 export class ExtrudeGeometry extends BufferGeometry {
-    constructor(shapes: Shape | Shape[], options?: ExtrudeGeometryOptions);
+    constructor(shapes?: Shape | Shape[], options?: ExtrudeGeometryOptions);
 
     /**
      * @default 'ExtrudeGeometry'

three/src/geometries/Geometries.d.ts

@@ -8,14 +8,12 @@ export * from './ExtrudeGeometry';
 export * from './IcosahedronGeometry';
 export * from './LatheGeometry';
 export * from './OctahedronGeometry';
-export * from './ParametricGeometry';
 export * from './PlaneGeometry';
 export * from './PolyhedronGeometry';
 export * from './RingGeometry';
 export * from './ShapeGeometry';
 export * from './SphereGeometry';
 export * from './TetrahedronGeometry';
-export * from './TextGeometry';
 export * from './TorusGeometry';
 export * from './TorusKnotGeometry';
 export * from './TubeGeometry';

three/src/geometries/LatheGeometry.d.ts

@@ -8,7 +8,7 @@ export class LatheGeometry extends BufferGeometry {
      * @param [phiStart=0]
      * @param [phiLength=Math.PI * 2]
      */
-    constructor(points: Vector2[], segments?: number, phiStart?: number, phiLength?: number);
+    constructor(points?: Vector2[], segments?: number, phiStart?: number, phiLength?: number);
 
     /**
      * @default 'LatheGeometry'

three/src/geometries/PolyhedronGeometry.d.ts

@@ -7,7 +7,7 @@ export class PolyhedronGeometry extends BufferGeometry {
      * @param [radius=1]
      * @param [detail=0]
      */
-    constructor(vertices: number[], indices: number[], radius?: number, detail?: number);
+    constructor(vertices?: number[], indices?: number[], radius?: number, detail?: number);
 
     /**
      * @default 'PolyhedronGeometry'

three/src/geometries/ShapeGeometry.d.ts

@@ -7,7 +7,7 @@ export class ShapeGeometry extends BufferGeometry {
      */
     type: string;
 
-    constructor(shapes: Shape | Shape[], curveSegments?: number);
+    constructor(shapes?: Shape | Shape[], curveSegments?: number);
 
     static fromJSON(data: any): ShapeGeometry;
 }

three/src/geometries/TubeGeometry.d.ts

@@ -11,7 +11,7 @@ export class TubeGeometry extends BufferGeometry {
      * @param [closed=false]
      */
     constructor(
-        path: Curve<Vector3>,
+        path?: Curve<Vector3>,
         tubularSegments?: number,
         radius?: number,
         radiusSegments?: number,

three/src/geometries/WireframeGeometry.d.ts

@@ -1,10 +1,14 @@
 import { BufferGeometry } from './../core/BufferGeometry';
 
-export class WireframeGeometry extends BufferGeometry {
-    constructor(geometry: BufferGeometry);
+export class WireframeGeometry<TBufferGeometry extends BufferGeometry = BufferGeometry> extends BufferGeometry {
+    constructor(geometry?: TBufferGeometry);
 
     /**
      * @default 'WireframeGeometry'
      */
     type: string;
+
+    parameters: {
+        geometry: TBufferGeometry;
+    };
 }

three/src/lights/DirectionalLight.d.ts

@@ -24,7 +24,7 @@ export class DirectionalLight extends Light {
     /**
      * @default THREE.Object3D.DefaultUp
      */
-    position: Vector3;
+    readonly position: Vector3;
 
     /**
      * Target used for shadow camera orientation.

three/src/lights/LightShadow.d.ts

@@ -3,7 +3,7 @@ import { Light } from './../lights/Light';
 import { Vector2 } from './../math/Vector2';
 import { Vector4 } from './../math/Vector4';
 import { Matrix4 } from './../math/Matrix4';
-import { RenderTarget } from '../renderers/webgl/WebGLRenderLists';
+import { WebGLRenderTarget } from '../renderers/WebGLRenderTarget';
 
 export class LightShadow {
     constructor(camera: Camera);
@@ -38,12 +38,12 @@ export class LightShadow {
     /**
      * @default null
      */
-    map: RenderTarget;
+    map: WebGLRenderTarget;
 
     /**
      * @default null
      */
-    mapPass: RenderTarget;
+    mapPass: WebGLRenderTarget;
 
     /**
      * @default new THREE.Matrix4()

three/src/loaders/LoaderUtils.d.ts

@@ -1,6 +1,7 @@
 export interface LoaderUtils {
     decodeText(array: BufferSource): string;
     extractUrlBase(url: string): string;
+    resolveURL(url: string, path: string): string;
 }
 
 export const LoaderUtils: LoaderUtils;

three/src/materials/Material.d.ts

@@ -317,7 +317,7 @@ export class Material extends EventDispatcher {
      * If *null*, the value is opposite that of side, above.
      * @default null
      */
-    shadowSide: Side;
+    shadowSide: Side | null;
 
     /**
      * Defines whether this material is tone mapped according to the renderer's toneMapping setting.

three/src/materials/MeshPhysicalMaterial.d.ts

@@ -14,17 +14,19 @@ export interface MeshPhysicalMaterialParameters extends MeshStandardMaterialPara
     reflectivity?: number | undefined;
     ior?: number | undefined;
 
-    sheenTint?: Color | undefined;
+    sheen?: number | undefined;
+    sheenColor?: Color | undefined;
+    sheenRoughness?: number | undefined;
 
     transmission?: number | undefined;
     transmissionMap?: Texture | null | undefined;
     attenuationDistance?: number | undefined;
-    attenuationTint?: Color | undefined;
+    attenuationColor?: Color | undefined;
 
     specularIntensity?: number | undefined;
-    specularTint?: Color | undefined;
+    specularColor?: Color | undefined;
     specularIntensityMap?: Texture | null | undefined;
-    specularTintMap?: Texture | null | undefined;
+    specularColorMap?: Texture | null | undefined;
 }
 
 export class MeshPhysicalMaterial extends MeshStandardMaterial {
@@ -80,10 +82,30 @@ export class MeshPhysicalMaterial extends MeshStandardMaterial {
      */
     ior: number;
 
+    /**
+     * @default 0.0
+     */
+    sheen: number;
+
+    /**
+     * @default Color( 0x000000 )
+     */
+    sheenColor: Color;
+
+    /**
+     * @default null
+     */
+    sheenColorMap: Texture | null;
+
+    /**
+     * @default 1.0
+     */
+    sheenRoughness: number;
+
     /**
      * @default null
      */
-    sheenTint: Color | null;
+    sheenRoughnessMap: Texture | null;
 
     /**
      * @default 0
@@ -123,7 +145,7 @@ export class MeshPhysicalMaterial extends MeshStandardMaterial {
     /**
      * @default Color(1, 1, 1)
      */
-    specularTint: Color;
+    specularColor: Color;
 
     /**
      * @default null
@@ -133,5 +155,5 @@ export class MeshPhysicalMaterial extends MeshStandardMaterial {
     /**
      * @default null
      */
-    specularTintMap: Texture | null;
+    specularColorMap: Texture | null;
 }

three/src/math/Quaternion.d.ts

@@ -172,4 +172,6 @@ export class Quaternion {
      * @deprecated Use {@link Quaternion#invert .invert()} instead.
      */
     inverse(): Quaternion;
+
+    random(): Quaternion;
 }

three/src/math/Triangle.d.ts

@@ -3,6 +3,9 @@ import { Vector3 } from './Vector3';
 import { Plane } from './Plane';
 import { Box3 } from './Box3';
 
+import { InterleavedBufferAttribute } from '../core/InterleavedBufferAttribute';
+import { BufferAttribute } from '../core/BufferAttribute';
+
 export class Triangle {
     constructor(a?: Vector3, b?: Vector3, c?: Vector3);
 
@@ -22,7 +25,13 @@ export class Triangle {
     c: Vector3;
 
     set(a: Vector3, b: Vector3, c: Vector3): Triangle;
-    setFromPointsAndIndices(points: Vector3[], i0: number, i1: number, i2: number): Triangle;
+    setFromPointsAndIndices(points: Vector3[], i0: number, i1: number, i2: number): this;
+    setFromAttributeAndIndices(
+        attribute: BufferAttribute | InterleavedBufferAttribute,
+        i0: number,
+        i1: number,
+        i2: number,
+    ): this;
     clone(): this;
     copy(triangle: Triangle): this;
     getArea(): number;

three/src/math/Vector3.d.ts

@@ -287,4 +287,6 @@ export class Vector3 implements Vector {
      * Sets this vector's x, y and z from Math.random
      */
     random(): this;
+
+    randomDirection(): this;
 }

three/src/renderers/WebGLRenderer.d.ts

@@ -6,12 +6,13 @@ import { WebGLShadowMap } from './webgl/WebGLShadowMap';
 import { WebGLCapabilities } from './webgl/WebGLCapabilities';
 import { WebGLProperties } from './webgl/WebGLProperties';
 import { WebGLProgram } from './webgl/WebGLProgram';
-import { RenderTarget, WebGLRenderLists } from './webgl/WebGLRenderLists';
+import { WebGLRenderLists } from './webgl/WebGLRenderLists';
 import { WebGLState } from './webgl/WebGLState';
 import { Vector2 } from './../math/Vector2';
 import { Vector4 } from './../math/Vector4';
 import { Color } from './../math/Color';
 import { WebGLRenderTarget } from './WebGLRenderTarget';
+import { WebGLMultipleRenderTargets } from './WebGLMultipleRenderTargets';
 import { Object3D } from './../core/Object3D';
 import { Material } from './../materials/Material';
 import { ToneMapping, ShadowMapType, CullFace, TextureEncoding } from '../constants';
@@ -221,6 +222,7 @@ export class WebGLRenderer implements Renderer {
     getContext(): WebGLRenderingContext;
     getContextAttributes(): any;
     forceContextLoss(): void;
+    forceContextRestore(): void;
 
     /**
      * @deprecated Use {@link WebGLCapabilities#getMaxAnisotropy .capabilities.getMaxAnisotropy()} instead.
@@ -322,8 +324,6 @@ export class WebGLRenderer implements Renderer {
     resetGLState(): void;
     dispose(): void;
 
-    renderBufferImmediate(object: Object3D, program: WebGLProgram): void;
-
     renderBufferDirect(
         camera: Camera,
         scene: Scene,
@@ -375,12 +375,12 @@ export class WebGLRenderer implements Renderer {
     /**
      * Returns the current render target. If no render target is set, null is returned.
      */
-    getRenderTarget(): RenderTarget | null;
+    getRenderTarget(): WebGLRenderTarget | null;
 
     /**
      * @deprecated Use {@link WebGLRenderer#getRenderTarget .getRenderTarget()} instead.
      */
-    getCurrentRenderTarget(): RenderTarget | null;
+    getCurrentRenderTarget(): WebGLRenderTarget | null;
 
     /**
      * Sets the active render target.
@@ -389,10 +389,14 @@ export class WebGLRenderer implements Renderer {
      * @param activeCubeFace Specifies the active cube side (PX 0, NX 1, PY 2, NY 3, PZ 4, NZ 5) of {@link WebGLCubeRenderTarget}.
      * @param activeMipmapLevel Specifies the active mipmap level.
      */
-    setRenderTarget(renderTarget: RenderTarget | null, activeCubeFace?: number, activeMipmapLevel?: number): void;
+    setRenderTarget(
+        renderTarget: WebGLRenderTarget | WebGLMultipleRenderTargets | null,
+        activeCubeFace?: number,
+        activeMipmapLevel?: number,
+    ): void;
 
     readRenderTargetPixels(
-        renderTarget: RenderTarget,
+        renderTarget: WebGLRenderTarget | WebGLMultipleRenderTargets,
         x: number,
         y: number,
         width: number,

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

@@ -7,9 +7,6 @@ import { Camera } from './../../cameras/Camera';
 import { BufferGeometry } from '../../core/BufferGeometry';
 import { WebGLProperties } from './WebGLProperties';
 
-// tslint:disable-next-line:no-empty-interface
-export interface RenderTarget {} // not defined in the code, used in LightShadow and WebGRenderer classes
-
 export interface RenderItem {
     id: number;
     object: Object3D;

three/src/textures/Texture.d.ts

@@ -158,6 +158,12 @@ export class Texture extends EventDispatcher {
      */
     isRenderTargetTexture: boolean;
 
+    /**
+     * An object that can be used to store custom data about the Material. It should not hold references to functions as these will not be cloned.
+     * @default {}
+     */
+    userData: any;
+
     /**
      * @default 0
      */

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

@@ -1,19 +0,0 @@
-import { Camera, EventDispatcher } from '../../../src/Three';
-
-export class DeviceOrientationControls extends EventDispatcher {
-    constructor(object: Camera);
-
-    object: Camera;
-
-    // API
-
-    alphaOffset: number;
-    deviceOrientation: any;
-    enabled: boolean;
-    screenOrientation: number;
-
-    connect(): void;
-    disconnect(): void;
-    dispose(): void;
-    update(): void;
-}