@nativescript/canvas-three 2.0.0-webgpu.3 → 2.0.0-webgpu.31

package/three/src/geometries/RingGeometry.d.ts

@@ -0,0 +1,52 @@
+import { BufferGeometry } from '../core/BufferGeometry.js';
+
+/**
+ * A class for generating a two-dimensional ring geometry.
+ * @example
+ * ```typescript
+ * const geometry = new THREE.RingGeometry(1, 5, 32);
+ * const material = new THREE.MeshBasicMaterial({
+ *     color: 0xffff00,
+ *     side: THREE.DoubleSide
+ * });
+ * const mesh = new THREE.Mesh(geometry, material);
+ * scene.add(mesh);
+ * ```
+ * @see {@link https://threejs.org/docs/index.html#api/en/geometries/RingGeometry | Official Documentation}
+ * @see {@link https://github.com/mrdoob/three.js/blob/master/src/geometries/RingGeometry.js | Source}
+ */
+export class RingGeometry extends BufferGeometry {
+	/**
+	 * Create a new instance of {@link RingGeometry}
+	 * @param innerRadius Expects a `Float`. Default `0.5`.
+	 * @param outerRadius Expects a `Float`. Default `1`.
+	 * @param thetaSegments Number of segments. A higher number means the ring will be more round. Minimum is 3. Expects a `Integer`. Default `32`.
+	 * @param phiSegments Number of segments per ring segment. Minimum is `1`. Expects a `Integer`. Default `1`.
+	 * @param thetaStart Starting angle. Expects a `Float`. Default `0`.
+	 * @param thetaLength Central angle. Expects a `Float`. Default `Math.PI * 2`.
+	 */
+	constructor(innerRadius?: number, outerRadius?: number, thetaSegments?: number, phiSegments?: number, thetaStart?: number, thetaLength?: number);
+
+	/**
+	 * A Read-only _string_ to check if `this` object type.
+	 * @remarks Sub-classes will update this value.
+	 * @defaultValue `RingGeometry`
+	 */
+	override readonly type: string | 'RingGeometry';
+
+	/**
+	 * An object with a property for each of the constructor parameters.
+	 * @remarks Any modification after instantiation does not change the geometry.
+	 */
+	readonly parameters: {
+		readonly innerRadius: number;
+		readonly outerRadius: number;
+		readonly thetaSegments: number;
+		readonly phiSegments: number;
+		readonly thetaStart: number;
+		readonly thetaLength: number;
+	};
+
+	/** @internal */
+	static fromJSON(data: {}): RingGeometry;
+}

package/three/src/geometries/ShapeGeometry.d.ts

@@ -0,0 +1,53 @@
+import { BufferGeometry } from '../core/BufferGeometry.js';
+import { Shape } from '../extras/core/Shape.js';
+
+/**
+ * Creates an one-sided polygonal geometry from one or more path shapes.
+ * @example
+ * ```typescript
+ * const x = 0, y = 0;
+ * const heartShape = new THREE.Shape();
+ * heartShape.moveTo(x + 5, y + 5);
+ * heartShape.bezierCurveTo(x + 5, y + 5, x + 4, y, x, y);
+ * heartShape.bezierCurveTo(x - 6, y, x - 6, y + 7, x - 6, y + 7);
+ * heartShape.bezierCurveTo(x - 6, y + 11, x - 3, y + 15.4, x + 5, y + 19);
+ * heartShape.bezierCurveTo(x + 12, y + 15.4, x + 16, y + 11, x + 16, y + 7);
+ * heartShape.bezierCurveTo(x + 16, y + 7, x + 16, y, x + 10, y);
+ * heartShape.bezierCurveTo(x + 7, y, x + 5, y + 5, x + 5, y + 5);
+ * const geometry = new THREE.ShapeGeometry(heartShape);
+ * const material = new THREE.MeshBasicMaterial({
+ *     color: 0x00ff00
+ * });
+ * const mesh = new THREE.Mesh(geometry, material);
+ * scene.add(mesh);
+ * ```
+ * @see {@link https://threejs.org/docs/index.html#api/en/geometries/ShapeGeometry | Official Documentation}
+ * @see {@link https://github.com/mrdoob/three.js/blob/master/src/geometries/ShapeGeometry.js | Source}
+ */
+export class ShapeGeometry extends BufferGeometry {
+	/**
+	 * Create a new instance of {@link ShapeGeometry}
+	 * @param shapes Array of shapes or a single {@link THREE.Shape | Shape}. Default `new Shape([new Vector2(0, 0.5), new Vector2(-0.5, -0.5), new Vector2(0.5, -0.5)])`, _a single triangle shape_.
+	 * @param curveSegments Number of segments per shape. Expects a `Integer`. Default `12`
+	 */
+	constructor(shapes?: Shape | Shape[], curveSegments?: number);
+
+	/**
+	 * A Read-only _string_ to check if `this` object type.
+	 * @remarks Sub-classes will update this value.
+	 * @defaultValue `ShapeGeometry`
+	 */
+	override readonly type: string | 'ShapeGeometry';
+
+	/**
+	 * 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 curveSegments: number;
+	};
+
+	/** @internal */
+	static fromJSON(data: {}): ShapeGeometry;
+}

