@types/three 0.157.2 → 0.158.1

three/src/core/Object3D.d.ts

@@ -235,14 +235,14 @@ export class Object3D<TEventMap extends Object3DEventMap = Object3DEventMap> ext
      * are not renderable and thus this callback is not executed for such objects.
      * @defaultValue `() => {}`
      */
-    onBeforeRender: (
+    onBeforeRender(
         renderer: WebGLRenderer,
         scene: Scene,
         camera: Camera,
         geometry: BufferGeometry,
         material: Material,
         group: Group,
-    ) => void;
+    ): void;
 
     /**
      * An optional callback that is executed immediately after a 3D object is rendered.
@@ -254,14 +254,14 @@ export class Object3D<TEventMap extends Object3DEventMap = Object3DEventMap> ext
      * are not renderable and thus this callback is not executed for such objects.
      * @defaultValue `() => {}`
      */
-    onAfterRender: (
+    onAfterRender(
         renderer: WebGLRenderer,
         scene: Scene,
         camera: Camera,
         geometry: BufferGeometry,
         material: Material,
         group: Group,
-    ) => void;
+    ): void;
 
     /**
      * The default {@link up} direction for objects, also used as the default position for {@link THREE.DirectionalLight | DirectionalLight},

three/src/core/Raycaster.d.ts

@@ -31,6 +31,7 @@ export interface Intersection<TIntersected extends Object3D = Object3D> {
     normal?: Vector3;
     /** The index number of the instance where the ray intersects the {@link THREE.InstancedMesh | InstancedMesh } */
     instanceId?: number | undefined;
