@types/three 0.150.2 → 0.152.0

three/src/extras/curves/LineCurve3.d.ts

@@ -1,21 +1,42 @@
 import { Vector3 } from './../../math/Vector3';
 import { Curve } from './../core/Curve';
 
+/**
+ * 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> {
-    constructor(v1: Vector3, v2: 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;
 
     /**
-     * @default 'LineCurve3'
+     * A Read-only _string_ to check if `this` object type.
+     * @remarks Sub-classes will update this value.
+     * @defaultValue `LineCurve3`
      */
-    type: string;
+    override readonly type: string | 'LineCurve3';
 
     /**
-     * @default new THREE.Vector3()
+     * The start point.
+     * @defaultValue `new THREE.Vector3()`.
      */
     v1: Vector3;
 
     /**
-     * @default new THREE.Vector3()
+     * The end point.
+     * @defaultValue `new THREE.Vector3()`.
      */
     v2: Vector3;
 }

three/src/extras/curves/QuadraticBezierCurve.d.ts

@@ -1,26 +1,64 @@
 import { Vector2 } from './../../math/Vector2';
 import { Curve } from './../core/Curve';
 
+/**
+ * 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> {
-    constructor(v0: Vector2, v1: Vector2, v2: 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;
 
     /**
-     * @default 'QuadraticBezierCurve'
+     * A Read-only _string_ to check if `this` object type.
+     * @remarks Sub-classes will update this value.
+     * @defaultValue `QuadraticBezierCurve`
      */
-    type: string;
+    override readonly type: string | 'QuadraticBezierCurve';
 
     /**
-     * @default new THREE.Vector2()
+     * The start point.
+     * @defaultValue `new THREE.Vector2()`
      */
     v0: Vector2;
 
     /**
-     * @default new THREE.Vector2()
+     * The control point.
+     * @defaultValue `new THREE.Vector2()`
      */
     v1: Vector2;
 
     /**
-     * @default new THREE.Vector2()
+     * The end point.
+     * @defaultValue `new THREE.Vector2()`
      */
     v2: Vector2;
 }

three/src/extras/curves/QuadraticBezierCurve3.d.ts

@@ -1,26 +1,64 @@
 import { Vector3 } from './../../math/Vector3';
 import { Curve } from './../core/Curve';
 
+/**
+ * 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> {
-    constructor(v0: Vector3, v1: Vector3, v2: 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;
 
     /**
-     * @default 'QuadraticBezierCurve3'
+     * A Read-only _string_ to check if `this` object type.
+     * @remarks Sub-classes will update this value.
+     * @defaultValue `QuadraticBezierCurve3`
      */
-    type: string;
+    override readonly type: string | 'QuadraticBezierCurve3';
 
     /**
-     * @default new THREE.Vector3()
+     * The start point.
+     * @defaultValue `new THREE.Vector3()`
      */
     v0: Vector3;
 
     /**
-     * @default new THREE.Vector3()
+     * The control point.
+     * @defaultValue `new THREE.Vector3()`
      */
     v1: Vector3;
 
     /**
-     * @default new THREE.Vector3()
+     * The end point.
+     * @defaultValue `new THREE.Vector3()`
      */
     v2: Vector3;
 }

three/src/extras/curves/SplineCurve.d.ts

@@ -1,16 +1,52 @@
 import { Vector2 } from './../../math/Vector2';
 import { Curve } from './../core/Curve';
 
+/**
+ * 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[]);
 
     /**
-     * @default 'SplineCurve'
+     * 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`
      */
-    type: string;
+    override readonly type: string | 'SplineCurve';
 
     /**
-     * @default []
+     * The array of {@link THREE.Vector2 | Vector2} points that define the curve.
+     * @defaultValue `[]`
      */
     points: Vector2[];
 }

three/src/helpers/ArrowHelper.d.ts

@@ -4,16 +4,32 @@ import { Mesh } from './../objects/Mesh';
 import { Object3D } from './../core/Object3D';
 import { ColorRepresentation } from '../math/Color';
 
-// Extras / Helpers /////////////////////////////////////////////////////////////////////
-
+/**
+ * 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 {
     /**
-     * @param [dir] Direction from origin. Must be a unit vector.
-     * @param [origin] Point at which the arrow starts.
-     * @param [length] Length of the arrow.
-     * @param [color] Hexadecimal value to define color.
-     * @param [headLength] The length of the head of the arrow.
-     * @param [headWidth] The width of the head of the arrow.
+     * 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,
@@ -25,9 +41,12 @@ export class ArrowHelper extends Object3D {
     );
 
     /**
-     * @default 'ArrowHelper'
+     * A Read-only _string_ to check if `this` object type.
+     * @remarks Sub-classes will update this value.
+     * @override
+     * @defaultValue `ArrowHelper`
      */
-    type: string;
+    override readonly type: string | 'ArrowHelper';
 
     /**
      * Contains the line part of the arrowHelper.
@@ -39,24 +58,36 @@ export class ArrowHelper extends Object3D {
      */
     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.
-     * @param [headWidth] The width of the head of the arrow.
+     * @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;
 
     /**
-     * @param color The desired color.
+     * 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
      */
-    setColor(color: ColorRepresentation): void;
-
-    copy(source: this): this;
+    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;
 }

three/src/helpers/AxesHelper.d.ts

@@ -1,18 +1,50 @@
 import { Color } from '../math/Color';
 import { LineSegments } from './../objects/LineSegments';
 
