@xeokit/xeokit-sdk 2.6.78-rc2-no-las → 2.6.78

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

@@ -30,55 +30,134 @@ export declare class PointLight extends Light {
    constructor(owner: Component, cfg: PointLightConfiguration);
 
   /**
-   * The position of this PointLight.
+   * 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.
    */
-  pos: number[];
+  set pos(pos: number[]);
 
   /**
-   * The RGB color of this PointLight.
+   * 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.
    */
-  color: number[];
+  set color(color: number[]);
 
   /**
-   * The intensity of this PointLight.
+   * 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.
    */
-  intensity: number;
+  set constantAttenuation(value: number);
 
   /**
-   * The constant attenuation factor for this PointLight.
+   * Gets the constant attenuation factor for this PointLight.
    *
    * Default value is ````0````.
+   *
+   * @returns {Number} The constant attenuation factor.
    */
-  constantAttenuation: number;
+  get constantAttenuation(): number;
 
   /**
-   * The linear attenuation factor for this PointLight.
+   * Sets the linear attenuation factor for this PointLight.
    *
    * Default value is ````0````.
+   *
+   * @param {Number} value The linear attenuation factor.
    */
-  linearAttenuation: number;
+  set linearAttenuation(value: number);
 
   /**
-   * The quadratic attenuation factor for this PointLight.
+   * Gets the linear attenuation factor for this PointLight.
    *
    * Default value is ````0````.
+   *
+   * @returns {Number} The linear attenuation factor.
    */
-  quadraticAttenuation: number;
+  get linearAttenuation(): number;
 
   /**
-   * Whether this PointLight casts a shadow.
+   * 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.
    */
-  castsShadow: boolean;
+  get castsShadow(): boolean;
 
   /**
    * Destroys this PointLight.

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

@@ -26,33 +26,58 @@ export declare class EdgeMaterial extends Material {
   constructor(owner: Component, cfg?: EdgeMaterialConfiguration);
 
   /**
-   * Available EdgeMaterial presets.
+   * Gets available EdgeMaterial presets.
    */
-  readonly presets: any;
+  get presets(): any;
 
   /**
-   * Preset EdgeMaterial configuration.
+   * Selects a preset EdgeMaterial configuration.
    * @type {String}
    */
-  preset: string;
+  set preset(arg: string);
 
   /**
-   * RGB edge color.
+   * The current preset EdgeMaterial configuration.
    */
-  edgeColor: number[];
+  get preset(): string;
 
   /**
-   * Edge transparency.
+   * Sets RGB edge color.
    */
-  edgeAlpha: number;
+  set edgeColor(arg: number[]);
 
   /**
-   * Edge width.
+   * Gets RGB edge color.
    */
-  edgeWidth: number;
+  get edgeColor(): number[];
 
   /**
-   * Whether edges are visible.
+   * Sets edge transparency.
    */
-  edges: boolean;
+  set edgeAlpha(arg: number);
+
+  /**
+   * Gets edge transparency.
+   */
+  get edgeAlpha(): number;
+
+  /**
+   * Sets edge width.
+   */
+  set edgeWidth(arg: number);
+
+  /**
+   * Gets edge width.
+   */
+  get edgeWidth(): number;
+
+  /**
+   * Sets if edges are visible.
+   */
+  set edges(arg: boolean);
+
+  /**
+   * Gets if edges are visible.
+   */
+  get edges(): boolean;
 }

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

