@needle-tools/three 0.169.12 → 0.169.13

package/types/src/extras/curves/CatmullRomCurve3.d.ts

@@ -0,0 +1,77 @@
+import { Vector3 } from "../../math/Vector3.js";
+import { Curve } from "../core/Curve.js";
+
+export type CurveType = "centripetal" | "chordal" | "catmullrom";
+
+/**
+ * Create a smooth **3D** spline curve from a series of points using the {@link https://en.wikipedia.org/wiki/Centripetal_Catmull-Rom_spline | Catmull-Rom} algorithm.
+ * @example
+ * ```typescript
+ * //Create a closed wavey loop
+ * const curve = new THREE.CatmullRomCurve3([
+ * new THREE.Vector3(-10, 0, 10),
+ * new THREE.Vector3(-5, 5, 5),
+ * new THREE.Vector3(0, 0, 0),
+ * new THREE.Vector3(5, -5, 5),
+ * new THREE.Vector3(10, 0, 10)]);
+ * const points = curve.getPoints(50);
+ * const geometry = new THREE.BufferGeometry().setFromPoints(points);
+ * const material = new THREE.LineBasicMaterial({
+ *     color: 0xff0000
+ * });
+ * // Create the final object to add to the scene
+ * const curveObject = new THREE.Line(geometry, material);
+ * ```
+ * @see Example: {@link https://threejs.org/examples/#webgl_geometry_extrude_splines | WebGL / geometry / extrude / splines}
+ * @see {@link https://threejs.org/docs/index.html#api/en/extras/curves/CatmullRomCurve3 | Official Documentation}
+ * @see {@link https://github.com/mrdoob/three.js/blob/master/src/extras/curves/CatmullRomCurve3.js | Source}
+ */
+export class CatmullRomCurve3 extends Curve<Vector3> {
+    /**
+     * This constructor creates a new {@link CatmullRomCurve3}.
+     * @param points An array of {@link THREE.Vector3 | Vector3} points
+     * @param closed Whether the curve is closed. Default `false`
+     * @param curveType Type of the curve. Default `centripetal`
+     * @param tension Tension of the curve. Expects a `Float`. Default `0.5`
+     */
+    constructor(points?: Vector3[], closed?: boolean, curveType?: CurveType, tension?: number);
+
+    /**
+     * Read-only flag to check if a given object is of type {@link CatmullRomCurve3}.
+     * @remarks This is a _constant_ value
+     * @defaultValue `true`
+     */
+    readonly isCatmullRomCurve3 = true;
+
+    /**
+     * A Read-only _string_ to check if `this` object type.
+     * @remarks Sub-classes will update this value.
+     * @defaultValue `CatmullRomCurve3`
+     */
+    override readonly type: string | "CatmullRomCurve3";
+
+    /**
+     * The curve will loop back onto itself when this is true.
+     * @defaultValue `false`
+     */
+    closed: boolean;
+
+    /**
+     * The array of {@link THREE.Vector3 | Vector3} points that define the curve.
+     * @remarks It needs at least two entries.
+     * @defaultValue `[]`
+     */
+    points: Vector3[];
+
+    /**
+     * Possible values are `centripetal`, `chordal` and `catmullrom`.
+     * @defaultValue `centripetal`
+     */
+    curveType: CurveType;
+
+    /**
+     * When {@link .curveType} is `catmullrom`, defines catmullrom's tension.
+     * @remarks Expects a `Float`
+     */
+    tension: number;
+}

package/types/src/extras/curves/CubicBezierCurve.d.ts

