@types/three 0.137.0 → 0.140.0

three/src/Three.d.ts

@@ -65,6 +65,7 @@ export * from './extras/core/ShapePath';
 export * from './extras/core/CurvePath';
 export * from './extras/core/Curve';
 export * from './extras/DataUtils';
+export * from './extras/Earcut';
 export * from './extras/ImageUtils';
 export * from './extras/ShapeUtils';
 export * from './extras/PMREMGenerator';
@@ -181,6 +182,8 @@ export * from './renderers/WebGLMultipleRenderTargets';
 export * from './renderers/WebGLRenderTarget';
 export * from './renderers/WebGLRenderer';
 export * from './renderers/WebGL1Renderer';
+export * from './renderers/WebGL3DRenderTarget';
+export * from './renderers/WebGLArrayRenderTarget';
 export * from './renderers/shaders/ShaderLib';
 export * from './renderers/shaders/UniformsLib';
 export * from './renderers/shaders/UniformsUtils';
@@ -207,6 +210,7 @@ export * from './renderers/webgl/WebGLUniforms';
 export * from './renderers/webxr/WebXR';
 export * from './renderers/webxr/WebXRController';
 export * from './renderers/webxr/WebXRManager';
+export { WebGLUtils } from './renderers/webgl/WebGLUtils.js';
 /**
  * Scenes
  */
@@ -222,7 +226,10 @@ export * from './textures/DataTexture2DArray';
 export * from './textures/DataTexture3D';
 export * from './textures/CompressedTexture';
 export * from './textures/CubeTexture';
+export * from './textures/Data3DTexture';
+export * from './textures/DataArrayTexture';
 export * from './textures/CanvasTexture';
 export * from './textures/DepthTexture';
 export * from './textures/FramebufferTexture';
+export * from './textures/Source';
 export * from './textures/Texture';

three/src/animation/AnimationUtils.d.ts