package/three/src/geometries/SphereGeometry.d.ts

@@ -0,0 +1,59 @@
+import { BufferGeometry } from '../core/BufferGeometry.js';
+
+/**
+ * A class for generating sphere geometries.
+ * @example
+ * ```typescript
+ * const geometry = new THREE.SphereGeometry(15, 32, 16);
+ * const material = new THREE.MeshBasicMaterial({
+ *     color: 0xffff00
+ * });
+ * const sphere = new THREE.Mesh(geometry, material);
+ * scene.add(sphere);
+ * ```
+ * @see {@link https://threejs.org/docs/index.html#api/en/geometries/SphereGeometry | Official Documentation}
+ * @see {@link https://github.com/mrdoob/three.js/blob/master/src/geometries/SphereGeometry.js | Source}
+ */
+export class SphereGeometry extends BufferGeometry {
+	/**
+	 * Create a new instance of {@link SphereGeometry}
+	 * @remarks
+	 * The geometry is created by sweeping and calculating vertexes
+	 * around the **Y** axis (horizontal sweep) and the **Z** axis (vertical sweep)
+	 * Thus, incomplete spheres (akin to `'sphere slices'`) can be created
+	 * through the use of different values of {@link phiStart}, {@link phiLength}, {@link thetaStart} and {@link thetaLength},
+	 * in order to define the points in which we start (or end) calculating those vertices.
+	 * @param radius Sphere radius. Expects a `Float`. Default `1`
+	 * @param widthSegments Number of horizontal segments. Minimum value is 3, and the Expects a `Integer`. Default `32`
+	 * @param heightSegments Number of vertical segments. Minimum value is 2, and the Expects a `Integer`. Default `16`
+	 * @param phiStart Specify horizontal starting angle. Expects a `Float`. Default `0`
+	 * @param phiLength Specify horizontal sweep angle size. Expects a `Float`. Default `Math.PI * 2`
+	 * @param thetaStart Specify vertical starting angle. Expects a `Float`. Default `0`
+	 * @param thetaLength Specify vertical sweep angle size. Expects a `Float`. Default `Math.PI`
+	 */
+	constructor(radius?: number, widthSegments?: number, heightSegments?: number, phiStart?: number, phiLength?: number, thetaStart?: number, thetaLength?: number);
+
+	/**
+	 * A Read-only _string_ to check if `this` object type.
+	 * @remarks Sub-classes will update this value.
+	 * @defaultValue `SphereGeometry`
+	 */
+	override readonly type: string | 'SphereGeometry';
+
+	/**
+	 * An object with a property for each of the constructor parameters.
+	 * @remarks Any modification after instantiation does not change the geometry.
+	 */
+	readonly parameters: {
+		readonly radius: number;
+		readonly widthSegments: number;
+		readonly heightSegments: number;
+		readonly phiStart: number;
+		readonly phiLength: number;
+		readonly thetaStart: number;
+		readonly thetaLength: number;
+	};
+
+	/** @internal */
+	static fromJSON(data: {}): SphereGeometry;
+}

package/three/src/geometries/TetrahedronGeometry.d.ts

