@xeokit/xeokit-sdk 2.6.73 → 2.6.77-slim-rc1

package/types/viewer/scene/input/input.d.ts

@@ -10,6 +10,123 @@ import { Component } from "../Component";
  */
 export declare class Input extends Component {
 
+  KEY_BACKSPACE: number;
+  KEY_TAB: number;
+  KEY_ENTER: number;
+  KEY_SHIFT: number;
+  KEY_CTRL: number;
+  KEY_ALT: number;
+  KEY_PAUSE_BREAK: number;
+  KEY_CAPS_LOCK: number;
+  KEY_ESCAPE: number;
+  KEY_PAGE_UP: number;
+  KEY_PAGE_DOWN: number;
+  KEY_END: number;
+  KEY_HOME: number;
+  KEY_LEFT_ARROW: number;
+  KEY_UP_ARROW: number;
+  KEY_RIGHT_ARROW: number;
+  KEY_DOWN_ARROW: number;
+  KEY_INSERT: number;
+  KEY_DELETE: number;
+  KEY_NUM_0: number;
+  KEY_NUM_1: number;
+  KEY_NUM_2: number;
+  KEY_NUM_3: number;
+  KEY_NUM_4: number;
+  KEY_NUM_5: number;
+  KEY_NUM_6: number;
+  KEY_NUM_7: number;
+  KEY_NUM_8: number;
+  KEY_NUM_9: number;
+  KEY_A: number;
+  KEY_B: number;
+  KEY_C: number;
+  KEY_D: number;
+  KEY_E: number;
+  KEY_F: number;
+  KEY_G: number;
+  KEY_H: number;
+  KEY_I: number;
+  KEY_J: number;
+  KEY_K: number;
+  KEY_L: number;
+  KEY_M: number;
+  KEY_N: number;
+  KEY_O: number;
+  KEY_P: number;
+  KEY_Q: number;
+  KEY_R: number;
+  KEY_S: number;
+  KEY_T: number;
+  KEY_U: number;
+  KEY_V: number;
+  KEY_W: number;
+  KEY_X: number;
+  KEY_Y: number;
+  KEY_Z: number;
+  KEY_LEFT_WINDOW: number;
+  KEY_RIGHT_WINDOW: number;
+  KEY_SELECT_KEY: number;
+  KEY_NUMPAD_0: number;
+  KEY_NUMPAD_1: number;
+  KEY_NUMPAD_2: number;
+  KEY_NUMPAD_3: number;
+  KEY_NUMPAD_4: number;
+  KEY_NUMPAD_5: number;
+  KEY_NUMPAD_6: number;
+  KEY_NUMPAD_7: number;
+  KEY_NUMPAD_8: number;
+  KEY_NUMPAD_9: number;
+  KEY_MULTIPLY: number;
+  KEY_ADD: number;
+  KEY_SUBTRACT: number;
+  KEY_DECIMAL_POINT: number;
+  KEY_DIVIDE: number;
+  KEY_F1: number;
+  KEY_F2: number;
+  KEY_F3: number;
+  KEY_F4: number;
+  KEY_F5: number;
+  KEY_F6: number;
+  KEY_F7: number;
+  KEY_F8: number;
+  KEY_F9: number;
+  KEY_F10: number;
+  KEY_F11: number;
+  KEY_F12: number;
+  KEY_NUM_LOCK: number;
+  KEY_SCROLL_LOCK: number;
+  KEY_SEMI_COLON: number;
+  KEY_EQUAL_SIGN: number;
+  KEY_COMMA: number;
+  KEY_DASH: number;
+  KEY_PERIOD: number;
+  KEY_FORWARD_SLASH: number;
+  KEY_GRAVE_ACCENT: number;
+  KEY_OPEN_BRACKET: number;
+  KEY_BACK_SLASH: number;
+  KEY_CLOSE_BRACKET: number;
+  KEY_SINGLE_QUOTE: number;
+  KEY_SPACE: number;
+  MOUSE_LEFT_BUTTON: number;
+  MOUSE_MIDDLE_BUTTON: number;
+  MOUSE_RIGHT_BUTTON: number;
+
+  element: HTMLCanvasElement;
+
+  altDown: boolean;
+  ctrlDown: boolean;
+  mouseDownLeft: boolean;
+  mouseDownMiddle: boolean;
+  mouseDownRight: boolean;
+  keyDown: boolean[];
+  enabled: boolean;
+  keyboardEnabled: boolean;
+  mouseover: boolean;
+  mouseCanvasPos: number[];
+
+
   /**
    * Sets whether input handlers are enabled.
    */

package/types/viewer/scene/lights/AmbientLight.d.ts

@@ -16,4 +16,45 @@ export declare class AmbientLight extends Light {
    * @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;
 }

package/types/viewer/scene/lights/CubeTexture.d.ts

@@ -0,0 +1,27 @@
+import { Component } from '../Component';
+
+export declare type CubeTextureConfiguration = {
+    /**Optional ID for this CubeTexture, unique among all components in the parent scene, generated automatically when omitted. */
+    id?: string;
+    /**Paths to six image files to load into this CubeTexture. */
+    src: string[];
+    /**Flips this CubeTexture's source data along its vertical axis when true. */
+    flipY?: boolean;
+    /**Encoding format. Supported values are {@link LinearEncoding} and {@link sRGBEncoding}. */
+    encoding?: number;
+}
+
+export declare class CubeTexture extends Component {
+    /**
+     * @constructor
+     * @param {Component} owner Owner component. When destroyed, the owner will destroy this component as well.
+     * @param {CubeTextureConfiguration} [cfg] Configs
+     */
+    constructor(owner: Component, cfg?: CubeTextureConfiguration);
+
+    /**
+     * Destroys this CubeTexture
+     *
+     */
+    destroy(): void;
+}

package/types/viewer/scene/lights/DirLight.d.ts

@@ -22,4 +22,81 @@ export declare class DirLight extends Light {
    * @param {DirLightConfiguration} [cfg] DirLight configuration
    */
   constructor(owner: Component, cfg: DirLightConfiguration);
+
+  /**
+   * Sets the direction in which the DirLight is shining.
+   *
+   * Default value is ````[1.0, 1.0, 1.0]````.
+   *
+   * @param {Number[]} value The direction vector.
+   */
+  set dir(value: number);
+
+  /**
+   * Gets the direction in which the DirLight is shining.
+   *
+   * Default value is ````[1.0, 1.0, 1.0]````.
+   *
+   * @returns {Number[]} The direction vector.
+   */
+  get dir(): number;
+
+  /**
+   * Sets the RGB color of this DirLight.
+   *
+   * Default value is ````[0.7, 0.7, 0.8]````.
+   *
+   * @param {Number[]} color The DirLight's RGB color.
+   */
+  set color(color: number[]);
+
+  /**
+   * Gets the RGB color of this DirLight.
+   *
+   * Default value is ````[0.7, 0.7, 0.8]````.
+   *
+   * @returns {Number[]} The DirLight's RGB color.
+   */
+  get color(): number[];
+
+  /**
+   * Sets the intensity of this DirLight.
+   *
+   * Default intensity is ````1.0```` for maximum intensity.
+   *
+   * @param {Number} intensity The DirLight's intensity
+   */
+  set intensity(intensity: number);
+
+  /**
+   * Gets the intensity of this DirLight.
+   *
+   * Default value is ````1.0```` for maximum intensity.
+   *
+   * @returns {Number} The DirLight's intensity.
+   */
+  get intensity(): number;
+
+  /**
+   * Sets if this DirLight casts a shadow.
+   *
+   * Default value is ````false````.
+   *
+   * @param {Boolean} castsShadow Set ````true```` to cast shadows.
+   */
+  set castsShadow(castsShadow: boolean);
+
+  /**
+   * Gets if this DirLight casts a shadow.
+   *
+   * Default value is ````false````.
+   *
+   * @returns {Boolean} ````true```` if this DirLight casts shadows.
+   */
+  get castsShadow(): boolean;
+  
+  /**
+   * Destroys this DirLight.
+   */
+  destroy(): void;
 }

package/types/viewer/scene/lights/LightMap.d.ts

@@ -0,0 +1,27 @@
+import { Component } from '../Component';
+import { CubeTexture } from './CubeTexture';
+
+export declare type LightMapConfiguration = {
+    /**Optional ID for this LightMap, unique among all components in the parent scene, generated automatically when omitted. */
+    id?: string;
+    /**Optional map of user-defined metadata to attach to this LightMap. */
+    /**Don't know where this property is being used */
+    meta?: any;
+    /**Paths to six image files to load into this LightMap. */
+    src: string[];
+    /**Flips this LightMap's source data along its vertical axis when true. */
+    flipY?: boolean;
+    /**Encoding format. Supported values are {@link LinearEncoding} and {@link sRGBEncoding}. */
+    encoding?: number;
+}
+
+export declare class LightMap extends CubeTexture {
+    /**
+     * @constructor
+     * @param {Component} owner Owner component. When destroyed, the owner will destroy this component as well.
+     * @param {LightMapConfiguration} [cfg] Configs
+     */
+    constructor(owner: Component, cfg?: LightMapConfiguration);
+
+    destroy(): void;
+}

package/types/viewer/scene/lights/PointLight.d.ts

@@ -28,4 +28,139 @@ export declare class PointLight extends Light {
    * @param {PointLightConfiguration} [cfg] PointLight configuration
    */
    constructor(owner: Component, cfg: PointLightConfiguration);
+
+  /**
+   * Sets the position of this PointLight.
+   *
+   * This will be either World- or View-space, depending on the value of {@link PointLight#space}.
+   *
+   * Default value is ````[1.0, 1.0, 1.0]````.
+   *
+   * @param {Number[]} pos The position.
+   */
+  set pos(pos: number[]);
+
+  /**
+   * Gets the position of this PointLight.
+   *
+   * This will be either World- or View-space, depending on the value of {@link PointLight#space}.
+   *
+   * Default value is ````[1.0, 1.0, 1.0]````.
+   *
+   * @returns {Number[]} The position.
+   */
+  get pos(): number[];
+
+  /**
+   * Sets the RGB color of this PointLight.
+   *
+   * Default value is ````[0.7, 0.7, 0.8]````.
+   *
+   * @param {Number[]} color The PointLight's RGB color.
+   */
+  set color(color: number[]);
+
+  /**
+   * Gets the RGB color of this PointLight.
+   *
+   * Default value is ````[0.7, 0.7, 0.8]````.
+   *
+   * @returns {Number[]} The PointLight's RGB color.
+   */
+  get color(): number[];
+
+  /**
+   * Sets the intensity of this PointLight.
+   *
+   * Default intensity is ````1.0```` for maximum intensity.
+   *
+   * @param {Number} intensity The PointLight's intensity
+   */
+  set intensity(intensity: number);
+
+  /**
+   * Gets the intensity of this PointLight.
+   *
+   * Default value is ````1.0```` for maximum intensity.
+   *
+   * @returns {Number} The PointLight's intensity.
+   */
+  get intensity(): number;
+
+  /**
+   * Sets the constant attenuation factor for this PointLight.
+   *
+   * Default value is ````0````.
+   *
+   * @param {Number} value The constant attenuation factor.
+   */
+  set constantAttenuation(value: number);
+
+  /**
+   * Gets the constant attenuation factor for this PointLight.
+   *
+   * Default value is ````0````.
+   *
+   * @returns {Number} The constant attenuation factor.
+   */
+  get constantAttenuation(): number;
+
+  /**
+   * Sets the linear attenuation factor for this PointLight.
+   *
+   * Default value is ````0````.
+   *
+   * @param {Number} value The linear attenuation factor.
+   */
+  set linearAttenuation(value: number);
+
+  /**
+   * Gets the linear attenuation factor for this PointLight.
+   *
+   * Default value is ````0````.
+   *
+   * @returns {Number} The linear attenuation factor.
+   */
+  get linearAttenuation(): number;
+
+  /**
+   * Sets the quadratic attenuation factor for this PointLight.
+   *
+   * Default value is ````0````.
+   *
+   * @param {Number} value The quadratic attenuation factor.
+   */
+  set quadraticAttenuation(value: number);
+
+  /**
+   * Gets the quadratic attenuation factor for this PointLight.
+   *
+   * Default value is ````0````.
+   *
+   * @returns {Number} The quadratic attenuation factor.
+   */
+  get quadraticAttenuation(): number;
+
+  /**
+   * Sets if this PointLight casts a shadow.
+   *
+   * Default value is ````false````.
+   *
+   * @param {Boolean} castsShadow Set ````true```` to cast shadows.
+   */
+  set castsShadow(castsShadow: boolean);
+
+  /**
+   * Gets if this PointLight casts a shadow.
+   *
+   * Default value is ````false````.
+   *
+   * @returns {Boolean} ````true```` if this PointLight casts shadows.
+   */
+  get castsShadow(): boolean;
+
+  /**
+   * Destroys this PointLight.
+   */
+  destroy(): void;
 }

package/types/viewer/scene/lights/ReflectionMap.d.ts

@@ -0,0 +1,26 @@
+import { Component } from '../Component';
+import { CubeTexture } from './CubeTexture';
+
+export declare type CubeTextureConfiguraton = {
+    /**Optional ID for this ReflectionMap, unique among all components in the parent scene, generated automatically when omitted. */
+    id?: string;
+    /** Paths to six image files to load into this ReflectionMap. */
+    src: string[];
+    /** Flips this ReflectionMap's source data along its vertical axis when true. */
+    flipY: boolean;
+    /** Encoding format. Supported values are {@link LinearEncoding} and {@link sRGBEncoding}. */
+    encoding?: number;
+}
+
+export declare class ReflectionMap extends CubeTexture {
+    /**
+     * @param {Component} owner Owner component. When destroyed, the owner will destroy this component as well.
+     * @param {CubeTextureConfiguraton} [cfg] Configs
+     */
+    constructor(owner: Component, cfg?: CubeTextureConfiguraton);
+
+    /**
+     * Destroys this ReflectionMap.
+     */
+    destroy(): void;
+}

package/types/viewer/scene/lights/index.d.ts

@@ -1,3 +1,6 @@
 export * from "./AmbientLight";
+export * from './CubeTexture';
 export * from "./DirLight";
-export * from "./PointLight";
+export * from './LightMap';
+export * from "./PointLight";
+export * from "./ReflectionMap";

package/types/viewer/scene/marker/Marker.d.ts

@@ -133,4 +133,9 @@ export declare class Marker extends Component {
    * @type {Boolean}
    */
   get visible(): boolean;
+
+  /**
+   * Destroys this Marker.
+   */
+  destroy(): void;
 }

package/types/viewer/scene/materials/EmphasisMaterial.d.ts

@@ -238,4 +238,9 @@ export declare class EmphasisMaterial extends Material {
    * @type {Boolean}
    */
   get glowThrough(): boolean;
+
+  /**
+   * Destroys this EmphasisMaterial.
+   */
+  destroy(): void;
 }

package/types/viewer/scene/materials/Fresnel.d.ts

@@ -1,69 +1,28 @@
-/**
- * @desc Configures Fresnel effects for {@link PhongMaterial}s.
- *
- * Fresnels are attached to {@link PhongMaterial}s, which are attached to {@link Mesh}es.
- *
- * ## Usage
- *
- * In the example below we'll create a {@link Mesh} with a {@link PhongMaterial} that applies a Fresnel to its alpha channel to give a glasss-like effect.
- *
- * [[Run this example](http://xeokit.github.io/xeokit-sdk/examples/#materials_Fresnel)]
- *
- * ````javascript
- * import {Viewer, Mesh, buildTorusGeometry,
- *      ReadableGeometry, PhongMaterial, Texture, Fresnel} from "xeokit-sdk.es.js";
- *
- * const viewer = new Viewer({
- *       canvasId: "myCanvas",
- *       transparent: true
- * });
- *
- * viewer.scene.camera.eye = [0, 0, 5];
- * viewer.scene.camera.look = [0, 0, 0];
- * viewer.scene.camera.up = [0, 1, 0];
- *
- * new Mesh(viewer.scene, {
- *      geometry: new ReadableGeometry(viewer.scene, buildTorusGeometry({
- *          center: [0, 0, 0],
- *          radius: 1.5,
- *          tube: 0.5,
- *          radialSegments: 32,
- *          tubeSegments: 24,
- *          arc: Math.PI * 2.0
- *      }),
- *      material: new PhongMaterial(viewer.scene, {
- *          alpha: 0.9,
- *          alphaMode: "blend",
- *          ambient: [0.0, 0.0, 0.0],
- *          shininess: 30,
- *          diffuseMap: new Texture(viewer.scene, {
- *              src: "textures/diffuse/uvGrid2.jpg"
- *          }),
- *          alphaFresnel: new Fresnel(viewer.scene, {
-v               edgeBias: 0.2,
- *              centerBias: 0.8,
- *              edgeColor: [1.0, 1.0, 1.0],
- *              centerColor: [0.0, 0.0, 0.0],
- *              power: 2
- *          })
- *      })
- * });
- * ````
- */
+import { Component } from "../Component";
+
+export declare type FresnelMaterialConfiguration = {
+    /** Optional ID, unique among all components in the parent scene, generated automatically when omitted. */
+    id?: string;
+    /** Color used on edges. */
+    edgeColor?: number[];
+    /** Color used on center. */
+    centerColor?: number[];
+    /** Bias at the edge. */
+    edgeBias?: number;
+    /** Bias at the center. */
+    centerBias?: number;
+    /** The power. */
+    power?: number;
+}
+
 export declare class Fresnel extends Component {
     /**
      * @constructor
      * @param {Component} owner Owner component. When destroyed, the owner will destroy this Fresnel as well.
-     * @param {*} [cfg] Configs
-     * @param {String} [cfg.id] Optional ID, unique among all components in the parent scene, generated automatically when omitted.
-     * @param {Number[]} [cfg.edgeColor=[ 0.0, 0.0, 0.0 ]]  Color used on edges.
-     * @param {Number[]} [cfg.centerColor=[ 1.0, 1.0, 1.0 ]]  Color used on center.
-     * @param {Number} [cfg.edgeBias=0]  Bias at the edge.
-     * @param {Number} [cfg.centerBias=1]  Bias at the center.
-     * @param {Number} [cfg.power=0]  The power.
+     * @param {FresnelMaterialConfiguration} [cfg] Configs
      */
-    constructor(owner: Component, cfg?: any);
-    _state: any;
+    constructor(owner: Component, cfg?: FresnelMaterialConfiguration);
+
     /**
      * Sets the Fresnel's edge color.
      *
@@ -144,5 +103,9 @@ export declare class Fresnel extends Component {
      * @type {Number}
      */
     get power(): number;
+
+    /**
+     * Destroys this Fresnel.
+     */
+    destroy(): void;
 }
-import { Component } from "../Component";