🤖 Merge PR DefinitelyTyped#74890 [three] r184 by @Methuselah96

Author: Methuselah96

types/three/examples/jsm/Addons.d.ts

@@ -30,6 +30,7 @@ export * from "./effects/OutlineEffect.js";
 export * from "./effects/ParallaxBarrierEffect.js";
 export * from "./effects/StereoEffect.js";
 
+export * from "./environments/ColorEnvironment.js";
 export * from "./environments/DebugEnvironment.js";
 export * from "./environments/RoomEnvironment.js";
 
@@ -51,9 +52,11 @@ export * from "./geometries/RoundedBoxGeometry.js";
 export * from "./geometries/TeapotGeometry.js";
 export * from "./geometries/TextGeometry.js";
 
+export * from "./helpers/AnimationPathHelper.js";
 export * from "./helpers/LightProbeHelper.js";
 export * from "./helpers/OctreeHelper.js";
 export * from "./helpers/PositionalAudioHelper.js";
+export * from "./helpers/RapierHelper.js";
 export * from "./helpers/RectAreaLightHelper.js";
 export * from "./helpers/TextureHelper.js";
 export * from "./helpers/VertexNormalsHelper.js";
@@ -98,6 +101,7 @@ export * from "./loaders/LDrawLoader.js";
 export * from "./loaders/LottieLoader.js";
 export * from "./loaders/LUT3dlLoader.js";
 export * from "./loaders/LUTCubeLoader.js";
+export * from "./loaders/LUTImageLoader.js";
 export * from "./loaders/LWOLoader.js";
 export * from "./loaders/MD2Loader.js";
 export * from "./loaders/MDDLoader.js";
@@ -126,6 +130,7 @@ export * from "./materials/LDrawConditionalLineMaterial.js";
 
 export * from "./math/Capsule.js";
 export * from "./math/ColorConverter.js";
+export * as ColorSpaces from "./math/ColorSpaces.js";
 export * from "./math/ConvexHull.js";
 export * from "./math/ImprovedNoise.js";
 export * from "./math/Lut.js";
@@ -165,6 +170,7 @@ export { Water as Water2 } from "./objects/Water2.js";
 export type { WaterOptions as Water2Options } from "./objects/Water2.js";
 
 export * from "./physics/AmmoPhysics.js";
+export * from "./physics/JoltPhysics.js";
 export * from "./physics/RapierPhysics.js";
 
 export * from "./postprocessing/AfterimagePass.js";
@@ -175,6 +181,7 @@ export * from "./postprocessing/CubeTexturePass.js";
 export * from "./postprocessing/DotScreenPass.js";
 export * from "./postprocessing/EffectComposer.js";
 export * from "./postprocessing/FilmPass.js";
+export * from "./postprocessing/FXAAPass.js";
 export * from "./postprocessing/GlitchPass.js";
 export * from "./postprocessing/GTAOPass.js";
 export * from "./postprocessing/HalftonePass.js";
@@ -185,6 +192,7 @@ export * from "./postprocessing/OutputPass.js";
 export * from "./postprocessing/Pass.js";
 export * from "./postprocessing/RenderPass.js";
 export * from "./postprocessing/RenderPixelatedPass.js";
+export * from "./postprocessing/RenderTransitionPass.js";
 export * from "./postprocessing/SAOPass.js";
 export * from "./postprocessing/SavePass.js";
 export * from "./postprocessing/ShaderPass.js";
@@ -234,6 +242,7 @@ export * from "./shaders/LuminosityShader.js";
 export * from "./shaders/MirrorShader.js";
 export * from "./shaders/NormalMapShader.js";
 export * from "./shaders/OutputShader.js";
+export * from "./shaders/PoissonDenoiseShader.js";
 export * from "./shaders/RGBShiftShader.js";
 export * from "./shaders/SAOShader.js";
 export * from "./shaders/SepiaShader.js";
@@ -257,9 +266,11 @@ export * from "./textures/FlakesTexture.js";
 
 export * as BufferGeometryUtils from "./utils/BufferGeometryUtils.js";
 export * as CameraUtils from "./utils/CameraUtils.js";
+export * as ColorUtils from "./utils/ColorUtils.js";
 export * as GeometryCompressionUtils from "./utils/GeometryCompressionUtils.js";
 export * as GeometryUtils from "./utils/GeometryUtils.js";
 export * from "./utils/LDrawUtils.js";