@@ -0,0 +1,72 @@
+import { Vector2 } from "../../math/Vector2.js";
+import { Curve } from "../core/Curve.js";
+
+/**
+ * Create a smooth **2D** {@link http://en.wikipedia.org/wiki/B%C3%A9zier_curve#mediaviewer/File:Bezier_curve.svg | cubic bezier curve},
+ * defined by a start point, endpoint and two control points.
+ * @example
+ * ```typescript
+ * const curve = new THREE.CubicBezierCurve(
+ * new THREE.Vector2(-10, 0),
+ * new THREE.Vector2(-5, 15),
+ * new THREE.Vector2(20, 15),
+ * new THREE.Vector2(10, 0));
+ * const points = curve.getPoints(50);
+ * const geometry = new THREE.BufferGeometry().setFromPoints(points);
+ * const material = new THREE.LineBasicMaterial({
+ *     color: 0xff0000
+ * });
+ * // Create the final object to add to the scene
+ * const curveObject = new THREE.Line(geometry, material);
+ * ```
+ * @see {@link https://threejs.org/docs/index.html#api/en/extras/curves/CubicBezierCurve | Official Documentation}
+ * @see {@link https://github.com/mrdoob/three.js/blob/master/src/extras/curves/CubicBezierCurve.js | Source}
+ */
+export class CubicBezierCurve extends Curve<Vector2> {
+    /**
+     * This constructor creates a new {@link CubicBezierCurve}.
+     * @param v0 The starting point. Default is `new THREE.Vector2()`.
+     * @param v1 The first control point. Default is `new THREE.Vector2()`.
+     * @param v2 The second control point. Default is `new THREE.Vector2()`.
+     * @param v3 The ending point. Default is `new THREE.Vector2()`.
+     */
+    constructor(v0?: Vector2, v1?: Vector2, v2?: Vector2, v3?: Vector2);
+
+    /**
+     * Read-only flag to check if a given object is of type {@link CubicBezierCurve}.
+     * @remarks This is a _constant_ value
+     * @defaultValue `true`
+     */
+    readonly isCubicBezierCurve = true;
+
+    /**
+     * A Read-only _string_ to check if `this` object type.
+     * @remarks Sub-classes will update this value.
+     * @defaultValue `CubicBezierCurve`
+     */
+    override readonly type: string | "CubicBezierCurve";
+
+    /**
+     * The starting point.
+     * @defaultValue `new THREE.Vector2()`
+     */
+    v0: Vector2;
+
+    /**
+     * The first control point.
+     * @defaultValue `new THREE.Vector2()`
+     */
+    v1: Vector2;
+
+    /**
+     * The second control point.
+     * @defaultValue `new THREE.Vector2()`
+     */
+    v2: Vector2;
+
+    /**
+     * The ending point.
+     * @defaultValue `new THREE.Vector2()`
+     */
+    v3: Vector2;
+}

package/types/src/extras/curves/CubicBezierCurve3.d.ts

