@types/three 0.157.2 → 0.158.0

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}

three/examples/jsm/controls/FirstPersonControls.d.ts

@@ -1,31 +0,0 @@
-import { Camera, Vector3 } from '../../../src/Three.js';
-
-export class FirstPersonControls {
-    constructor(object: Camera, domElement?: HTMLElement);
-
-    object: Camera;
-    domElement: HTMLElement | Document;
-
-    enabled: boolean;
-    movementSpeed: number;
-    lookSpeed: number;
-    lookVertical: boolean;
-    autoForward: boolean;
-    activeLook: boolean;
-    heightSpeed: boolean;
-    heightCoef: number;
-    heightMin: number;
-    heightMax: number;
-    constrainVertical: boolean;
-    verticalMin: number;
-    verticalMax: number;
-    mouseDragOn: boolean;
-
-    handleResize(): void;
-
-    lookAt(x: Vector3): this;
-    lookAt(x: number, y: number, z: number): this;
-
-    update(delta: number): this;
-    dispose(): void;
-}

three/examples/jsm/geometries/TextGeometry.d.ts

@@ -1,115 +0,0 @@
-import { ExtrudeGeometry, ExtrudeGeometryOptions, Shape } from '../../../src/Three.js';
-
-import { Font } from '../loaders/FontLoader.js';
-
-export interface TextGeometryParameters extends ExtrudeGeometryOptions {
-    font: Font;
-
-    /**
-     * Size of the text
-     * Expects a `Float`.
-     * @defaultValue `100`
-     */
-    size?: number | undefined;
-
-    /**
-     * Thickness to extrude text.
-     * Expects a `Float`.
-     * @defaultValue `50`
-     */
-    height?: number | undefined;
-
-    /**
-     * @override
-     * @defaultValue `12`
-     */
-    curveSegments?: number | undefined;
-
-    /**
-     * @defaultValue `false`
-     */
-    bevelEnabled?: boolean | undefined;
-
-    /**
-     * How deep into text bevel goes.
-     * Expects a `Float`.
-     * @override
-     * @defaultValue `10`
-     */
-    bevelThickness?: number | undefined;
-
-    /**
-     * How far from text outline is bevel.
-     * Expects a `Float`.
-     * @override
-     * @defaultValue `8`
-     */
-    bevelSize?: number | undefined;
-
-    /**
-     * How far from text outline bevel starts.
-     * Expects a `Float`.
-     * @override
-     * @defaultValue `0`
-     */
-    bevelOffset?: number | undefined;
-
-    /**
-     * @override
-     * @defaultValue `3`
-     */
-    bevelSegments?: number | undefined;
-}
-
-/**
- * A class for generating text as a single geometry
- * @remarks
- * It is constructed by providing a string of text, and a set of parameters consisting of a loaded font and settings for the geometry's parent {@link THREE.ExtrudeGeometry | ExtrudeGeometry}
- * See the {@link THREE.FontLoader | FontLoader} page for additional details.
- * @example
- * ```typescript
- * const loader = new FontLoader();
- * loader.load('fonts/helvetiker_regular.typeface.json', function (font) {
- *     const geometry = new TextGeometry('Hello three.js!', {
- *         font: font,
- *         size: 80,
- *         height: 5,
- *         curveSegments: 12,
- *         bevelEnabled: true,
- *         bevelThickness: 10,
- *         bevelSize: 8,
- *         bevelOffset: 0,
- *         bevelSegments: 5
- *     });
- * });
- * ```
- * @see Example: {@link https://threejs.org/examples/#webgl_geometry_text | geometry / text }
- * @see {@link https://threejs.org/docs/index.html#api/en/C:/rafaelsc/Source/threejs/three.js/docs/examples/en/geometries/TextGeometry | Official Documentation}
- * @see {@link https://github.com/mrdoob/three.js/blob/master/examples/jsm/geometries/TextGeometry.js | Source}
- */
-export class TextGeometry extends ExtrudeGeometry {
-    /**
-     * Create a new instance of {@link TextGeometry}
-     * @param text The text that needs to be shown.
-     * @param parameters Object that can contain the following parameters. @see {@link TextGeometryParameters} for defaults.
-     */
-    constructor(text: string, parameters?: TextGeometryParameters);
-
-    /**
-     * A Read-only _string_ to check if `this` object type.
-     * @remarks Sub-classes will update this value.
-     * @defaultValue `TextGeometry`
-     */
-    override readonly type: string | 'TextGeometry';
-
-    /**
-     * An object with a property for each of the constructor parameters.
-     * @remarks Any modification after instantiation does not change the geometry.
-     */
-    readonly parameters: {
-        readonly shapes: Shape | Shape[];
-        readonly options: TextGeometryParameters;
-    };
-}
-
-export { TextGeometry as TextBufferGeometry };

