@openhps/core/dist/cjs/three/scenes/FogExp2.js

Open Hybrid Positioning System - Core component

"use strict";

Object.defineProperty(exports, "__esModule", {
  value: true
});
exports.FogExp2 = void 0;
var _Color = require("../math/Color.js");
/**
 * This class can be used to define an exponential squared fog,
 * which gives a clear view near the camera and a faster than exponentially
 * densening fog farther from the camera.
 *
 * ```js
 * const scene = new THREE.Scene();
 * scene.fog = new THREE.FogExp2( 0xcccccc, 0.002 );
 * ```
 */
class FogExp2 {
  /**
   * Constructs a new fog.
   *
   * @param {number|Color} color - The fog's color.
   * @param {number} [density=0.00025] - Defines how fast the fog will grow dense.
   */
  constructor(color, density = 0.00025) {
    /**
     * This flag can be used for type testing.
     *
     * @type {boolean}
     * @readonly
     * @default true
     */
    this.isFogExp2 = true;

    /**
     * The name of the fog.
     *
     * @type {string}
     */
    this.name = '';

    /**
     * The fog's color.
     *
     * @type {Color}
     */
    this.color = new _Color.Color(color);

    /**
     *  Defines how fast the fog will grow dense.
     *
     * @type {number}
     * @default 0.00025
     */
    this.density = density;
  }

  /**
   * Returns a new fog with copied values from this instance.
   *
   * @return {FogExp2} A clone of this instance.
   */
  clone() {
    return new FogExp2(this.color, this.density);
  }

  /**
   * Serializes the fog into JSON.
   *
   * @param {?(Object|string)} meta - An optional value holding meta information about the serialization.
   * @return {Object} A JSON object representing the serialized fog
   */
  toJSON( /* meta */
  ) {
    return {
      type: 'FogExp2',
      name: this.name,
      color: this.color.getHex(),
      density: this.density
    };
  }
}
exports.FogExp2 = FogExp2;