@@ -0,0 +1,25 @@
+import { PolyhedronGeometry } from './PolyhedronGeometry.js';
+
+/**
+ * A class for generating a tetrahedron geometries.
+ * @see {@link https://threejs.org/docs/index.html#api/en/geometries/TetrahedronGeometry | Official Documentation}
+ * @see {@link https://github.com/mrdoob/three.js/blob/master/src/geometries/TetrahedronGeometry.js | Source}
+ */
+export class TetrahedronGeometry extends PolyhedronGeometry {
+	/**
+	 * Create a new instance of {@link TetrahedronGeometry}
+	 * @param radius Radius of the tetrahedron. Expects a `Float`. Default `1`
+	 * @param detail Setting this to a value greater than 0 adds vertices making it no longer a tetrahedron. Expects a `Integer`. Default `0`
+	 */
+	constructor(radius?: number, detail?: number);
+
+	/**
+	 * A Read-only _string_ to check if `this` object type.
+	 * @remarks Sub-classes will update this value.
+	 * @defaultValue `TetrahedronGeometry`
+	 */
+	override readonly type: string | 'TetrahedronGeometry';
+
+	/** @internal */
+	static fromJSON(data: {}): TetrahedronGeometry;
+}

package/three/src/geometries/TorusGeometry.d.ts

@@ -0,0 +1,49 @@
+import { BufferGeometry } from '../core/BufferGeometry.js';
+
+/**
+ * A class for generating torus geometries.
+ * @example
+ * ```typescript
+ * const geometry = new THREE.TorusGeometry(10, 3, 16, 100);
+ * const material = new THREE.MeshBasicMaterial({
+ *     color: 0xffff00
+ * });
+ * const torus = new THREE.Mesh(geometry, material);
+ * scene.add(torus);
+ * ```
+ * @see {@link https://threejs.org/docs/index.html#api/en/geometries/TorusGeometry | Official Documentation}
+ * @see {@link https://github.com/mrdoob/three.js/blob/master/src/geometries/TorusGeometry.js | Source}
+ */
+export class TorusGeometry extends BufferGeometry {
+	/**
+	 * Create a new instance of {@link TorusGeometry}
+	 * @param radius Radius of the torus, from the center of the torus to the center of the tube. Expects a `Float`. Default `1`.
+	 * @param tube Radius of the tube. Expects a `Float`. Default `0.4`.
+	 * @param radialSegments Expects a `Integer`.Default is `12`.
+	 * @param tubularSegments Expects a `Integer`. Default `48`.
+	 * @param arc Central angle. Expects a `Float`. Default `Math.PI * 2`
+	 */
+	constructor(radius?: number, tube?: number, radialSegments?: number, tubularSegments?: number, arc?: number);
+
+	/**
+	 * A Read-only _string_ to check if `this` object type.
+	 * @remarks Sub-classes will update this value.
+	 * @defaultValue `TorusGeometry`
+	 */
+	override readonly type: string | 'TorusGeometry';
+
+	/**
+	 * An object with a property for each of the constructor parameters.
+	 * @remarks Any modification after instantiation does not change the geometry.
+	 */
+	readonly parameters: {
+		readonly radius: number;
+		readonly tube: number;
+		readonly radialSegments: number;
+		readonly tubularSegments: number;
+		readonly arc: number;
+	};
+
+	/** @internal */
+	static fromJSON(data: any): TorusGeometry;
+}

package/three/src/geometries/TorusKnotGeometry.d.ts

@@ -0,0 +1,52 @@
+import { BufferGeometry } from '../core/BufferGeometry.js';
+
+/**
+ * Creates a torus knot, the particular shape of which is defined by a pair of coprime integers, p and q
+ * If p and q are not coprime, the result will be a torus link.
+ * @example
+ * ```typescript
+ * const geometry = new THREE.TorusKnotGeometry(10, 3, 100, 16);
+ * const material = new THREE.MeshBasicMaterial({
+ *     color: 0xffff00
+ * });
+ * const torusKnot = new THREE.Mesh(geometry, material);
+ * scene.add(torusKnot);
+ * ```
+ * @see {@link https://threejs.org/docs/index.html#api/en/geometries/TorusKnotGeometry | Official Documentation}
+ * @see {@link https://github.com/mrdoob/three.js/blob/master/src/geometries/TorusKnotGeometry.js | Source}
+ */
+export class TorusKnotGeometry extends BufferGeometry {
+	/**
+	 * Create a new instance of {@link TorusKnotGeometry}
+	 * @param radius Radius of the torus.. Default `1`.
+	 * @param tube Expects a `Float`. Default `0.4`.
+	 * @param tubularSegments Expects a `Integer`. Default `64`.
+	 * @param radialSegments Expects a `Integer`. Default `8`.
+	 * @param p This value determines, how many times the geometry winds around its axis of rotational symmetry. Expects a `Integer`. Default `2`.
+	 * @param q This value determines, how many times the geometry winds around a circle in the interior of the torus. Expects a `Integer`. Default `3`.
+	 */
+	constructor(radius?: number, tube?: number, tubularSegments?: number, radialSegments?: number, p?: number, q?: number);
+
+	/**
+	 * A Read-only _string_ to check if `this` object type.
+	 * @remarks Sub-classes will update this value.
+	 * @defaultValue `TorusKnotGeometry`
+	 */
+	override readonly type: string | 'TorusKnotGeometry';
+
+	/**
+	 * An object with a property for each of the constructor parameters.
+	 * @remarks Any modification after instantiation does not change the geometry.
+	 */
+	readonly parameters: {
+		readonly radius: number;
+		readonly tube: number;
+		readonly tubularSegments: number;
+		readonly radialSegments: number;
+		readonly p: number;
+		readonly q: number;
+	};
+
+	/** @internal */
+	static fromJSON(data: {}): TorusKnotGeometry;
+}