three/examples/jsm/loaders/FontLoader.d.ts

@@ -1,27 +0,0 @@
-import { Shape, Loader, LoadingManager } from '../../../src/Three.js';
-
-export class FontLoader extends Loader<Font> {
-    constructor(manager?: LoadingManager);
-
-    load(
-        url: string,
-        onLoad?: (data: Font) => void,
-        onProgress?: (event: ProgressEvent) => void,
-        onError?: (err: unknown) => void,
-    ): void;
-
-    parse(json: any): Font;
-}
-
-export class Font {
-    constructor(jsondata: any);
-
-    /**
-     * @default 'Font'
-     */
-    type: string;
-
-    data: string;
-
-    generateShapes(text: string, size: number): Shape[];
-}

three/examples/jsm/loaders/HDRCubeTextureLoader.d.ts

@@ -1,18 +0,0 @@
-import { CubeTexture, Loader, LoadingManager, TextureDataType } from '../../../src/Three.js';
-
-import { RGBELoader } from './RGBELoader.js';
-
-export class HDRCubeTextureLoader extends Loader<CubeTexture, readonly string[]> {
-    constructor(manager?: LoadingManager);
-    hdrLoader: RGBELoader;
-    type: TextureDataType;
-
-    load(
-        url: readonly string[],
-        onLoad?: (data: CubeTexture) => void,
-        onProgress?: (event: ProgressEvent) => void,
-        onError?: (err: unknown) => void,
-    ): CubeTexture;
-
-    setDataType(type: TextureDataType): this;
-}

three/examples/jsm/loaders/RGBMLoader.d.ts

@@ -1,32 +0,0 @@
-import { CubeTexture, LoadingManager, DataTextureLoader, PixelFormat, TextureDataType } from '../../../src/Three.js';
-
-export interface RGBM {
-    width: number;
-    height: number;
-    data: Uint16Array | Float32Array;
-    header: string;
-    format: PixelFormat;
-    type: TextureDataType;
-    flipY: boolean;
-}
-
-export class RGBMLoader extends DataTextureLoader {
-    type: TextureDataType;
-
-    maxRange: number;
-
-    constructor(manager?: LoadingManager);
-
-    loadCubemap(
-        urls: string[],
-        onLoad?: (texture: CubeTexture) => void,
-        onProgress?: (event: ProgressEvent) => void,
-        onError?: (event: ErrorEvent) => void,
-    ): CubeTexture;
-
-    parse(buffer: ArrayBuffer): RGBM;
-
-    setDataType(dataType: TextureDataType): this;
-
-    setMaxRange(value: number): this;
-}

three/examples/jsm/modifiers/TessellateModifier.d.ts

@@ -1,9 +0,0 @@
-import { BufferGeometry } from '../../../src/Three.js';
-
-export class TessellateModifier {
-    constructor(maxEdgeLength?: number, maxIterations?: number);
-    maxEdgeLength: number;
-    maxIterations: number;
-
-    modify<TGeometry extends BufferGeometry>(geometry: TGeometry): TGeometry;
-}

three/examples/jsm/objects/GroundProjectedSkybox.d.ts

@@ -1,13 +0,0 @@
-import { Mesh, IcosahedronGeometry, ShaderMaterial, Texture } from '../../../src/Three.js';
-
-export class GroundProjectedSkybox extends Mesh<IcosahedronGeometry, ShaderMaterial> {
-    constructor(texture: Texture, options?: { height?: number; radius?: number });
-
-    set radius(radius: number);
-
-    get radius(): number;
-
-    set height(height: number);
-
-    get height(): number;
-}

three/examples/jsm/objects/MarchingCubes.d.ts

