@types/three 0.150.0 → 0.150.2

three/src/geometries/TubeGeometry.d.ts

@@ -2,37 +2,85 @@ import { Curve } from './../extras/core/Curve';
 import { Vector3 } from './../math/Vector3';
 import { BufferGeometry } from './../core/BufferGeometry';
 
+/**
+ * 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 {
     /**
-     * @param path
-     * @param [tubularSegments=64]
-     * @param [radius=1]
-     * @param [radiusSegments=8]
-     * @param [closed=false]
+     * 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,
-        radiusSegments?: number,
+        radialSegments?: number,
         closed?: boolean,
     );
 
     /**
-     * @default 'TubeGeometry'
+     * A Read-only _string_ to check if `this` object type.
+     * @remarks Sub-classes will update this value.
+     * @defaultValue `TubeGeometry`
      */
-    type: string;
+    override readonly type: string | 'TubeGeometry';
 
-    parameters: {
-        path: Curve<Vector3>;
-        tubularSegments: number;
-        radius: number;
-        radialSegments: number;
-        closed: boolean;
+    /**
+     * 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[];
 
-    static fromJSON(data: any): TubeGeometry;
+    /** @internal */
+    static fromJSON(data: {}): TubeGeometry;
 }

three/src/geometries/WireframeGeometry.d.ts

@@ -1,14 +1,40 @@
 import { BufferGeometry } from './../core/BufferGeometry';
 
+/**
+ * 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);
 
     /**
-     * @default 'WireframeGeometry'
+     * A Read-only _string_ to check if `this` object type.
+     * @remarks Sub-classes will update this value.
+     * @defaultValue `WireframeGeometry`
      */
-    type: string;
+    override readonly type: string | 'WireframeGeometry';
 
