@xeokit/xeokit-sdk 2.6.72 → 2.6.75

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";

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

@@ -0,0 +1,192 @@
+import { Material } from "./Material";
+import { Component } from "../Component";
+
+export declare type LambertMaterialConfiguration = {
+  /** Optional ID, unique among all components in the parent {@link Scene}, generated automatically when omitted. */
+  id?: string;
+  /** Metadata to attach to this LambertMaterial. */
+  meta?: any;
+  /** LambertMaterial ambient color. */
+  ambient?: number[];
+  /** LambertMaterial diffuse color. */
+  color?: number[];
+  /** LambertMaterial emissive color. */
+  emissive?: number[];
+  /** Scalar in range 0-1 that controls alpha, where 0 is completely transparent and 1 is completely opaque. */
+  alpha?: number;
+  /** Scalar in range 0-1 that controls how much {@link ReflectionMap} is reflected. */
+  reflectivity?: number;
+  /** Scalar that controls the width of {@link Geometry} lines. */
+  lineWidth: number;
+  /** Scalar that controls the size of points for {@link Geometry} with {@link Geometry#primitive} set to "points". */
+  pointSize: number;
+  /** Whether to render {@link Geometry} backfaces. */
+  backfaces: boolean;
+  /** The winding order for {@link Geometry} front faces - "cw" for clockwise, or "ccw" for counter-clockwise. */
+  frontface: "cw" | "ccw"; 
+};
+
+/**
+ * Configures the shape of "lines" geometry primitives.
+ */
+export declare class LambertMaterial extends Material {
+    /**
+     * @constructor
+     * @param {Component} owner Owner component. When destroyed, the owner will destroy this component as well.
+     * @param {LambertMaterialConfiguration} [cfg] The LambertMaterial configuration
+     */
+    constructor(owner: Component, cfg?: LambertMaterialConfiguration);
+  
+    /**
+    * Sets the LambertMaterial's ambient color.
+    *
+    * Default value is ````[0.3, 0.3, 0.3]````.
+    *
+    * @type {Number[]}
+    */
+    set ambient(value: number[]);
+
+    /**
+    * Gets the LambertMaterial's ambient color.
+    *
+    * Default value is ````[0.3, 0.3, 0.3]````.
+    *
+    * @type {Number[]}
+    */
+    get ambient(): number[];
+
+    /**
+    * Sets the LambertMaterial's diffuse color.
+    *
+    * Default value is ````[1.0, 1.0, 1.0]````.
+    *
+    * @type {Number[]}
+    */
+    set color(value: number[]);
+
+    /**
+    * Gets the LambertMaterial's diffuse color.
+    *
+    * Default value is ````[1.0, 1.0, 1.0]````.
+    *
+    * @type {Number[]}
+    */
+    get color(): number[];
+   
+    /**
+    * Sets the LambertMaterial's emissive color.
+    *
+    * Default value is ````[0.0, 0.0, 0.0]````.
+    *
+    * @type {Number[]}
+    */
+    set emissive(value: number[]);
+
+    /**
+    * Gets the LambertMaterial's emissive color.
+    *
+    * Default value is ````[0.0, 0.0, 0.0]````.
+    *
+    * @type {Number[]}
+    */
+    get emissive(): number[];
+
+    /**
+    * Sets factor in the range ````[0..1]```` indicating how transparent the LambertMaterial is.
+    *
+    * A value of ````0.0```` indicates fully transparent, ````1.0```` is fully opaque.
+    *
+    * Default value is ````1.0````
+    *
+    * @type {Number}
+    */
+    set alpha(value: number);
+
+    /**
+    * Gets factor in the range ````[0..1]```` indicating how transparent the LambertMaterial is.
+    *
+    * A value of ````0.0```` indicates fully transparent, ````1.0```` is fully opaque.
+    *
+    * Default value is ````1.0````
+    *
+    * @type {Number}
+    */
+    get alpha(): number;
+
+    /**
+    * Sets the LambertMaterial's line width.
+    *
+    * This is not supported by WebGL implementations based on DirectX [2019].
+    *
+    * Default value is ````1.0````.
+    *
+    * @type {Number}
+    */
+    set lineWidth(value: number);
+
+    /**
+    * Gets the LambertMaterial's line width.
+    *
+    * This is not supported by WebGL implementations based on DirectX [2019].
+    *
+    * Default value is ````1.0````.
+    *
+    * @type {Number}
+    */
+    get lineWidth(): number;
+
+    /**
+    * Sets the LambertMaterial's point size.
+    *
+    * Default value is ````1.0````.
+    *
+    * @type {Number}
+    */
+    set pointSize(value: number);
+
+    /**
+    * Gets the LambertMaterial's point size.
+    *
+    * Default value is ````1.0````.
+    *
+    * @type {Number}
+    */
+    get pointSize(): number;
+
+    /**
+    * Sets whether backfaces are visible on attached {@link Mesh}es.
+    *
+    * @type {Boolean}
+    */
+    set backfaces(value: boolean);
+
+    /**
+    * Gets whether backfaces are visible on attached {@link Mesh}es.
+    *
+    * @type {Boolean}
+    */
+    get backfaces(): boolean;
+
+    /**
+    * Sets the winding direction of front faces of {@link Geometry} of attached {@link Mesh}es.
+    *
+    * Default value is ````"ccw"````.
+    *
+    * @type {String}
+    */
+    set frontface(value: "cw" | "ccw");
+
+    /**
+    * Gets the winding direction of front faces of {@link Geometry} of attached {@link Mesh}es.
+    *
+    * Default value is ````"ccw"````.
+    *
+    * @type {String}
+    */
+    get frontface(): "cw" | "ccw";
+
+    /**
+    * Destroys this LambertMaterial.
+    */
+    destroy(): void;
+}