@@ -0,0 +1,72 @@
+import { Vector3 } from "../../math/Vector3.js";
+import { Curve } from "../core/Curve.js";
+
+/**
+ * Create a smooth **3D** {@link http://en.wikipedia.org/wiki/B%C3%A9zier_curve#mediaviewer/File:Bezier_curve.svg | cubic bezier curve},
+ * defined by a start point, endpoint and two control points.
+ * @example
+ * ```typescript
+ * const curve = new THREE.CubicBezierCurve(
+ * new THREE.Vector2(-10, 0),
+ * new THREE.Vector2(-5, 15),
+ * new THREE.Vector2(20, 15),
+ * new THREE.Vector2(10, 0));
+ * const points = curve.getPoints(50);
+ * const geometry = new THREE.BufferGeometry().setFromPoints(points);
+ * const material = new THREE.LineBasicMaterial({
+ *     color: 0xff0000
+ * });
+ * // Create the final object to add to the scene
+ * const curveObject = new THREE.Line(geometry, material);
+ * ```
+ * @see {@link https://threejs.org/docs/index.html#api/en/extras/curves/CubicBezierCurve | Official Documentation}
+ * @see {@link https://github.com/mrdoob/three.js/blob/master/src/extras/curves/CubicBezierCurve.js | Source}
+ */
+export class CubicBezierCurve3 extends Curve<Vector3> {
+    /**
+     * This constructor creates a new {@link CubicBezierCurve3}.
+     * @param v0 The starting point. Default is `new THREE.Vector3()`.
+     * @param v1 The first control point. Default is `new THREE.Vector3()`.
+     * @param v2 The second control point. Default is `new THREE.Vector3()`.
+     * @param v3 The ending point. Default is `new THREE.Vector3()`.
+     */
+    constructor(v0?: Vector3, v1?: Vector3, v2?: Vector3, v3?: Vector3);
+
+    /**
+     * Read-only flag to check if a given object is of type {@link CubicBezierCurve3}.
+     * @remarks This is a _constant_ value
+     * @defaultValue `true`
+     */
+    readonly isCubicBezierCurve3 = true;
+
+    /**
+     * A Read-only _string_ to check if `this` object type.
+     * @remarks Sub-classes will update this value.
+     * @defaultValue `CubicBezierCurve3`
+     */
+    override readonly type: string | "CubicBezierCurve3";
+
+    /**
+     * The starting point.
+     * @defaultValue `new THREE.Vector3()`.
+     */
+    v0: Vector3;
+
+    /**
+     * The first control point.
+     * @defaultValue `new THREE.Vector3()`.
+     */
+    v1: Vector3;
+
+    /**
+     * The second control point.
+     * @defaultValue `new THREE.Vector3()`.
+     */
+    v2: Vector3;
+
+    /**
+     * The ending point.
+     * @defaultValue `new THREE.Vector3()`.
+     */
+    v3: Vector3;
+}

package/types/src/extras/curves/Curves.d.ts

@@ -0,0 +1,10 @@
+export * from "./ArcCurve.js";
+export * from "./CatmullRomCurve3.js";
+export * from "./CubicBezierCurve.js";
+export * from "./CubicBezierCurve3.js";
+export * from "./EllipseCurve.js";
+export * from "./LineCurve.js";
+export * from "./LineCurve3.js";
+export * from "./QuadraticBezierCurve.js";
+export * from "./QuadraticBezierCurve3.js";
+export * from "./SplineCurve.js";

package/types/src/extras/curves/EllipseCurve.d.ts