+export * from "./utils/SceneOptimizer.js";
 export * as SceneUtils from "./utils/SceneUtils.js";
 export * from "./utils/ShadowMapViewer.js";
 export * as SkeletonUtils from "./utils/SkeletonUtils.js";

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

@@ -24,11 +24,6 @@ declare class FirstPersonControls extends Controls<{}> {
      */
     autoForward: boolean;
 
-    /**
-     * Whether or not it's possible to look around. Default is `true`.
-     */
-    activeLook: boolean;
-
     /**
      * Whether or not the camera's height influences the forward movement speed. Default is `false`.
      * Use the properties {@link .heightCoef}, {@link .heightMin} and {@link .heightMax} for configuration
@@ -78,11 +73,6 @@ declare class FirstPersonControls extends Controls<{}> {
      */
     constructor(object: Camera, domElement?: HTMLElement | SVGElement);
 
-    /**
-     * Should be called if the application window is resized.
-     */
-    handleResize(): void;
-
     /**
      * Ensures the controls orient the camera towards the defined target position.
      * @param vector A vector representing the target position.
@@ -96,6 +86,11 @@ declare class FirstPersonControls extends Controls<{}> {
      * @param z The z component of the world space position.
      */
     lookAt(x: number, y: number, z: number): this;
+
+    /**
+     * @deprecated The controls now handle resize internally.
+     */
+    handleResize(): void;
 }
 
 export { FirstPersonControls };

types/three/examples/jsm/controls/TransformControls.d.ts