@@ -38,41 +38,68 @@ export declare class EmphasisMaterial extends Material {
   constructor(owner: Component, cfg?: EmphasisMaterialConfiguration);
 
   /**
-   * Available EmphasisMaterial presets.
+   * Gets available EmphasisMaterial presets.
    *
    * @type {Object}
    */
-  readonly presets: any;
+  get presets(): any;
 
   /**
-   * Preset EmphasisMaterial configuration.
+   * Selects a preset EmphasisMaterial configuration.
    *
    * Default value is "default".
    *
    * @type {String}
    */
-  preset: string;
+  set preset(arg: string);
 
   /**
-   * Whether surfaces are filled with color.
+   * Gets the current preset EmphasisMaterial configuration.
+   *
+   * Default value is "default".
+   *
+   * @type {String}
+   */
+  get preset(): string;
+
+  /**
+   * Sets if surfaces are filled with color.
+   *
+   * Default is ````true````.
+   *
+   * @type {Boolean}
+   */
+  set fill(arg: boolean);
+
+  /**
+   * Gets if surfaces are filled with color.
    *
    * Default is ````true````.
    *
    * @type {Boolean}
    */
-  fill: boolean;
+  get fill(): boolean;
 
   /**
-   * RGB color of filled faces.
+   * Sets the RGB color of filled faces.
    *
    * Default is ````[0.4, 0.4, 0.4]````.
    *
    * @type {Number[]}
    */
-  fillColor: number[];
+  set fillColor(arg: number[]);
 
   /**
-   * Transparency of filled faces.
+   * Gets the RGB color of filled faces.
+   *
+   * Default is ````[0.4, 0.4, 0.4]````.
+   *
+   * @type {Number[]}
+   */
+  get fillColor(): number[];
+
+  /**
+   * Sets the transparency of filled faces.
    *
    * A value of ````0.0```` indicates fully transparent, ````1.0```` is fully opaque.
    *
@@ -80,28 +107,58 @@ export declare class EmphasisMaterial extends Material {
    *
    * @type {Number}
    */
-  fillAlpha: number;
+  set fillAlpha(arg: number);
 
   /**
-   * Whether edges are visible.
+   * Gets the transparency of filled faces.
+   *
+   * A value of ````0.0```` indicates fully transparent, ````1.0```` is fully opaque.
+   *
+   * Default is ````0.2````.
+   *
+   * @type {Number}
+   */
+
+  get fillAlpha(): number;
+
+  /**
+   * Sets if edges are visible.
    *
    * Default is ````true````.
    *
    * @type {Boolean}
    */
-  edges: boolean;
+  set edges(arg: boolean);
 
   /**
-   * RGB color of edges.
+   * Gets if edges are visible.
+   *
+   * Default is ````true````.
+   *
+   * @type {Boolean}
+   */
+  get edges(): boolean;
+
+  /**
+   * Sets the RGB color of edges.
    *
    * Default is ```` [0.2, 0.2, 0.2]````.
    *
    * @type {Number[]}
    */
-  edgeColor: number[];
+  set edgeColor(arg: number[]);
 
   /**
-   * Transparency of edges.
+   * Gets the RGB color of edges.
+   *
+   * Default is ```` [0.2, 0.2, 0.2]````.
+   *
+   * @type {Number[]}
+   */
+  get edgeColor(): number[];
+
+  /**
+   * Sets the transparency of edges.
    *
    * A value of ````0.0```` indicates fully transparent, ````1.0```` is fully opaque.
    *
@@ -109,10 +166,32 @@ export declare class EmphasisMaterial extends Material {
    *
    * @type {Number}
    */
-  edgeAlpha: number;
+  set edgeAlpha(arg: number);
+
+  /**
+   * Gets the transparency of edges.
+   *
+   * A value of ````0.0```` indicates fully transparent, ````1.0```` is fully opaque.
+   *
+   * Default is ````0.2````.
+   *
+   * @type {Number}
+   */
+  get edgeAlpha(): number;
+
+  /**
+   * Sets edge width.
+   *
+   * This is not supported by WebGL implementations based on DirectX [2019].
+   *
+   * Default value is ````1.0```` pixels.
+   *
+   * @type {Number}
+   */
+  set edgeWidth(arg: number);
 
   /**
-   * Edge width.
+   * Gets edge width.
    *
    * This is not supported by WebGL implementations based on DirectX [2019].
    *
@@ -120,19 +199,28 @@ export declare class EmphasisMaterial extends Material {
    *
    * @type {Number}
    */
-  edgeWidth: number;
+  get edgeWidth(): number;
 
   /**
-   * Whether to render backfaces when {@link EmphasisMaterial.fill} is ````true````.
+   * Sets whether to render backfaces when {@link EmphasisMaterial.fill} is ````true````.
    *
    * Default is ````false````.
    *
    * @type {Boolean}
    */
-  backfaces: boolean;
+  set backfaces(arg: boolean);
 
   /**
-   * Whether to render emphasized objects over the top of other objects, as if they were "glowing through".
+   * Gets whether to render backfaces when {@link EmphasisMaterial.fill} is ````true````.
+   *
+   * Default is ````true````.
+   *
+   * @type {Boolean}
+   */
+  get backfaces(): boolean;
+
+  /**
+   * Sets whether to render emphasized objects over the top of other objects, as if they were "glowing through".
    *
    * Default is ````true````.
    *
@@ -140,7 +228,16 @@ export declare class EmphasisMaterial extends Material {
    *
    * @type {Boolean}
    */
-  glowThrough: boolean;
+  set glowThrough(arg: boolean);
+
+  /**
+   * Sets whether to render emphasized objects over the top of other objects, as if they were "glowing through".
+   *
+   * Default is ````true````.
+   *
+   * @type {Boolean}
+   */
+  get glowThrough(): boolean;
 
   /**
    * Destroys this EmphasisMaterial.

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

@@ -24,45 +24,85 @@ export declare class Fresnel extends Component {
     constructor(owner: Component, cfg?: FresnelMaterialConfiguration);
 
     /**
-     * Fresnel's edge color.
+     * Sets the Fresnel's edge color.
      *
      * Default value is ````[0.0, 0.0, 0.0]````.
      *
      * @type {Number[]}
      */
-    edgeColor: number[];
+    set edgeColor(arg: number[]);
     /**
-     * Fresnel's center color.
+     * Gets the Fresnel's edge color.
+     *
+     * Default value is ````[0.0, 0.0, 0.0]````.
+     *
+     * @type {Number[]}
+     */
+    get edgeColor(): number[];
+    /**
+     * Sets the Fresnel's center color.
      *
      * Default value is ````[1.0, 1.0, 1.0]````.
      *
      * @type {Number[]}
      */
-    centerColor: number[];
+    set centerColor(arg: number[]);
+    /**
+     * Gets the Fresnel's center color.
+     *
+     * Default value is ````[1.0, 1.0, 1.0]````.
+     *
+     * @type {Number[]}
+     */
+    get centerColor(): number[];
+    /**
+     * Sets the Fresnel's edge bias.
+     *
+     * Default value is ````0````.
+     *
+     * @type {Number}
+     */
+    set edgeBias(arg: number);
     /**
-     * Fresnel's edge bias.
+     * Gets the Fresnel's edge bias.
      *
      * Default value is ````0````.
      *
      * @type {Number}
      */
-    edgeBias: number;
+    get edgeBias(): number;
+    /**
+     * Sets the Fresnel's center bias.
+     *
+     * Default value is ````1````.
+     *
+     * @type {Number}
+     */
+    set centerBias(arg: number);
+    /**
+     * Gets the Fresnel's center bias.
+     *
+     * Default value is ````1````.
+     *
+     * @type {Number}
+     */
+    get centerBias(): number;
     /**
-     * Fresnel's center bias.
+     * Sets the Fresnel's power.
      *
      * Default value is ````1````.
      *
      * @type {Number}
      */
-    centerBias: number;
+    set power(arg: number);
     /**
-     * Fresnel's power.
+     * Gets the Fresnel's power.
      *
      * Default value is ````1````.
      *
      * @type {Number}
      */
-    power: number;
+    get power(): number;
 
     /**
      * Destroys this Fresnel.

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

@@ -38,34 +38,72 @@ export declare class LambertMaterial extends Material {
     constructor(owner: Component, cfg?: LambertMaterialConfiguration);
   
     /**
-    * LambertMaterial's ambient color.
+    * Sets the LambertMaterial's ambient color.
     *
     * Default value is ````[0.3, 0.3, 0.3]````.
     *
     * @type {Number[]}
     */
-    ambient: number[];
+    set ambient(value: number[]);
 
     /**
-    * LambertMaterial's diffuse color.
+    * 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[]}
     */
-    color: 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[];
    
     /**
-    * LambertMaterial's emissive color.
+    * Sets the LambertMaterial's emissive color.
     *
     * Default value is ````[0.0, 0.0, 0.0]````.
     *
     * @type {Number[]}
     */
-    emissive: 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);
 
     /**
-    * Factor in the range ````[0..1]```` indicating how transparent the LambertMaterial is.
+    * 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.
     *
@@ -73,10 +111,10 @@ export declare class LambertMaterial extends Material {
     *
     * @type {Number}
     */