@@ -0,0 +1,115 @@
+import { Vector2 } from "../../math/Vector2.js";
+import { Curve } from "../core/Curve.js";
+
+/**
+ * Creates a 2d curve in the shape of an ellipse
+ * @remarks
+ * Setting the {@link xRadius} equal to the {@link yRadius} will result in a circle.
+ * @example
+ * ```typescript
+ * const curve = new THREE.EllipseCurve(
+ *   0,  0,  // ax, aY
+ *   10, 10, // xRadius, yRadius
+ *   0,  2 * Math.PI, // aStartAngle, aEndAngle
+ *   false,  // aClockwise
+ *   0       // aRotation
+ *   );
+ * const points = curve.getPoints(50);
+ * const geometry = new THREE.BufferGeometry().setFromPoints(points);
+ * const material = new THREE.LineBasicMaterial({ color: 0xff0000 });
+ * // Create the final object to add to the scene
+ * const ellipse = new THREE.Line(geometry, material);
+ * ```
+ * @see {@link https://threejs.org/docs/index.html#api/en/extras/curves/EllipseCurve | Official Documentation}
+ * @see {@link https://github.com/mrdoob/three.js/blob/master/src/extras/curves/EllipseCurve.js | Source}
+ */
+export class EllipseCurve extends Curve<Vector2> {
+    /**
+     * This constructor creates a new {@link EllipseCurve}.
+     * @param aX The X center of the ellipse. Expects a `Float`. Default is `0`.
+     * @param aY The Y center of the ellipse. Expects a `Float`. Default is `0`.
+     * @param xRadius The radius of the ellipse in the x direction. Expects a `Float`. Default is `1`.
+     * @param yRadius The radius of the ellipse in the y direction. Expects a `Float`. Default is `1`.
+     * @param aStartAngle The start angle of the curve in radians starting from the positive X axis. Default is `0`.
+     * @param aEndAngle The end angle of the curve in radians starting from the positive X axis. Default is `2 x Math.PI`.
+     * @param aClockwise Whether the ellipse is drawn clockwise. Default is `false`.
+     * @param aRotation The rotation angle of the ellipse in radians, counterclockwise from the positive X axis. Default is `0`.
+     */
+    constructor(
+        aX?: number,
+        aY?: number,
+        xRadius?: number,
+        yRadius?: number,
+        aStartAngle?: number,
+        aEndAngle?: number,
+        aClockwise?: boolean,
+        aRotation?: number,
+    );
+
+    /**
+     * Read-only flag to check if a given object is of type {@link EllipseCurve}.
+     * @remarks This is a _constant_ value
+     * @defaultValue `true`
+     */
+    readonly isEllipseCurve = true;
+
+    /**
+     * A Read-only _string_ to check if `this` object type.
+     * @remarks Sub-classes will update this value.
+     * @defaultValue `EllipseCurve`
+     */
+    override readonly type: string | "EllipseCurve";
+
+    /**
+     * The X center of the ellipse.
+     * @remarks Expects a `Float`
+     * @defaultValue `0`
+     */
+    aX: number;
+
+    /**
+     * The Y center of the ellipse.
+     * @remarks Expects a `Float`
+     * @defaultValue `0`
+     */
+    aY: number;
+
+    /**
+     * The radius of the ellipse in the x direction.
+     * @defaultValue `1`
+     */
+    xRadius: number;
+
+    /**
+     * The radius of the ellipse in the y direction.
+     * @defaultValue `1`
+     */
+    yRadius: number;
+
+    /**
+     * The start angle of the curve in radians starting from the middle right side.
+     * @remarks Expects a `Float`
+     * @defaultValue `0`
+     */
+    aStartAngle: number;
+
+    /**
+     * The end angle of the curve in radians starting from the middle right side.
+     * @remarks Expects a `Float`
+     * @defaultValue `2 * Math.PI`
+     */
+    aEndAngle: number;
+
+    /**
+     * Whether the ellipse is drawn clockwise.
+     * @defaultValue `false``
+     */
+    aClockwise: boolean;
+
+    /**
+     * The rotation angle of the ellipse in radians, counterclockwise from the positive X axis (optional).
+     * @remarks Expects a `Float`
+     * @defaultValue `0`
+     */
+    aRotation: number;
+}

package/types/src/extras/curves/LineCurve.d.ts

@@ -0,0 +1,42 @@
+import { Vector2 } from "../../math/Vector2.js";
+import { Curve } from "../core/Curve.js";
+
+/**
+ * A curve representing a **2D** line segment.
+ * @see {@link https://threejs.org/docs/index.html#api/en/extras/curves/LineCurve | Official Documentation}
+ * @see {@link https://github.com/mrdoob/three.js/blob/master/src/extras/curves/LineCurve.js | Source}
+ */
+export class LineCurve extends Curve<Vector2> {
+    /**
+     * This constructor creates a new {@link LineCurve}.
+     * @param v1 The start point. Default is `new THREE.Vector2()`.
+     * @param v2 The end point. Default is `new THREE.Vector2()`.
+     */
+    constructor(v1?: Vector2, v2?: Vector2);
+
+    /**
+     * Read-only flag to check if a given object is of type {@link LineCurve}.
+     * @remarks This is a _constant_ value
+     * @defaultValue `true`
+     */
+    readonly isLineCurve = true;
+
+    /**
+     * A Read-only _string_ to check if `this` object type.
+     * @remarks Sub-classes will update this value.
+     * @defaultValue `LineCurve`
+     */
+    override readonly type: string | "LineCurve";
+
+    /**
+     * The start point.
+     * @defaultValue `new THREE.Vector2()`
+     */
+    v1: Vector2;
+
+    /**
+     * The end point
+     * @defaultValue `new THREE.Vector2()`
+     */
+    v2: Vector2;
+}

package/types/src/extras/curves/LineCurve3.d.ts