package/three/src/geometries/TubeGeometry.d.ts

@@ -0,0 +1,80 @@
+import { BufferGeometry } from '../core/BufferGeometry.js';
+import { Curve } from '../extras/core/Curve.js';
+import { Vector3 } from '../math/Vector3.js';
+
+/**
+ * Creates a tube that extrudes along a 3d curve.
+ * @example
+ * ```typescript
+ * class CustomSinCurve extends THREE.Curve {
+ *     constructor(scale = 1) {
+ *         super();
+ *         this.scale = scale;
+ *     }
+ *     getPoint(t, optionalTarget = new THREE.Vector3()) {
+ *         const tx = t * 3 - 1.5;
+ *         const ty = Math.sin(2 * Math.PI * t);
+ *         const tz = 0;
+ *         return optionalTarget.set(tx, ty, tz).multiplyScalar(this.scale);
+ *     }
+ * }
+ * const path = new CustomSinCurve(10);
+ * const geometry = new THREE.TubeGeometry(path, 20, 2, 8, false);
+ * const material = new THREE.MeshBasicMaterial({
+ *     color: 0x00ff00
+ * });
+ * const mesh = new THREE.Mesh(geometry, material);
+ * scene.add(mesh);
+ * ```
+ * @see {@link https://threejs.org/docs/index.html#api/en/geometries/TubeGeometry | Official Documentation}
+ * @see {@link https://github.com/mrdoob/three.js/blob/master/src/geometries/TubeGeometry.js | Source}
+ */
+export class TubeGeometry extends BufferGeometry {
+	/**
+	 * Create a new instance of {@link TubeGeometry}
+	 * @param path A 3D path that inherits from the {@link THREE.Curve | Curve} base class.
+	 *             Default {@link THREE.QuadraticBezierCurve3 | new THREE.QuadraticBezierCurve3(new Vector3(-1, -1, 0 ), new Vector3(-1, 1, 0), new Vector3(1, 1, 0))}.
+	 * @param tubularSegments The number of segments that make up the tube. Expects a `Integer`. Default `64`.
+	 * @param radius The radius of the tube. Expects a `Float`. Default `1`.
+	 * @param radialSegments The number of segments that make up the cross-section. Expects a `Integer`. Default `8`.
+	 * @param closed Is the tube open or closed. Default `false`.
+	 */
+	constructor(path?: Curve<Vector3>, tubularSegments?: number, radius?: number, radialSegments?: number, closed?: boolean);
+
+	/**
+	 * A Read-only _string_ to check if `this` object type.
+	 * @remarks Sub-classes will update this value.
+	 * @defaultValue `TubeGeometry`
+	 */
+	override readonly type: string | 'TubeGeometry';
+
+	/**
+	 * An object with a property for each of the constructor parameters.
+	 * @remarks Any modification after instantiation does not change the geometry.
+	 */
+	readonly parameters: {
+		readonly path: Curve<Vector3>;
+		readonly tubularSegments: number;
+		readonly radius: number;
+		readonly radialSegments: number;
+		readonly closed: boolean;
+	};
+
+	/**
+	 * An array of {@link THREE.Vector3 | Vector3} tangents
+	 */
+	tangents: Vector3[];
+
+	/**
+	 * An array of {@link THREE.Vector3 | Vector3} normals
+	 */
+	normals: Vector3[];
+
+	/**
+	 * An array of {@link THREE.Vector3 | Vector3} binormals
+	 */
+	binormals: Vector3[];
+
+	/** @internal */
+	static fromJSON(data: {}): TubeGeometry;
+}

