@types/three 0.181.0 → 0.183.0

three/src/constants.d.ts

@@ -50,13 +50,15 @@ export const AdditiveBlending: 2;
 export const SubtractiveBlending: 3;
 export const MultiplyBlending: 4;
 export const CustomBlending: 5;
+export const MaterialBlending: 6;
 export type Blending =
     | typeof NoBlending
     | typeof NormalBlending
     | typeof AdditiveBlending
     | typeof SubtractiveBlending
     | typeof MultiplyBlending
-    | typeof CustomBlending;
+    | typeof CustomBlending
+    | typeof MaterialBlending;
 
 // custom blending equations
 // (numbers start from 100 not to clash with other
@@ -508,6 +510,11 @@ export const RGB_ETC2_Format: 37492;
  */
 export const RGBA_ETC2_EAC_Format: 37496;
 
+export const R11_EAC_Format: 37488;
+export const SIGNED_R11_EAC_Format: 37489;
+export const RG11_EAC_Format: 37490;
+export const SIGNED_RG11_EAC_Format: 37491;
+
 // ASTC compressed texture formats
 
 /**
@@ -598,6 +605,10 @@ export type CompressedPixelFormat =
     | typeof RGB_ETC1_Format
     | typeof RGB_ETC2_Format
     | typeof RGBA_ETC2_EAC_Format
+    | typeof R11_EAC_Format
+    | typeof SIGNED_R11_EAC_Format
+    | typeof RG11_EAC_Format
+    | typeof SIGNED_RG11_EAC_Format
     | typeof RGBA_ASTC_4x4_Format
     | typeof RGBA_ASTC_5x4_Format
     | typeof RGBA_ASTC_5x5_Format
@@ -642,7 +653,12 @@ export type AnimationActionLoopStyles = typeof LoopOnce | typeof LoopRepeat | ty
 export const InterpolateDiscrete: 2300;
 export const InterpolateLinear: 2301;
 export const InterpolateSmooth: 2302;
-export type InterpolationModes = typeof InterpolateDiscrete | typeof InterpolateLinear | typeof InterpolateSmooth;
+export const InterpolateBezier: 2303;
+export type InterpolationModes =
+    | typeof InterpolateDiscrete
+    | typeof InterpolateLinear
+    | typeof InterpolateSmooth
+    | typeof InterpolateBezier;
 
 // Interpolant ending modes
 export const ZeroCurvatureEnding: 2400;
@@ -693,6 +709,11 @@ export const LinearTransfer: "linear";
 export const SRGBTransfer: "srgb";
 export type ColorSpaceTransfer = typeof LinearTransfer | typeof SRGBTransfer;
 
+export const NoNormalPacking: "";
+export const NormalRGPacking: "rg";
+export const NormalGAPacking: "ga";
+export type NormalPacking = typeof NoNormalPacking | typeof NormalRGPacking | typeof NormalGAPacking;
+
 // Stencil Op types
 export const ZeroStencilOp: 0;
 export const KeepStencilOp: 7680;
@@ -810,6 +831,11 @@ export type InterpolationSamplingMode =
     | typeof InterpolationSamplingMode.FIRST
     | typeof InterpolationSamplingMode.EITHER;
 
+export const Compatibility: {
+    TEXTURE_COMPARE: "depthTextureCompare";
+};
+export type Compatibility = typeof Compatibility.TEXTURE_COMPARE;
+
 ///////////////////////////////////////////////////////////////////////////////
 // Texture - Internal Pixel Formats
 

three/src/core/BufferGeometry.d.ts

@@ -163,6 +163,8 @@ export class BufferGeometry<
 
     indirect: IndirectStorageBufferAttribute | null;
 
+    indirectOffset: number | number[];
+
     /**
      * This hashmap has as id the name of the attribute to be set and as value the {@link THREE.BufferAttribute | buffer} to set it to. Rather than accessing this property directly,
      * use {@link setAttribute | .setAttribute} and {@link getAttribute | .getAttribute} to access attributes of this geometry.
@@ -243,7 +245,7 @@ export class BufferGeometry<
      */
     setIndex(index: BufferAttribute | number[] | null): this;
 