@@ -0,0 +1,42 @@
+import { Vector3 } from "../../math/Vector3.js";
+import { Curve } from "../core/Curve.js";
+
+/**
+ * A curve representing a **3D** line segment.
+ * @see {@link https://threejs.org/docs/index.html#api/en/extras/curves/LineCurve3 | Official Documentation}
+ * @see {@link https://github.com/mrdoob/three.js/blob/master/src/extras/curves/LineCurve3.js | Source}
+ */
+export class LineCurve3 extends Curve<Vector3> {
+    /**
+     * This constructor creates a new {@link LineCurve3}.
+     * @param v1 The start point. Default is `new THREE.Vector3()`.
+     * @param v2 The end point. Default is `new THREE.Vector3()`.
+     */
+    constructor(v1?: Vector3, v2?: Vector3);
+
+    /**
+     * Read-only flag to check if a given object is of type {@link LineCurve3}.
+     * @remarks This is a _constant_ value
+     * @defaultValue `true`
+     */
+    readonly isLineCurve3 = true;
+
+    /**
+     * A Read-only _string_ to check if `this` object type.
+     * @remarks Sub-classes will update this value.
+     * @defaultValue `LineCurve3`
+     */
+    override readonly type: string | "LineCurve3";
+
+    /**
+     * The start point.
+     * @defaultValue `new THREE.Vector3()`.
+     */
+    v1: Vector3;
+
+    /**
+     * The end point.
+     * @defaultValue `new THREE.Vector3()`.
+     */
+    v2: Vector3;
+}

package/types/src/extras/curves/QuadraticBezierCurve.d.ts

@@ -0,0 +1,64 @@
+import { Vector2 } from "../../math/Vector2.js";
+import { Curve } from "../core/Curve.js";
+
+/**
+ * Create a smooth **2D** {@link http://en.wikipedia.org/wiki/B%C3%A9zier_curve#mediaviewer/File:B%C3%A9zier_2_big.gif | quadratic bezier curve},
+ * defined by a start point, end point and a single control point.
+ * @example
+ * ```typescript
+ * const curve = new THREE.QuadraticBezierCurve(
+ * new THREE.Vector2(-10, 0),
+ * new THREE.Vector2(20, 15),
+ * new THREE.Vector2(10, 0));
+ * const points = curve.getPoints(50);
+ * const geometry = new THREE.BufferGeometry().setFromPoints(points);
+ * const material = new THREE.LineBasicMaterial({
+ *     color: 0xff0000
+ * });
+ * // Create the final object to add to the scene
+ * const curveObject = new THREE.Line(geometry, material);
+ * ```
+ * @see {@link https://threejs.org/docs/index.html#api/en/extras/curves/QuadraticBezierCurve | Official Documentation}
+ * @see {@link https://github.com/mrdoob/three.js/blob/master/src/extras/curves/QuadraticBezierCurve.js | Source}
+ */
+export class QuadraticBezierCurve extends Curve<Vector2> {
+    /**
+     * This constructor creates a new {@link QuadraticBezierCurve}.
+     * @param v0 The start point. Default is `new THREE.Vector2()`.
+     * @param v1 The control point. Default is `new THREE.Vector2()`.
+     * @param v2 The end point. Default is `new THREE.Vector2()`.
+     */
+    constructor(v0?: Vector2, v1?: Vector2, v2?: Vector2);
+
+    /**
+     * Read-only flag to check if a given object is of type {@link LineCurve3}.
+     * @remarks This is a _constant_ value
+     * @defaultValue `true`
+     */
+    readonly isQuadraticBezierCurve = true;
+
+    /**
+     * A Read-only _string_ to check if `this` object type.
+     * @remarks Sub-classes will update this value.
+     * @defaultValue `QuadraticBezierCurve`
+     */
+    override readonly type: string | "QuadraticBezierCurve";
+
+    /**
+     * The start point.
+     * @defaultValue `new THREE.Vector2()`
+     */
+    v0: Vector2;
+
+    /**
+     * The control point.
+     * @defaultValue `new THREE.Vector2()`
+     */
+    v1: Vector2;
+
+    /**
+     * The end point.
+     * @defaultValue `new THREE.Vector2()`
+     */
+    v2: Vector2;
+}