-    alpha: number;
+    get alpha(): number;
 
     /**
-    * LambertMaterial's line width.
+    * Sets the LambertMaterial's line width.
     *
     * This is not supported by WebGL implementations based on DirectX [2019].
     *
@@ -84,32 +122,68 @@ export declare class LambertMaterial extends Material {
     *
     * @type {Number}
     */
-    lineWidth: number;
+    set lineWidth(value: number);
 
     /**
-    * LambertMaterial's point size.
+    * Gets the LambertMaterial's line width.
+    *
+    * This is not supported by WebGL implementations based on DirectX [2019].
     *
     * Default value is ````1.0````.
     *
     * @type {Number}
     */
-    pointSize: number;
+    get lineWidth(): number;
 
     /**
-    * Whether backfaces are visible on attached {@link Mesh}es.
+    * 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}
     */
-    backfaces: 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");
 
     /**
-    * Winding direction of front faces of {@link Geometry} of attached {@link Mesh}es.
+    * Gets the winding direction of front faces of {@link Geometry} of attached {@link Mesh}es.
     *
     * Default value is ````"ccw"````.
     *
     * @type {String}
     */
-    frontface: "cw" | "ccw";
+    get frontface(): "cw" | "ccw";
 
     /**
     * Destroys this LambertMaterial.