@shapediver/viewer.rendering-engine.light-engine 1.15.5 → 2.0.0

package/src/implementation/types/PointLight.ts

@@ -0,0 +1,90 @@
+import { ITreeNodeData } from '@shapediver/viewer.shared.node-tree'
+import { vec3 } from 'gl-matrix'
+
+import { LIGHT_TYPE } from '../../interface/ILight'
+import { IPointLight } from '../../interface/types/IPointLight';
+import { AbstractLight } from '../AbstractLight'
+
+export class PointLight extends AbstractLight implements IPointLight {
+  // #region Properties (3)
+
+  private _decay: number = 2;
+  private _distance: number = 0;
+  private _position: vec3 = vec3.fromValues(0, 0, 0);
+
+  // #endregion Properties (3)
+
+  // #region Constructors (1)
+
+  constructor(properties: {
+    color?: string,
+    intensity?: number,
+    position?: vec3,
+    distance?: number,
+    decay?: number,
+    name?: string,
+    order?: number,
+    id?: string
+  }) {
+    super({
+      color: properties.color || '#ffffff',
+      intensity: properties.intensity !== undefined ? properties.intensity : 0.5,
+      type: LIGHT_TYPE.POINT,
+      name: properties.name,
+      order: properties.order,
+      id: properties.id
+    });
+    if (properties.position) this._position = properties.position;
+    if (properties.distance) this._distance = properties.distance;
+    if (properties.decay) this._decay = properties.decay;
+  }
+
+  // #endregion Constructors (1)
+
+  // #region Public Accessors (6)
+
+  public get decay(): number {
+    return this._decay;
+  }
+
+  public set decay(value: number) {
+    this._decay = value;
+    this.updateVersion();
+  }
+
+  public get distance(): number {
+    return this._distance;
+  }
+
+  public set distance(value: number) {
+    this._distance = value;
+    this.updateVersion();
+  }
+
+  public get position(): vec3 {
+    return this._position;
+  }
+
+  public set position(value: vec3) {
+    this._position = value;
+    this.updateVersion();
+  }
+
+  // #endregion Public Accessors (6)
+
+  // #region Public Methods (1)
+
+  public clone(): IPointLight {
+    return new PointLight({
+      color: this.color,
+      position: this.position,
+      distance: this.distance,
+      decay: this.decay,
+      intensity: this.intensity,
+      name: this.name,
+      order: this.order
+    });
+  }
+
+  // #endregion Public Methods (1)
+}

package/src/implementation/types/SpotLight.ts