+    pointOnLine?: Vector3;
 }
 
 export interface RaycasterParameters {

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

@@ -82,7 +82,7 @@ export abstract class Curve<T extends Vector> {
     getLengths(divisions?: number): number[];
 
     /**
-     * Update the cumlative segment distance cache
+     * Update the cumulative segment distance cache
      * @remarks
      * The method must be called every time {@link Curve} parameters are changed
      * If an updated {@link Curve} is part of a composed {@link Curve} like {@link THREE.CurvePath | CurvePath},

three/src/geometries/CapsuleGeometry.d.ts

@@ -20,7 +20,7 @@ export class CapsuleGeometry extends BufferGeometry {
      * Create a new instance of {@link CapsuleGeometry}
      * @param radius Radius of the capsule. Expects a `Float`. Default `1`
      * @param length Length of the middle section. Expects a `Float`. Default `1`
-     * @param capSubdivisions Number of curve segments used to build the caps. Expects a `Integer`. Default `4`
+     * @param capSegments Number of curve segments used to build the caps. Expects a `Integer`. Default `4`
      * @param radialSegments Number of segmented faces around the circumference of the capsule. Expects a `Integer`. Default `8`
      */
     constructor(radius?: number, length?: number, capSegments?: number, radialSegments?: number);

three/src/helpers/AxesHelper.d.ts

@@ -1,4 +1,4 @@
-import { Color } from '../math/Color.js';
+import { ColorRepresentation } from '../math/Color.js';
 import { LineSegments } from './../objects/LineSegments.js';
 
 /**
@@ -39,7 +39,7 @@ export class AxesHelper extends LineSegments {
      * @param yAxisColor
      * @param zAxisColor
      */
-    setColors(xAxisColor: Color, yAxisColor: Color, zAxisColor: Color): this;
+    setColors(xAxisColor: ColorRepresentation, yAxisColor: ColorRepresentation, zAxisColor: ColorRepresentation): this;
 
     /**
      * Frees the GPU-related resources allocated by this instance

three/src/helpers/Box3Helper.d.ts

@@ -1,5 +1,5 @@
 import { Box3 } from './../math/Box3.js';
-import { Color } from './../math/Color.js';
+import { ColorRepresentation } from './../math/Color.js';
 import { LineSegments } from './../objects/LineSegments.js';
 
 /**
@@ -20,7 +20,7 @@ export class Box3Helper extends LineSegments {
      * @param box The Box3 to show.
      * @param color The box's color. Default `0xffff00`
      */
-    constructor(box: Box3, color?: Color);
+    constructor(box: Box3, color?: ColorRepresentation);
 
     /**
      * A Read-only _string_ to check if `this` object type.

three/src/lights/Light.d.ts

@@ -38,8 +38,7 @@ export abstract class Light<TShadowSupport extends LightShadow | undefined = Lig
 
     /**
      * The light's intensity, or strength.
-     * When {@link THREE.WebGLRenderer.useLegacyLights | legacy lighting mode} is disabled, the units of intensity depend on the type of light.
-     * @remarks Expects a `Float`
+     * The units of intensity depend on the type of light.
      * @defaultValue `1`
      */
     intensity: number;

three/src/materials/Material.d.ts

@@ -13,11 +13,14 @@ import {
     StencilOp,
     PixelFormat,
 } from '../constants.js';
+import { Color, ColorRepresentation } from '../math/Color.js';
 
 export interface MaterialParameters {
     alphaHash?: boolean | undefined;
     alphaTest?: number | undefined;
     alphaToCoverage?: boolean | undefined;
+    blendAlpha?: number | undefined;
+    blendColor?: ColorRepresentation | undefined;
     blendDst?: BlendingDstFactor | undefined;
     blendDstAlpha?: number | undefined;
     blendEquation?: BlendingEquation | undefined;
@@ -86,6 +89,20 @@ export class Material extends EventDispatcher<{ dispose: {} }> {
      */
     alphaToCoverage: boolean;
 
+    /**
+     * Represents the alpha value of the constant blend color. This property has only an effect when using custom
+     * blending with {@link ConstantAlphaFactor} or {@link OneMinusConstantAlphaFactor}.
+     * @default 0
+     */
+    blendAlpha: number;
+
+    /**
+     * Represent the RGB values of the constant blend color. This property has only an effect when using custom
+     * blending with {@link ConstantColorFactor} or {@link OneMinusConstantColorFactor}.
+     * @default 0x000000
+     */
+    blendColor: Color;
+
     /**
      * Blending destination. It's one of the blending mode constants defined in Three.js. Default is {@link OneMinusSrcAlphaFactor}.
      * @default THREE.OneMinusSrcAlphaFactor
@@ -141,7 +158,7 @@ export class Material extends EventDispatcher<{ dispose: {} }> {
      * See the WebGL / clipping /intersection example. Default is null.
      * @default null
      */
-    clippingPlanes: Plane[];
+    clippingPlanes: Plane[] | null;
 
     /**
      * Defines whether to clip shadows according to the clipping planes specified on this material. Default is false.
@@ -169,7 +186,8 @@ export class Material extends EventDispatcher<{ dispose: {} }> {
     depthFunc: DepthModes;
 
     /**
-     * Whether to have depth test enabled when rendering this material. Default is true.
+     * Whether to have depth test enabled when rendering this material. When the depth test is disabled, the depth write
+     * will also be implicitly disabled.
      * @default true
      */
     depthTest: boolean;

three/src/materials/MeshPhysicalMaterial.d.ts

@@ -1,7 +1,7 @@
-import { Texture } from './../textures/Texture.js';
-import { Vector2 } from './../math/Vector2.js';
+import { Texture } from '../textures/Texture.js';
+import { Vector2 } from '../math/Vector2.js';
 import { MeshStandardMaterialParameters, MeshStandardMaterial } from './MeshStandardMaterial.js';
-import { Color } from './../math/Color.js';
+import { Color, ColorRepresentation } from '../math/Color.js';
 
 export interface MeshPhysicalMaterialParameters extends MeshStandardMaterialParameters {
     clearcoat?: number | undefined;
@@ -15,7 +15,7 @@ export interface MeshPhysicalMaterialParameters extends MeshStandardMaterialPara
     ior?: number | undefined;
 
     sheen?: number | undefined;
-    sheenColor?: Color | undefined;
+    sheenColor?: ColorRepresentation | undefined;
     sheenColorMap?: Texture | null | undefined;
     sheenRoughness?: number | undefined;
     sheenRoughnessMap?: Texture | null | undefined;
@@ -27,10 +27,10 @@ export interface MeshPhysicalMaterialParameters extends MeshStandardMaterialPara
     thicknessMap?: Texture | null | undefined;
 
     attenuationDistance?: number | undefined;
-    attenuationColor?: Color | undefined;
+    attenuationColor?: ColorRepresentation | undefined;
 
     specularIntensity?: number | undefined;
-    specularColor?: Color | undefined;
+    specularColor?: ColorRepresentation | undefined;
     specularIntensityMap?: Texture | null | undefined;
     specularColorMap?: Texture | null | undefined;
 
@@ -48,6 +48,8 @@ export interface MeshPhysicalMaterialParameters extends MeshStandardMaterialPara
 export class MeshPhysicalMaterial extends MeshStandardMaterial {
     constructor(parameters?: MeshPhysicalMaterialParameters);
 
+    isMeshPhysicalMaterial: boolean;
+
     /**
      * @default 'MeshPhysicalMaterial'
      */

three/src/math/ColorManagement.d.ts

@@ -26,7 +26,7 @@ export interface ColorManagement {
      * @default LinearSRGBColorSpace
      */
     get workingColorSpace(): WorkingColorSpace;
-    set workingSpaceColor(colorSpace: WorkingColorSpace);
+    set workingColorSpace(colorSpace: WorkingColorSpace);
 
     convert: (color: Color, sourceColorSpace: DefinedColorSpace, targetColorSpace: DefinedColorSpace) => Color;
 

three/src/math/Matrix4.d.ts

@@ -156,7 +156,8 @@ export class Matrix4 implements Matrix {
     /**
      * Sets the position component for this matrix from vector v.
      */
-    setPosition(v: Vector3 | number, y?: number, z?: number): Matrix4;
+    setPosition(v: Vector3): Matrix4;
+    setPosition(x: number, y: number, z: number): Matrix4;
 
     /**
      * Inverts this matrix.

three/src/objects/SkinnedMesh.d.ts

@@ -1,11 +1,12 @@
-import { Material } from './../materials/Material.js';
+import { Material } from '../materials/Material.js';
 import { Box3 } from '../math/Box3.js';
-import { Matrix4 } from './../math/Matrix4.js';
-import { Vector3 } from './../math/Vector3.js';
+import { Matrix4 } from '../math/Matrix4.js';
+import { Vector3 } from '../math/Vector3.js';
 import { Skeleton } from './Skeleton.js';
 import { Mesh } from './Mesh.js';
 import { BufferGeometry } from '../core/BufferGeometry.js';
 import { Sphere } from '../math/Sphere.js';
+import { BindMode } from '../constants.js';
 
 /**
  * A mesh that has a {@link THREE.Skeleton | Skeleton} with {@link Bone | bones} that can then be used to animate the vertices of the geometry.
@@ -72,12 +73,12 @@ export class SkinnedMesh<
     override readonly type: string | 'SkinnedMesh';
 
     /**
-     * Either `attached` or `detached`.
-     *  - `attached` uses the {@link THREE.SkinnedMesh.matrixWorld | SkinnedMesh.matrixWorld} property for the base transform matrix of the bones.
-     *  - `detached` uses the {@link THREE.SkinnedMesh.bindMatrix | SkinnedMesh.bindMatrix}.
-     * @defaultValue `attached`.
+     * Either {@link AttachedBindMode} or {@link DetachedBindMode}. {@link AttachedBindMode} means the skinned mesh
+     * shares the same world space as the skeleton. This is not true when using {@link DetachedBindMode} which is useful
+     * when sharing a skeleton across multiple skinned meshes.
+     * @defaultValue `AttachedBindMode`
      */
-    bindMode: 'attached' | 'detached';
+    bindMode: BindMode;
 
     /**
      * The base matrix that is used for the bound bone transforms.

three/src/renderers/WebGLRenderer.d.ts

@@ -370,9 +370,19 @@ export class WebGLRenderer implements Renderer {
     animate(callback: () => void): void;
 
     /**
-     * Compiles all materials in the scene with the camera. This is useful to precompile shaders before the first rendering.
+     * Compiles all materials in the scene with the camera. This is useful to precompile shaders before the first
+     * rendering. If you want to add a 3D object to an existing scene, use the third optional parameter for applying the
+     * target scene.
+     * Note that the (target) scene's lighting should be configured before calling this method.
      */
-    compile(scene: Object3D, camera: Camera): void;
+    compile: (scene: Object3D, camera: Camera, targetScene?: Scene | null) => Set<Material>;
+
+    /**
+     * Asynchronous version of {@link compile}(). The method returns a Promise that resolves when the given scene can be
+     * rendered without unnecessary stalling due to shader compilation.
+     * This method makes use of the KHR_parallel_shader_compile WebGL extension.
+     */
+    compileAsync: (scene: Object3D, camera: Camera, targetScene?: Scene | null) => Promise<Object3D>;
 
     /**
      * Render a scene or an object using a camera.

three/src/scenes/Scene.d.ts

@@ -1,6 +1,6 @@
 import { FogBase } from './Fog.js';
-import { Material } from './../materials/Material.js';
-import { Object3D } from './../core/Object3D.js';
+import { Material } from '../materials/Material.js';
+import { Object3D } from '../core/Object3D.js';
 import { Color } from '../math/Color.js';
 import { Texture } from '../textures/Texture.js';
 import { CubeTexture } from '../Three.js';

three/src/textures/DepthTexture.d.ts

@@ -3,7 +3,7 @@ import {
     Mapping,
     Wrapping,
     TextureDataType,
-    DeepTexturePixelFormat,
+    DepthTexturePixelFormat,
     MagnificationTextureFilter,
     MinificationTextureFilter,
     TextureComparisonFunction,
@@ -42,7 +42,7 @@ export class DepthTexture extends Texture {
         magFilter?: MagnificationTextureFilter,
         minFilter?: MinificationTextureFilter,
         anisotropy?: number,
-        format?: DeepTexturePixelFormat,
+        format?: DepthTexturePixelFormat,
     );
 
     /**
@@ -88,7 +88,7 @@ export class DepthTexture extends Texture {
      * @see {@link Texture.format | Texture.format}
      * @defaultValue {@link THREE.DepthFormat}.
      */
-    format: DeepTexturePixelFormat;
+    format: DepthTexturePixelFormat;
 
     /**
      * @override

three/src/textures/Texture.d.ts

@@ -201,8 +201,8 @@ export class Texture extends EventDispatcher<{ dispose: {} }> {
 
     /**
      * These define how elements of a 2D texture, or texels, are read by shaders.
-     * @remarks All {@link Texture} types except {@link THREE.DeepTexture} and {@link THREE.CompressedPixelFormat} expect the _values_ be {@link THREE.PixelFormat}
-     * @remarks {@link DeepTexture} expect the _values_ be {@link THREE.CubeTextureMapping}
+     * @remarks All {@link Texture} types except {@link THREE.DepthTexture} and {@link THREE.CompressedPixelFormat} expect the _values_ be {@link THREE.PixelFormat}
+     * @remarks {@link DepthTexture} expect the _values_ be {@link THREE.CubeTextureMapping}
      * @remarks {@link CompressedPixelFormat} expect the _values_ be {@link THREE.CubeTextureMapping}
      * @see {@link https://threejs.org/docs/index.html#api/en/constants/Textures | Texture Constants}
      * @see {@link THREE.PixelFormat}