@@ -38,6 +38,9 @@ export interface TransformControlsEventMap {
     "showX-changed": { value: unknown };
     "showY-changed": { value: unknown };
     "showZ-changed": { value: unknown };
+    "showXY-changed": { value: unknown };
+    "showYZ-changed": { value: unknown };
+    "showXZ-changed": { value: unknown };
     "minX-changed": { value: unknown };
     "maxX-changed": { value: unknown };
     "minY-changed": { value: unknown };
@@ -128,6 +131,27 @@ declare class TransformControls extends Controls<TransformControlsEventMap> {
      */
     showZ: boolean;
 
+    /**
+     * Whether the xy-plane helper should be visible or not.
+     *
+     * @default true
+     */
+    showXY: boolean;
+
+    /**
+     * Whether the xy-plane helper should be visible or not.
+     *
+     * @default true
+     */
+    showYZ: boolean;
+
+    /**
+     * Whether the xy-plane helper should be visible or not.
+     *
+     * @default true
+     */
+    showXZ: boolean;
+
     /**
      * The minimum allowed X position during translation. Default is `-Infinity`.
      */

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

@@ -3,115 +3,87 @@ import { ExtrudeGeometry, ExtrudeGeometryOptions, Shape } from "three";
 import { Font } from "../loaders/FontLoader.js";
 
 export interface TextGeometryParameters extends ExtrudeGeometryOptions {
+    /**
+     * The font.
+     */
     font: Font;
 
     /**
-     * Size of the text
-     * Expects a `Float`.
-     * @defaultValue `100`
+     * The text size.
+     * @default 100
      */
     size?: number | undefined;
 
     /**
-     * Thickness to extrude text.
-     * Expects a `Float`.
-     * @defaultValue `50`
+     * Depth to extrude the shape.
+     * @default 50
      */
     depth?: number | undefined;
 
     /**
-     * @override
-     * @defaultValue `12`
-     */
-    curveSegments?: number | undefined;
-
-    /**
-     * @defaultValue `false`
+     * Whether to beveling to the shape or not.
+     * @default false
      */
     bevelEnabled?: boolean | undefined;
 
     /**
-     * How deep into text bevel goes.
-     * Expects a `Float`.
-     * @override
-     * @defaultValue `10`
+     * How deep into the original shape the bevel goes.
+     * @default 10
      */
     bevelThickness?: number | undefined;
 
     /**
-     * How far from text outline is bevel.
-     * Expects a `Float`.
-     * @override
-     * @defaultValue `8`
+     * Distance from the shape outline that the bevel extends.
+     * @default 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;
-
     direction?: "ltr" | "rtl" | "tb" | 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
+ * A class for generating text as a single geometry. It is constructed by providing a string of text, and a set of
+ * parameters consisting of a loaded font and extrude settings.
+ *
+ * See the {@link FontLoader} page for additional details.
+ *
+ * `TextGeometry` uses [typeface.json](http://gero3.github.io/facetype.js/) generated fonts.
+ * Some existing fonts can be found located in `/examples/fonts`.
+ *
+ * ```js
  * 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
- *     });
- * });
+ * const font = await loader.loadAsync( 'fonts/helvetiker_regular.typeface.json' );
+ * const geometry = new TextGeometry( 'Hello three.js!', {
+ * 	font: font,
+ * 	size: 80,
+ * 	depth: 5,
+ * 	curveSegments: 12
+ * } );
  * ```
- * @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}
+ *
+ * @augments ExtrudeGeometry
+ * @three_import import { TextGeometry } from 'three/addons/geometries/TextGeometry.js';
  */
-export class TextGeometry extends ExtrudeGeometry {
+declare 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.
+     * Constructs a new text geometry.
+     *
+     * @param {string} text - The text that should be transformed into a geometry.
+     * @param {TextGeometry~Options} [parameters] - The text settings.
      */
     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.
+     * Holds the constructor parameters that have been
+     * used to generate the geometry. Any modification
+     * after instantiation does not change the geometry.
+     *
+     * @type {Object}
      */
     readonly parameters: {
         readonly shapes: Shape | Shape[];
         readonly options: TextGeometryParameters;
     };
 }
 
-export { TextGeometry as TextBufferGeometry };
+export { TextGeometry };

types/three/examples/jsm/helpers/LightProbeGridHelper.d.ts

@@ -0,0 +1,12 @@
+import { InstancedMesh, ShaderMaterial, SphereGeometry } from "three";
+import { LightProbeGrid } from "../lighting/LightProbeGrid.js";
+
+declare class LightProbeGridHelper extends InstancedMesh<SphereGeometry, ShaderMaterial> {
+    probes: LightProbeGrid;
+
+    constructor(probes: LightProbeGrid, sphereSize?: number);
+
+    update(): void;
+}
+
+export { LightProbeGridHelper };

types/three/examples/jsm/inspector/Extension.d.ts

@@ -0,0 +1,9 @@
+import { Tab, TabEventMap } from "./ui/Tab.js";
+
+export interface ExtensionEventMap extends TabEventMap {}
+
+export class Extension<TEventMap extends ExtensionEventMap = ExtensionEventMap> extends Tab<TEventMap> {
+    readonly isExtension: boolean;
+
+    constructor(name: string);
+}

types/three/examples/jsm/inspector/Inspector.d.ts

@@ -1,10 +1,29 @@
-import { RendererInspector } from "./RendererInspector.js";
+import { TSLGraphEditor } from "./extensions/tsl-graph/TSLGraphEditor.js";
+import { RendererInspector, RendererInspectorEventMap } from "./RendererInspector.js";
 import { ParametersGroup } from "./tabs/Parameters.js";
+import { Tab } from "./ui/Tab.js";
 
-declare class Inspector extends RendererInspector {
+export interface InspectorEventMap extends RendererInspectorEventMap {
+    resize: {};
+}
+
+declare class Inspector extends RendererInspector<InspectorEventMap> {
     createParameters(name: string): ParametersGroup;
 
     get domElement(): HTMLDivElement;
+
+    onExtension(name: "TSL Graph", callback: (extension: TSLGraphEditor) => void): this;
+
+    hide(): void;
+    show(): void;
+
+    getSize(): { width: number; height: number };
+
+    setActiveTab(tab: Tab): this;
+    addTab(tab: Tab): this;
+    removeTab(tab: Tab): this;
+
+    setActiveExtension(name: "TSL Graph", value: boolean): this;
 }
 
 export { Inspector };

types/three/examples/jsm/inspector/RendererInspector.d.ts

@@ -1,4 +1,9 @@
-import { InspectorBase } from "three/webgpu";
+import { InspectorBase, InspectorBaseEventMap } from "three/webgpu";
 
-export class RendererInspector extends InspectorBase {
+export interface RendererInspectorEventMap extends InspectorBaseEventMap {
+}
+
+export class RendererInspector<TEventMap extends RendererInspectorEventMap = RendererInspectorEventMap>
+    extends InspectorBase<TEventMap>
+{
 }