@types/three 0.157.1 → 0.158.0

three/README.md

@@ -8,7 +8,7 @@ This package contains type definitions for three (https://threejs.org/).
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/three.
 
 ### Additional Details
- * Last updated: Wed, 18 Oct 2023 11:45:06 GMT
+ * Last updated: Fri, 27 Oct 2023 18:16:28 GMT
  * Dependencies: [@types/stats.js](https://npmjs.com/package/@types/stats.js), [@types/webxr](https://npmjs.com/package/@types/webxr), [fflate](https://npmjs.com/package/fflate), [meshoptimizer](https://npmjs.com/package/meshoptimizer)
 
 # Credits

three/examples/jsm/Addons.d.ts

@@ -0,0 +1,290 @@
+export * from './animation/AnimationClipCreator.js';
+export * from './animation/CCDIKSolver.js';
+export * from './animation/MMDAnimationHelper.js';
+export * from './animation/MMDPhysics.js';
+
+export * from './cameras/CinematicCamera.js';
+
+export { default as WebGL } from './capabilities/WebGL.js';
+
+export * from './controls/ArcballControls.js';
+export * from './controls/DragControls.js';
+export * from './controls/FirstPersonControls.js';
+export * from './controls/FlyControls.js';
+export * from './controls/MapControls.js';
+export * from './controls/OrbitControls.js';
+export * from './controls/PointerLockControls.js';
+export * from './controls/TrackballControls.js';
+export * from './controls/TransformControls.js';
+
+export * from './csm/CSM.js';
+export * from './csm/CSMFrustum.js';
+export * from './csm/CSMHelper.js';
+export * from './csm/CSMShader.js';
+
+export * as Curves from './curves/CurveExtras.js';
+export * from './curves/NURBSCurve.js';
+export * from './curves/NURBSSurface.js';
+export * as NURBSUtils from './curves/NURBSUtils.js';
+
+export * from './effects/AnaglyphEffect.js';
+export * from './effects/AsciiEffect.js';
+export * from './effects/OutlineEffect.js';
+export * from './effects/ParallaxBarrierEffect.js';
+export * from './effects/PeppersGhostEffect.js';
+export * from './effects/StereoEffect.js';
+
+export * from './environments/DebugEnvironment.js';
+export * from './environments/RoomEnvironment.js';
+
+export * from './exporters/DRACOExporter.js';
+export * from './exporters/EXRExporter.js';
+export * from './exporters/GLTFExporter.js';
+export * from './exporters/KTX2Exporter.js';
+export * from './exporters/MMDExporter.js';
+export * from './exporters/OBJExporter.js';
+export * from './exporters/PLYExporter.js';
+export * from './exporters/STLExporter.js';
+export * from './exporters/USDZExporter.js';
+
+export * from './geometries/BoxLineGeometry.js';
+export * from './geometries/ConvexGeometry.js';
+export * from './geometries/DecalGeometry.js';
+export * from './geometries/ParametricGeometries.js';
+export * from './geometries/ParametricGeometry.js';
+export * from './geometries/RoundedBoxGeometry.js';
+export * from './geometries/TeapotGeometry.js';
+export * from './geometries/TextGeometry.js';
+
+export * from './helpers/LightProbeHelper.js';
+export * from './helpers/OctreeHelper.js';
+export * from './helpers/PositionalAudioHelper.js';
+export * from './helpers/RectAreaLightHelper.js';
+export * from './helpers/VertexNormalsHelper.js';
+export * from './helpers/VertexTangentsHelper.js';
+export * from './helpers/ViewHelper.js';
+
+export * from './interactive/HTMLMesh.js';
+export * from './interactive/InteractiveGroup.js';
+export * from './interactive/SelectionBox.js';
+export * from './interactive/SelectionHelper.js';
+
+export { default as IESSpotLight } from './lights/IESSpotLight.js';
+export * from './lights/LightProbeGenerator.js';
+export * from './lights/RectAreaLightUniformsLib.js';
+
+export * from './lines/Line2.js';
+export * from './lines/LineGeometry.js';
+export * from './lines/LineMaterial.js';
+export * from './lines/LineSegments2.js';
+export * from './lines/LineSegmentsGeometry.js';
+export * from './lines/Wireframe.js';
+export * from './lines/WireframeGeometry2.js';
+
+export * from './loaders/3DMLoader.js';
+export * from './loaders/3MFLoader.js';
+export * from './loaders/AMFLoader.js';
+export * from './loaders/BVHLoader.js';
+export * from './loaders/ColladaLoader.js';
+export * from './loaders/DDSLoader.js';
+export * from './loaders/DRACOLoader.js';
+export * from './loaders/EXRLoader.js';
+export * from './loaders/FBXLoader.js';
+export * from './loaders/FontLoader.js';
+export * from './loaders/GCodeLoader.js';
+export * from './loaders/GLTFLoader.js';
+export * from './loaders/HDRCubeTextureLoader.js';
+export * from './loaders/IESLoader.js';
+export * from './loaders/KMZLoader.js';
+export * from './loaders/KTX2Loader.js';
+export * from './loaders/KTXLoader.js';
+export * from './loaders/LDrawLoader.js';
+export * from './loaders/LUT3dlLoader.js';
+export * from './loaders/LUTCubeLoader.js';
+export * from './loaders/LWOLoader.js';
+export * from './loaders/LogLuvLoader.js';
+export * from './loaders/LottieLoader.js';
+export * from './loaders/MD2Loader.js';
+export * from './loaders/MDDLoader.js';
+export * from './loaders/MMDLoader.js';
+export * from './loaders/MTLLoader.js';
+export * from './loaders/NRRDLoader.js';
+export * from './loaders/OBJLoader.js';
+export * from './loaders/PCDLoader.js';
+export * from './loaders/PDBLoader.js';
+export * from './loaders/PLYLoader.js';
+export * from './loaders/PVRLoader.js';
+export * from './loaders/RGBELoader.js';
+export * from './loaders/RGBMLoader.js';
+export * from './loaders/STLLoader.js';
+export * from './loaders/SVGLoader.js';
+export * from './loaders/TDSLoader.js';
+export * from './loaders/TGALoader.js';
+export * from './loaders/TIFFLoader.js';
+export * from './loaders/TTFLoader.js';
+export * from './loaders/TiltLoader.js';
+export * from './loaders/USDZLoader.js';
+export * from './loaders/VOXLoader.js';
+export * from './loaders/VRMLLoader.js';
+export * from './loaders/VTKLoader.js';
+export * from './loaders/XYZLoader.js';
+
+export * from './materials/MeshGouraudMaterial.js';
+
+export * from './math/Capsule.js';
+export * from './math/ColorConverter.js';
+export * from './math/ConvexHull.js';
+export * from './math/ImprovedNoise.js';
+export * from './math/Lut.js';
+export * from './math/MeshSurfaceSampler.js';
+export * from './math/OBB.js';
+export * from './math/Octree.js';
+export * from './math/SimplexNoise.js';
+
+export * from './misc/ConvexObjectBreaker.js';
+export * from './misc/GPUComputationRenderer.js';
+export * from './misc/Gyroscope.js';
+export * from './misc/MD2Character.js';
+export * from './misc/MD2CharacterComplex.js';
+export * from './misc/MorphAnimMesh.js';
+export * from './misc/MorphBlendMesh.js';
+export * from './misc/ProgressiveLightMap.js';
+export * from './misc/RollerCoaster.js';
+export * from './misc/TubePainter.js';
+export * from './misc/Volume.js';
+export * from './misc/VolumeSlice.js';
+
+export * from './modifiers/CurveModifier.js';
+export * from './modifiers/EdgeSplitModifier.js';
+export * from './modifiers/SimplifyModifier.js';
+export * from './modifiers/TessellateModifier.js';
+
+export * from './objects/BatchedMesh.js';
+export * from './objects/GroundProjectedSkybox.js';
+export * from './objects/Lensflare.js';
+export * from './objects/MarchingCubes.js';
+export * from './objects/Reflector.js';
+export * from './objects/ReflectorForSSRPass.js';
+export * from './objects/Refractor.js';
+export * from './objects/ShadowMesh.js';
+export * from './objects/Sky.js';
+export * from './objects/Water.js';
+export { Water as Water2 } from './objects/Water2.js';
+
+export * from './physics/AmmoPhysics.js';
+export * from './physics/RapierPhysics.js';
+
+export * from './postprocessing/AfterimagePass.js';
+export * from './postprocessing/BloomPass.js';
+export * from './postprocessing/BokehPass.js';
+export * from './postprocessing/ClearPass.js';
+export * from './postprocessing/CubeTexturePass.js';
+export * from './postprocessing/DotScreenPass.js';
+export * from './postprocessing/EffectComposer.js';
+export * from './postprocessing/FilmPass.js';
+export * from './postprocessing/GlitchPass.js';
+export * from './postprocessing/HalftonePass.js';
+export * from './postprocessing/LUTPass.js';
+export * from './postprocessing/MaskPass.js';
+export * from './postprocessing/OutlinePass.js';
+export * from './postprocessing/OutputPass.js';
+export * from './postprocessing/Pass.js';
+export * from './postprocessing/RenderPass.js';
+export * from './postprocessing/RenderPixelatedPass.js';
+export * from './postprocessing/SAOPass.js';
+export * from './postprocessing/SMAAPass.js';
+export * from './postprocessing/SSAARenderPass.js';
+export * from './postprocessing/SSAOPass.js';
+export * from './postprocessing/SSRPass.js';
+export * from './postprocessing/SavePass.js';
+export * from './postprocessing/ShaderPass.js';
+export * from './postprocessing/TAARenderPass.js';
+export * from './postprocessing/TexturePass.js';
+export * from './postprocessing/UnrealBloomPass.js';
+
+export * from './renderers/CSS2DRenderer.js';
+export * from './renderers/CSS3DRenderer.js';
+export * from './renderers/Projector.js';
+export * from './renderers/SVGRenderer.js';
+
+export * from './shaders/ACESFilmicToneMappingShader.js';
+export * from './shaders/AfterimageShader.js';
+export * from './shaders/BasicShader.js';
+export * from './shaders/BleachBypassShader.js';
+export * from './shaders/BlendShader.js';
+export * from './shaders/BokehShader.js';
+export { BokehShader as BokehShader2 } from './shaders/BokehShader2.js';
+export * from './shaders/BrightnessContrastShader.js';
+export * from './shaders/ColorCorrectionShader.js';
+export * from './shaders/ColorifyShader.js';
+export * from './shaders/ConvolutionShader.js';
+export * from './shaders/CopyShader.js';
+export * from './shaders/DOFMipMapShader.js';
+export * from './shaders/DepthLimitedBlurShader.js';
+export * from './shaders/DigitalGlitch.js';
+export * from './shaders/DotScreenShader.js';
+export * from './shaders/ExposureShader.js';
+export * from './shaders/FXAAShader.js';
+export * from './shaders/FilmShader.js';
+export * from './shaders/FocusShader.js';
+export * from './shaders/FreiChenShader.js';
+export * from './shaders/GammaCorrectionShader.js';
+export * from './shaders/GodRaysShader.js';
+export * from './shaders/HalftoneShader.js';
+export * from './shaders/HorizontalBlurShader.js';
+export * from './shaders/HorizontalTiltShiftShader.js';
+export * from './shaders/HueSaturationShader.js';
+export * from './shaders/KaleidoShader.js';
+export * from './shaders/LuminosityHighPassShader.js';
+export * from './shaders/LuminosityShader.js';
+export * from './shaders/MMDToonShader.js';
+export * from './shaders/MirrorShader.js';
+export * from './shaders/NormalMapShader.js';
+export * from './shaders/OutputShader.js';
+export * from './shaders/RGBShiftShader.js';
+export * from './shaders/SAOShader.js';
+export * from './shaders/SMAAShader.js';
+export * from './shaders/SSAOShader.js';
+export * from './shaders/SSRShader.js';
+export * from './shaders/SepiaShader.js';
+export * from './shaders/SobelOperatorShader.js';
+export * from './shaders/SubsurfaceScatteringShader.js';
+export * from './shaders/TechnicolorShader.js';
+export * from './shaders/ToonShader.js';
+export * from './shaders/TriangleBlurShader.js';
+export * from './shaders/UnpackDepthRGBAShader.js';
+export * from './shaders/VelocityShader.js';
+export * from './shaders/VerticalBlurShader.js';
+export * from './shaders/VerticalTiltShiftShader.js';
+export * from './shaders/VignetteShader.js';
+export * from './shaders/VolumeShader.js';
+export * from './shaders/WaterRefractionShader.js';
+
+export * from './textures/FlakesTexture.js';
+
+export * as BufferGeometryUtils from './utils/BufferGeometryUtils.js';
+export * as CameraUtils from './utils/CameraUtils.js';
+export * from './utils/GPUStatsPanel.js';
+export * as GeometryCompressionUtils from './utils/GeometryCompressionUtils.js';
+export * as GeometryUtils from './utils/GeometryUtils.js';
+export * from './utils/LDrawUtils.js';
+export * from './utils/PackedPhongMaterial.js';
+export * as SceneUtils from './utils/SceneUtils.js';
+export * from './utils/ShadowMapViewer.js';
+export * as SkeletonUtils from './utils/SkeletonUtils.js';
+export * from './utils/TextureUtils.js';
+export * from './utils/UVsDebug.js';
+export * from './utils/WorkerPool.js';
+
+export * from './webxr/ARButton.js';
+export * from './webxr/OculusHandModel.js';
+export * from './webxr/OculusHandPointerModel.js';
+export * from './webxr/Text2D.js';
+export * from './webxr/VRButton.js';
+export * from './webxr/XRButton.js';
+export * from './webxr/XRControllerModelFactory.js';
+export * from './webxr/XREstimatedLight.js';
+export * from './webxr/XRHandMeshModel.js';
+export * from './webxr/XRHandModelFactory.js';
+export * from './webxr/XRHandPrimitiveModel.js';
+export * from './webxr/XRPlanes.js';

three/examples/jsm/animation/CCDIKSolver.d.ts

@@ -0,0 +1,30 @@
+import { Object3D, SkinnedMesh, Vector3 } from '../../../src/Three.js';
+
+// tslint:disable-next-line:interface-name
+export interface IKS {
+    effector: number;
+    iteration?: number | undefined;
+    links: Array<{
+        enabled?: boolean | undefined;
+        index: number;
+        limitation?: Vector3 | undefined;
+        rotationMin?: Vector3 | undefined;
+        rotationMax?: Vector3 | undefined;
+    }>;
+    minAngle?: number | undefined;
+    maxAngle?: number | undefined;
+    target: number;
+}
+
+export class CCDIKSolver {
+    constructor(mesh: SkinnedMesh, iks: IKS[]);
+
+    update(): this;
+    updateOne(iks: IKS): this;
+    createHelper(): CCDIKHelper;
+}
+
+export class CCDIKHelper extends Object3D {
+    constructor(mesh: SkinnedMesh, iks?: IKS[], sphereSize?: number);
+    dispose(): void;
+}

three/examples/jsm/animation/MMDAnimationHelper.d.ts

@@ -0,0 +1,105 @@
+import {
+    AnimationClip,
+    Audio,
+    Camera,
+    Mesh,
+    Object3D,
+    Quaternion,
+    SkinnedMesh,
+    Bone,
+    AnimationMixer,
+} from '../../../src/Three.js';
+
+import { CCDIKSolver } from './CCDIKSolver.js';
+import { MMDPhysics } from './MMDPhysics.js';
+
+export interface MMDAnimationHelperParameter {
+    sync?: boolean | undefined;
+    afterglow?: number | undefined;
+    resetPhysicsOnLoop?: boolean | undefined;
+    pmxAnimation?: boolean | undefined;
+}
+
+export interface MMDAnimationHelperAddParameter {
+    animation?: AnimationClip | AnimationClip[] | undefined;
+    physics?: boolean | undefined;
+    warmup?: number | undefined;
+    unitStep?: number | undefined;
+    maxStepNum?: number | undefined;
+    gravity?: number | undefined;
+    delayTime?: number | undefined;
+}
+
+export interface MMDAnimationHelperPoseParameter {
+    resetPose?: boolean | undefined;
+    ik?: boolean | undefined;
+    grant?: boolean | undefined;
+}
+
+export interface MMDAnimationHelperMixer {
+    looped: boolean;
+    mixer?: AnimationMixer | undefined;
+    ikSolver: CCDIKSolver;
+    grantSolver: GrantSolver;
+    physics?: MMDPhysics | undefined;
+    duration?: number | undefined;
+}
+
+export class MMDAnimationHelper {
+    constructor(params?: MMDAnimationHelperParameter);
+    meshes: SkinnedMesh[];
+    camera: Camera | null;
+    cameraTarget: Object3D;
+    audio: Audio;
+    audioManager: AudioManager;
+    configuration: {
+        sync: boolean;
+        afterglow: number;
+        resetPhysicsOnLoop: boolean;
+        pmxAnimation: boolean;
+    };
+    enabled: {
+        animation: boolean;
+        ik: boolean;
+        grant: boolean;
+        physics: boolean;
+        cameraAnimation: boolean;
+    };
+    objects: WeakMap<SkinnedMesh | Camera | AudioManager, MMDAnimationHelperMixer>;
+    onBeforePhysics: (mesh: SkinnedMesh) => void;
+    sharedPhysics: boolean;
+    masterPhysics: null;
+
+    add(object: SkinnedMesh | Camera | Audio, params?: MMDAnimationHelperAddParameter): this;
+    remove(object: SkinnedMesh | Camera | Audio): this;
+    update(delta: number): this;
+    pose(mesh: SkinnedMesh, vpd: object, params?: MMDAnimationHelperPoseParameter): this;
+    enable(key: string, enabled: boolean): this;
+    createGrantSolver(mesh: SkinnedMesh): GrantSolver;
+}
+
+export interface AudioManagerParameter {
+    delayTime?: number | undefined;
+}
+
+export class AudioManager {
+    constructor(audio: Audio, params?: AudioManagerParameter);
+    audio: Audio;
+    elapsedTime: number;
+    currentTime: number;
+    delayTime: number;
+    audioDuration: number;
+    duration: number;
+
+    control(delta: number): this;
+}
+
+export class GrantSolver {
+    constructor(mesh: SkinnedMesh, grants: object[]);
+    mesh: SkinnedMesh;
+    grants: object[];
+
+    update(): this;
+    updateOne(gran: object[]): this;
+    addGrantRotation(bone: Bone, q: Quaternion, ratio: number): this;
+}

three/examples/jsm/animation/MMDPhysics.d.ts

@@ -0,0 +1,124 @@
+import { Bone, Euler, Matrix4, Object3D, Quaternion, SkinnedMesh, Vector3 } from '../../../src/Three.js';
+
+export interface MMDPhysicsParameter {
+    unitStep?: number | undefined;
+    maxStepNum?: number | undefined;
+    gravity?: Vector3 | undefined;
+}
+
+export class MMDPhysics {
+    constructor(
+        mesh: SkinnedMesh,
+        rigidBodyParams: object[],
+        constraintParams?: object[],
+        params?: MMDPhysicsParameter,
+    );
+    manager: ResourceManager;
+    mesh: SkinnedMesh;
+    unitStep: number;
+    maxStepNum: number;
+    gravity: Vector3;
+    world: null;
+    bodies: RigidBody[];
+    constraints: Constraint[];
+
+    update(delta: number): this;
+    reset(): this;
+    warmup(cycles: number): this;
+    setGravity(gravity: Vector3): this;
+    createHelper(): MMDPhysicsHelper;
+}
+
+export class ResourceManager {
+    constructor();
+    threeVector3s: Vector3[];
+    threeMatrix4s: Matrix4[];
+    threeQuaternions: Quaternion[];
+    threeEulers: Euler[];
+    transforms: object[];
+    quaternions: object[];
+    vector3s: object[];
+
+    allocThreeVector3(): void;
+    freeThreeVector3(v: Vector3): void;
+    allocThreeMatrix4(): void;
+    freeThreeMatrix4(m: Matrix4): void;
+    allocThreeQuaternion(): void;
+    freeThreeQuaternion(q: Quaternion): void;
+    allocThreeEuler(): void;
+    freeThreeEuler(e: Euler): void;
+    allocTransform(): void;
+    freeTransform(t: object): void;
+    allocQuaternion(): void;
+    freeQuaternion(q: object): void;
+    allocVector3(): void;
+    freeVector3(v: object): void;
+    setIdentity(): void;
+    getBasis(t: object): object;
+    getBasisAsMatrix3(t: object): object;
+    getOrigin(t: object): object;
+    setOrigin(t: object, v: object): void;
+    copyOrigin(t1: object, t2: object): void;
+    setBasis(t: object, q: object): void;
+    setBasisFromMatrix3(t: object, m: object): void;
+    setOriginFromArray3(t: object, a: number[]): void;
+    setOriginFromThreeVector3(t: object, v: Vector3): void;
+    setBasisFromArray3(t: object, a: number[]): void;
+    setBasisFromThreeQuaternion(t: object, a: Quaternion): void;
+    multiplyTransforms(t1: object, t2: object): object;
+    inverseTransform(t: object): object;
+    multiplyMatrices3(m1: object, m2: object): object;
+    addVector3(v1: object, v2: object): object;
+    dotVectors3(v1: object, v2: object): number;
+    rowOfMatrix3(m: object, i: number): object;
+    columnOfMatrix3(m: object, i: number): object;
+    negativeVector3(v: object): object;
+    multiplyMatrix3ByVector3(m: object, v: object): object;
+    transposeMatrix3(m: object): object;
+    quaternionToMatrix3(q: object): object;
+    matrix3ToQuaternion(m: object): object;
+}
+
+export class RigidBody {
+    constructor(mesh: SkinnedMesh, world: object, params: object, manager: ResourceManager);
+    mesh: SkinnedMesh;
+    world: object;
+    params: object;
+    manager: ResourceManager;
+
+    body: object;
+    bone: Bone;
+    boneOffsetForm: object;
+    boneOffsetFormInverse: object;
+
+    reset(): this;
+    updateFromBone(): this;
+    updateBone(): this;
+}
+
+export class Constraint {
+    constructor(
+        mesh: SkinnedMesh,
+        world: object,
+        bodyA: RigidBody,
+        bodyB: RigidBody,
+        params: object,
+        manager: ResourceManager,
+    );
+
+    mesh: SkinnedMesh;
+    world: object;
+    bodyA: RigidBody;
+    bodyB: RigidBody;
+    params: object;
+    manager: ResourceManager;
+}
+
+export class MMDPhysicsHelper extends Object3D {
+    mesh: THREE.SkinnedMesh;
+    physics: MMDPhysics;
+    materials: [THREE.MeshBasicMaterial, THREE.MeshBasicMaterial, THREE.MeshBasicMaterial];
+
+    constructor(mesh: THREE.SkinnedMesh, physics: MMDPhysics);
+    dispose(): void;
+}

three/examples/jsm/cameras/CinematicCamera.d.ts

@@ -0,0 +1,41 @@
+import {
+    PerspectiveCamera,
+    ShaderMaterial,
+    Scene,
+    WebGLRenderer,
+    OrthographicCamera,
+    WebGLRenderTarget,
+} from '../../../src/Three.js';
+
+import { BokehShaderUniforms } from './../shaders/BokehShader2.js';
+
+export class CinematicCamera extends PerspectiveCamera {
+    constructor(fov: number, aspect: number, near: number, far: number);
+
+    postprocessing: {
+        enabled: boolean;
+        scene: Scene;
+        camera: OrthographicCamera;
+        rtTextureDepth: WebGLRenderTarget;
+        rtTextureColor: WebGLRenderTarget;
+        bokeh_uniforms: BokehShaderUniforms;
+    };
+    shaderSettings: {
+        rings: number;
+        samples: number;
+    };
+    materialDepth: ShaderMaterial;
+    coc: number;
+    aperture: number;
+    fNumber: number;
+    hyperFocal: number;
+    filmGauge: number;
+
+    linearize(depth: number): number;
+    smoothstep(near: number, far: number, depth: number): number;
+    saturate(x: number): number;
+    focusAt(focusDistance: number): void;
+    initPostProcessing(): void;
+    renderCinematic(scene: Scene, renderer: WebGLRenderer): void;
+    setLens(focalLength: number, frameHeight?: number, fNumber?: number, coc?: number): void;
+}

three/examples/jsm/capabilities/WebGL.d.ts

@@ -0,0 +1,9 @@
+// tslint:disable-next-line:no-unnecessary-class
+export default class WebGL {
+    static isWebGLAvailable(): boolean;
+    static isWebGL2Available(): boolean;
+    static isColorSpaceAvailable(colorSpace: PredefinedColorSpace): boolean;
+    static getWebGLErrorMessage(): HTMLElement;
+    static getWebGL2ErrorMessage(): HTMLElement;
+    static getErrorMessage(version: number): HTMLElement;
+}