@@ -4,7 +4,7 @@ export namespace AnimationUtils {
     function arraySlice(array: any, from: number, to: number): any;
     function convertArray(array: any, type: any, forceClone: boolean): any;
     function isTypedArray(object: any): boolean;
-    function getKeyFrameOrder(times: number[]): number[];
+    function getKeyframeOrder(times: number[]): number[];
     function sortedArray(values: any[], stride: number, order: number[]): any[];
     function flattenJSON(jsonKeys: string[], times: any[], values: any[], valuePropertyName: string): void;
 

three/src/constants.d.ts

@@ -115,7 +115,6 @@ export const CubeRefractionMapping: Mapping;
 export const EquirectangularReflectionMapping: Mapping;
 export const EquirectangularRefractionMapping: Mapping;
 export const CubeUVReflectionMapping: Mapping;
-export const CubeUVRefractionMapping: Mapping;
 
 // Wrapping modes
 export enum Wrapping {}
@@ -153,6 +152,7 @@ export const UnsignedInt248Type: TextureDataType;
 // Pixel formats
 export enum PixelFormat {}
 export const AlphaFormat: PixelFormat;
+export const RGBFormat: PixelFormat;
 export const RGBAFormat: PixelFormat;
 export const LuminanceFormat: PixelFormat;
 export const LuminanceAlphaFormat: PixelFormat;
@@ -301,9 +301,6 @@ export const TriangleFanDrawMode: TrianglesDrawModes;
 export enum TextureEncoding {}
 export const LinearEncoding: TextureEncoding;
 export const sRGBEncoding: TextureEncoding;
-export const LogLuvEncoding: TextureEncoding;
-export const RGBM7Encoding: TextureEncoding;
-export const RGBM16Encoding: TextureEncoding;
 
 // Depth packing strategies
 export enum DepthPackingStrategies {}
@@ -315,6 +312,11 @@ export enum NormalMapTypes {}
 export const TangentSpaceNormalMap: NormalMapTypes;
 export const ObjectSpaceNormalMap: NormalMapTypes;
 
+export type ColorSpace = NoColorSpace | SRGBColorSpace | LinearSRGBColorSpace;
+export type NoColorSpace = '';
+export type SRGBColorSpace = 'srgb';
+export type LinearSRGBColorSpace = 'srgb-linear';
+
 // Stencil Op types
 export enum StencilOp {}
 export const ZeroStencilOp: StencilOp;

three/src/core/BufferGeometry.d.ts

@@ -22,8 +22,6 @@ export class BufferGeometry extends EventDispatcher {
      */
     constructor();
 
-    static MaxIndex: number;
-
     /**
      * Unique number of this buffergeometry instance
      */

three/src/core/InstancedBufferGeometry.d.ts

@@ -13,12 +13,8 @@ export class InstancedBufferGeometry extends BufferGeometry {
 
     isInstancedBufferGeometry: boolean;
 
-    groups: Array<{ start: number; count: number; instances: number }>;
-
     /**
      * @default Infinity
      */
     instanceCount: number;
-
-    addGroup(start: number, count: number, instances: number): void;
 }

three/src/core/Raycaster.d.ts

@@ -95,7 +95,7 @@ export class Raycaster {
     /**
      * Checks all intersection between the ray and the object with or without the descendants. Intersections are returned sorted by distance, closest first.
      * @param object The object to check for intersection with the ray.
-     * @param recursive If true, it also checks all descendants. Otherwise it only checks intersecton with the object. Default is false.
+     * @param recursive If true, it also checks all descendants. Otherwise it only checks intersecton with the object. Default is true.
      * @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<TIntersected extends Object3D>(
@@ -109,7 +109,7 @@ export class Raycaster {
      * Intersections are returned sorted by distance, closest first.
      * Intersections are of the same form as those returned by .intersectObject.
      * @param objects The objects to check for intersection with the ray.
-     * @param recursive If true, it also checks all descendants of the objects. Otherwise it only checks intersecton with the objects. Default is false.
+     * @param recursive If true, it also checks all descendants of the objects. Otherwise it only checks intersecton with the objects. Default is true.
      * @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<TIntersected extends Object3D>(

three/src/core/Uniform.d.ts

@@ -13,7 +13,6 @@ export class Uniform {
      * @deprecated Use {@link Object3D#onBeforeRender object.onBeforeRender()} instead.
      */
     dynamic: boolean;
-    onUpdateCallback: () => void;
 
     /**
      * @deprecated Use {@link Object3D#onBeforeRender object.onBeforeRender()} instead.

three/src/extras/DataUtils.d.ts

@@ -1,3 +1,4 @@
 export namespace DataUtils {
     function toHalfFloat(val: number): number;
+    function fromHalfFloat(val: number): number;
 }

three/src/extras/Earcut.d.ts

@@ -0,0 +1,4 @@
+import { Triangle } from '../Three';
+export namespace Earcut {
+    function triangulate(data: number[], holeIndices: number[], dim: number): Triangle[];
+}

three/src/geometries/CapsuleGeometry.d.ts

@@ -0,0 +1,27 @@
+import { BufferGeometry } from '../core/BufferGeometry';
+
+export class CapsuleGeometry extends BufferGeometry {
+    /**
+     * @param [radius=1] — Radius of the capsule.
+     * @param [length=1] — Length of the middle section.
+     * @param [capSegments=4] — Number of curve segments used to build the caps.
+     * @param [radialSegments=8] — Number of segmented faces around the circumference of the capsule.
+     */
+    constructor(radius?: number, length?: number, capSegments?: number, radialSegments?: number);
+
+    /**
+     * @default 'CapsuleGeometry'
+     */
+    type: string;
+
+    parameters: {
+        radius: number;
+        length: number;
+        capSegments: number;
+        radialSegments: number;
+    };
+
+    static fromJSON(data: any): CapsuleGeometry;
+}
+
+export { CapsuleGeometry as CapsuleBufferGeometry };

three/src/geometries/Geometries.d.ts

@@ -1,4 +1,5 @@
 export * from './BoxGeometry';
+export * from './CapsuleGeometry';
 export * from './CircleGeometry';
 export * from './ConeGeometry';
 export * from './CylinderGeometry';

three/src/materials/Material.d.ts

@@ -13,9 +13,6 @@ import {
     StencilOp,
     PixelFormat,
 } from '../constants';
-import { ColorRepresentation } from '../utils';
-import { Color } from '../math/Color';
-import { Texture } from '../textures/Texture';
 
 export interface MaterialParameters {
     alphaTest?: number | undefined;
@@ -35,7 +32,6 @@ export interface MaterialParameters {
     depthFunc?: DepthModes | undefined;
     depthTest?: boolean | undefined;
     depthWrite?: boolean | undefined;
-    fog?: boolean | undefined;
     name?: string | undefined;
     opacity?: number | undefined;
     polygonOffset?: boolean | undefined;
@@ -80,11 +76,6 @@ export class Material extends EventDispatcher {
      */
     alphaToCoverage: boolean;
 
-    /**
-     * @default false
-     */
-    alphaWrite: boolean;
-
     /**
      * Blending destination. It's one of the blending mode constants defined in Three.js. Default is {@link OneMinusSrcAlphaFactor}.
      * @default THREE.OneMinusSrcAlphaFactor
@@ -180,12 +171,6 @@ export class Material extends EventDispatcher {
      */
     depthWrite: boolean;
 
-    /**
-     * Whether the material is affected by fog. Default is true.
-     * @default fog
-     */
-    fog: boolean;
-
     /**
      * Unique number of this material instance.
      */

three/src/materials/MeshBasicMaterial.d.ts

@@ -16,6 +16,7 @@ export interface MeshBasicMaterialParameters extends MaterialParameters {
     aoMapIntensity?: number | undefined;
     specularMap?: Texture | null | undefined;
     alphaMap?: Texture | null | undefined;
+    fog?: boolean | undefined;
     envMap?: Texture | null | undefined;
     combine?: Combine | undefined;
     reflectivity?: number | undefined;
@@ -114,5 +115,11 @@ export class MeshBasicMaterial extends Material {
      */
     wireframeLinejoin: string;
 
+    /**
+     * Whether the material is affected by fog. Default is true.
+     * @default fog
+     */
+    fog: boolean;
+
     setValues(parameters: MeshBasicMaterialParameters): void;
 }

three/src/materials/MeshLambertMaterial.d.ts

@@ -24,6 +24,7 @@ export interface MeshLambertMaterialParameters extends MaterialParameters {
     wireframeLinewidth?: number | undefined;
     wireframeLinecap?: string | undefined;
     wireframeLinejoin?: string | undefined;
+    fog?: boolean | undefined;
 }
 
 export class MeshLambertMaterial extends Material {
@@ -129,5 +130,11 @@ export class MeshLambertMaterial extends Material {
      */
     wireframeLinejoin: string;
 
+    /**
+     * Whether the material is affected by fog. Default is true.
+     * @default fog
+     */
+    fog: boolean;
+
     setValues(parameters: MeshLambertMaterialParameters): void;
 }

three/src/materials/MeshMatcapMaterial.d.ts

@@ -18,7 +18,7 @@ export interface MeshMatcapMaterialParameters extends MaterialParameters {
     displacementScale?: number | undefined;
     displacementBias?: number | undefined;
     alphaMap?: Texture | null | undefined;
-
+    fog?: boolean | undefined;
     flatShading?: boolean | undefined;
 }
 
@@ -101,5 +101,11 @@ export class MeshMatcapMaterial extends Material {
      */
     flatShading: boolean;
 
+    /**
+     * Whether the material is affected by fog. Default is true.
+     * @default fog
+     */
+    fog: boolean;
+
     setValues(parameters: MeshMatcapMaterialParameters): void;
 }

three/src/materials/MeshPhongMaterial.d.ts

@@ -37,7 +37,7 @@ export interface MeshPhongMaterialParameters extends MaterialParameters {
     wireframeLinewidth?: number | undefined;
     wireframeLinecap?: string | undefined;
     wireframeLinejoin?: string | undefined;
-
+    fog?: boolean | undefined;
     flatShading?: boolean | undefined;
 }
 
@@ -205,5 +205,11 @@ export class MeshPhongMaterial extends Material {
      */
     metal: boolean;
 
+    /**
+     * Whether the material is affected by fog. Default is true.
+     * @default fog
+     */
+    fog: boolean;
+
     setValues(parameters: MeshPhongMaterialParameters): void;
 }

three/src/materials/MeshStandardMaterial.d.ts

@@ -30,10 +30,9 @@ export interface MeshStandardMaterialParameters extends MaterialParameters {
     alphaMap?: Texture | null | undefined;
     envMap?: Texture | null | undefined;
     envMapIntensity?: number | undefined;
-    refractionRatio?: number | undefined;
     wireframe?: boolean | undefined;
     wireframeLinewidth?: number | undefined;
-
+    fog?: boolean | undefined;
     flatShading?: boolean | undefined;
 }
 
@@ -170,11 +169,6 @@ export class MeshStandardMaterial extends Material {
      */
     envMapIntensity: number;
 
-    /**
-     * @default 0.98
-     */
-    refractionRatio: number;
-
     /**
      * @default false
      */
@@ -201,6 +195,12 @@ export class MeshStandardMaterial extends Material {
      */
     flatShading: boolean;
 
+    /**
+     * Whether the material is affected by fog. Default is true.
+     * @default fog
+     */
+    fog: boolean;
+
     isMeshStandardMaterial: boolean;
 
     setValues(parameters: MeshStandardMaterialParameters): void;

three/src/materials/MeshToonMaterial.d.ts

@@ -31,6 +31,7 @@ export interface MeshToonMaterialParameters extends MaterialParameters {
     wireframeLinewidth?: number | undefined;
     wireframeLinecap?: string | undefined;
     wireframeLinejoin?: string | undefined;
+    fog?: boolean | undefined;
 }
 
 export class MeshToonMaterial extends Material {
@@ -161,5 +162,11 @@ export class MeshToonMaterial extends Material {
      */
     wireframeLinejoin: string;
 
+    /**
+     * Whether the material is affected by fog. Default is true.
+     * @default fog
+     */
+    fog: boolean;
+
     setValues(parameters: MeshToonMaterialParameters): void;
 }

three/src/materials/PointsMaterial.d.ts

@@ -9,6 +9,7 @@ export interface PointsMaterialParameters extends MaterialParameters {
     alphaMap?: Texture | null | undefined;
     size?: number | undefined;
     sizeAttenuation?: boolean | undefined;
+    fog?: boolean | undefined;
 }
 
 export class PointsMaterial extends Material {
@@ -44,5 +45,11 @@ export class PointsMaterial extends Material {
      */
     sizeAttenuation: boolean;
 
+    /**
+     * Whether the material is affected by fog. Default is true.
+     * @default fog
+     */
+    fog: boolean;
+
     setValues(parameters: PointsMaterialParameters): void;
 }

three/src/materials/ShadowMaterial.d.ts

@@ -4,6 +4,7 @@ import { MaterialParameters, Material } from './Material';
 
 export interface ShadowMaterialParameters extends MaterialParameters {
     color?: ColorRepresentation | undefined;
+    fog?: boolean | undefined;
 }
 
 export class ShadowMaterial extends Material {
@@ -23,4 +24,10 @@ export class ShadowMaterial extends Material {
      * @default true
      */
     transparent: boolean;
+
+    /**
+     * Whether the material is affected by fog. Default is true.
+     * @default fog
+     */
+    fog: boolean;
 }

three/src/materials/SpriteMaterial.d.ts

@@ -9,6 +9,7 @@ export interface SpriteMaterialParameters extends MaterialParameters {
     alphaMap?: Texture | null | undefined;
     rotation?: number | undefined;
     sizeAttenuation?: boolean | undefined;
+    fog?: boolean | undefined;
 }
 
 export class SpriteMaterial extends Material {
@@ -48,6 +49,12 @@ export class SpriteMaterial extends Material {
      */
     transparent: boolean;
 
+    /**
+     * Whether the material is affected by fog. Default is true.
+     * @default fog
+     */
+    fog: boolean;
+
     readonly isSpriteMaterial: true;
 
     setValues(parameters: SpriteMaterialParameters): void;

three/src/math/Color.d.ts

@@ -1,13 +1,21 @@
+import { ColorSpace } from '../constants';
 import { ColorRepresentation } from '../utils';
+
 import { BufferAttribute } from './../core/BufferAttribute';
 
+export { SRGBToLinear } from './ColorManagement';
+
 export interface HSL {
     h: number;
     s: number;
     l: number;
 }
 
-export function SRGBToLinear(c: number): number;
+export interface RGB {
+    r: number;
+    g: number;
+    b: number;
+}
 
 /**
  * Represents a color. See also {@link ColorUtils}.
@@ -43,7 +51,7 @@ export class Color {
 
     set(color: ColorRepresentation): Color;
     setScalar(scalar: number): Color;
-    setHex(hex: number): Color;
+    setHex(hex: number, colorSpace?: ColorSpace): Color;
 
     /**
      * Sets this color from RGB values.
@@ -51,7 +59,7 @@ export class Color {
      * @param g Green channel value between 0 and 1.
      * @param b Blue channel value between 0 and 1.
      */
-    setRGB(r: number, g: number, b: number): Color;
+    setRGB(r: number, g: number, b: number, colorSpace?: ColorSpace): Color;
 
     /**
      * Sets this color from HSL values.
@@ -61,20 +69,20 @@ export class Color {
      * @param s Saturation value channel between 0 and 1.
      * @param l Value channel value between 0 and 1.
      */
-    setHSL(h: number, s: number, l: number): Color;
+    setHSL(h: number, s: number, l: number, colorSpace?: ColorSpace): Color;
 
     /**
      * Sets this color from a CSS context style string.
      * @param contextStyle Color in CSS context style format.
      */
-    setStyle(style: string): Color;
+    setStyle(style: string, colorSpace?: ColorSpace): Color;
 
     /**
      * Sets this color from a color name.
      * Faster than {@link Color#setStyle .setStyle()} method if you don't need the other CSS-style formats.
      * @param style Color name in X11 format.
      */
-    setColorName(style: string): Color;
+    setColorName(style: string, colorSpace?: ColorSpace): Color;
 
     /**
      * Clones this color.
@@ -112,20 +120,22 @@ export class Color {
     /**
      * Returns the hexadecimal value of this color.
      */
-    getHex(): number;
+    getHex(colorSpace?: ColorSpace): number;
 
     /**
      * Returns the string formated hexadecimal value of this color.
      */
-    getHexString(): string;
+    getHexString(colorSpace?: ColorSpace): string;
 
-    getHSL(target: HSL): HSL;
+    getHSL(target: HSL, colorSpace?: ColorSpace): HSL;
+
+    getRGB(target: RGB, colorSpace?: ColorSpace): RGB;
 
     /**
      * Returns the value of this color in CSS context style.
      * Example: rgb(r, g, b)
      */
-    getStyle(): string;
+    getStyle(colorSpace?: ColorSpace): string;
 
     offsetHSL(h: number, s: number, l: number): this;
 
@@ -165,6 +175,8 @@ export class Color {
 
     fromBufferAttribute(attribute: BufferAttribute, index: number): this;
 
+    [Symbol.iterator](): Generator<number, void>;
+
     /**
      * List of X11 color names.
      */

three/src/math/ColorManagement.d.ts

@@ -0,0 +1,18 @@
+import { LinearSRGBColorSpace, SRGBColorSpace } from '../constants';
+import { Color } from './Color';
+
+export function SRGBToLinear(c: number): number;
+
+export function LinearToSRGB(c: number): number;
+
+export namespace ColorManagement {
+    function convert(
+        color: Color,
+        sourceColorSpace: SRGBColorSpace | LinearSRGBColorSpace,
+        targetColorSpace: SRGBColorSpace | LinearSRGBColorSpace,
+    ): Color;
+
+    function fromWorkingColorSpace(color: Color, targetColorSpace: SRGBColorSpace | LinearSRGBColorSpace): Color;
+
+    function toWorkingColorSpace(color: Color, sourceColorSpace: SRGBColorSpace | LinearSRGBColorSpace): Color;
+}

three/src/math/Euler.d.ts

@@ -38,9 +38,10 @@ export class Euler {
     equals(euler: Euler): boolean;
     fromArray(xyzo: any[]): Euler;
     toArray(array?: number[], offset?: number): number[];
-    toVector3(optionalResult?: Vector3): Vector3;
     _onChange(callback: () => void): this;
 
     static RotationOrders: string[];
     static DefaultOrder: string;
+
+    [Symbol.iterator](): Generator<string | number, void>;
 }

three/src/math/Plane.d.ts

@@ -31,7 +31,6 @@ export class Plane {
     distanceToPoint(point: Vector3): number;
     distanceToSphere(sphere: Sphere): number;
     projectPoint(point: Vector3, target: Vector3): Vector3;
-    orthoPoint(point: Vector3, target: Vector3): Vector3;
     intersectLine(line: Line3, target: Vector3): Vector3 | null;
     intersectsLine(line: Line3): boolean;
     intersectsBox(box: Box3): boolean;

three/src/math/Quaternion.d.ts

@@ -174,4 +174,6 @@ export class Quaternion {
     inverse(): Quaternion;
 
     random(): Quaternion;
+
+    [Symbol.iterator](): Generator<number, void>;
 }

three/src/math/Vector3.d.ts

@@ -252,6 +252,11 @@ export class Vector3 implements Vector {
     setFromMatrixColumn(matrix: Matrix4, index: number): this;
     setFromMatrix3Column(matrix: Matrix3, index: number): this;
 
+    /**
+     * Sets this vector's {@link x}, {@link y} and {@link z} components from the x, y, and z components of the specified {@link Euler Euler Angle}.
+     */
+    setFromEuler(e: Euler): this;
+
     /**
      * Checks for strict equality of this vector and v.
      */

three/src/renderers/WebGL3DRenderTarget.d.ts

@@ -0,0 +1,28 @@
+import { Data3DTexture } from '../textures/Data3DTexture';
+import { WebGLRenderTarget } from './WebGLRenderTarget';
+
+/**
+ * Represents a three-dimensional render target.
+ */
+export class WebGL3DRenderTarget extends WebGLRenderTarget {
+    /**
+     * Creates a new WebGL3DRenderTarget.
+     *
+     * @param width the width of the render target, in pixels.
+     * @param height the height of the render target, in pixels.
+     * @param depth the depth of the render target.
+     */
+    constructor(width: number, height: number, depth: number);
+
+    /**
+     * The depth of the render target.
+     */
+    depth: number;
+
+    /**
+     * The texture property is overwritten with an instance of {@link Data3DTexture}.
+     */
+    texture: Data3DTexture;
+
+    readonly isWebGL3DRenderTarget: true;
+}

three/src/renderers/WebGLArrayRenderTarget.d.ts

@@ -0,0 +1,28 @@
+import { DataArrayTexture } from '../textures/DataArrayTexture';
+import { WebGLRenderTarget } from './WebGLRenderTarget';
+
+/**
+ * This type of render target represents an array of textures.
+ */
+export class WebGLArrayRenderTarget extends WebGLRenderTarget {
+    /**
+     * Creates a new WebGLArrayRenderTarget.
+     *
+     * @param width the width of the render target, in pixels.
+     * @param height the height of the render target, in pixels.
+     * @param depth the depth/layer count of the render target.
+     */
+    constructor(width: number, height: number, depth: number);
+
+    /**
+     * The depth of the render target.
+     */
+    depth: number;
+
+    /**
+     * The texture property is overwritten with an instance of {@link DataArrayTexture}.
+     */
+    texture: DataArrayTexture;
+
+    readonly isWebGLArrayRenderTarget: true;
+}

three/src/renderers/WebGLMultipleRenderTargets.d.ts

@@ -1,5 +1,6 @@
 import { EventDispatcher } from '../core/EventDispatcher';
 import { Texture } from '../textures/Texture';
+import { WebGLRenderTargetOptions } from './WebGLRenderTarget';
 
 /**
  * This class originall extended WebGLMultipleRenderTarget
@@ -10,7 +11,14 @@ export class WebGLMultipleRenderTargets extends EventDispatcher {
 
     readonly isWebGLMultipleRenderTargets = true;
 
-    constructor(width: number, height: number, count: number);
+    /**
+     * @param width The width of the render target.
+     * @param height The height of the render target.
+     * @param count The number of render targets.
+     * @param options object that holds texture parameters for an auto-generated target texture and depthBuffer/stencilBuffer booleans.
+     * For an explanation of the texture parameters see {@link Texture}.
+     */
+    constructor(width: number, height: number, count: number, options?: WebGLRenderTargetOptions);
 
     setSize(width: number, height: number, depth?: number): this;
     copy(source: WebGLMultipleRenderTargets): this;