-    parameters: {
-        geometry: TBufferGeometry;
+    /**
+     * 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;
     };
 }

three/src/helpers/ArrowHelper.d.ts

@@ -2,7 +2,7 @@ import { Vector3 } from './../math/Vector3';
 import { Line } from './../objects/Line';
 import { Mesh } from './../objects/Mesh';
 import { Object3D } from './../core/Object3D';
-import { ColorRepresentation } from '../utils';
+import { ColorRepresentation } from '../math/Color';
 
 // Extras / Helpers /////////////////////////////////////////////////////////////////////
 

three/src/helpers/BoxHelper.d.ts

@@ -1,4 +1,4 @@
-import { ColorRepresentation } from '../utils';
+import { ColorRepresentation } from '../math/Color';
 import { Object3D } from './../core/Object3D';
 import { LineSegments } from './../objects/LineSegments';
 

three/src/helpers/DirectionalLightHelper.d.ts

@@ -2,7 +2,7 @@ import { DirectionalLight } from './../lights/DirectionalLight';
 import { Line } from './../objects/Line';
 import { Matrix4 } from './../math/Matrix4';
 import { Object3D } from './../core/Object3D';
-import { ColorRepresentation } from '../utils';
+import { ColorRepresentation } from '../math/Color';
 
 export class DirectionalLightHelper extends Object3D {
     /**

three/src/helpers/GridHelper.d.ts

@@ -1,4 +1,4 @@
-import { ColorRepresentation } from '../utils';
+import { ColorRepresentation } from '../math/Color';
 import { LineSegments } from './../objects/LineSegments';
 
 export class GridHelper extends LineSegments {

three/src/helpers/HemisphereLightHelper.d.ts

@@ -1,9 +1,8 @@
 import { HemisphereLight } from './../lights/HemisphereLight';
-import { Color } from './../math/Color';
 import { Matrix4 } from './../math/Matrix4';
 import { MeshBasicMaterial } from './../materials/MeshBasicMaterial';
 import { Object3D } from './../core/Object3D';
-import { ColorRepresentation } from '../utils';
+import { ColorRepresentation } from '../math/Color';
 
 export class HemisphereLightHelper extends Object3D {
     constructor(light: HemisphereLight, size: number, color?: ColorRepresentation);

three/src/helpers/PointLightHelper.d.ts

@@ -1,7 +1,7 @@
 import { PointLight } from './../lights/PointLight';
 import { Matrix4 } from './../math/Matrix4';
 import { Object3D } from './../core/Object3D';
-import { ColorRepresentation } from '../utils';
+import { ColorRepresentation } from '../math/Color';
 
 export class PointLightHelper extends Object3D {
     constructor(light: PointLight, sphereSize?: number, color?: ColorRepresentation);

three/src/helpers/PolarGridHelper.d.ts

@@ -1,5 +1,5 @@
 import { LineSegments } from '../objects/LineSegments';
-import { ColorRepresentation } from '../utils';
+import { ColorRepresentation } from '../math/Color';
 
 export class PolarGridHelper extends LineSegments {
     /**

three/src/helpers/SpotLightHelper.d.ts

@@ -2,7 +2,7 @@ import { Light } from './../lights/Light';
 import { Matrix4 } from './../math/Matrix4';
 import { Object3D } from './../core/Object3D';
 import { LineSegments } from '../objects/LineSegments';
-import { ColorRepresentation } from '../utils';
+import { ColorRepresentation } from '../math/Color';
 
 export class SpotLightHelper extends Object3D {
     constructor(light: Light, color?: ColorRepresentation);

three/src/lights/AmbientLight.d.ts

@@ -1,4 +1,4 @@
-import { ColorRepresentation } from '../utils';
+import { ColorRepresentation } from '../math/Color';
 import { Light } from './Light';
 
 /**

three/src/lights/AmbientLightProbe.d.ts

@@ -1,4 +1,4 @@
-import { ColorRepresentation } from '../utils';
+import { ColorRepresentation } from '../math/Color';
 import { LightProbe } from './LightProbe';
 
 export class AmbientLightProbe extends LightProbe {

three/src/lights/DirectionalLight.d.ts

@@ -2,7 +2,7 @@ import { Object3D } from './../core/Object3D';
 import { DirectionalLightShadow } from './DirectionalLightShadow';
 import { Light } from './Light';
 import { Vector3 } from '../math/Vector3';
-import { ColorRepresentation } from '../utils';
+import { ColorRepresentation } from '../math/Color';
 
 /**
  * see {@link https://github.com/mrdoob/three.js/blob/master/src/lights/DirectionalLight.js|src/lights/DirectionalLight.js}

three/src/lights/HemisphereLight.d.ts

@@ -1,7 +1,6 @@
-import { Color } from './../math/Color';
+import { Color, ColorRepresentation } from './../math/Color';
 import { Vector3 } from '../math/Vector3';
 import { Light } from './Light';
-import { ColorRepresentation } from '../utils';
 
 export class HemisphereLight extends Light {
     /**

three/src/lights/HemisphereLightProbe.d.ts

@@ -1,4 +1,4 @@
-import { ColorRepresentation } from '../utils';
+import { ColorRepresentation } from '../math/Color';
 import { LightProbe } from './LightProbe';
 
 export class HemisphereLightProbe extends LightProbe {

three/src/lights/PointLight.d.ts

@@ -1,4 +1,4 @@
-import { ColorRepresentation } from '../utils';
+import { ColorRepresentation } from '../math/Color';
 import { Light } from './Light';
 import { PointLightShadow } from './PointLightShadow';
 

three/src/lights/RectAreaLight.d.ts

@@ -1,5 +1,5 @@
 import { Light } from './Light';
-import { ColorRepresentation } from '../utils';
+import { ColorRepresentation } from '../math/Color';
 
 export class RectAreaLight extends Light {
     constructor(color?: ColorRepresentation, intensity?: number, width?: number, height?: number);

three/src/lights/SpotLight.d.ts

@@ -1,9 +1,8 @@
-import { Color } from './../math/Color';
 import { Vector3 } from '../math/Vector3';
 import { Object3D } from './../core/Object3D';
 import { SpotLightShadow } from './SpotLightShadow';
 import { Light } from './Light';
-import { ColorRepresentation } from '../utils';
+import { ColorRepresentation } from '../math/Color';
 import { Texture } from '../textures/Texture';
 
 /**

three/src/materials/LineBasicMaterial.d.ts

@@ -1,5 +1,4 @@
-import { ColorRepresentation } from '../utils';
-import { Color } from './../math/Color';
+import { Color, ColorRepresentation } from './../math/Color';
 import { MaterialParameters, Material } from './Material';
 
 export interface LineBasicMaterialParameters extends MaterialParameters {

three/src/materials/MeshBasicMaterial.d.ts

@@ -1,8 +1,7 @@
-import { Color } from './../math/Color';
+import { Color, ColorRepresentation } from './../math/Color';
 import { Texture } from './../textures/Texture';
 import { MaterialParameters, Material } from './Material';
 import { Combine } from '../constants';
-import { ColorRepresentation } from '../utils';
 /**
  * parameters is an object with one or more properties defining the material's appearance.
  */

three/src/materials/MeshLambertMaterial.d.ts

@@ -1,8 +1,7 @@
-import { Color } from './../math/Color';
+import { Color, ColorRepresentation } from './../math/Color';
 import { Texture } from './../textures/Texture';
 import { MaterialParameters, Material } from './Material';
 import { Combine, NormalMapTypes } from '../constants';
-import { ColorRepresentation } from '../utils';
 import { Vector2 } from '../Three';
 
 export interface MeshLambertMaterialParameters extends MaterialParameters {

three/src/materials/MeshMatcapMaterial.d.ts

@@ -1,9 +1,8 @@
-import { Color } from './../math/Color';
+import { Color, ColorRepresentation } from './../math/Color';
 import { Texture } from './../textures/Texture';
 import { Vector2 } from './../math/Vector2';
 import { MaterialParameters, Material } from './Material';
 import { NormalMapTypes } from '../constants';
-import { ColorRepresentation } from '../utils';
 
 export interface MeshMatcapMaterialParameters extends MaterialParameters {
     color?: ColorRepresentation | undefined;

three/src/materials/MeshPhongMaterial.d.ts

@@ -1,9 +1,8 @@
-import { Color } from './../math/Color';
+import { Color, ColorRepresentation } from './../math/Color';
 import { Texture } from './../textures/Texture';
 import { Vector2 } from './../math/Vector2';
 import { MaterialParameters, Material } from './Material';
 import { Combine, NormalMapTypes } from '../constants';
-import { ColorRepresentation } from '../utils';
 
 export interface MeshPhongMaterialParameters extends MaterialParameters {
     /** geometry color in hexadecimal. Default is 0xffffff. */

three/src/materials/MeshStandardMaterial.d.ts

@@ -1,9 +1,8 @@
-import { Color } from './../math/Color';
+import { Color, ColorRepresentation } from './../math/Color';
 import { Texture } from './../textures/Texture';
 import { Vector2 } from './../math/Vector2';
 import { MaterialParameters, Material } from './Material';
 import { NormalMapTypes } from '../constants';
-import { ColorRepresentation } from '../utils';
 
 export interface MeshStandardMaterialParameters extends MaterialParameters {
     color?: ColorRepresentation | undefined;

three/src/materials/MeshToonMaterial.d.ts

@@ -1,9 +1,8 @@
-import { Color } from './../math/Color';
+import { Color, ColorRepresentation } from './../math/Color';
 import { Texture } from './../textures/Texture';
 import { Vector2 } from './../math/Vector2';
 import { MaterialParameters, Material } from './Material';
 import { NormalMapTypes } from '../constants';
-import { ColorRepresentation } from '../utils';
 
 export interface MeshToonMaterialParameters extends MaterialParameters {
     /** geometry color in hexadecimal. Default is 0xffffff. */

three/src/materials/PointsMaterial.d.ts

@@ -1,7 +1,6 @@
 import { Material, MaterialParameters } from './Material';
-import { Color } from './../math/Color';
+import { Color, ColorRepresentation } from './../math/Color';
 import { Texture } from './../textures/Texture';
-import { ColorRepresentation } from '../utils';
 
 export interface PointsMaterialParameters extends MaterialParameters {
     color?: ColorRepresentation | undefined;

three/src/materials/ShadowMaterial.d.ts

@@ -1,5 +1,4 @@
-import { ColorRepresentation } from '../utils';
-import { Color } from './../math/Color';
+import { Color, ColorRepresentation } from './../math/Color';
 import { MaterialParameters, Material } from './Material';
 
 export interface ShadowMaterialParameters extends MaterialParameters {

three/src/materials/SpriteMaterial.d.ts

@@ -1,5 +1,4 @@
-import { ColorRepresentation } from '../utils';
-import { Color } from './../math/Color';
+import { Color, ColorRepresentation } from './../math/Color';
 import { Texture } from './../textures/Texture';
 import { MaterialParameters, Material } from './Material';
 

three/src/math/Color.d.ts

@@ -1,5 +1,4 @@
 import { ColorSpace } from '../constants';
-import { ColorRepresentation } from '../utils';
 
 import { BufferAttribute } from './../core/BufferAttribute';
 import { InterleavedBufferAttribute } from './../core/InterleavedBufferAttribute';
@@ -157,7 +156,7 @@ declare const _colorKeywords: {
     yellowgreen: 0x9acd32;
 };
 
-export type ColorKeyword = keyof typeof _colorKeywords;
+export type ColorRepresentation = Color | string | number;
 
 export interface HSL {
     h: number;
@@ -236,7 +235,7 @@ export class Color {
      * Faster than {@link Color#setStyle .setStyle()} method if you don't need the other CSS-style formats.
      * @param style Color name in X11 format.
      */
-    setColorName(style: ColorKeyword, colorSpace?: ColorSpace): Color;
+    setColorName(style: string, colorSpace?: ColorSpace): Color;
 
     /**
      * Clones this color.

three/src/math/ColorManagement.d.ts

@@ -24,11 +24,11 @@ export namespace ColorManagement {
 
     function fromWorkingColorSpace(
         color: Color,
-        targetColorSpace: typeof SRGBColorSpace | typeof LinearSRGBColorSpace,
+        targetColorSpace: typeof SRGBColorSpace | typeof LinearSRGBColorSpace | typeof DisplayP3ColorSpace,
     ): Color;
 
     function toWorkingColorSpace(
         color: Color,
-        sourceColorSpace: typeof SRGBColorSpace | typeof LinearSRGBColorSpace,
+        sourceColorSpace: typeof SRGBColorSpace | typeof LinearSRGBColorSpace | typeof DisplayP3ColorSpace,
     ): Color;
 }

three/src/objects/Bone.d.ts

@@ -1,9 +1,36 @@
 import { Object3D } from './../core/Object3D';
 
-// Objects //////////////////////////////////////////////////////////////////////////////////
-
+/**
+ * A {@link Bone} which is part of a {@link THREE.Skeleton | Skeleton}
+ * @remarks
+ * The skeleton in turn is used by the {@link THREE.SkinnedMesh | SkinnedMesh}
+ * Bones are almost identical to a blank {@link THREE.Object3D | Object3D}.
+ * @example
+ * ```typescript
+ * const root = new THREE.Bone();
+ * const child = new THREE.Bone();
+ * root.add(child);
+ * child.position.y = 5;
+ * ```
+ * @see {@link https://threejs.org/docs/index.html#api/en/objects/Bone | Official Documentation}
+ * @see {@link https://github.com/mrdoob/three.js/blob/master/src/objects/Bone.js | Source}
+ */
 export class Bone extends Object3D {
+    /**
+     * Creates a new {@link Bone}.
+     */
     constructor();
+
+    /**
+     * Read-only flag to check if a given object is of type {@link Bone}.
+     * @remarks This is a _constant_ value
+     * @defaultValue `true`
+     */
     readonly isBone: true;
-    type: 'Bone';
+
+    /**
+     * @override
+     * @defaultValue `Bone`
+     */
+    override readonly type: string | 'Bone';
 }

three/src/objects/Group.d.ts

@@ -1,7 +1,43 @@
 import { Object3D } from './../core/Object3D';
 
+/**
+ * Its purpose is to make working with groups of objects syntactically clearer.
+ * @remarks This is almost identical to an {@link Object3D | Object3D}
+ * @example
+ * ```typescript
+ * const geometry = new THREE.BoxGeometry(1, 1, 1);
+ * const material = new THREE.MeshBasicMaterial({
+ *     color: 0x00ff00
+ * });
+ * const cubeA = new THREE.Mesh(geometry, material);
+ * cubeA.position.set(100, 100, 0);
+ * const cubeB = new THREE.Mesh(geometry, material);
+ * cubeB.position.set(-100, -100, 0);
+ * //create a {@link Group} and add the two cubes
+ * //These cubes can now be rotated / scaled etc as a {@link Group}  * const {@link Group} = new THREE.Group();
+ * group.add(cubeA);
+ * group.add(cubeB);
+ * scene.add(group);
+ * ```
+ * @see {@link https://threejs.org/docs/index.html#api/en/objects/Group | Official Documentation}
+ * @see {@link https://github.com/mrdoob/three.js/blob/master/src/objects/Group.js | Source}
+ */
 export class Group extends Object3D {
+    /**
+     * Creates a new {@link Bone}.
+     */
     constructor();
-    type: 'Group';
+
+    /**
+     * Read-only flag to check if a given object is of type {@link Group}.
+     * @remarks This is a _constant_ value
+     * @defaultValue `true`
+     */
     readonly isGroup: true;
+
+    /**
+     * @override
+     * @defaultValue `Group`
+     */
+    override readonly type: string | 'Group';
 }