@types/three 0.159.0 → 0.161.0

three/src/math/Vector2.d.ts

@@ -3,140 +3,15 @@ import { BufferAttribute } from '../core/BufferAttribute.js';
 
 export type Vector2Tuple = [number, number];
 
-/**
- * ( interface Vector<T> )
- *
- * Abstract interface of {@link https://github.com/mrdoob/three.js/blob/master/src/math/Vector2.js|Vector2},
- * {@link https://github.com/mrdoob/three.js/blob/master/src/math/Vector3.js|Vector3}
- * and {@link https://github.com/mrdoob/three.js/blob/master/src/math/Vector4.js|Vector4}.
- *
- * Currently the members of Vector is NOT type safe because it accepts different typed vectors.
- *
- * Those definitions will be changed when TypeScript innovates Generics to be type safe.
- *
- * @example
- * const v:THREE.Vector = new THREE.Vector3();
- * v.addVectors(new THREE.Vector2(0, 1), new THREE.Vector2(2, 3)); // invalid but compiled successfully
- */
-export interface Vector {
-    setComponent(index: number, value: number): this;
-
-    getComponent(index: number): number;
-
-    set(...args: number[]): this;
-
-    setScalar(scalar: number): this;
-
-    /**
-     * copy(v:T):T;
-     */
-    copy(v: Vector): this;
-
-    /**
-     * NOTE: The second argument is deprecated.
-     *
-     * add(v:T):T;
-     */
-    add(v: Vector): this;
-
-    /**
-     * addVectors(a:T, b:T):T;
-     */
-    addVectors(a: Vector, b: Vector): this;
-
-    addScaledVector(vector: Vector, scale: number): this;
-
-    /**
-     * Adds the scalar value s to this vector's values.
-     */
-    addScalar(scalar: number): this;
-
-    /**
-     * sub(v:T):T;
-     */
-    sub(v: Vector): this;
-
-    /**
-     * subVectors(a:T, b:T):T;
-     */
-    subVectors(a: Vector, b: Vector): this;
-
-    /**
-     * multiplyScalar(s:number):T;
-     */
-    multiplyScalar(s: number): this;
-
-    /**
-     * divideScalar(s:number):T;
-     */
-    divideScalar(s: number): this;
-
-    /**
-     * negate():T;
-     */
-    negate(): this;
-
-    /**
-     * dot(v:T):T;
-     */
-    dot(v: Vector): number;
-
-    /**
-     * lengthSq():number;
-     */
-    lengthSq(): number;
-
-    /**
-     * length():number;
-     */
-    length(): number;
-
-    /**
-     * normalize():T;
-     */
-    normalize(): this;
-
-    /**
-     * NOTE: Vector4 doesn't have the property.
-     *
-     * distanceTo(v:T):number;
-     */
-    distanceTo?(v: Vector): number;
-
-    /**
-     * NOTE: Vector4 doesn't have the property.
-     *
-     * distanceToSquared(v:T):number;
-     */
-    distanceToSquared?(v: Vector): number;
-
-    /**
-     * setLength(l:number):T;
-     */
-    setLength(l: number): this;
-
-    /**
-     * lerp(v:T, alpha:number):T;
-     */
-    lerp(v: Vector, alpha: number): this;
-
-    /**
-     * equals(v:T):boolean;
-     */
-    equals(v: Vector): boolean;
-
-    /**
-     * clone():T;
-     */
-    clone(): Vector;
+export interface Vector2Like {
+    readonly x: number;
+    readonly y: number;
 }
 
 /**
  * 2D vector.
- *
- * ( class Vector2 implements Vector<Vector2> )
  */
-export class Vector2 implements Vector {
+export class Vector2 {
     constructor(x?: number, y?: number);
 
     /**
@@ -190,12 +65,12 @@ export class Vector2 implements Vector {
     /**
      * Copies value of v to this vector.
      */
-    copy(v: Vector2): this;
+    copy(v: Vector2Like): this;
 
     /**
      * Adds v to this vector.
      */
-    add(v: Vector2, w?: Vector2): this;
+    add(v: Vector2Like): this;
 
     /**
      * Adds the scalar value s to this vector's x and y values.
@@ -205,17 +80,17 @@ export class Vector2 implements Vector {
     /**
      * Sets this vector to a + b.
      */
-    addVectors(a: Vector2, b: Vector2): this;
+    addVectors(a: Vector2Like, b: Vector2Like): this;
 
     /**
      * Adds the multiple of v and s to this vector.
      */
-    addScaledVector(v: Vector2, s: number): this;
+    addScaledVector(v: Vector2Like, s: number): this;
 
     /**
      * Subtracts v from this vector.
      */
-    sub(v: Vector2): this;
+    sub(v: Vector2Like): this;
 
     /**
      * Subtracts s from this vector's x and y components.
@@ -225,12 +100,12 @@ export class Vector2 implements Vector {
     /**
      * Sets this vector to a - b.
      */
-    subVectors(a: Vector2, b: Vector2): this;
+    subVectors(a: Vector2Like, b: Vector2Like): this;
 
     /**
      * Multiplies this vector by v.
      */
-    multiply(v: Vector2): this;
+    multiply(v: Vector2Like): this;
 
     /**
      * Multiplies this vector by scalar s.
@@ -240,7 +115,7 @@ export class Vector2 implements Vector {
     /**
      * Divides this vector by v.
      */
-    divide(v: Vector2): this;
+    divide(v: Vector2Like): this;
 
     /**
      * Divides this vector by scalar s.
@@ -256,12 +131,12 @@ export class Vector2 implements Vector {
     /**
      * If this vector's x or y value is greater than v's x or y value, replace that value with the corresponding min value.
      */
-    min(v: Vector2): this;
+    min(v: Vector2Like): this;
 
     /**
      * If this vector's x or y value is less than v's x or y value, replace that value with the corresponding max value.
      */
-    max(v: Vector2): this;
+    max(v: Vector2Like): this;
 
     /**
      * If this vector's x or y value is greater than the max vector's x or y value, it is replaced by the corresponding value.
@@ -269,7 +144,7 @@ export class Vector2 implements Vector {
      * @param min the minimum x and y values.
      * @param max the maximum x and y values in the desired range.
      */
-    clamp(min: Vector2, max: Vector2): this;
+    clamp(min: Vector2Like, max: Vector2Like): this;
 
     /**
      * If this vector's x or y values are greater than the max value, they are replaced by the max value.
@@ -315,12 +190,12 @@ export class Vector2 implements Vector {
     /**
      * Computes dot product of this vector and v.
      */
-    dot(v: Vector2): number;
+    dot(v: Vector2Like): number;
 
     /**
      * Computes cross product of this vector and v.
      */
-    cross(v: Vector2): number;
+    cross(v: Vector2Like): number;
 
     /**
      * Computes squared length of this vector.
@@ -332,11 +207,6 @@ export class Vector2 implements Vector {
      */
     length(): number;
 
-    /**
-     * @deprecated Use {@link Vector2#manhattanLength .manhattanLength()} instead.
-     */
-    lengthManhattan(): number;
-
     /**
      * Computes the Manhattan length of this vector.
      *
@@ -362,24 +232,19 @@ export class Vector2 implements Vector {
     /**
      * Computes distance of this vector to v.
      */
-    distanceTo(v: Vector2): number;
+    distanceTo(v: Vector2Like): number;
 
     /**
      * Computes squared distance of this vector to v.
      */
-    distanceToSquared(v: Vector2): number;
-
-    /**
-     * @deprecated Use {@link Vector2#manhattanDistanceTo .manhattanDistanceTo()} instead.
-     */
-    distanceToManhattan(v: Vector2): number;
+    distanceToSquared(v: Vector2Like): number;
 
     /**
      * Computes the Manhattan length (distance) from this vector to the given vector v
      *
      * see {@link http://en.wikipedia.org/wiki/Taxicab_geometry|Wikipedia: Taxicab Geometry}
      */
-    manhattanDistanceTo(v: Vector2): number;
+    manhattanDistanceTo(v: Vector2Like): number;
 
     /**
      * Normalizes this vector and multiplies it by l.
@@ -391,7 +256,7 @@ export class Vector2 implements Vector {
      * @param v vector to interpolate towards.
      * @param alpha interpolation factor in the closed interval [0, 1].
      */
-    lerp(v: Vector2, alpha: number): this;
+    lerp(v: Vector2Like, alpha: number): this;
 
     /**
      * Sets this vector to be the vector linearly interpolated between v1 and v2 where alpha is the distance along the line connecting the two vectors - alpha = 0 will be v1, and alpha = 1 will be v2.
@@ -399,12 +264,12 @@ export class Vector2 implements Vector {
      * @param v2 vector to interpolate towards.
      * @param alpha interpolation factor in the closed interval [0, 1].
      */
-    lerpVectors(v1: Vector2, v2: Vector2, alpha: number): this;
+    lerpVectors(v1: Vector2Like, v2: Vector2Like, alpha: number): this;
 
     /**
      * Checks for strict equality of this vector and v.
      */
-    equals(v: Vector2): boolean;
+    equals(v: Vector2Like): boolean;
 
     /**
      * Sets this vector's x and y value from the provided array or array-like.
@@ -442,7 +307,7 @@ export class Vector2 implements Vector {
      * @param center the point around which to rotate.
      * @param angle the angle to rotate, in radians.
      */
-    rotateAround(center: Vector2, angle: number): this;
+    rotateAround(center: Vector2Like, angle: number): this;
 
     /**
      * Sets this vector's x and y from Math.random

three/src/math/Vector3.d.ts

@@ -1,19 +1,24 @@
 import { Euler } from './Euler.js';
 import { Matrix3 } from './Matrix3.js';
 import { Matrix4 } from './Matrix4.js';
-import { Quaternion } from './Quaternion.js';
+import { QuaternionLike } from './Quaternion.js';
 import { Camera } from '../cameras/Camera.js';
 import { Spherical } from './Spherical.js';
 import { Cylindrical } from './Cylindrical.js';
 import { BufferAttribute } from '../core/BufferAttribute.js';
 import { InterleavedBufferAttribute } from '../core/InterleavedBufferAttribute.js';
-import { Vector } from './Vector2.js';
-import { Color } from './Color.js';
+import { RGB } from './Color.js';
 
 export type Vector3Tuple = [number, number, number];
 
+export interface Vector3Like {
+    readonly x: number;
+    readonly y: number;
+    readonly z: number;
+}
+
 /**
- * 3D vector. ( class Vector3 implements Vector<Vector3> )
+ * 3D vector.
  *
  * see {@link https://github.com/mrdoob/three.js/blob/master/src/math/Vector3.js}
  *
@@ -23,7 +28,7 @@ export type Vector3Tuple = [number, number, number];
  * const c = new THREE.Vector3();
  * c.crossVectors( a, b );
  */
-export class Vector3 implements Vector {
+export class Vector3 {
     constructor(x?: number, y?: number, z?: number);
 
     /**
@@ -55,26 +60,20 @@ export class Vector3 implements Vector {
     /**
      * Sets x value of this vector.
      */
-    setX(x: number): Vector3;
+    setX(x: number): this;
 
     /**
      * Sets y value of this vector.
      */
-    setY(y: number): Vector3;
+    setY(y: number): this;
 
     /**
      * Sets z value of this vector.
      */
-    setZ(z: number): Vector3;
+    setZ(z: number): this;
 
     setComponent(index: number, value: number): this;
 
-    /**
-     * Sets this vector's {@link x}, {@link y} and {@link z} components from the r, g, and b components of the specified
-     * {@link Color | color}.
-     */
-    setFromColor(color: Color): this;
-
     getComponent(index: number): number;
 
     /**
@@ -85,42 +84,42 @@ export class Vector3 implements Vector {
     /**
      * Copies value of v to this vector.
      */
-    copy(v: Vector3): this;
+    copy(v: Vector3Like): this;
 
     /**
      * Adds v to this vector.
      */
-    add(v: Vector3): this;
+    add(v: Vector3Like): this;
 
     addScalar(s: number): this;
 
-    addScaledVector(v: Vector3, s: number): this;
-
     /**
      * Sets this vector to a + b.
      */
-    addVectors(a: Vector3, b: Vector3): this;
+    addVectors(a: Vector3Like, b: Vector3Like): this;
+
+    addScaledVector(v: Vector3, s: number): this;
 
     /**
      * Subtracts v from this vector.
      */
-    sub(a: Vector3): this;
+    sub(a: Vector3Like): this;
 
     subScalar(s: number): this;
 
     /**
      * Sets this vector to a - b.
      */
-    subVectors(a: Vector3, b: Vector3): this;
+    subVectors(a: Vector3Like, b: Vector3Like): this;
 
-    multiply(v: Vector3): this;
+    multiply(v: Vector3Like): this;
 
     /**
      * Multiplies this vector by scalar s.
      */
     multiplyScalar(s: number): this;
 
-    multiplyVectors(a: Vector3, b: Vector3): this;
+    multiplyVectors(a: Vector3Like, b: Vector3Like): this;
 
     applyEuler(euler: Euler): this;
 
@@ -132,7 +131,7 @@ export class Vector3 implements Vector {
 
     applyMatrix4(m: Matrix4): this;
 
-    applyQuaternion(q: Quaternion): this;
+    applyQuaternion(q: QuaternionLike): this;
 
     project(camera: Camera): this;
 
@@ -140,7 +139,7 @@ export class Vector3 implements Vector {
 
     transformDirection(m: Matrix4): this;
 
-    divide(v: Vector3): this;
+    divide(v: Vector3Like): this;
 
     /**
      * Divides this vector by scalar s.
@@ -148,11 +147,11 @@ export class Vector3 implements Vector {
      */
     divideScalar(s: number): this;
 
-    min(v: Vector3): this;
+    min(v: Vector3Like): this;
 
-    max(v: Vector3): this;
+    max(v: Vector3Like): this;
 
-    clamp(min: Vector3, max: Vector3): this;
+    clamp(min: Vector3Like, max: Vector3Like): this;
 
     clampScalar(min: number, max: number): this;
 
@@ -174,7 +173,7 @@ export class Vector3 implements Vector {
     /**
      * Computes dot product of this vector and v.
      */
-    dot(v: Vector3): number;
+    dot(v: Vector3Like): number;
 
     /**
      * Computes squared length of this vector.
@@ -186,14 +185,6 @@ export class Vector3 implements Vector {
      */
     length(): number;
 
-    /**
-     * Computes Manhattan length of this vector.
-     * http://en.wikipedia.org/wiki/Taxicab_geometry
-     *
-     * @deprecated Use {@link Vector3#manhattanLength .manhattanLength()} instead.
-     */
-    lengthManhattan(): number;
-
     /**
      * Computes the Manhattan length of this vector.
      *
@@ -201,13 +192,6 @@ export class Vector3 implements Vector {
      */
     manhattanLength(): number;
 
-    /**
-     * Computes the Manhattan length (distance) from this vector to the given vector v
-     *
-     * see {@link http://en.wikipedia.org/wiki/Taxicab_geometry|Wikipedia: Taxicab Geometry}
-     */
-    manhattanDistanceTo(v: Vector3): number;
-
     /**
      * Normalizes this vector.
      */
@@ -217,38 +201,40 @@ export class Vector3 implements Vector {
      * Normalizes this vector and multiplies it by l.
      */
     setLength(l: number): this;
-    lerp(v: Vector3, alpha: number): this;
+    lerp(v: Vector3Like, alpha: number): this;
 
-    lerpVectors(v1: Vector3, v2: Vector3, alpha: number): this;
+    lerpVectors(v1: Vector3Like, v2: Vector3Like, alpha: number): this;
 
     /**
      * Sets this vector to cross product of itself and v.
      */
-    cross(a: Vector3): this;
+    cross(a: Vector3Like): this;
 
     /**
      * Sets this vector to cross product of a and b.
      */
-    crossVectors(a: Vector3, b: Vector3): this;
+    crossVectors(a: Vector3Like, b: Vector3Like): this;
     projectOnVector(v: Vector3): this;
     projectOnPlane(planeNormal: Vector3): this;
-    reflect(vector: Vector3): this;
+    reflect(vector: Vector3Like): this;
     angleTo(v: Vector3): number;
 
     /**
      * Computes distance of this vector to v.
      */
-    distanceTo(v: Vector3): number;
+    distanceTo(v: Vector3Like): number;
 
     /**
      * Computes squared distance of this vector to v.
      */
-    distanceToSquared(v: Vector3): number;
+    distanceToSquared(v: Vector3Like): number;
 
     /**
-     * @deprecated Use {@link Vector3#manhattanDistanceTo .manhattanDistanceTo()} instead.
+     * Computes the Manhattan length (distance) from this vector to the given vector v
+     *
+     * see {@link http://en.wikipedia.org/wiki/Taxicab_geometry|Wikipedia: Taxicab Geometry}
      */
-    distanceToManhattan(v: Vector3): number;
+    manhattanDistanceTo(v: Vector3Like): number;
 
     setFromSpherical(s: Spherical): this;
     setFromSphericalCoords(r: number, phi: number, theta: number): this;
@@ -264,10 +250,16 @@ export class Vector3 implements Vector {
      */
     setFromEuler(e: Euler): this;
 
+    /**
+     * Sets this vector's {@link x}, {@link y} and {@link z} components from the r, g, and b components of the specified
+     * {@link Color | color}.
+     */
+    setFromColor(color: RGB): this;
+
     /**
      * Checks for strict equality of this vector and v.
      */
-    equals(v: Vector3): boolean;
+    equals(v: Vector3Like): boolean;
 
     /**
      * Sets this vector's x, y and z value from the provided array or array-like.

three/src/math/Vector4.d.ts

@@ -1,16 +1,20 @@
 import { Matrix4 } from './Matrix4.js';
-import { Quaternion } from './Quaternion.js';
+import { QuaternionLike } from './Quaternion.js';
 import { BufferAttribute } from '../core/BufferAttribute.js';
-import { Vector } from './Vector2.js';
 
 export type Vector4Tuple = [number, number, number, number];
 
+export interface Vector4Like {
+    readonly x: number;
+    readonly y: number;
+    readonly z: number;
+    readonly w: number;
+}
+
 /**
  * 4D vector.
- *
- * ( class Vector4 implements Vector<Vector4> )
  */
-export class Vector4 implements Vector {
+export class Vector4 {
     constructor(x?: number, y?: number, z?: number, w?: number);
 
     /**
@@ -79,34 +83,34 @@ export class Vector4 implements Vector {
     /**
      * Copies value of v to this vector.
      */
-    copy(v: Vector4): this;
+    copy(v: Vector4Like): this;
 
     /**
      * Adds v to this vector.
      */
-    add(v: Vector4): this;
+    add(v: Vector4Like): this;
 
     addScalar(scalar: number): this;
 
     /**
      * Sets this vector to a + b.
      */
-    addVectors(a: Vector4, b: Vector4): this;
+    addVectors(a: Vector4Like, b: Vector4Like): this;
 
-    addScaledVector(v: Vector4, s: number): this;
+    addScaledVector(v: Vector4Like, s: number): this;
     /**
      * Subtracts v from this vector.
      */
-    sub(v: Vector4): this;
+    sub(v: Vector4Like): this;
 
     subScalar(s: number): this;
 
     /**
      * Sets this vector to a - b.
      */
-    subVectors(a: Vector4, b: Vector4): this;
+    subVectors(a: Vector4Like, b: Vector4Like): this;
 
-    multiply(v: Vector4): this;
+    multiply(v: Vector4Like): this;
 
     /**
      * Multiplies this vector by scalar s.
@@ -125,7 +129,7 @@ export class Vector4 implements Vector {
      * http://www.euclideanspace.com/maths/geometry/rotations/conversions/quaternionToAngle/index.htm
      * @param q is assumed to be normalized
      */
-    setAxisAngleFromQuaternion(q: Quaternion): this;
+    setAxisAngleFromQuaternion(q: QuaternionLike): this;
 
     /**
      * http://www.euclideanspace.com/maths/geometry/rotations/conversions/matrixToAngle/index.htm
@@ -133,9 +137,9 @@ export class Vector4 implements Vector {
      */
     setAxisAngleFromRotationMatrix(m: Matrix4): this;
 
-    min(v: Vector4): this;
-    max(v: Vector4): this;
-    clamp(min: Vector4, max: Vector4): this;
+    min(v: Vector4Like): this;
+    max(v: Vector4Like): this;
+    clamp(min: Vector4Like, max: Vector4Like): this;
     clampScalar(min: number, max: number): this;
     floor(): this;
     ceil(): this;
@@ -150,7 +154,7 @@ export class Vector4 implements Vector {
     /**
      * Computes dot product of this vector and v.
      */
-    dot(v: Vector4): number;
+    dot(v: Vector4Like): number;
 
     /**
      * Computes squared length of this vector.
@@ -173,6 +177,7 @@ export class Vector4 implements Vector {
      * Normalizes this vector.
      */
     normalize(): this;
+
     /**
      * Normalizes this vector and multiplies it by l.
      */
@@ -181,14 +186,14 @@ export class Vector4 implements Vector {
     /**
      * Linearly interpolate between this vector and v with alpha factor.
      */
-    lerp(v: Vector4, alpha: number): this;
+    lerp(v: Vector4Like, alpha: number): this;
 
-    lerpVectors(v1: Vector4, v2: Vector4, alpha: number): this;
+    lerpVectors(v1: Vector4Like, v2: Vector4Like, alpha: number): this;
 
     /**
      * Checks for strict equality of this vector and v.
      */
-    equals(v: Vector4): boolean;
+    equals(v: Vector4Like): boolean;
 
     /**
      * Sets this vector's x, y, z and w value from the provided array or array-like.

three/src/objects/BatchedMesh.d.ts

@@ -162,8 +162,8 @@ declare class BatchedMesh extends Mesh<BufferGeometry, Material> {
      */
     deleteGeometry(index: number): this;
 
-    getBoundingBoxAt(index: number, target: Box3): Box3;
-    getBoundingSphereAt(index: number, target: Sphere): Sphere;
+    getBoundingBoxAt(index: number, target: Box3): Box3 | null;
+    getBoundingSphereAt(index: number, target: Sphere): Sphere | null;
 }
 
 export { BatchedMesh };