package/three/src/geometries/WireframeGeometry.d.ts

@@ -0,0 +1,40 @@
+import { BufferGeometry } from '../core/BufferGeometry.js';
+
+/**
+ * This can be used as a helper object to view a {@link BufferGeometry | geometry} as a wireframe.
+ * @example
+ * ```typescript
+ * const geometry = new THREE.SphereGeometry(100, 100, 100);
+ * const wireframe = new THREE.WireframeGeometry(geometry);
+ * const line = new THREE.LineSegments(wireframe);
+ * line.material.depthTest = false;
+ * line.material.opacity = 0.25;
+ * line.material.transparent = true;
+ * scene.add(line);
+ * ```
+ * @see Example: {@link https://threejs.org/examples/#webgl_helpers | helpers}
+ * @see {@link https://threejs.org/docs/index.html#api/en/geometries/WireframeGeometry | Official Documentation}
+ * @see {@link https://github.com/mrdoob/three.js/blob/master/src/geometries/WireframeGeometry.js | Source}
+ */
+export class WireframeGeometry<TBufferGeometry extends BufferGeometry = BufferGeometry> extends BufferGeometry {
+	/**
+	 * Create a new instance of {@link WireframeGeometry}
+	 * @param geometry Any geometry object. Default `null`.
+	 */
+	constructor(geometry?: TBufferGeometry);
+
+	/**
+	 * A Read-only _string_ to check if `this` object type.
+	 * @remarks Sub-classes will update this value.
+	 * @defaultValue `WireframeGeometry`
+	 */
+	override readonly type: string | 'WireframeGeometry';
+
+	/**
+	 * An object with a property for each of the constructor parameters.
+	 * @remarks Any modification after instantiation does not change the geometry.
+	 */
+	readonly parameters: {
+		readonly geometry: TBufferGeometry;
+	};
+}

package/three/src/helpers/ArrowHelper.d.ts

@@ -0,0 +1,86 @@
+import { Object3D } from '../core/Object3D.js';
+import { ColorRepresentation } from '../math/Color.js';
+import { Vector3 } from '../math/Vector3.js';
+import { Line } from '../objects/Line.js';
+import { Mesh } from '../objects/Mesh.js';
+
+/**
+ * An 3D arrow object for visualizing directions.
+ * @example
+ * ```typescript
+ * const dir = new THREE.Vector3(1, 2, 0);
+ * //normalize the direction vector (convert to vector of length 1)
+ * dir.normalize();
+ * const origin = new THREE.Vector3(0, 0, 0);
+ * const length = 1;
+ * const hex = 0xffff00;
+ * const {@link ArrowHelper} = new THREE.ArrowHelper(dir, origin, length, hex);
+ * scene.add(arrowHelper);
+ * ```
+ * @see Example: {@link https://threejs.org/examples/#webgl_shadowmesh | WebGL / shadowmesh}
+ * @see {@link https://threejs.org/docs/index.html#api/en/helpers/ArrowHelper | Official Documentation}
+ * @see {@link https://github.com/mrdoob/three.js/blob/master/src/helpers/ArrowHelper.js | Source}
+ */
+export class ArrowHelper extends Object3D {
+	/**
+	 * Create a new instance of {@link ArrowHelper}
+	 * @param dir Direction from origin. Must be a unit vector. Default `new THREE.Vector3(0, 0, 1)`
+	 * @param origin Point at which the arrow starts. Default `new THREE.Vector3(0, 0, 0)`
+	 * @param length Length of the arrow. Default `1`
+	 * @param hex Hexadecimal value to define color. Default `0xffff00`
+	 * @param headLength The length of the head of the arrow. Default `0.2 * length`
+	 * @param headWidth The width of the head of the arrow. Default `0.2 * headLength`
+	 */
+	constructor(dir?: Vector3, origin?: Vector3, length?: number, color?: ColorRepresentation, headLength?: number, headWidth?: number);
+
+	/**
+	 * A Read-only _string_ to check if `this` object type.
+	 * @remarks Sub-classes will update this value.
+	 * @override
+	 * @defaultValue `ArrowHelper`
+	 */
+	override readonly type: string | 'ArrowHelper';
+
+	/**
+	 * Contains the line part of the arrowHelper.
+	 */
+	line: Line;
+
+	/**
+	 * Contains the cone part of the arrowHelper.
+	 */
+	cone: Mesh;
+
+	/**
+	 * Sets the color of the arrowHelper.
+	 * @param color The desired color.
+	 */
+	setColor(color: ColorRepresentation): void;
+
+	/**
+	 * @param dir The desired direction. Must be a unit vector.
+	 */
+	setDirection(dir: Vector3): void;
+
+	/**
+	 * Sets the length of the arrowhelper.
+	 * @param length The desired length.
+	 * @param headLength The length of the head of the arrow. Default `0.2 * length`
+	 * @param headWidth The width of the head of the arrow. Default `0.2 * headLength`
+	 */
+	setLength(length: number, headLength?: number, headWidth?: number): void;
+
+	/**
+	 * Copy the given object into this object
+	 * @remarks Note: event listeners and user-defined callbacks ({@link onAfterRender | .onAfterRender} and {@link onBeforeRender | .onBeforeRender}) are not copied.
+	 * @param source
+	 */
+	override copy(source: this): this;
+
+	/**
+	 * Frees the GPU-related resources allocated by this instance
+	 * @remarks
+	 * Call this method whenever this instance is no longer used in your app.
+	 */
+	dispose(): void;
+}