-    setIndirect(indirect: IndirectStorageBufferAttribute | null): this;
+    setIndirect(indirect: IndirectStorageBufferAttribute | null, indirectOffset?: number | number[]): this;
 
     getIndirect(): IndirectStorageBufferAttribute | null;
 

three/src/core/Clock.d.ts

@@ -3,10 +3,13 @@
  * [performance.now]{@link https://developer.mozilla.org/en-US/docs/Web/API/Performance/now}.
  * @see [Official Documentation]{@link https://threejs.org/docs/index.html#api/en/core/Clock}
  * @see [Source]{@link https://github.com/mrdoob/three.js/blob/master/src/core/Clock.js}
+ *
+ * @deprecated Please use THREE.Timer instead.
  */
 export class Clock {
     /**
      * Create a new instance of {@link THREE.Clock | Clock}
+     * @deprecated Please use THREE.Timer instead.
      * @param autoStart - Whether to automatically start the clock when {@link getDelta | .getDelta()} is called for the first time. Default `true`
      */
     constructor(autoStart?: boolean);

three/src/core/Object3D.d.ts

@@ -28,12 +28,15 @@ export interface Object3DJSONObject {
     visible?: boolean;
     frustumCulled?: boolean;
     renderOrder?: number;
+    static?: boolean;
     userData?: Record<string, unknown>;
 
     layers: number;
     matrix: Matrix4Tuple;
     up: Vector3Tuple;
 
+    pivot?: Vector3Tuple;
+
     matrixAutoUpdate?: boolean;
 
     material?: string | string[];
@@ -265,13 +268,6 @@ export class Object3D<TEventMap extends Object3DEventMap = Object3DEventMap> ext
      */
     animations: AnimationClip[];
 
-    /**
-     * An object that can be used to store custom data about the {@link Object3D}.
-     * @remarks It should not hold references to _functions_ as these **will not** be cloned.
-     * @default `{}`
-     */
-    userData: Record<string, any>;
-
     /**
      * Custom depth material to be used when rendering to the depth map.
      * @remarks Can only be used in context of meshes.
@@ -287,6 +283,34 @@ export class Object3D<TEventMap extends Object3DEventMap = Object3DEventMap> ext
      */
     customDistanceMaterial?: Material | undefined;
 
+    /**
+     * Whether the 3D object is supposed to be static or not. If set to `true`, it means
+     * the 3D object is not going to be changed after the initial renderer. This includes
+     * geometry and material settings. A static 3D object can be processed by the renderer
+     * slightly faster since certain state checks can be bypassed.
+     *
+     * Only relevant in context of {@link WebGPURenderer}.
+     *
+     * @default false
+     */
+    static: boolean;
+
+    /**
+     * An object that can be used to store custom data about the {@link Object3D}.
+     * @remarks It should not hold references to _functions_ as these **will not** be cloned.
+     * @default `{}`
+     */
+    userData: Record<string, any>;
+
+    /**
+     * The pivot point for rotation and scale transformations.
+     * When set, rotation and scale are applied around this point
+     * instead of the object's origin.
+     *
+     * @default null
+     */
+    pivot: Vector3 | null;
+
     /**
      * An optional callback that is executed immediately before a 3D object is rendered to a shadow map.
      * @remarks This function is called with the following parameters: renderer, scene, camera, shadowCamera, geometry,

three/src/extras/Controls.d.ts

@@ -14,7 +14,7 @@ declare abstract class Controls<TEventMap extends {}> extends EventDispatcher<TE
      * The HTML element used for event listeners. If not provided via the constructor, {@link .connect} must be called
      * after `domElement` has been set.
      */
-    domElement: HTMLElement | null;
+    domElement: HTMLElement | SVGElement | null;
 
     /**
      * When set to `false`, the controls will not respond to user input. Default is `true`.
@@ -26,13 +26,13 @@ declare abstract class Controls<TEventMap extends {}> extends EventDispatcher<TE
      * @param object The object the controls should manage (usually the camera).
      * @param domElement The HTML element used for event listeners. (optional)
      */
-    constructor(object: Object3D, domElement?: HTMLElement | null);
+    constructor(object: Object3D, domElement?: HTMLElement | SVGElement | null);
 
     /**
      * Connects the controls to the DOM. This method has so called "side effects" since it adds the module's event
      * listeners to the DOM.
      */
-    connect(element: HTMLElement): void;
+    connect(element: HTMLElement | SVGElement): void;
 
     /**
      * Disconnects the controls from the DOM.

three/src/geometries/TorusGeometry.d.ts

@@ -1,5 +1,13 @@
 import { BufferGeometry } from "../core/BufferGeometry.js";
 
+export interface TorusGeometryJSON {
+    radius: number;
+    tube: number;
+    radialSegments: number;
+    tubularSegments: number;
+    arc: number;
+}
+
 /**
  * A class for generating torus geometries.
  * @example
@@ -21,8 +29,18 @@ export class TorusGeometry extends BufferGeometry {
      * @param radialSegments Default is `12`.
      * @param tubularSegments Default is `48`.
      * @param arc Central angle. Default is Math.PI * 2.
+     * @param {number} [thetaStart=0] - Start of the tubular sweep in radians.
+     * @param {number} [thetaLength=Math.PI times 2] - Length of the tubular sweep in radians.
      */
-    constructor(radius?: number, tube?: number, radialSegments?: number, tubularSegments?: number, arc?: number);
+    constructor(
+        radius?: number,
+        tube?: number,
+        radialSegments?: number,
+        tubularSegments?: number,
+        arc?: number,
+        thetaStart?: number,
+        thetaLength?: number,
+    );
 
     /**
      * A Read-only _string_ to check if `this` object type.
@@ -41,8 +59,9 @@ export class TorusGeometry extends BufferGeometry {
         readonly radialSegments: number;
         readonly tubularSegments: number;
         readonly arc: number;
+        readonly thetaStart: number;
+        readonly thetaLength: number;
     };
 
-    /** @internal */
-    static fromJSON(data: any): TorusGeometry;
+    static fromJSON(data: TorusGeometryJSON): TorusGeometry;
 }

three/src/helpers/ArrowHelper.d.ts

@@ -6,30 +6,31 @@ import { Mesh } from "../objects/Mesh.js";
 
 /**
  * An 3D arrow object for visualizing directions.
- * @example
- * ```typescript
- * const dir = new THREE.Vector3(1, 2, 0);
+ *
+ * ```js
+ * const dir = new THREE.Vector3( 1, 2, 0 );
+ *
  * //normalize the direction vector (convert to vector of length 1)
  * dir.normalize();
- * const origin = new THREE.Vector3(0, 0, 0);
+ *
+ * const origin = new THREE.Vector3( 0, 0, 0 );
  * const length = 1;
  * const hex = 0xffff00;
- * const {@link ArrowHelper} = new THREE.ArrowHelper(dir, origin, length, hex);
- * scene.add(arrowHelper);
+ *
+ * const arrowHelper = new THREE.ArrowHelper( dir, origin, length, hex );
+ * scene.add( arrowHelper );
  * ```
- * @see Example: {@link https://threejs.org/examples/#webgl_shadowmesh | WebGL / shadowmesh}
- * @see {@link https://threejs.org/docs/index.html#api/en/helpers/ArrowHelper | Official Documentation}
- * @see {@link https://github.com/mrdoob/three.js/blob/master/src/helpers/ArrowHelper.js | Source}
  */
 export class ArrowHelper extends Object3D {
     /**
-     * Create a new instance of {@link ArrowHelper}
-     * @param dir Direction from origin. Must be a unit vector. Default `new THREE.Vector3(0, 0, 1)`
-     * @param origin Point at which the arrow starts. Default `new THREE.Vector3(0, 0, 0)`
-     * @param length Length of the arrow. Default `1`
-     * @param hex Hexadecimal value to define color. Default `0xffff00`
-     * @param headLength The length of the head of the arrow. Default `0.2 * length`
-     * @param headWidth The width of the head of the arrow. Default `0.2 * headLength`
+     * Constructs a new arrow helper.
+     *
+     * @param {Vector3} [dir=(0, 0, 1)] - The (normalized) direction vector.
+     * @param {Vector3} [origin=(0, 0, 0)] - Point at which the arrow starts.
+     * @param {number} [length=1] - Length of the arrow in world units.
+     * @param {(number|Color|string)} [color=0xffff00] - Color of the arrow.
+     * @param {number} [headLength=length times 0.2] - The length of the head of the arrow.
+     * @param {number} [headWidth=headLength times 0.2] - The width of the head of the arrow.
      */
     constructor(
         dir?: Vector3,
@@ -39,55 +40,38 @@ export class ArrowHelper extends Object3D {
         headLength?: number,
         headWidth?: number,
     );
-
-    /**
-     * A Read-only _string_ to check if `this` object type.
-     * @remarks Sub-classes will update this value.
-     * @override
-     * @defaultValue `ArrowHelper`
-     */
-    override readonly type: string | "ArrowHelper";
-
     /**
-     * Contains the line part of the arrowHelper.
+     * The line part of the arrow helper.
      */
     line: Line;
-
     /**
-     * Contains the cone part of the arrowHelper.
+     * The cone part of the arrow helper.
      */
     cone: Mesh;
-
-    /**
-     * Sets the color of the arrowHelper.
-     * @param color The desired color.
-     */
-    setColor(color: ColorRepresentation): void;
-
     /**
-     * @param dir The desired direction. Must be a unit vector.
+     * Sets the direction of the helper.
+     *
+     * @param {Vector3} dir - The normalized direction vector.
      */
     setDirection(dir: Vector3): void;
-
     /**
-     * Sets the length of the arrowhelper.
-     * @param length The desired length.
-     * @param headLength The length of the head of the arrow. Default `0.2 * length`
-     * @param headWidth The width of the head of the arrow. Default `0.2 * headLength`
+     * Sets the length of the helper.
+     *
+     * @param {number} length - Length of the arrow in world units.
+     * @param {number} [headLength=length times 0.2] - The length of the head of the arrow.
+     * @param {number} [headWidth=headLength times 0.2] - The width of the head of the arrow.
      */
     setLength(length: number, headLength?: number, headWidth?: number): void;
-
     /**
-     * Copy the given object into this object
-     * @remarks Note: event listeners and user-defined callbacks ({@link onAfterRender | .onAfterRender} and {@link onBeforeRender | .onBeforeRender}) are not copied.
-     * @param source
+     * Sets the color of the helper.
+     *
+     * @param {number|Color|string} color - The color to set.
      */
-    override copy(source: this): this;
-
+    setColor(color: ColorRepresentation): void;
+    copy(source: ArrowHelper): this;
     /**
-     * Frees the GPU-related resources allocated by this instance
-     * @remarks
-     * Call this method whenever this instance is no longer used in your app.
+     * Frees the GPU-related resources allocated by this instance. Call this
+     * method whenever this instance is no longer used in your app.
      */
     dispose(): void;
 }

three/src/helpers/AxesHelper.d.ts

@@ -1,52 +1,38 @@
-import { BufferGeometry } from "../core/BufferGeometry.js";
-import { LineBasicMaterial } from "../materials/LineBasicMaterial.js";
 import { ColorRepresentation } from "../math/Color.js";
 import { LineSegments } from "../objects/LineSegments.js";
 
 /**
  * An axis object to visualize the 3 axes in a simple way.
- * @remarks
- * The X axis is red
- * The Y axis is green
- * The Z axis is blue.
- * @example
- * ```typescript
- * const {@link AxesHelper} = new THREE.AxesHelper(5);
- * scene.add(axesHelper);
+ * The X axis is red. The Y axis is green. The Z axis is blue.
+ *
+ * ```js
+ * const axesHelper = new THREE.AxesHelper( 5 );
+ * scene.add( axesHelper );
  * ```
- * @see Example: {@link https://threejs.org/examples/#webgl_buffergeometry_compression | WebGL / buffergeometry / compression}
- * @see Example: {@link https://threejs.org/examples/#webgl_geometry_convex | WebGL / geometry / convex}
- * @see Example: {@link https://threejs.org/examples/#webgl_loader_nrrd | WebGL / loader / nrrd}
- * @see {@link https://threejs.org/docs/index.html#api/en/helpers/AxesHelper | Official Documentation}
- * @see {@link https://github.com/mrdoob/three.js/blob/master/src/helpers/AxesHelper.js | Source}
  */
-export class AxesHelper extends LineSegments<BufferGeometry, LineBasicMaterial> {
+export class AxesHelper extends LineSegments {
     /**
-     * Create a new instance of {@link AxesHelper}
-     * @param size Size of the lines representing the axes. Default `1`
+     * Constructs a new axes helper.
+     *
+     * @param {number} [size=1] - Size of the lines representing the axes.
      */
     constructor(size?: number);
-
     /**
-     * A Read-only _string_ to check if `this` object type.
-     * @remarks Sub-classes will update this value.
-     * @override
-     * @defaultValue `AxesHelper`
+     * Defines the colors of the axes helper.
+     *
+     * @param {number|Color|string} xAxisColor - The color for the x axis.
+     * @param {number|Color|string} yAxisColor - The color for the y axis.
+     * @param {number|Color|string} zAxisColor - The color for the z axis.
+     * @return {AxesHelper} A reference to this axes helper.
      */
-    override readonly type: string | "AxesHelper";
-
-    /**
-     * Sets the axes colors to {@link Color | xAxisColor}, {@link Color | yAxisColor}, {@link Color | zAxisColor}.
-     * @param xAxisColor
-     * @param yAxisColor
-     * @param zAxisColor
-     */
-    setColors(xAxisColor: ColorRepresentation, yAxisColor: ColorRepresentation, zAxisColor: ColorRepresentation): this;
-
+    setColors(
+        xAxisColor: ColorRepresentation,
+        yAxisColor: ColorRepresentation,
+        zAxisColor: ColorRepresentation,
+    ): AxesHelper;
     /**
-     * Frees the GPU-related resources allocated by this instance
-     * @remarks
-     * Call this method whenever this instance is no longer used in your app.
+     * Frees the GPU-related resources allocated by this instance. Call this
+     * method whenever this instance is no longer used in your app.
      */
     dispose(): void;
 }

three/src/helpers/Box3Helper.d.ts

@@ -3,42 +3,31 @@ import { ColorRepresentation } from "../math/Color.js";
 import { LineSegments } from "../objects/LineSegments.js";
 
 /**
- * Helper object to visualize a {@link THREE.Box3 | Box3}.
- * @example
- * ```typescript
+ * A helper object to visualize an instance of {@link Box3}.
+ *
+ * ```js
  * const box = new THREE.Box3();
- * box.setFromCenterAndSize(new THREE.Vector3(1, 1, 1), new THREE.Vector3(2, 1, 3));
- * const helper = new THREE.Box3Helper(box, 0xffff00);
- * scene.add(helper);
+ * box.setFromCenterAndSize( new THREE.Vector3( 1, 1, 1 ), new THREE.Vector3( 2, 1, 3 ) );
+ *
+ * const helper = new THREE.Box3Helper( box, 0xffff00 );
+ * scene.add( helper )
  * ```
- * @see {@link https://threejs.org/docs/index.html#api/en/helpers/Box3Helper | Official Documentation}
- * @see {@link https://github.com/mrdoob/three.js/blob/master/src/helpers/Box3Helper.js | Source}
  */
 export class Box3Helper extends LineSegments {
     /**
-     * Creates a new wireframe box that represents the passed Box3.
-     * @param box The Box3 to show.
-     * @param color The box's color. Default `0xffff00`
+     * Constructs a new box3 helper.
+     *
+     * @param {Box3} box - The box to visualize.
+     * @param {number|Color|string} [color=0xffff00] - The box's color.
      */
     constructor(box: Box3, color?: ColorRepresentation);
-
     /**
-     * A Read-only _string_ to check if `this` object type.
-     * @remarks Sub-classes will update this value.
-     * @override
-     * @defaultValue `Box3Helper`
-     */
-    override readonly type: string | "Box3Helper";
-
-    /**
-     * The Box3 being visualized.
+     * The box being visualized.
      */
     box: Box3;
-
     /**
-     * Frees the GPU-related resources allocated by this instance
-     * @remarks
-     * Call this method whenever this instance is no longer used in your app.
+     * Frees the GPU-related resources allocated by this instance. Call this
+     * method whenever this instance is no longer used in your app.
      */
     dispose(): void;
 }

three/src/helpers/BoxHelper.d.ts

@@ -1,64 +1,53 @@
 import { BufferGeometry } from "../core/BufferGeometry.js";
 import { Object3D } from "../core/Object3D.js";
 import { LineBasicMaterial } from "../materials/LineBasicMaterial.js";
+import { Box3 } from "../math/Box3.js";
 import { ColorRepresentation } from "../math/Color.js";
 import { LineSegments } from "../objects/LineSegments.js";
 
 /**
- * Helper object to graphically show the world-axis-aligned bounding box around an object
- * @remarks
- * The actual bounding box is handled with {@link THREE.Box3 | Box3}, this is just a visual helper for debugging
- * It can be automatically resized with the {@link THREE.BoxHelper.update | BoxHelper.update} method when the object it's created from is transformed
- * Note that the object must have a {@link THREE.BufferGeometry | BufferGeometry} for this to work, so it won't work with {@link Sprite | Sprites}.
- * @example
- * ```typescript
+ * Helper object to graphically show the world-axis-aligned bounding box
+ * around an object. The actual bounding box is handled with {@link Box3},
+ * this is just a visual helper for debugging. It can be automatically
+ * resized with {@link BoxHelper#update} when the object it's created from
+ * is transformed. Note that the object must have a geometry for this to work,
+ * so it won't work with sprites.
+ *
+ * ```js
  * const sphere = new THREE.SphereGeometry();
- * const object = new THREE.Mesh(sphere, new THREE.MeshBasicMaterial(0xff0000));
- * const box = new THREE.BoxHelper(object, 0xffff00);
- * scene.add(box);
+ * const object = new THREE.Mesh( sphere, new THREE.MeshBasicMaterial( 0xff0000 ) );
+ * const box = new THREE.BoxHelper( object, 0xffff00 );
+ * scene.add( box );
  * ```
- * @see Example: {@link https://threejs.org/examples/#webgl_helpers | WebGL / helpers}
- * @see Example: {@link https://threejs.org/examples/#webgl_loader_nrrd | WebGL / loader / nrrd}
- * @see Example: {@link https://threejs.org/examples/#webgl_buffergeometry_drawrange | WebGL / buffergeometry / drawrange}
- * @see {@link https://threejs.org/docs/index.html#api/en/helpers/BoxHelper | Official Documentation}
- * @see {@link https://github.com/mrdoob/three.js/blob/master/src/helpers/BoxHelper.js | Source}
  */
 export class BoxHelper extends LineSegments<BufferGeometry, LineBasicMaterial> {
     /**
-     * Creates a new wireframe box that bounds the passed object
-     * @remarks
-     * Internally this uses {@link THREE.Box3.setFromObject | Box3.setFromObject} to calculate the dimensions
-     * Note that this includes any children.
-     * @param object The object3D to show the world-axis-aligned bounding box.
-     * @param color Hexadecimal value that defines the box's color. Default `0xffff00`
+     * Constructs a new box helper.
+     *
+     * @param {Object3D} [object] - The 3D object to show the world-axis-aligned bounding box.
+     * @param {number|Color|string} [color=0xffff00] - The box's color.
      */
     constructor(object: Object3D, color?: ColorRepresentation);
-
     /**
-     * A Read-only _string_ to check if `this` object type.
-     * @remarks Sub-classes will update this value.
-     * @override
-     * @defaultValue `BoxHelper`
+     * The 3D object being visualized.
      */
-    override readonly type: string | "BoxHelper";
-
+    object: Object3D;
     /**
-     * Updates the helper's geometry to match the dimensions of the object, including any children
-     * @remarks
-     * See {@link THREE.Box3.setFromObject | Box3.setFromObject}.
+     * Updates the helper's geometry to match the dimensions of the object,
+     * including any children.
      */
-    update(object?: Object3D): void;
-
+    update(): void;
     /**
      * Updates the wireframe box for the passed object.
-     * @param object {@link THREE.Object3D | Object3D} to create the helper of.
+     *
+     * @param {Object3D} object - The 3D object to create the helper for.
+     * @return {BoxHelper} A reference to this instance.
      */
-    setFromObject(object: Object3D): this;
-
+    setFromObject(object: Object3D): BoxHelper;
+    copy(source: BoxHelper, recursive?: boolean): this;
     /**
-     * Frees the GPU-related resources allocated by this instance
-     * @remarks
-     * Call this method whenever this instance is no longer used in your app.
+     * Frees the GPU-related resources allocated by this instance. Call this
+     * method whenever this instance is no longer used in your app.
      */
     dispose(): void;
 }