@types/three 0.184.0 → 0.185.0

three/src/math/FrustumArray.d.ts

@@ -6,22 +6,81 @@ import { Box3 } from "./Box3.js";
 import { Sphere } from "./Sphere.js";
 import { Vector3 } from "./Vector3.js";
 
-declare class FrustumArray {
+/**
+ * FrustumArray is used to determine if an object is visible in at least one camera
+ * from an array of cameras. This is particularly useful for multi-view renderers.
+ */
+export class FrustumArray {
+    /**
+     * The coordinate system to use.
+     *
+     * @type {WebGLCoordinateSystem|WebGPUCoordinateSystem}
+     * @default WebGLCoordinateSystem
+     */
     coordinateSystem: CoordinateSystem;
-
-    constructor();
-
-    intersectsObject(object: Object3D, cameraArray: ArrayCamera): boolean;
-
-    intersectsSprite(sprite: Sprite, cameraArray: ArrayCamera): boolean;
-
-    intersectsSprite(sphere: Sphere, cameraArray: ArrayCamera): boolean;
-
-    intersectsBox(box: Box3, cameraArray: ArrayCamera): boolean;
-
-    containsPoint(point: Vector3, cameraArray: ArrayCamera): boolean;
-
+    /**
+     * Computes and caches a frustum for each camera of the given array camera.
+     *
+     * @param {ArrayCamera} cameraArray - The array camera whose sub-cameras define the frustums.
+     * @return {FrustumArray} A reference to this frustum array.
+     */
+    setFromArrayCamera(cameraArray: ArrayCamera): FrustumArray;
+    /**
+     * Returns `true` if the 3D object's bounding sphere is intersecting any cached frustum.
+     *
+     * {@link FrustumArray#setFromArrayCamera} must be called once per render before this method.
+     *
+     * @param {Object3D} object - The 3D object to test.
+     * @return {boolean} Whether the 3D object is visible in any camera.
+     */
+    intersectsObject(object: Object3D): boolean;
+    /**
+     * Returns `true` if the given sprite is intersecting any cached frustum.
+     *
+     * {@link FrustumArray#setFromArrayCamera} must be called once per render before this method.
+     *
+     * @param {Sprite} sprite - The sprite to test.
+     * @return {boolean} Whether the sprite is visible in any camera.
+     */
+    intersectsSprite(sprite: Sprite): boolean;
+    /**
+     * Returns `true` if the given bounding sphere is intersecting any cached frustum.
+     *
+     * {@link FrustumArray#setFromArrayCamera} must be called once per render before this method.
+     *
+     * @param {Sphere} sphere - The bounding sphere to test.
+     * @return {boolean} Whether the sphere is visible in any camera.
+     */
+    intersectsSphere(sphere: Sphere): boolean;
+    /**
+     * Returns `true` if the given bounding box is intersecting any cached frustum.
+     *
+     * {@link FrustumArray#setFromArrayCamera} must be called once per render before this method.
+     *
+     * @param {Box3} box - The bounding box to test.
+     * @return {boolean} Whether the box is visible in any camera.
+     */
+    intersectsBox(box: Box3): boolean;
+    /**
+     * Returns `true` if the given point lies within any cached frustum.
+     *
+     * {@link FrustumArray#setFromArrayCamera} must be called once per render before this method.
+     *
+     * @param {Vector3} point - The point to test.
+     * @return {boolean} Whether the point is visible in any camera.
+     */
+    containsPoint(point: Vector3): boolean;
+    /**
+     * Copies the values of the given frustum array to this instance.
+     *
+     * @param {FrustumArray} frustumArray - The frustum array to copy.
+     * @return {FrustumArray} A reference to this frustum array.
+     */
+    copy(source: FrustumArray): this;
+    /**
+     * Returns a new frustum array with copied values from this instance.
+     *
+     * @return {FrustumArray} A clone of this instance.
+     */
     clone(): FrustumArray;
 }
-
-export { FrustumArray };

three/src/math/Interpolant.d.ts

@@ -1,10 +1,113 @@
-export abstract class Interpolant {
-    constructor(parameterPositions: any, sampleValues: any, sampleSize: number, resultBuffer?: any);
+import { TypedArray } from "../core/BufferAttribute.js";
 
-    parameterPositions: any;
-    sampleValues: any;
-    valueSize: number;
-    resultBuffer: any;
-
-    evaluate(time: number): any;
+/**
+ * Abstract base class of interpolants over parametric samples.
+ *
+ * The parameter domain is one dimensional, typically the time or a path
+ * along a curve defined by the data.
+ *
+ * The sample values can have any dimensionality and derived classes may
+ * apply special interpretations to the data.
+ *
+ * This class provides the interval seek in a Template Method, deferring
+ * the actual interpolation to derived classes.
+ *
+ * Time complexity is O(1) for linear access crossing at most two points
+ * and O(log N) for random access, where N is the number of positions.
+ *
+ * References: {@link http://www.oodesign.com/template-method-pattern.html}
+ *
+ * @abstract
+ */
+export abstract class Interpolant<TSettings = {}> {
+    /**
+     * Constructs a new interpolant.
+     *
+     * @param {TypedArray} parameterPositions - The parameter positions hold the interpolation factors.
+     * @param {TypedArray} sampleValues - The sample values.
+     * @param {number} sampleSize - The sample size
+     * @param {TypedArray} [resultBuffer] - The result buffer.
+     */
+    constructor(
+        parameterPositions: TypedArray,
+        sampleValues: TypedArray,
+        sampleSize: number,
+        resultBuffer?: TypedArray,
+    );
+    /**
+     * The parameter positions.
+     *
+     * @type {TypedArray}
+     */
+    parameterPositions: TypedArray;
+    /**
+     * The result buffer.
+     *
+     * @type {TypedArray}
+     */
+    resultBuffer: TypedArray;
+    /**
+     * The sample values.
+     *
+     * @type {TypedArray}
+     */
+    sampleValues: TypedArray;
+    /**
+     * The value size.
+     *
+     * @type {TypedArray}
+     */
+    valueSize: TypedArray;
+    /**
+     * The interpolation settings.
+     *
+     * @type {?Object}
+     * @default null
+     */
+    settings: TSettings | null;
+    /**
+     * The default settings object.
+     *
+     * @type {Object}
+     */
+    DefaultSettings_: TSettings;
+    /**
+     * Evaluate the interpolant at position `t`.
+     *
+     * @param {number} t - The interpolation factor.
+     * @return {TypedArray} The result buffer.
+     */
+    evaluate(t: number): TypedArray;
+    /**
+     * Returns the interpolation settings.
+     *
+     * @return {Object} The interpolation settings.
+     */
+    getSettings_(): unknown;
+    /**
+     * Copies a sample value to the result buffer.
+     *
+     * @param {number} index - An index into the sample value buffer.
+     * @return {TypedArray} The result buffer.
+     */
+    copySampleValue_(index: number): TypedArray;
+    /**
+     * Copies a sample value to the result buffer.
+     *
+     * @abstract
+     * @param {number} i1 - An index into the sample value buffer.
+     * @param {number} t0 - The previous interpolation factor.
+     * @param {number} t - The current interpolation factor.
+     * @param {number} t1 - The next interpolation factor.
+     * @return {TypedArray} The result buffer.
+     */
+    abstract interpolate_(i1: number, t0: number, t: number, t1: number): TypedArray;
+    /**
+     * Optional method that is executed when the interval has changed.
+     *
+     * @param {number} i1 - An index into the sample value buffer.
+     * @param {number} t0 - The previous interpolation factor.
+     * @param {number} t - The current interpolation factor.
+     */
+    intervalChanged_(i1: number, t0: number, t: number): void;
 }

three/src/math/Matrix2.d.ts

@@ -12,7 +12,7 @@ export type Matrix2Tuple = [
  * const m = new Matrix2();
  */
 export class Matrix2 {
-    static readonly isMatrix2: boolean;
+    readonly isMatrix2: true;
 
     /**
      * A {@link https://en.wikipedia.org/wiki/Row-_and_column-major_order column-major} list of matrix values.

three/src/math/Matrix3.d.ts

@@ -17,7 +17,7 @@ export type Matrix3Tuple = [
 ];
 
 export class Matrix3 {
-    static readonly isMatrix3: boolean;
+    readonly isMatrix3: true;
 
     /**
      * Array with matrix values.
@@ -99,10 +99,19 @@ export class Matrix3 {
 
     setUvTransform(tx: number, ty: number, sx: number, sy: number, rotation: number, cx: number, cy: number): this;
 
+    /**
+     * @deprecated Use .makeScale() instead.
+     */
     scale(sx: number, sy: number): this;
 
+    /**
+     * @deprecated Use .makeRotation() instead.
+     */
     rotate(theta: number): this;
 
+    /**
+     * @deprecated Use .makeTranslation() instead.
+     */
     translate(tx: number, ty: number): this;
 
     /**