@@ -1,76 +0,0 @@
-import { BufferGeometry, Material, Mesh, Color } from '../../../src/Three.js';
-
-export class MarchingCubes extends Mesh {
-    constructor(
-        resolution: number,
-        material: Material,
-        enableUvs?: boolean,
-        enableColors?: boolean,
-        maxPolyCount?: number,
-    );
-
-    enableUvs: boolean;
-    enableColors: boolean;
-
-    resolution: number;
-
-    // parameters
-
-    isolation: number;
-
-    // size of field, 32 is pushing it in Javascript :)
-
-    size: number;
-    size2: number;
-    size3: number;
-    halfsize: number;
-
-    // deltas
-
-    delta: number;
-    yd: number;
-    zd: number;
-
-    field: Float32Array;
-    normal_cache: Float32Array;
-    palette: Float32Array;
-
-    maxCount: number;
-    count: number;
-
-    hasPositions: boolean;
-    hasNormals: boolean;
-    hasColors: boolean;
-    hasUvs: boolean;
-
-    positionArray: Float32Array;
-    normalArray: Float32Array;
-
-    uvArray: Float32Array;
-    colorArray: Float32Array;
-
-    begin(): void;
-    end(): void;
-
-    init(resolution: number): void;
-
-    addBall(ballx: number, bally: number, ballz: number, strength: number, subtract: number, colors?: Color): void;
-
-    addPlaneX(strength: number, subtract: number): void;
-    addPlaneY(strength: number, subtract: number): void;
-    addPlaneZ(strength: number, subtract: number): void;
-
-    setCell(x: number, y: number, z: number, value: number): void;
-    getCell(x: number, y: number, z: number): number;
-
-    blur(intensity: number): void;
-
-    reset(): void;
-    update(): void;
-    render(renderCallback: any): void;
-    generateGeometry(): BufferGeometry;
-    generateBufferGeometry(): BufferGeometry;
-}
-
-export const edgeTable: Int32Array[];
-export const triTable: Int32Array[];

three/examples/jsm/shaders/ToonShader.d.ts

@@ -1,54 +0,0 @@
-import { IUniform } from '../../../src/Three.js';
-
-export const ToonShader1: {
-    uniforms: {
-        uDirLightPos: IUniform;
-        uDirLightColor: IUniform;
-        uAmbientLightColor: IUniform;
-        uBaseColor: IUniform;
-    };
-    vertexShader: string;
-    fragmentShader: string;
-};
-
-export const ToonShader2: {
-    uniforms: {
-        uDirLightPos: IUniform;
-        uDirLightColor: IUniform;
-        uAmbientLightColor: IUniform;
-        uBaseColor: IUniform;
-        uLineColor1: IUniform;
-        uLineColor2: IUniform;
-        uLineColor3: IUniform;
-        uLineColor4: IUniform;
-    };
-    vertexShader: string;
-    fragmentShader: string;
-};
-
-export const ToonShaderHatching: {
-    uniforms: {
-        uDirLightPos: IUniform;
-        uDirLightColor: IUniform;
-        uAmbientLightColor: IUniform;
-        uBaseColor: IUniform;
-        uLineColor1: IUniform;
-        uLineColor2: IUniform;
-        uLineColor3: IUniform;
-        uLineColor4: IUniform;
-    };
-    vertexShader: string;
-    fragmentShader: string;
-};
-
-export const ToonShaderDotted: {
-    uniforms: {
-        uDirLightPos: IUniform;
-        uDirLightColor: IUniform;
-        uAmbientLightColor: IUniform;
-        uBaseColor: IUniform;
-        uLineColor1: IUniform;
-    };
-    vertexShader: string;
-    fragmentShader: string;
-};

three/examples/jsm/textures/FlakesTexture.d.ts

@@ -1,3 +0,0 @@
-export class FlakesTexture extends HTMLCanvasElement {
-    constructor(width?: number, height?: number);
-}

three/examples/jsm/utils/CameraUtils.d.ts

@@ -1,9 +0,0 @@
-import { PerspectiveCamera, Vector3 } from '../../../src/Three.js';
-
-export function frameCorners(
-    camera: PerspectiveCamera,
-    bottomLeftCorner: Vector3,
-    bottomRightCorner: Vector3,
-    topLeftCorner: Vector3,
-    estimateViewFrustum?: boolean,
-): void;

three/examples/jsm/utils/ShadowMapViewer.d.ts

@@ -1,24 +0,0 @@
-import { Light, Renderer } from '../../../src/Three.js';
-
-export interface Size {
-    width: number;
-    height: number;
-    set: (width: number, height: number) => void;
-}
-
-export interface Position {
-    x: number;
-    y: number;
-    set: (x: number, y: number) => void;
-}
-
-export class ShadowMapViewer {
-    constructor(light: Light);
-
-    enabled: boolean;
-    size: Size;
-    position: Position;
-    render(renderer: Renderer): void;
-    updateForWindowResize(): void;
-    update(): void;
-}