+/**
+ * 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 {
     /**
-     * @param [size=1]
+     * Create a new instance of {@link AxesHelper}
+     * @param size Size of the lines representing the axes. Default `1`
      */
     constructor(size?: number);
 
     /**
-     * @default 'AxesHelper'
+     * A Read-only _string_ to check if `this` object type.
+     * @remarks Sub-classes will update this value.
+     * @override
+     * @defaultValue `AxesHelper`
      */
-    type: string;
+    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: Color, yAxisColor: Color, zAxisColor: Color): 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;
 }

three/src/helpers/Box3Helper.d.ts

@@ -2,19 +2,43 @@ import { Box3 } from './../math/Box3';
 import { Color } from './../math/Color';
 import { LineSegments } from './../objects/LineSegments';
 
+/**
+ * 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 {
     /**
-     * @param box
-     * @param [color=0xffff00]
+     * 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?: Color);
 
     /**
-     * @default 'Box3Helper'
+     * A Read-only _string_ to check if `this` object type.
+     * @remarks Sub-classes will update this value.
+     * @override
+     * @defaultValue `Box3Helper`
      */
-    type: string;
+    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;
 }

three/src/helpers/BoxHelper.d.ts

@@ -2,21 +2,61 @@ import { ColorRepresentation } from '../math/Color';
 import { Object3D } from './../core/Object3D';
 import { LineSegments } from './../objects/LineSegments';
 
+/**
+ * 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 {
     /**
-     * @param object
-     * @param [color=0xffff00]
+     * 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);
 
     /**
-     * @default 'BoxHelper'
+     * A Read-only _string_ to check if `this` object type.
+     * @remarks Sub-classes will update this value.
+     * @override
+     * @defaultValue `BoxHelper`
      */
-    type: string;
+    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;
 }

three/src/helpers/CameraHelper.d.ts

@@ -4,19 +4,36 @@ import { Camera } from './../cameras/Camera';
 import { LineSegments } from './../objects/LineSegments';
 
 /**
- * This helps with visualizing what a camera contains in its frustum.
- * It visualizes the frustum of a camera using a {@link LineSegments}.
- *
- * CameraHelper must be a child of the scene.
+ * This helps with visualizing what a camera contains in its frustum
+ * @remarks
+ * It visualizes the frustum of a camera using a {@link THREE.LineSegments | LineSegments}.
+ * @remarks {@link CameraHelper} must be a child of the scene.
+ * @example
+ * ```typescript
+ * const camera = new THREE.PerspectiveCamera(75, window.innerWidth / window.innerHeight, 0.1, 1000);
+ * const helper = new THREE.CameraHelper(camera);
+ * scene.add(helper);
+ * ```
+ * @see Example: {@link https://threejs.org/examples/#webgl_camera | WebGL / camera}
+ * @see Example: {@link https://threejs.org/examples/#webgl_geometry_extrude_splines | WebGL / extrude / splines}
+ * @see {@link https://threejs.org/docs/index.html#api/en/helpers/CameraHelper | Official Documentation}
+ * @see {@link https://github.com/mrdoob/three.js/blob/master/src/helpers/CameraHelper.js | Source}
  */
 export class CameraHelper extends LineSegments {
     /**
-     * This create a new CameraHelper for the specified camera.
-     *
-     * @param camera - The camera to visualize.
+     * This create a new {@link CameraHelper} for the specified camera.
+     * @param camera The camera to visualize.
      */
     constructor(camera: Camera);
 
+    /**
+     * A Read-only _string_ to check if `this` object type.
+     * @remarks Sub-classes will update this value.
+     * @override
+     * @defaultValue `CameraHelper`
+     */
+    override readonly type: string | 'CameraHelper';
+
     /**
      * The camera being visualized.
      */
@@ -28,20 +45,26 @@ export class CameraHelper extends LineSegments {
     pointMap: { [id: string]: number[] };
 
     /**
-     * Reference to the {@link Camera.matrixWorld}.
+     * Reference to the {@link THREE.Camera.matrixWorld | camera.matrixWorld}.
      */
     matrix: Matrix4;
 
     /**
-     * See {@link Object3D.matrixAutoUpdate}.
-     * Set to `false` here as the helper is using the camera's {@link Camera.matrixWorld}.
+     * Is set to `false`, as the helper is using the {@link THREE.Camera.matrixWorld | camera.matrixWorld}.
+     * @see {@link THREE.Object3D.matrixAutoUpdate | Object3D.matrixAutoUpdate}.
+     * @defaultValue `false`.
      */
-    matrixAutoUpdate: boolean;
+    override matrixAutoUpdate: boolean;
 
     /**
-     * @default 'CameraHelper'
+     * Defines the colors of the helper.
+     * @param frustum
+     * @param cone
+     * @param up
+     * @param target
+     * @param cross
      */
-    type: string;
+    setColors(frustum: Color, cone: Color, up: Color, target: Color, cross: Color): this;
 
     /**
      * Updates the helper based on the projectionMatrix of the camera.
@@ -49,13 +72,9 @@ export class CameraHelper extends LineSegments {
     update(): void;
 
     /**
-     * Frees the GPU-related resources allocated by this instance.
+     * 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;
-
-    /**
-     * Defines the colors of the helper.
-     */
-    setColors(frustum: Color, cone: Color, up: Color, target: Color, cross: Color): this;
 }