@xeokit/xeokit-sdk/types/viewer/scene/lights/AmbientLight.d.ts

3D BIM IFC Viewer SDK for AEC engineering applications. Open Source JavaScript Toolkit based on pure WebGL for top performance, real-world coordinates and full double precision

import { Component } from '../Component';
import { Light } from './Light';

export declare type AmbientLightConfiguration = {
  /** Optional ID, unique among all components in the parent {@link Scene}, generated automatically when omitted. */
  id?: string;
  /** The color of this AmbientLight. */
  color?: number[]
  /** The intensity of this AmbientLight, as a factor in range ````[0..1]````. */
  intensity?: number;
};

export declare class AmbientLight extends Light {
  /**
   * @param {Component} owner Owner component. When destroyed, the owner will destroy this AmbientLight as well.
   * @param {AmbientLightConfiguration} [cfg] AmbientLight configuration
   */
  constructor(owner: Component, cfg: AmbientLightConfiguration);

  /**
   * Sets the RGB color of this AmbientLight.
   *
   * Default value is ````[0.7, 0.7, 0.8]````.
   *
   * @param {Number[]} color The AmbientLight's RGB color.
   */
  set color(color: number[]);

  /**
   * Gets the RGB color of this AmbientLight.
   *
   * Default value is ````[0.7, 0.7, 0.8]````.
   *
   * @returns {Number[]} The AmbientLight's RGB color.
   */
  get color(): number;

  /**
   * Sets the intensity of this AmbientLight.
   *
   * Default value is ````1.0```` for maximum intensity.
   *
   * @param {Number} intensity The AmbientLight's intensity.
   */
  set intensity(intensity: number);

  /**
   * Gets the intensity of this AmbientLight.
   *
   * Default value is ````1.0```` for maximum intensity.
   *
   * @returns {Number} The AmbientLight's intensity.
   */
  get intensity(): number;

  /**
   * Destroys this AmbientLight.
   */
  destroy(): void;
}