@@ -0,0 +1,129 @@
+import { ITreeNodeData } from '@shapediver/viewer.shared.node-tree'
+import { vec3 } from 'gl-matrix'
+
+import { LIGHT_TYPE } from '../../interface/ILight'
+import { ISpotLight } from '../../interface/types/ISpotLight';
+import { AbstractLight } from '../AbstractLight'
+
+export class SpotLight extends AbstractLight implements ISpotLight {
+  // #region Properties (6)
+
+  private _angle: number = Math.PI / 4.0;
+  private _decay: number = 1;
+  private _distance: number = 0;
+  private _penumbra: number = 0.5;
+  private _position: vec3 = vec3.fromValues(-1, 0, 1);
+  private _target: vec3 = vec3.fromValues(0, 0, 0);
+
+  // #endregion Properties (6)
+
+  // #region Constructors (1)
+
+  constructor(properties: {
+    color?: string,
+    intensity?: number,
+    position?: vec3,
+    target?: vec3,
+    distance?: number,
+    decay?: number,
+    angle?: number,
+    penumbra?: number,
+    name?: string,
+    order?: number,
+    id?: string
+  }) {
+    super({
+      color: properties.color || '#ffffff',
+      intensity: properties.intensity !== undefined ? properties.intensity : 0.5,
+      type: LIGHT_TYPE.SPOT,
+      name: properties.name,
+      order: properties.order,
+      id: properties.id
+    });
+    if (properties.position) this._position = properties.position;
+    if (properties.target) this._target = properties.target;
+    if (properties.distance) this._distance = properties.distance;
+    if (properties.decay) this._decay = properties.decay;
+    if (properties.angle) this._angle = properties.angle;
+    if (properties.penumbra) this._penumbra = properties.penumbra;
+  }
+
+  // #endregion Constructors (1)
+
+  // #region Public Accessors (12)
+
+  public get angle(): number {
+    return this._angle;
+  }
+
+  public set angle(value: number) {
+    this._angle = value;
+    this.updateVersion();
+  }
+
+  public get decay(): number {
+    return this._decay;
+  }
+
+  public set decay(value: number) {
+    this._decay = value;
+    this.updateVersion();
+  }
+
+  public get distance(): number {
+    return this._distance;
+  }
+
+  public set distance(value: number) {
+    this._distance = value;
+    this.updateVersion();
+  }
+
+  public get penumbra(): number {
+    return this._penumbra;
+  }
+
+  public set penumbra(value: number) {
+    this._penumbra = value;
+    this.updateVersion();
+  }
+
+  public get position(): vec3 {
+    return this._position;
+  }
+
+  public set position(value: vec3) {
+    this._position = value;
+    this.updateVersion();
+  }
+
+  public get target(): vec3 {
+    return this._target;
+  }
+
+  public set target(value: vec3) {
+    this._target = value;
+    this.updateVersion();
+  }
+
+  // #endregion Public Accessors (12)
+
+  // #region Public Methods (1)
+
+  public clone(): ISpotLight {
+    return new SpotLight({
+      color: this.color,
+      position: this.position,
+      target: this.target,
+      distance: this.distance,
+      decay: this.decay,
+      angle: this.angle,
+      penumbra: this.penumbra,
+      intensity: this.intensity,
+      name: this.name,
+      order: this.order
+    });
+  }
+
+  // #endregion Public Methods (1)
+}

package/src/index.ts

@@ -0,0 +1,28 @@
+import { AbstractLight } from './implementation/AbstractLight'
+import { LightEngine } from './implementation/LightEngine'
+import { LightScene } from './implementation/LightScene'
+import { AmbientLight } from './implementation/types/AmbientLight'
+import { DirectionalLight } from './implementation/types/DirectionalLight'
+import { HemisphereLight } from './implementation/types/HemisphereLight'
+import { PointLight } from './implementation/types/PointLight'
+import { SpotLight } from './implementation/types/SpotLight'
+import { ILight, LIGHT_TYPE } from './interface/ILight'
+import { ILightEngine } from './interface/ILightEngine'
+import { ILightScene } from './interface/ILightScene'
+import { IAmbientLight } from './interface/types/IAmbientLight'
+import { IDirectionalLight } from './interface/types/IDirectionalLight'
+import { IHemisphereLight } from './interface/types/IHemisphereLight'
+import { IPointLight } from './interface/types/IPointLight'
+import { ISpotLight } from './interface/types/ISpotLight'
+
+export {
+  ILightEngine, LightEngine, LIGHT_TYPE, ILightScene, LightScene, ILight
+}
+
+export {
+  IAmbientLight, IDirectionalLight, IHemisphereLight, IPointLight, ISpotLight
+}
+
+export {
+  AbstractLight, AmbientLight, DirectionalLight, HemisphereLight, PointLight, SpotLight
+}

package/src/interface/ILight.ts

@@ -0,0 +1,24 @@
+import { ITreeNodeData } from '@shapediver/viewer.shared.node-tree'
+import { vec3 } from 'gl-matrix'
+
+export enum LIGHT_TYPE {
+  AMBIENT = 'ambient',
+  DIRECTIONAL = 'directional',
+  HEMISPHERE = 'hemisphere',
+  POINT = 'point',
+  RECTANGLE = 'rectangle',
+  SPOT = 'spot'
+}
+
+export interface ILight extends ITreeNodeData {
+  // #region Properties (5)
+
+  id: string;
+  color: string | number | vec3,
+  intensity: number,
+  name?: string
+  order?: number
+  type: LIGHT_TYPE,
+
+  // #endregion Properties (5)
+}

package/src/interface/ILightEngine.ts

