@types/three 0.150.2 → 0.152.0

three/src/helpers/DirectionalLightHelper.d.ts

@@ -4,29 +4,76 @@ import { Matrix4 } from './../math/Matrix4';
 import { Object3D } from './../core/Object3D';
 import { ColorRepresentation } from '../math/Color';
 
+/**
+ * Helper object to assist with visualizing a {@link THREE.DirectionalLight | DirectionalLight}'s effect on the scene
+ * @remarks
+ * This consists of plane and a line representing the light's position and direction.
+ * @example
+ * ```typescript
+ * const light = new THREE.DirectionalLight(0xFFFFFF);
+ * const helper = new THREE.DirectionalLightHelper(light, 5);
+ * scene.add(helper);
+ * ```
+ * @see {@link https://threejs.org/docs/index.html#api/en/helpers/DirectionalLightHelper | Official Documentation}
+ * @see {@link https://github.com/mrdoob/three.js/blob/master/src/helpers/DirectionalLightHelper.js | Source}
+ */
 export class DirectionalLightHelper extends Object3D {
     /**
-     * @param light
-     * @param [size=1]
-     * @param color
+     * Create a new instance of {@link DirectionalLightHelper}
+     * @param light The light to be visualized.
+     * @param size Dimensions of the plane. Default `1`
+     * @param color If this is not the set the helper will take the color of the light. Default `light.color`
      */
     constructor(light: DirectionalLight, size?: number, color?: ColorRepresentation);
 
-    light: DirectionalLight;
+    /**
+     * A Read-only _string_ to check if `this` object type.
+     * @remarks Sub-classes will update this value.
+     * @override
+     * @defaultValue `DirectionalLightHelper`
+     */
+    override readonly type: string | 'DirectionalLightHelper';
+
+    /**
+     * Contains the line mesh showing the location of the directional light.
+     */
     lightPlane: Line;
-    targetLine: Line;
 
     /**
-     * @default undefined
+     * Reference to the {@link THREE.DirectionalLight | directionalLight} being visualized.
+     */
+    light: DirectionalLight;
+
+    /**
+     * Reference to the {@link THREE.DirectionalLight.matrixWorld | light.matrixWorld}.
      */
-    color: ColorRepresentation | undefined;
     matrix: Matrix4;
 
     /**
-     * @default false
+     * Is set to `false`, as the helper is using the {@link THREE.DirectionalLight.matrixWorld | light.matrixWorld}.
+     * @see {@link THREE.Object3D.matrixAutoUpdate | Object3D.matrixAutoUpdate}.
+     * @defaultValue `false`.
      */
-    matrixAutoUpdate: boolean;
+    override matrixAutoUpdate: boolean;
 
-    dispose(): void;
+    /**
+     * The color parameter passed in the constructor.
+     * @remarks If this is changed, the helper's color will update the next time {@link update} is called.
+     * @defaultValue `undefined`
+     */
+    color: ColorRepresentation | undefined;
+
+    targetLine: Line; // TODO: Double check if this need to be exposed or not.
+
+    /**
+     * Updates the helper to match the position and direction of the {@link light | DirectionalLight} being visualized.
+     */
     update(): void;
+
+    /**
+     * 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/GridHelper.d.ts

@@ -1,19 +1,45 @@
 import { ColorRepresentation } from '../math/Color';
 import { LineSegments } from './../objects/LineSegments';
 
+/**
+ * The {@link GridHelper} is an object to define grids
+ * @remarks
+ * Grids are two-dimensional arrays of lines.
+ * @example
+ * ```typescript
+ * const size = 10;
+ * const divisions = 10;
+ * const {@link GridHelper} = new THREE.GridHelper(size, divisions);
+ * scene.add(gridHelper);
+ * ```
+ * @see Example: {@link https://threejs.org/examples/#webgl_helpers | WebGL / helpers}
+ * @see {@link https://threejs.org/docs/index.html#api/en/helpers/GridHelper | Official Documentation}
+ * @see {@link https://github.com/mrdoob/three.js/blob/master/src/helpers/GridHelper.js | Source}
+ */
 export class GridHelper extends LineSegments {
     /**
-     * @param [size=10]
-     * @param [divisions=10]
-     * @param [color1=0x444444]
-     * @param [color2=0x888888]
+     * Creates a new {@link GridHelper} of size 'size' and divided into 'divisions' segments per side
+     * @remarks
+     * Colors are optional.
+     * @param size The size of the grid. Default `10`
+     * @param divisions The number of divisions across the grid. Default `10`
+     * @param colorCenterLine The color of the centerline. This can be a {@link THREE.Color | Color}, a hexadecimal value and an CSS-Color name. Default `0x444444`
+     * @param colorGrid The color of the lines of the grid. This can be a {@link THREE.Color | Color}, a hexadecimal value and an CSS-Color name. Default `0x888888`
      */
     constructor(size?: number, divisions?: number, color1?: ColorRepresentation, color2?: ColorRepresentation);
 
     /**
-     * @default 'GridHelper'
+     * A Read-only _string_ to check if `this` object type.
+     * @remarks Sub-classes will update this value.
+     * @override
+     * @defaultValue `GridHelper`
      */
-    type: string;
+    override readonly type: string | 'GridHelper';
 
+    /**
+     * 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/HemisphereLightHelper.d.ts

@@ -4,16 +4,69 @@ import { MeshBasicMaterial } from './../materials/MeshBasicMaterial';
 import { Object3D } from './../core/Object3D';
 import { ColorRepresentation } from '../math/Color';
 
+/**
+ * Creates a visual aid consisting of a spherical {@link THREE.Mesh | Mesh} for a {@link THREE.HemisphereLight | HemisphereLight}.
+ * @example
+ * ```typescript
+ * const light = new THREE.HemisphereLight(0xffffbb, 0x080820, 1);
+ * const helper = new THREE.HemisphereLightHelper(light, 5);
+ * scene.add(helper);
+ * ```
+ * @see {@link https://threejs.org/docs/index.html#api/en/helpers/HemisphereLightHelper | Official Documentation}
+ * @see {@link https://github.com/mrdoob/three.js/blob/master/src/helpers/HemisphereLightHelper.js | Source}
+ */
 export class HemisphereLightHelper extends Object3D {
+    /**
+     *  Create a new instance of {@link HemisphereLightHelper}
+     * @param light The light being visualized.
+     * @param size Thr sphere size
+     * @param color If this is not the set the helper will take the color of the light.
+     */
     constructor(light: HemisphereLight, size: number, color?: ColorRepresentation);
 
+    /**
+     * A Read-only _string_ to check if `this` object type.
+     * @remarks Sub-classes will update this value.
+     * @override
+     * @defaultValue `HemisphereLightHelper`
+     */
+    override readonly type: string | 'HemisphereLightHelper';
+
+    /**
+     * Reference to the HemisphereLight being visualized.
+     */
     light: HemisphereLight;
+
+    /**
+     * Reference to the {@link THREE.HemisphereLight.matrixWorld | light.matrixWorld}.
+     */
     matrix: Matrix4;
-    matrixAutoUpdate: boolean;
-    material: MeshBasicMaterial;
 
+    /**
+     * Is set to `false`, as the helper is using the {@link THREE.HemisphereLight.matrixWorld | light.matrixWorld}.
+     * @see {@link THREE.Object3D.matrixAutoUpdate | Object3D.matrixAutoUpdate}.
+     * @defaultValue `false`.
+     */
+    override matrixAutoUpdate: boolean;
+
+    material: MeshBasicMaterial; // TODO: Double check if this need to be exposed or not.
+
+    /**
+     * The color parameter passed in the constructor.
+     * @remarks If this is changed, the helper's color will update the next time {@link update} is called.
+     * @defaultValue `undefined`
+     */
     color: ColorRepresentation | undefined;
 
-    dispose(): void;
+    /**
+     * Updates the helper to match the position and direction of the {@link .light | HemisphereLight}.
+     */
     update(): void;
+
+    /**
+     * 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/PlaneHelper.d.ts

@@ -1,27 +1,50 @@
 import { Plane } from './../math/Plane';
 import { LineSegments } from './../objects/LineSegments';
 
+/**
+ * Helper object to visualize a {@link THREE.Plane | Plane}.
+ * @example
+ * ```typescript
+ * const plane = new THREE.Plane(new THREE.Vector3(1, 1, 0.2), 3);
+ * const helper = new THREE.PlaneHelper(plane, 1, 0xffff00);
+ * scene.add(helper);
+ * ```
+ * @see {@link https://threejs.org/docs/index.html#api/en/helpers/PlaneHelper | Official Documentation}
+ * @see {@link https://github.com/mrdoob/three.js/blob/master/src/helpers/PlaneHelper.js | Source}
+ */
 export class PlaneHelper extends LineSegments {
     /**
-     * @param plane
-     * @param [size=1]
-     * @param [hex=0xffff00]
+     * Creates a new wireframe representation of the passed plane.
+     * @param plane The plane to visualize.
+     * @param size Side length of plane helper. Expects a `Float`. Default `1`
+     * @param hex Color. Default `0xffff00`
      */
     constructor(plane: Plane, size?: number, hex?: number);
 
     /**
-     * @default 'PlaneHelper'
+     * A Read-only _string_ to check if `this` object type.
+     * @remarks Sub-classes will update this value.
+     * @override
+     * @defaultValue `PlaneHelper`
      */
-    type: string;
+    override readonly type: string | 'PlaneHelper';
 
+    /**
+     * The {@link Plane | plane} being visualized.
+     */
     plane: Plane;
 
     /**
-     * @default 1
+     * The side lengths of plane helper.
+     * @remarks Expects a `Float`
+     * @defaultValue `1`
      */
     size: number;
 
-    updateMatrixWorld(force?: boolean): void;
-
+    /**
+     * 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/PointLightHelper.d.ts

@@ -3,23 +3,71 @@ import { Matrix4 } from './../math/Matrix4';
 import { Object3D } from './../core/Object3D';
 import { ColorRepresentation } from '../math/Color';
 
+/**
+ * This displays a helper object consisting of a spherical {@link THREE.Mesh | Mesh} for visualizing a {@link THREE.PointLight | PointLight}.
+ * @example
+ * ```typescript
+ * const pointLight = new THREE.PointLight(0xff0000, 1, 100);
+ * pointLight.position.set(10, 10, 10);
+ * scene.add(pointLight);
+ * const sphereSize = 1;
+ * const {@link PointLightHelper} = new THREE.PointLightHelper(pointLight, sphereSize);
+ * scene.add(pointLightHelper);
+ * ```
+ * @see Example: {@link https://threejs.org/examples/#webgl_helpers | WebGL / helpers}
+ * @see {@link https://threejs.org/docs/index.html#api/en/helpers/PointLightHelper | Official Documentation}
+ * @see {@link https://github.com/mrdoob/three.js/blob/master/src/helpers/PointLightHelper.js | Source}
+ */
 export class PointLightHelper extends Object3D {
+    /**
+     * Create a new instance of {@link PointLightHelper}
+     * @param light The light to be visualized.
+     * @param sphereSize The size of the sphere helper. Expects a `Float`. Default `1`
+     * @param color If this is not the set the helper will take the color of the light.
+     */
     constructor(light: PointLight, sphereSize?: number, color?: ColorRepresentation);
 
     /**
-     * @default 'PointLightHelper'
+     * A Read-only _string_ to check if `this` object type.
+     * @remarks Sub-classes will update this value.
+     * @override
+     * @defaultValue `PointLightHelper`
      */
-    type: string;
+    override readonly type: string | 'PointLightHelper';
 
+    /**
+     * The {@link THREE.PointLight | PointLight} that is being visualized.
+     */
     light: PointLight;
-    color: ColorRepresentation | undefined;
+
+    /**
+     * Reference to the {@link THREE.PointLight.matrixWorld | light.matrixWorld}.
+     */
     matrix: Matrix4;
 
     /**
-     * @default false
+     * The color parameter passed in the constructor.
+     * @remarks If this is changed, the helper's color will update the next time {@link update} is called.
+     * @defaultValue `undefined`
      */
-    matrixAutoUpdate: boolean;
+    color: ColorRepresentation | undefined;
 
-    dispose(): void;
+    /**
+     * Is set to `false`, as the helper is using the {@link THREE.PointLight.matrixWorld | light.matrixWorld}.
+     * @see {@link THREE.Object3D.matrixAutoUpdate | Object3D.matrixAutoUpdate}.
+     * @defaultValue `false`.
+     */
+    override matrixAutoUpdate: boolean;
+
+    /**
+     * Updates the helper to match the position of the {@link THREE..light | .light}.
+     */
     update(): void;
+
+    /**
+     * 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/PolarGridHelper.d.ts

@@ -1,14 +1,33 @@
 import { LineSegments } from '../objects/LineSegments';
 import { ColorRepresentation } from '../math/Color';
 
+/**
+ * The {@link PolarGridHelper} is an object to define polar grids
+ * @remarks
+ * Grids are two-dimensional arrays of lines.
+ * @example
+ * ```typescript
+ * const radius = 10;
+ * const sectors = 16;
+ * const rings = 8;
+ * const divisions = 64;
+ * const helper = new THREE.PolarGridHelper(radius, sectors, rings, divisions);
+ * scene.add(helper);
+ * ```
+ * @see Example: {@link https://threejs.org/examples/#webgl_helpers | WebGL / helpers}
+ * @see {@link https://threejs.org/docs/index.html#api/en/helpers/PolarGridHelper | Official Documentation}
+ * @see {@link https://github.com/mrdoob/three.js/blob/master/src/helpers/PolarGridHelper.js | Source}
+ */
 export class PolarGridHelper extends LineSegments {
     /**
-     * @param [radius=10]
-     * @param [radials=16]
-     * @param [circles=8]
-     * @param [divisions=64]
-     * @param [color1=0x444444]
-     * @param [color2=0x888888]
+     * Creates a new {@link PolarGridHelper} of radius 'radius' with 'sectors' number of sectors and 'rings' number of rings, where each circle is smoothed into 'divisions' number of line segments.
+     * @remarks Colors are optional.
+     * @param radius The radius of the polar grid. This can be any positive number. Default `10`.
+     * @param sectors The number of sectors the grid will be divided into. This can be any positive integer. Default `16`.
+     * @param rings The number of rings. This can be any positive integer. Default `8`.
+     * @param divisions The number of line segments used for each circle. This can be any positive integer that is 3 or greater. Default `64`.
+     * @param color1 The first color used for grid elements. This can be a {@link THREE.Color | Color}, a hexadecimal value and an CSS-Color name. Default `0x444444`.
+     * @param color2 The second color used for grid elements. This can be a {@link THREE.Color | Color}, a hexadecimal value and an CSS-Color name. Default `0x888888`.
      */
     constructor(
         radius?: number,
@@ -20,9 +39,17 @@ export class PolarGridHelper extends LineSegments {
     );
 
     /**
-     * @default 'PolarGridHelper'
+     * A Read-only _string_ to check if `this` object type.
+     * @remarks Sub-classes will update this value.
+     * @override
+     * @defaultValue `PolarGridHelper`
      */
-    type: string;
+    override readonly type: string | 'PolarGridHelper';
 
+    /**
+     * 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/SkeletonHelper.d.ts

@@ -1,30 +1,78 @@
+import { SkinnedMesh } from '../Three';
 import { Object3D } from './../core/Object3D';
 import { Matrix4 } from './../math/Matrix4';
 import { Bone } from './../objects/Bone';
 import { LineSegments } from './../objects/LineSegments';
 
+/**
+ * A helper object to assist with visualizing a {@link Skeleton | Skeleton}
+ * @remarks
+ * The helper is rendered using a {@link LineBasicMaterial | LineBasicMaterial}.
+ * @example
+ * ```typescript
+ * const helper = new THREE.SkeletonHelper(skinnedMesh);
+ * scene.add(helper);
+ * ```
+ * @see Example: {@link https://threejs.org/examples/#webgl_animation_skinning_blending | WebGL / animation / skinning / blending}
+ * @see Example: {@link https://threejs.org/examples/#webgl_animation_skinning_morph | WebGL / animation / skinning / morph}
+ * @see Example: {@link https://threejs.org/examples/#webgl_loader_bvh | WebGL / loader / bvh }
+ * @see {@link https://threejs.org/docs/index.html#api/en/helpers/SkeletonHelper | Official Documentation}
+ * @see {@link https://github.com/mrdoob/three.js/blob/master/src/helpers/SkeletonHelper.js | Source}
+ */
 export class SkeletonHelper extends LineSegments {
-    constructor(object: Object3D);
+    /**
+     * Create a new instance of {@link SkeletonHelper}
+     * @param object Usually an instance of {@link THREE.SkinnedMesh | SkinnedMesh}.
+     * However, any instance of {@link THREE.Object3D | Object3D} can be used if it represents a hierarchy of {@link Bone | Bone}s (via {@link THREE.Object3D.children | Object3D.children}).
+     */
+    constructor(object: SkinnedMesh | Object3D);
+
+    /**
+     * Read-only flag to check if a given object is of type {@link SkeletonHelper}.
+     * @remarks This is a _constant_ value
+     * @defaultValue `true`
+     */
+    readonly isSkeletonHelper = true;
 
     /**
-     * @default 'SkeletonHelper'
+     * A Read-only _string_ to check if `this` object type.
+     * @remarks Sub-classes will update this value.
+     * @override
+     * @defaultValue `SkeletonHelper`
      */
-    type: string;
+    override readonly type: string | 'SkeletonHelper';
 
+    /**
+     * The list of bones that the helper renders as {@link Line | Lines}.
+     */
     bones: Bone[];
-    root: Object3D;
 
-    readonly isSkeletonHelper: true;
+    /**
+     * The object passed in the constructor.
+     */
+    root: SkinnedMesh | Object3D;
 
+    /**
+     * Reference to the {@link THREE.Object3D.matrixWorld | root.matrixWorld}.
+     */
     matrix: Matrix4;
 
     /**
-     * @default false
+     * Is set to `false`, as the helper is using the {@link THREE.Object3D.matrixWorld | root.matrixWorld}.
+     * @see {@link THREE.Object3D.matrixAutoUpdate | Object3D.matrixAutoUpdate}.
+     * @defaultValue `false`.
      */
-    matrixAutoUpdate: boolean;
+    override matrixAutoUpdate: boolean;
 
-    getBoneList(object: Object3D): Bone[];
+    /**
+     * Updates the helper.
+     */
     update(): void;
 
+    /**
+     * 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/SpotLightHelper.d.ts

@@ -4,19 +4,74 @@ import { Object3D } from './../core/Object3D';
 import { LineSegments } from '../objects/LineSegments';
 import { ColorRepresentation } from '../math/Color';
 
+/**
+ * This displays a cone shaped helper object for a {@link THREE.SpotLight | SpotLight}.
+ * @example
+ * ```typescript
+ * const spotLight = new THREE.SpotLight(0xffffff);
+ * spotLight.position.set(10, 10, 10);
+ * scene.add(spotLight);
+ * const {@link SpotLightHelper} = new THREE.SpotLightHelper(spotLight);
+ * scene.add(spotLightHelper);
+ * ```
+ * @see Example: {@link https://threejs.org/examples/#webgl_lights_spotlights | WebGL/ lights / spotlights }
+ * @see {@link https://threejs.org/docs/index.html#api/en/helpers/SpotLightHelper | Official Documentation}
+ * @see {@link https://github.com/mrdoob/three.js/blob/master/src/helpers/SpotLightHelper.js | Source}
+ */
 export class SpotLightHelper extends Object3D {
+    /**
+     * Create a new instance of {@link SpotLightHelper}
+     * @param light The {@link THREE.SpotLight | SpotLight} to be visualized.
+     * @param color If this is not the set the helper will take the color of the light. Default `light.color`
+     */
     constructor(light: Light, color?: ColorRepresentation);
 
+    /**
+     * A Read-only _string_ to check if `this` object type.
+     * @remarks Sub-classes will update this value.
+     * @override
+     * @defaultValue `SpotLightHelper`
+     */
+    override readonly type: string | 'SpotLightHelper';
+
+    /**
+     * {@link THREE.LineSegments | LineSegments} used to visualize the light.
+     */
+    cone: LineSegments;
+
+    /**
+     * Reference to the {@link THREE.SpotLight | SpotLight} being visualized.
+     */
     light: Light;
+
+    /**
+     * Reference to the spotLight's {@link Object3D.matrixWorld | matrixWorld}.
+     */
     matrix: Matrix4;
 
     /**
-     * @default false
+     * The color parameter passed in the constructor.
+     * If this is changed, the helper's color will update the next time {@link SpotLightHelper.update | update} is called.
+     * @defaultValue `undefined`
      */
-    matrixAutoUpdate: boolean;
     color: ColorRepresentation | undefined;
-    cone: LineSegments;
 
-    dispose(): void;
+    /**
+     * Is set to `false`, as the helper is using the {@link THREE.Light.matrixWorld | light.matrixWorld}.
+     * @see {@link THREE.Object3D.matrixAutoUpdate | Object3D.matrixAutoUpdate}.
+     * @defaultValue `false`.
+     */
+    override matrixAutoUpdate: boolean;
+
+    /**
+     * Updates the light helper.
+     */
     update(): void;
+
+    /**
+     * 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/lights/AmbientLight.d.ts

@@ -2,22 +2,35 @@ import { ColorRepresentation } from '../math/Color';
 import { Light } from './Light';
 
 /**
- * This light's color gets applied to all the objects in the scene globally.
- *
- * @source https://github.com/mrdoob/three.js/blob/master/src/lights/AmbientLight.js
+ * This light globally illuminates all objects in the scene equally.
+ * @remarks This light cannot be used to cast shadows as it does not have a direction.
+ * @example
+ * ```typescript
+ * const light = new THREE.AmbientLight(0x404040); // soft white light
+ * scene.add(light);
+ * ```
+ * @see {@link https://threejs.org/docs/index.html#api/en/lights/AmbientLight | Official Documentation}
+ * @see {@link https://github.com/mrdoob/three.js/blob/master/src/lights/AmbientLight.js | Source}
  */
-export class AmbientLight extends Light {
+export class AmbientLight extends Light<undefined> {
     /**
-     * This creates a Ambientlight with a color.
-     * @param color Numeric value of the RGB component of the color or a Color instance.
-     * @param [intensity=1]
+     * Creates a new {@link AmbientLight}.
+     * @param color Numeric value of the RGB component of the color. Default `0xffffff`
+     * @param intensity Numeric value of the light's strength/intensity. Expects a `Float`. Default `1`
      */
     constructor(color?: ColorRepresentation, intensity?: number);
 
     /**
-     * @default 'AmbientLight'
+     * Read-only flag to check if a given object is of type {@link AmbientLight}.
+     * @remarks This is a _constant_ value
+     * @defaultValue `true`
      */
-    type: string;
-
     readonly isAmbientLight: true;
+
+    /**
+     * A Read-only _string_ to check if `this` object type.
+     * @remarks Sub-classes will update this value.
+     * @defaultValue `AmbientLight`
+     */
+    override readonly type: string | 'AmbientLight';
 }

three/src/lights/AmbientLightProbe.d.ts

@@ -1,8 +1,26 @@
 import { ColorRepresentation } from '../math/Color';
 import { LightProbe } from './LightProbe';
 
+/**
+ * Light probes are an alternative way of adding light to a 3D scene
+ * @remarks
+ * {@link AmbientLightProbe} is the light estimation data of a single ambient light in the scene
+ * For more information about light probes, go to {@link THREE.LightProbe | LightProbe}.
+ * @see {@link https://threejs.org/docs/index.html#api/en/lights/AmbientLightProbe | Official Documentation}
+ * @see {@link https://github.com/mrdoob/three.js/blob/master/src/lights/AmbientLightProbe.js | Source}
+ */
 export class AmbientLightProbe extends LightProbe {
+    /**
+     * Creates a new {@link AmbientLightProbe}.
+     * @param color An instance of Color, string representing a color or a number representing a color.
+     * @param intensity Numeric value of the light probe's intensity. Expects a `Float`. Default `1`
+     */
     constructor(color?: ColorRepresentation, intensity?: number);
 
+    /**
+     * Read-only flag to check if a given object is of type {@link AmbientLightProbe}.
+     * @remarks This is a _constant_ value
+     * @defaultValue `true`
+     */
     readonly isAmbientLightProbe: true;
 }