@xeokit/xeokit-sdk/src/viewer/scene/lights/Shadow.js

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

/**
 A **Shadow** defines a shadow cast by a {@link DirLight} or a {@link SpotLight}.

 Work in progress!

 ## Overview

 * Shadows are attached to {@link DirLight} and {@link SpotLight} components.

 TODO

 ## Examples

 TODO

 ## Usage

 ```` javascript
 var mesh = new xeokit.Mesh(scene, {

        lights: new xeokit.Lights({
            lights: [

                new xeokit.SpotLight({
                    pos: [0, 100, 100],
                    dir: [0, -1, 0],
                    color: [0.5, 0.7, 0.5],
                    intensity: 1
                    constantAttenuation: 0,
                    linearAttenuation: 0,
                    quadraticAttenuation: 0,
                    space: "view",

                    shadow: new xeokit.Shadow({
                        resolution: [1000, 1000],
                        intensity: 0.7,
                        sampling: "stratified" // "stratified" | "poisson" | "basic"
                    });
                })
            ]
        }),
 ,
        material: new xeokit.PhongMaterial({
            diffuse: [0.5, 0.5, 0.0]
        }),

        geometry: new xeokit.BoxGeometry()
  });
 ````

 @class Shadow
 @module xeokit
 @submodule lighting
 @constructor
 @private
 @extends Component
 @param {Component} owner Owner component. When destroyed, the owner will destroy this component as well.
 @param {*} [cfg] The Shadow configuration
 @param {String} [cfg.id] Optional ID, unique among all components in the parent {@link Scene}, generated automatically when omitted.
 @param {String:Object} [cfg.meta] Optional map of user-defined metadata to attach to this Shadow.
 @param [cfg.resolution=[1000,1000]] {Uint16Array} Resolution of the texture map for this Shadow.
 @param [cfg.intensity=1.0] {Number} Intensity of this Shadow.
 */
import {Component} from '../Component.js';
import {math} from '../math/math.js';

class Shadow extends Component {

    /**
     @private
     */
    get type() {
        return "Shadow";
    }

    constructor(owner, cfg={}) {

        super(owner, cfg);

        this._state = {
            resolution: math.vec3([1000, 1000]),
            intensity: 1.0
        };

        this.resolution = cfg.resolution;
        this.intensity = cfg.intensity;
    }

    /**
     The resolution of the texture map for this Shadow.

     This will be either World- or View-space, depending on the value of {@link Shadow/space}.

     Fires a {@link Shadow/resolution:event} event on change.

     @property resolution
     @default [1000, 1000]
     @type Uint16Array
     */
    set resolution(value) {

        this._state.resolution.set(value || [1000.0, 1000.0]);

        this.glRedraw();
    }

    get resolution() {
        return this._state.resolution;
    }

    /**
     The intensity of this Shadow.

     Fires a {@link Shadow/intensity:event} event on change.

     @property intensity
     @default 1.0
     @type {Number}
     */
    set intensity(value) {

        value = value !== undefined ? value : 1.0;

        this._state.intensity = value;

        this.glRedraw();
    }

    get intensity() {
        return this._state.intensity;
    }

    destroy() {
        super.destroy();
        //this._state.destroy();
    }
}

export {Shadow};