@@ -0,0 +1,17 @@
+import { ILightScene } from './ILightScene'
+
+export interface ILightEngine {
+    // #region Properties (1)
+
+    update?: () => void;
+
+    // #endregion Properties (1)
+
+    // #region Public Methods (3)
+
+    assignLightScene(id: string): boolean;
+    createLightScene(properties: {name?: string, id?: string, standard?: boolean}): ILightScene;
+    removeLightScene(id: string): boolean;
+
+    // #endregion Public Methods (3)
+}

package/src/interface/ILightScene.ts

@@ -0,0 +1,27 @@
+import { ITreeNode, TreeNode } from '@shapediver/viewer.shared.node-tree'
+import { vec3 } from 'gl-matrix'
+
+import { ILight } from './ILight'
+
+export interface ILightScene {
+    // #region Properties (4)
+
+    id: string;
+    lights: { [key: string]: ILight; };
+    name?: string
+    node: ITreeNode;
+    update?: () => void;
+
+    // #endregion Properties (4)
+
+    // #region Public Methods (6)
+
+    addAmbientLight(properties: {color?: string | number | vec3, intensity?: number, id?: string, name?: string}): ILight;
+    addDirectionalLight(properties: {color?: string | number | vec3, intensity?: number, direction?: vec3, castShadow?: boolean, shadowMapResolution?: number, shadowMapBias?: number, id?: string, name?: string}): ILight;
+    addHemisphereLight(properties: {color?: string | number | vec3, intensity?: number, groundColor?: string | number | vec3, id?: string, name?: string}): ILight;
+    addPointLight(properties: {color?: string | number | vec3, intensity?: number, position?: vec3, distance?: number, decay?: number, id?: string, name?: string}): ILight;
+    addSpotLight(properties: {color?: string | number | vec3, intensity?: number, position?: vec3, target?: vec3, distance?: number, decay?: number, angle?: number, penumbra?: number, id?: string, name?: string}): ILight;
+    removeLight(id: string): boolean;
+
+    // #endregion Public Methods (6)
+}

package/src/interface/types/IAmbientLight.ts

@@ -0,0 +1,5 @@
+import { ILight } from '../ILight'
+
+export interface IAmbientLight extends ILight {
+    clone(): IAmbientLight;
+}

package/src/interface/types/IDirectionalLight.ts

@@ -0,0 +1,12 @@
+import { vec3 } from 'gl-matrix'
+
+import { ILight } from '../ILight'
+
+export interface IDirectionalLight extends ILight {
+    castShadow: boolean;
+    direction: vec3;
+    shadowMapBias: number;
+    shadowMapResolution: number;
+    
+    clone(): IDirectionalLight;
+}

package/src/interface/types/IHemisphereLight.ts

@@ -0,0 +1,9 @@
+import { vec3 } from 'gl-matrix'
+
+import { ILight } from '../ILight'
+
+export interface IHemisphereLight extends ILight {
+    groundColor: string | number | vec3;
+
+    clone(): IHemisphereLight;
+}

package/src/interface/types/IPointLight.ts

@@ -0,0 +1,11 @@
+import { vec3 } from 'gl-matrix'
+
+import { ILight } from '../ILight'
+
+export interface IPointLight extends ILight {
+    decay: number;
+    distance: number;
+    position: vec3;
+
+    clone(): IPointLight;
+}

package/src/interface/types/ISpotLight.ts

@@ -0,0 +1,14 @@
+import { vec3 } from 'gl-matrix'
+
+import { ILight } from '../ILight'
+
+export interface ISpotLight extends ILight {
+    angle: number;
+    decay: number;
+    distance: number;
+    penumbra: number;
+    position: vec3;
+    target: vec3;
+
+    clone(): ISpotLight;
+}

package/tsconfig.json

@@ -0,0 +1,17 @@
+{
+    "extends": "../../tsconfig.json",
+    "include": [
+        "./**/*.ts"
+    ],
+    "compilerOptions": {
+        "rootDir": "src",
+        "outDir": "dist"
+    },
+    "exclude": [
+        "__tests__",
+        "node_modules",
+        "dist",
+        "dist-dev",
+        "dist-prod"
+    ]
+}