package/types/src/extras/curves/QuadraticBezierCurve3.d.ts

@@ -0,0 +1,64 @@
+import { Vector3 } from "../../math/Vector3.js";
+import { Curve } from "../core/Curve.js";
+
+/**
+ * Create a smooth **3D** {@link http://en.wikipedia.org/wiki/B%C3%A9zier_curve#mediaviewer/File:B%C3%A9zier_2_big.gif | quadratic bezier curve},
+ * defined by a start point, end point and a single control point.
+ * @example
+ * ```typescript
+ * const curve = new THREE.QuadraticBezierCurve3(
+ * new THREE.Vector3(-10, 0, 0),
+ * new THREE.Vector3(20, 15, 0),
+ * new THREE.Vector3(10, 0, 0));
+ * const points = curve.getPoints(50);
+ * const geometry = new THREE.BufferGeometry().setFromPoints(points);
+ * const material = new THREE.LineBasicMaterial({
+ *     color: 0xff0000
+ * });
+ * // Create the final object to add to the scene
+ * const curveObject = new THREE.Line(geometry, material);
+ * ```
+ * @see {@link https://threejs.org/docs/index.html#api/en/extras/curves/QuadraticBezierCurve3 | Official Documentation}
+ * @see {@link https://github.com/mrdoob/three.js/blob/master/src/extras/curves/QuadraticBezierCurve3.js | Source}
+ */
+export class QuadraticBezierCurve3 extends Curve<Vector3> {
+    /**
+     * This constructor creates a new {@link QuadraticBezierCurve}.
+     * @param v0 The start point. Default is `new THREE.Vector3()`.
+     * @param v1 The control point. Default is `new THREE.Vector3()`.
+     * @param v2 The end point. Default is `new THREE.Vector3()`.
+     */
+    constructor(v0?: Vector3, v1?: Vector3, v2?: Vector3);
+
+    /**
+     * Read-only flag to check if a given object is of type {@link QuadraticBezierCurve3}.
+     * @remarks This is a _constant_ value
+     * @defaultValue `true`
+     */
+    readonly isQuadraticBezierCurve3 = true;
+
+    /**
+     * A Read-only _string_ to check if `this` object type.
+     * @remarks Sub-classes will update this value.
+     * @defaultValue `QuadraticBezierCurve3`
+     */
+    override readonly type: string | "QuadraticBezierCurve3";
+
+    /**
+     * The start point.
+     * @defaultValue `new THREE.Vector3()`
+     */
+    v0: Vector3;
+
+    /**
+     * The control point.
+     * @defaultValue `new THREE.Vector3()`
+     */
+    v1: Vector3;
+
+    /**
+     * The end point.
+     * @defaultValue `new THREE.Vector3()`
+     */
+    v2: Vector3;
+}

package/types/src/extras/curves/SplineCurve.d.ts

