@types/three 0.157.1 → 0.157.2

three/examples/jsm/effects/OutlineEffect.d.ts

@@ -0,0 +1,36 @@
+import {
+    Camera,
+    Scene,
+    Vector2,
+    Vector4,
+    WebGLRenderer,
+    WebGLRenderTarget,
+    WebGLShadowMap,
+} from '../../../src/Three.js';
+
+export interface OutlineEffectParameters {
+    defaultThickness?: number | undefined;
+    defaultColor?: number[] | undefined;
+    defaultAlpha?: number | undefined;
+    defaultKeepAlive?: boolean | undefined;
+}
+
+export class OutlineEffect {
+    constructor(renderer: WebGLRenderer, parameters?: OutlineEffectParameters);
+    enabled: boolean;
+    autoClear: boolean;
+    domElement: HTMLElement;
+    shadowMap: WebGLShadowMap;
+
+    clear(color?: boolean, depth?: boolean, stencil?: boolean): void;
+    getPixelRatio(): number;
+    getSize(target: Vector2): Vector2;
+    render(scene: Scene, camera: Camera): void;
+    renderOutline(scene: Scene, camera: Camera): void;
+    setRenderTarget(renderTarget: WebGLRenderTarget | null): void;
+    setPixelRatio(value: number): void;
+    setScissor(x: Vector4 | number, y?: number, width?: number, height?: number): void;
+    setScissorTest(enable: boolean): void;
+    setSize(width: number, height: number, updateStyle?: boolean): void;
+    setViewport(x: Vector4 | number, y?: number, width?: number, height?: number): void;
+}

three/examples/jsm/environments/RoomEnvironment.d.ts

@@ -0,0 +1,6 @@
+import { Scene, WebGLRenderer } from '../../../src/Three.js';
+
+export class RoomEnvironment extends Scene {
+    constructor(renderer?: WebGLRenderer);
+    dispose(): void;
+}

three/examples/jsm/exporters/PLYExporter.d.ts

@@ -0,0 +1,30 @@
+import { Object3D } from '../../../src/Three.js';
+
+export interface PLYExporterOptionsBase {
+    excludeAttributes?: string[];
+    littleEndian?: boolean;
+}
+
+export interface PLYExporterOptionsBinary extends PLYExporterOptionsBase {
+    binary: true;
+}
+
+export interface PLYExporterOptionsString extends PLYExporterOptionsBase {
+    binary?: false;
+}
+
+export interface PLYExporterOptions extends PLYExporterOptionsBase {
+    binary?: boolean;
+}
+
+export class PLYExporter {
+    constructor();
+
+    parse(object: Object3D, onDone: (res: ArrayBuffer) => void, options: PLYExporterOptionsBinary): ArrayBuffer | null;
+    parse(object: Object3D, onDone: (res: string) => void, options?: PLYExporterOptionsString): string | null;
+    parse(
+        object: Object3D,
+        onDone: (res: string | ArrayBuffer) => void,
+        options?: PLYExporterOptions,
+    ): string | ArrayBuffer | null;
+}

three/examples/jsm/exporters/STLExporter.d.ts

@@ -0,0 +1,21 @@
+import { Object3D } from '../../../src/Three.js';
+
+export interface STLExporterOptionsBinary {
+    binary: true;
+}
+
+export interface STLExporterOptionsString {
+    binary?: false;
+}
+
+export interface STLExporterOptions {
+    binary?: boolean;
+}
+
+export class STLExporter {
+    constructor();
+
+    parse(scene: Object3D, options: STLExporterOptionsBinary): DataView;
+    parse(scene: Object3D, options?: STLExporterOptionsString): string;
+    parse(scene: Object3D, options?: STLExporterOptions): string | DataView;
+}

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

@@ -0,0 +1,115 @@
+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/helpers/RectAreaLightHelper.d.ts

@@ -0,0 +1,10 @@
+import { Line, RectAreaLight, ColorRepresentation } from '../../../src/Three.js';
+
+export class RectAreaLightHelper extends Line {
+    constructor(light: RectAreaLight, color?: ColorRepresentation);
+
+    light: RectAreaLight;
+    color: ColorRepresentation | undefined;
+
+    dispose(): void;
+}

three/examples/jsm/helpers/ViewHelper.d.ts

@@ -0,0 +1,15 @@
+import { Camera, Object3D, Vector3, WebGLRenderer } from '../../../src/Three.js';
+
+export class ViewHelper extends Object3D {
+    animating: boolean;
+    center: Vector3;
+
+    readonly isViewHelper: true;
+
+    constructor(camera: Camera, domElement: HTMLElement);
+
+    render(renderer: WebGLRenderer): void;
+    handleClick(event: MouseEvent): boolean;
+    update(delta: number): void;
+    dispose(): void;
+}

three/examples/jsm/libs/fflate.module.d.ts

@@ -0,0 +1 @@
+export * from 'fflate';