package/three/src/helpers/AxesHelper.d.ts

@@ -0,0 +1,50 @@
+import { ColorRepresentation } from '../math/Color.js';
+import { LineSegments } from '../objects/LineSegments.js';
+
+/**
+ * An axis object to visualize the 3 axes in a simple way.
+ * @remarks
+ * The X axis is red
+ * The Y axis is green
+ * The Z axis is blue.
+ * @example
+ * ```typescript
+ * const {@link AxesHelper} = new THREE.AxesHelper(5);
+ * scene.add(axesHelper);
+ * ```
+ * @see Example: {@link https://threejs.org/examples/#webgl_buffergeometry_compression | WebGL / buffergeometry / compression}
+ * @see Example: {@link https://threejs.org/examples/#webgl_geometry_convex | WebGL / geometry / convex}
+ * @see Example: {@link https://threejs.org/examples/#webgl_loader_nrrd | WebGL / loader / nrrd}
+ * @see {@link https://threejs.org/docs/index.html#api/en/helpers/AxesHelper | Official Documentation}
+ * @see {@link https://github.com/mrdoob/three.js/blob/master/src/helpers/AxesHelper.js | Source}
+ */
+export class AxesHelper extends LineSegments {
+	/**
+	 * Create a new instance of {@link AxesHelper}
+	 * @param size Size of the lines representing the axes. Default `1`
+	 */
+	constructor(size?: number);
+
+	/**
+	 * A Read-only _string_ to check if `this` object type.
+	 * @remarks Sub-classes will update this value.
+	 * @override
+	 * @defaultValue `AxesHelper`
+	 */
+	override readonly type: string | 'AxesHelper';
+
+	/**
+	 * Sets the axes colors to {@link Color | xAxisColor}, {@link Color | yAxisColor}, {@link Color | zAxisColor}.
+	 * @param xAxisColor
+	 * @param yAxisColor
+	 * @param zAxisColor
+	 */
+	setColors(xAxisColor: ColorRepresentation, yAxisColor: ColorRepresentation, zAxisColor: ColorRepresentation): this;
+
+	/**
+	 * Frees the GPU-related resources allocated by this instance
+	 * @remarks
+	 * Call this method whenever this instance is no longer used in your app.
+	 */
+	dispose(): void;
+}

package/three/src/helpers/Box3Helper.d.ts