@@ -0,0 +1,52 @@
+import { Vector2 } from "../../math/Vector2.js";
+import { Curve } from "../core/Curve.js";
+
+/**
+ * Create a smooth **2D** spline curve from a series of points.
+ * @example
+ * ```typescript
+ * // Create a sine-like wave
+ * const curve = new THREE.SplineCurve([
+ * new THREE.Vector2(-10, 0),
+ * new THREE.Vector2(-5, 5),
+ * new THREE.Vector2(0, 0),
+ * new THREE.Vector2(5, -5),
+ * new THREE.Vector2(10, 0)]);
+ * const points = curve.getPoints(50);
+ * const geometry = new THREE.BufferGeometry().setFromPoints(points);
+ * const material = new THREE.LineBasicMaterial({
+ *     color: 0xff0000
+ * });
+ * // Create the final object to add to the scene
+ * const splineObject = new THREE.Line(geometry, material);
+ * ```
+ * @see {@link https://threejs.org/docs/index.html#api/en/extras/curves/SplineCurve | Official Documentation}
+ * @see {@link https://github.com/mrdoob/three.js/blob/master/src/extras/curves/SplineCurve.js | Source}
+ */
+export class SplineCurve extends Curve<Vector2> {
+    /**
+     * This constructor creates a new {@link SplineCurve}.
+     * @param points An array of {@link THREE.Vector2 | Vector2} points that define the curve. Default `[]`
+     */
+    constructor(points?: Vector2[]);
+
+    /**
+     * Read-only flag to check if a given object is of type {@link SplineCurve}.
+     * @remarks This is a _constant_ value
+     * @defaultValue `true`
+     */
+    readonly isSplineCurve = true;
+
+    /**
+     * A Read-only _string_ to check if `this` object type.
+     * @remarks Sub-classes will update this value.
+     * @defaultValue `SplineCurve`
+     */
+    override readonly type: string | "SplineCurve";
+
+    /**
+     * The array of {@link THREE.Vector2 | Vector2} points that define the curve.
+     * @defaultValue `[]`
+     */
+    points: Vector2[];
+}

package/types/src/geometries/BoxGeometry.d.ts

@@ -0,0 +1,59 @@
+import { BufferGeometry } from "../core/BufferGeometry.js";
+
+/**
+ * {@link BoxGeometry} is a geometry class for a rectangular cuboid with a given 'width', 'height', and 'depth'
+ * @remarks On creation, the cuboid is centred on the origin, with each edge parallel to one of the axes.
+ * @example
+ * ```typescript
+ * const geometry = new THREE.BoxGeometry(1, 1, 1);
+ * const material = new THREE.MeshBasicMaterial({
+ *     color: 0x00ff00
+ * });
+ * const cube = new THREE.Mesh(geometry, material);
+ * scene.add(cube);
+ * ```
+ * @see {@link https://threejs.org/docs/index.html#api/en/geometries/BoxGeometry | Official Documentation}
+ * @see {@link https://github.com/mrdoob/three.js/blob/master/src/geometries/BoxGeometry.js | Source}
+ */
+export class BoxGeometry extends BufferGeometry {
+    /**
+     * Create a new instance of {@link BoxGeometry}
+     * @param width Width; that is, the length of the edges parallel to the X axis. Optional; Expects a `Float`. Default `1`
+     * @param height Height; that is, the length of the edges parallel to the Y axis. Optional; Expects a `Float`. Default `1`
+     * @param depth Depth; that is, the length of the edges parallel to the Z axis. Optional; Expects a `Float`. Default `1`
+     * @param widthSegments Number of segmented rectangular faces along the width of the sides. Optional; Expects a `Integer`. Default `1`
+     * @param heightSegments Number of segmented rectangular faces along the height of the sides. Optional; Expects a `Integer`. Default `1`
+     * @param depthSegments Number of segmented rectangular faces along the depth of the sides. Optional; Expects a `Integer`. Default `1`
+     */
+    constructor(
+        width?: number,
+        height?: number,
+        depth?: number,
+        widthSegments?: number,
+        heightSegments?: number,
+        depthSegments?: number,
+    );
+
+    /**
+     * A Read-only _string_ to check if `this` object type.
+     * @remarks Sub-classes will update this value.
+     * @defaultValue `BoxGeometry`
+     */
+    override readonly type: string | "BoxGeometry";
+
+    /**
+     * An object with a property for each of the constructor parameters.
+     * @remarks Any modification after instantiation does not change the geometry.
+     */
+    readonly parameters: {
+        readonly width: number;
+        readonly height: number;
+        readonly depth: number;
+        readonly widthSegments: number;
+        readonly heightSegments: number;
+        readonly depthSegments: number;
+    };
+
+    /** @internal */
+    static fromJSON(data: {}): BoxGeometry;
+}