@zephyr3d/scene 0.9.17 → 0.9.19

package/dist/scene/light.js

@@ -4,9 +4,9 @@ import { BoundingBox } from '../utility/bounding_volume.js';
 import { ShadowMapper } from '../shadow/shadowmapper.js';
 import { LIGHT_TYPE_DIRECTIONAL, LIGHT_TYPE_POINT, LIGHT_TYPE_SPOT, LIGHT_TYPE_RECT } from '../values.js';
 
-/**
- * Base class for any kind of light node
- * @public
+/**
+ * Base class for any kind of light node
+ * @public
  */ class BaseLight extends GraphNode {
     /** @internal */ _type;
     /** @internal */ _intensity;
@@ -14,10 +14,10 @@ import { LIGHT_TYPE_DIRECTIONAL, LIGHT_TYPE_POINT, LIGHT_TYPE_SPOT, LIGHT_TYPE_R
     /** @internal */ _directionCutoff;
     /** @internal */ _diffuseIntensity;
     /** @internal */ _extraParams;
-    /**
-   * Creates a light node
-   * @param scene - The scene to which the light node belongs
-   * @param type - Type of the light node
+    /**
+   * Creates a light node
+   * @param scene - The scene to which the light node belongs
+   * @param type - Type of the light node
    */ constructor(scene, type){
         super(scene);
         this._intensity = 1;
@@ -36,66 +36,66 @@ import { LIGHT_TYPE_DIRECTIONAL, LIGHT_TYPE_POINT, LIGHT_TYPE_SPOT, LIGHT_TYPE_R
     set intensity(val) {
         this.setIntensity(val);
     }
-    /**
-   * Position and range of the light
-   *
-   * @remarks
-   * Gets the position in world space of the light.
-   * Light range is encoded into the W component.
+    /**
+   * Position and range of the light
+   *
+   * @remarks
+   * Gets the position in world space of the light.
+   * Light range is encoded into the W component.
    */ get positionAndRange() {
         if (!this._positionRange) {
             this.computeUniforms();
         }
         return this._positionRange;
     }
-    /**
-   * Direction and cutoff of the light
-   *
-   * @remarks
-   * Gets the direction in world space of the light
-   * Light cutoff (for spot light only) is encoded into the W component.
+    /**
+   * Direction and cutoff of the light
+   *
+   * @remarks
+   * Gets the direction in world space of the light
+   * Light cutoff (for spot light only) is encoded into the W component.
    */ get directionAndCutoff() {
         if (!this._directionCutoff) {
             this.computeUniforms();
         }
         return this._directionCutoff;
     }
-    /**
-   * Color and intensity of the light
-   *
-   * @remarks
-   * Gets the color of the light.
-   * Light intensity is encoded into the W component.
+    /**
+   * Color and intensity of the light
+   *
+   * @remarks
+   * Gets the color of the light.
+   * Light intensity is encoded into the W component.
    */ get diffuseAndIntensity() {
         if (!this._diffuseIntensity) {
             this.computeUniforms();
         }
         return this._diffuseIntensity;
     }
-    /**
-   * Extra parameters of the light
-   *
-   * @remarks
-   * Custom data for advanced light types.
+    /**
+   * Extra parameters of the light
+   *
+   * @remarks
+   * Custom data for advanced light types.
    */ get extraParams() {
         if (!this._extraParams) {
             this.computeUniforms();
         }
         return this._extraParams;
     }
-    /**
-   * View matrix of the light
-   *
-   * @remarks
-   * The view matrix of the light is used to transform a point
-   * from the world space to the light space.
+    /**
+   * View matrix of the light
+   *
+   * @remarks
+   * The view matrix of the light is used to transform a point
+   * from the world space to the light space.
    */ get viewMatrix() {
         return this.invWorldMatrix;
     }
-    /**
-   * Sets the intensity of the light
-   * @param val - Intensity of the light
-   * @returns self
+    /**
+   * Sets the intensity of the light
+   * @param val - Intensity of the light
+   * @returns self
    */ setIntensity(val) {
         if (this._intensity !== val) {
             this._intensity = val;
@@ -128,26 +128,26 @@ import { LIGHT_TYPE_DIRECTIONAL, LIGHT_TYPE_POINT, LIGHT_TYPE_SPOT, LIGHT_TYPE_R
         return false;
     }
 }
-/*
-export abstract class AmbientLight extends BaseLight {
-  constructor(scene: Scene, type: number) {
-    super(scene, type);
-  }
-  isAmbientLight(): this is AmbientLight {
-    return true;
-  }
-}
-*/ /**
- * Base class for any kind of puncual light
- * @public
+/*
+export abstract class AmbientLight extends BaseLight {
+  constructor(scene: Scene, type: number) {
+    super(scene, type);
+  }
+  isAmbientLight(): this is AmbientLight {
+    return true;
+  }
+}
+*/ /**
+ * Base class for any kind of puncual light
+ * @public
  */ class PunctualLight extends BaseLight {
     /** @internal */ _color;
     /** @internal */ _castShadow;
     /** @internal */ _shadowMapper;
-    /**
-   * Creates an instance of punctual light
-   * @param scene - The scene to which the punctual light belongs
-   * @param type - The light type
+    /**
+   * Creates an instance of punctual light
+   * @param scene - The scene to which the punctual light belongs
+   * @param type - The light type
    */ constructor(scene, type){
         super(scene, type);
         this.ensurePunctualState();
@@ -170,10 +170,10 @@ export abstract class AmbientLight extends BaseLight {
     set color(color) {
         this.setColor(color);
     }
-    /**
-   * Sets color of the light
-   * @param color - The color to set
-   * @returns self
+    /**
+   * Sets color of the light
+   * @param color - The color to set
+   * @returns self
    */ setColor(color) {
         this.ensurePunctualState();
         this._color.set(color);
@@ -187,10 +187,10 @@ export abstract class AmbientLight extends BaseLight {
     set castShadow(b) {
         this.setCastShadow(b);
     }
-    /**
-   * Sets whether this light casts shadows
-   * @param b - true if the light casts shadows
-   * @returns self
+    /**
+   * Sets whether this light casts shadows
+   * @param b - true if the light casts shadows
+   * @returns self
    */ setCastShadow(b) {
         this.ensurePunctualState();
         if (this._castShadow !== !!b) {
@@ -205,9 +205,9 @@ export abstract class AmbientLight extends BaseLight {
         this.ensurePunctualState();
         return this._shadowMapper;
     }
-    /**
-   * {@inheritDoc BaseLight.isPunctualLight}
-   * @override
+    /**
+   * {@inheritDoc BaseLight.isPunctualLight}
+   * @override
    */ isPunctualLight() {
         return true;
     }
@@ -222,14 +222,14 @@ export abstract class AmbientLight extends BaseLight {
     }
     /** @internal */ computeUniforms() {}
 }
-/**
- * Directional light
- * @public
+/**
+ * Directional light
+ * @public
  */ class DirectionalLight extends PunctualLight {
     static _currentSunLight = new WeakMap();
-    /**
-   * Creates an instance of directional light
-   * @param scene - The scene to which the light belongs
+    /**
+   * Creates an instance of directional light
+   * @param scene - The scene to which the light belongs
    */ constructor(scene){
         super(scene, LIGHT_TYPE_DIRECTIONAL);
         this.intensity = 10;
@@ -251,11 +251,11 @@ export abstract class AmbientLight extends BaseLight {
             ref.set(light);
         }
     }
-    /**
-   * true if the light was defined as sun light
-   *
-   * @remarks
-   * Only one directional light will be marked as sun light.
+    /**
+   * true if the light was defined as sun light
+   *
+   * @remarks
+   * Only one directional light will be marked as sun light.
    **/ get sunLight() {
         return DirectionalLight.getSunLight(this.scene) === this;
     }
@@ -266,9 +266,9 @@ export abstract class AmbientLight extends BaseLight {
             DirectionalLight.setSunLight(this.scene, null);
         }
     }
-    /**
-   * {@inheritDoc BaseLight.isDirectionLight}
-   * @override
+    /**
+   * {@inheritDoc BaseLight.isDirectionLight}
+   * @override
    */ isDirectionLight() {
         return true;
     }
@@ -284,17 +284,17 @@ export abstract class AmbientLight extends BaseLight {
         this._extraParams = new Vector4(0, 0, 0, this.lightType);
     }
 }
-/**
- * Point light
- * @public
+/**
+ * Point light
+ * @public
  */ class PointLight extends PunctualLight {
     /** @internal */ _range;
     /** @internal */ _diffuseScale;
     /** @internal */ _specularScale;
     /** @internal */ _sourceRadius;
-    /**
-   * Creates an instance of point light
-   * @param scene - The scene to which the light belongs
+    /**
+   * Creates an instance of point light
+   * @param scene - The scene to which the light belongs
    */ constructor(scene){
         super(scene, LIGHT_TYPE_POINT);
         this._range = 0;
@@ -327,10 +327,10 @@ export abstract class AmbientLight extends BaseLight {
     set sourceRadius(val) {
         this.setSourceRadius(val);
     }
-    /**
-   * Sets the range of the light
-   * @param val - The value to set
-   * @returns self
+    /**
+   * Sets the range of the light
+   * @param val - The value to set
+   * @returns self
    */ setRange(val) {
         val = val < 0 ? 0 : val;
         if (this._range !== val) {
@@ -340,10 +340,10 @@ export abstract class AmbientLight extends BaseLight {
         }
         return this;
     }
-    /**
-   * Sets the diffuse scale of the light
-   * @param val - The value to set
-   * @returns self
+    /**
+   * Sets the diffuse scale of the light
+   * @param val - The value to set
+   * @returns self
    */ setDiffuseScale(val) {
         val = val < 0 ? 0 : val;
         if (this._diffuseScale !== val) {
@@ -352,10 +352,10 @@ export abstract class AmbientLight extends BaseLight {
         }
         return this;
     }
-    /**
-   * Sets the specular scale of the light
-   * @param val - The value to set
-   * @returns self
+    /**
+   * Sets the specular scale of the light
+   * @param val - The value to set
+   * @returns self
    */ setSpecularScale(val) {
         val = val < 0 ? 0 : val;
         if (this._specularScale !== val) {
@@ -364,10 +364,10 @@ export abstract class AmbientLight extends BaseLight {
         }
         return this;
     }
-    /**
-   * Sets the source radius of the light
-   * @param val - The value to set
-   * @returns self
+    /**
+   * Sets the source radius of the light
+   * @param val - The value to set
+   * @returns self
    */ setSourceRadius(val) {
         val = val < 0 ? 0 : val;
         if (this._sourceRadius !== val) {
@@ -376,9 +376,9 @@ export abstract class AmbientLight extends BaseLight {
         }
         return this;
     }
-    /**
-   * {@inheritDoc BaseLight.isPointLight}
-   * @override
+    /**
+   * {@inheritDoc BaseLight.isPointLight}
+   * @override
    */ isPointLight() {
         return true;
     }
@@ -399,15 +399,15 @@ export abstract class AmbientLight extends BaseLight {
         this._extraParams = new Vector4(this._diffuseScale, this._specularScale, this._sourceRadius, this.lightType);
     }
 }
-/**
- * Spot light
- * @public
+/**
+ * Spot light
+ * @public
  */ class SpotLight extends PunctualLight {
     /** @internal */ _range;
     /** @internal */ _cutoff;
-    /**
-   * Creates an instance of spot light
-   * @param scene - The scene to which the light belongs
+    /**
+   * Creates an instance of spot light
+   * @param scene - The scene to which the light belongs
    */ constructor(scene){
         super(scene, LIGHT_TYPE_SPOT);
         this._range = 0;
@@ -420,10 +420,10 @@ export abstract class AmbientLight extends BaseLight {
     set range(val) {
         this.setRange(val);
     }
-    /**
-   * Sets the range of the light
-   * @param val - The value to set
-   * @returns self
+    /**
+   * Sets the range of the light
+   * @param val - The value to set
+   * @returns self
    */ setRange(val) {
         val = val < 0 ? 0 : val;
         if (this._range !== val) {
@@ -439,10 +439,10 @@ export abstract class AmbientLight extends BaseLight {
     set cutoff(val) {
         this.setCutoff(val);
     }
-    /**
-   * Sets the cutoff of the light
-   * @param val - The value to set
-   * @returns self
+    /**
+   * Sets the cutoff of the light
+   * @param val - The value to set
+   * @returns self
    */ setCutoff(val) {
         val = val < 0 ? 0 : val;
         if (this._cutoff !== val) {
@@ -452,9 +452,9 @@ export abstract class AmbientLight extends BaseLight {
         }
         return this;
     }
-    /**
-   * {@inheritDoc BaseLight.isSpotLight}
-   * @override
+    /**
+   * {@inheritDoc BaseLight.isSpotLight}
+   * @override
    */ isSpotLight() {
         return true;
     }
@@ -477,16 +477,16 @@ export abstract class AmbientLight extends BaseLight {
         this._extraParams = new Vector4(0, 0, 0, this.lightType);
     }
 }
-/**
- * Rectangular area light
- * @public
+/**
+ * Rectangular area light
+ * @public
  */ class RectLight extends PunctualLight {
     /** @internal */ _range;
     /** @internal */ _width;
     /** @internal */ _height;
-    /**
-   * Creates an instance of rect light
-   * @param scene - The scene to which the light belongs
+    /**
+   * Creates an instance of rect light
+   * @param scene - The scene to which the light belongs
    */ constructor(scene){
         super(scene, LIGHT_TYPE_RECT);
         this._range = 10;
@@ -500,10 +500,10 @@ export abstract class AmbientLight extends BaseLight {
     set range(val) {
         this.setRange(val);
     }
-    /**
-   * Sets the range of the light
-   * @param val - The value to set
-   * @returns self
+    /**
+   * Sets the range of the light
+   * @param val - The value to set
+   * @returns self
    */ setRange(val) {
         val = val < 0 ? 0 : val;
         if (this._range !== val) {
@@ -519,10 +519,10 @@ export abstract class AmbientLight extends BaseLight {
     set width(val) {
         this.setWidth(val);
     }
-    /**
-   * Sets the width of the light
-   * @param val - The value to set
-   * @returns self
+    /**
+   * Sets the width of the light
+   * @param val - The value to set
+   * @returns self
    */ setWidth(val) {
         val = val < 0 ? 0 : val;
         if (this._width !== val) {
@@ -538,10 +538,10 @@ export abstract class AmbientLight extends BaseLight {
     set height(val) {
         this.setHeight(val);
     }
-    /**
-   * Sets the height of the light
-   * @param val - The value to set
-   * @returns self
+    /**
+   * Sets the height of the light
+   * @param val - The value to set
+   * @returns self
    */ setHeight(val) {
         val = val < 0 ? 0 : val;
         if (this._height !== val) {
@@ -551,14 +551,14 @@ export abstract class AmbientLight extends BaseLight {
         }
         return this;
     }
-    /**
-   * {@inheritDoc BaseLight.isRectLight}
-   * @override
+    /**
+   * {@inheritDoc BaseLight.isRectLight}
+   * @override
    */ isRectLight() {
         return true;
     }
-    /**
-   * Rect light supports shadow in current pipeline
+    /**
+   * Rect light supports shadow in current pipeline
    */ /** @internal */ computeBoundingVolume() {
         const bbox = new BoundingBox();
         const r = this._range;