@@ -0,0 +1,44 @@
+import { Box3 } from '../math/Box3.js';
+import { ColorRepresentation } from '../math/Color.js';
+import { LineSegments } from '../objects/LineSegments.js';
+
+/**
+ * Helper object to visualize a {@link THREE.Box3 | Box3}.
+ * @example
+ * ```typescript
+ * const box = new THREE.Box3();
+ * box.setFromCenterAndSize(new THREE.Vector3(1, 1, 1), new THREE.Vector3(2, 1, 3));
+ * const helper = new THREE.Box3Helper(box, 0xffff00);
+ * scene.add(helper);
+ * ```
+ * @see {@link https://threejs.org/docs/index.html#api/en/helpers/Box3Helper | Official Documentation}
+ * @see {@link https://github.com/mrdoob/three.js/blob/master/src/helpers/Box3Helper.js | Source}
+ */
+export class Box3Helper extends LineSegments {
+	/**
+	 * Creates a new wireframe box that represents the passed Box3.
+	 * @param box The Box3 to show.
+	 * @param color The box's color. Default `0xffff00`
+	 */
+	constructor(box: Box3, color?: ColorRepresentation);
+
+	/**
+	 * A Read-only _string_ to check if `this` object type.
+	 * @remarks Sub-classes will update this value.
+	 * @override
+	 * @defaultValue `Box3Helper`
+	 */
+	override readonly type: string | 'Box3Helper';
+
+	/**
+	 * The Box3 being visualized.
+	 */
+	box: Box3;
+
+	/**
+	 * Frees the GPU-related resources allocated by this instance
+	 * @remarks
+	 * Call this method whenever this instance is no longer used in your app.
+	 */
+	dispose(): void;
+}

package/three/src/helpers/BoxHelper.d.ts

@@ -0,0 +1,64 @@
+import { BufferGeometry } from '../core/BufferGeometry.js';
+import { Object3D } from '../core/Object3D.js';
+import { LineBasicMaterial } from '../materials/LineBasicMaterial.js';
+import { ColorRepresentation } from '../math/Color.js';
+import { LineSegments } from '../objects/LineSegments.js';
+
+/**
+ * Helper object to graphically show the world-axis-aligned bounding box around an object
+ * @remarks
+ * The actual bounding box is handled with {@link THREE.Box3 | Box3}, this is just a visual helper for debugging
+ * It can be automatically resized with the {@link THREE.BoxHelper.update | BoxHelper.update} method when the object it's created from is transformed
+ * Note that the object must have a {@link THREE.BufferGeometry | BufferGeometry} for this to work, so it won't work with {@link Sprite | Sprites}.
+ * @example
+ * ```typescript
+ * const sphere = new THREE.SphereGeometry();
+ * const object = new THREE.Mesh(sphere, new THREE.MeshBasicMaterial(0xff0000));
+ * const box = new THREE.BoxHelper(object, 0xffff00);
+ * scene.add(box);
+ * ```
+ * @see Example: {@link https://threejs.org/examples/#webgl_helpers | WebGL / helpers}
+ * @see Example: {@link https://threejs.org/examples/#webgl_loader_nrrd | WebGL / loader / nrrd}
+ * @see Example: {@link https://threejs.org/examples/#webgl_buffergeometry_drawrange | WebGL / buffergeometry / drawrange}
+ * @see {@link https://threejs.org/docs/index.html#api/en/helpers/BoxHelper | Official Documentation}
+ * @see {@link https://github.com/mrdoob/three.js/blob/master/src/helpers/BoxHelper.js | Source}
+ */
+export class BoxHelper extends LineSegments<BufferGeometry, LineBasicMaterial> {
+	/**
+	 * Creates a new wireframe box that bounds the passed object
+	 * @remarks
+	 * Internally this uses {@link THREE.Box3.setFromObject | Box3.setFromObject} to calculate the dimensions
+	 * Note that this includes any children.
+	 * @param object The object3D to show the world-axis-aligned bounding box.
+	 * @param color Hexadecimal value that defines the box's color. Default `0xffff00`
+	 */
+	constructor(object: Object3D, color?: ColorRepresentation);
+
+	/**
+	 * A Read-only _string_ to check if `this` object type.
+	 * @remarks Sub-classes will update this value.
+	 * @override
+	 * @defaultValue `BoxHelper`
+	 */
+	override readonly type: string | 'BoxHelper';
+
+	/**
+	 * Updates the helper's geometry to match the dimensions of the object, including any children
+	 * @remarks
+	 * See {@link THREE.Box3.setFromObject | Box3.setFromObject}.
+	 */
+	update(object?: Object3D): void;
+
+	/**
+	 * Updates the wireframe box for the passed object.
+	 * @param object {@link THREE.Object3D | Object3D} to create the helper of.
+	 */
+	setFromObject(object: Object3D): this;
+
+	/**
+	 * Frees the GPU-related resources allocated by this instance
+	 * @remarks
+	 * Call this method whenever this instance is no longer used in your app.
+	 */
+	dispose(): void;
+}