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

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

@@ -71,16 +71,25 @@ export declare class PhongMaterial extends Material {
   constructor(owner: Component, cfg?: any);
 
   /**
-   * PhongMaterial's ambient color.
+   * Sets the PhongMaterial's ambient color.
    *
    * Default value is ````[0.3, 0.3, 0.3]````.
    *
    * @type {Number[]}
    */
-  ambient: number[];
+  set ambient(arg: number[]);
 
   /**
-   * PhongMaterial's diffuse color.
+   * Gets the PhongMaterial's ambient color.
+   *
+   * Default value is ````[0.3, 0.3, 0.3]````.
+   *
+   * @type {Number[]}
+   */
+  get ambient(): number[];
+
+  /**
+   * Sets the PhongMaterial's diffuse color.
    *
    * Multiplies by {@link PhongMaterial.diffuseMap}.
    *
@@ -88,29 +97,59 @@ export declare class PhongMaterial extends Material {
    *
    * @type {Number[]}
    */
-  diffuse: number[];
+  set diffuse(arg: number[]);
 
   /**
-   * PhongMaterial's specular color.
+   * Sets the PhongMaterial's diffuse color.
+   *
+   * Multiplies by {@link PhongMaterial.diffuseMap}.
+   *
+   * Default value is ````[1.0, 1.0, 1.0]````.
+   *
+   * @type {Number[]}
+   */
+  get diffuse(): number[];
+
+  /**
+   * Sets the PhongMaterial's specular color.
    *
    * Multiplies by {@link PhongMaterial.specularMap}.
    * Default value is ````[1.0, 1.0, 1.0]````.
    * @type {Number[]}
    */
-  specular: number[];
+  set specular(arg: number[]);
+
+  /**
+   * Gets the PhongMaterial's specular color.
+   *
+   * Multiplies by {@link PhongMaterial.specularMap}.
+   * Default value is ````[1.0, 1.0, 1.0]````.
+   * @type {Number[]}
+   */
+  get specular(): number[];
+
+  /**
+   * Sets the PhongMaterial's emissive color.
+   *
+   * Multiplies by {@link PhongMaterial.emissiveMap}.
+   *
+   * Default value is ````[0.0, 0.0, 0.0]````.
+   * @type {Number[]}
+   */
+  set emissive(arg: number[]);
 
   /**
-   * PhongMaterial's emissive color.
+   * Gets the PhongMaterial's emissive color.
    *
    * Multiplies by {@link PhongMaterial.emissiveMap}.
    *
    * Default value is ````[0.0, 0.0, 0.0]````.
    * @type {Number[]}
    */
-  emissive: number[];
+  get emissive(): number[];
 
   /**
-   * PhongMaterial alpha.
+   * Sets the PhongMaterial alpha.
    *
    * This is a factor in the range [0..1] indicating how transparent the PhongMaterial is.
    *
@@ -122,10 +161,25 @@ export declare class PhongMaterial extends Material {
    *
    * @type {Number}
    */
-  alpha: number;
+  set alpha(arg: number);
 
   /**
-   * PhongMaterial shininess.
+   * Gets the PhongMaterial alpha.
+   *
+   * This is a factor in the range [0..1] indicating how transparent the PhongMaterial is.
+   *
+   * A value of 0.0 indicates fully transparent, 1.0 is fully opaque.
+   *
+   * Multiplies by {@link PhongMaterial.alphaMap}.
+   *
+   * Default value is ````1.0````.
+   *
+   * @type {Number}
+   */
+  get alpha(): number;
+
+  /**
+   * Sets the PhongMaterial shininess.
    *
    * This is a factor in range [0..128] that determines the size and sharpness of the specular highlights create by this PhongMaterial.
    *
@@ -137,10 +191,38 @@ export declare class PhongMaterial extends Material {
    *
    * @type {Number}
    */
-  shininess: number;
+  set shininess(arg: number);
 
   /**
-   * How much {@link ReflectionMap} is reflected by this PhongMaterial.
+   * Gets the PhongMaterial shininess.
+   *
+   * This is a factor in range [0..128] that determines the size and sharpness of the specular highlights create by this PhongMaterial.
+   *
+   * Larger values produce smaller, sharper highlights. A value of 0.0 gives very large highlights that are almost never
+   * desirable. Try values close to 10 for a larger, fuzzier highlight and values of 100 or more for a small, sharp
+   * highlight.
+   *
+   * Default value is ```` 80.0````.
+   *
+   * @type {Number}
+   */
+  get shininess(): number;
+
+  /**
+   * Sets how much {@link ReflectionMap} is reflected by this PhongMaterial.
+   *
+   * This is a scalar in range ````[0-1]````. Default value is ````1.0````.
+   *
+   * The surface will be non-reflective when this is ````0````, and completely mirror-like when it is ````1.0````.
+   *
+   * Multiplies by {@link PhongMaterial.reflectivityMap}.
+   *
+   * @type {Number}
+   */
+  set reflectivity(arg: number);
+
+  /**
+   * Gets how much {@link ReflectionMap} is reflected by this PhongMaterial.
    *
    * This is a scalar in range ````[0-1]````. Default value is ````1.0````.
    *
@@ -150,10 +232,10 @@ export declare class PhongMaterial extends Material {
    *
    * @type {Number}
    */
-  reflectivity: number;
+  get reflectivity(): number;
 
   /**
-   * PhongMaterial's line width.
+   * Sets the PhongMaterial's line width.
    *
    * This is not supported by WebGL implementations based on DirectX [2019].
    *
@@ -161,19 +243,39 @@ export declare class PhongMaterial extends Material {
    *
    * @type {Number}
    */
-  lineWidth: number;
+  set lineWidth(arg: number);
 
   /**
-   * PhongMaterial's point size.
+   * Gets the PhongMaterial'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 PhongMaterial's point size.
    *
    * Default value is 1.0.
    *
    * @type {Number}
    */
-  pointSize: number;
+  set pointSize(arg: number);
 
   /**
-   * PhongMaterial's alpha rendering mode.
+   * Gets the PhongMaterial's point size.
+   *
+   * Default value is 1.0.
+   *
+   * @type {Number}
+   */
+  get pointSize(): number;
+
+  /**
+   * Sets the PhongMaterial's alpha rendering mode.
    *
    * This governs how alpha is treated. Alpha is the combined result of {@link PhongMaterial.alpha} and {@link PhongMaterial.alphaMap}.
    *
@@ -185,10 +287,17 @@ export declare class PhongMaterial extends Material {
    *
    *@type {String}
     */
-  alphaMode: "opaque"| "blend" | "mask";
+  set alphaMode(arg: "opaque"| "blend" | "mask");
 
   /**
-   * PhongMaterial's alpha cutoff value.
+   * Gets the PhongMaterial's alpha rendering mode.
+   *
+   *@type {String}
+    */
+  get alphaMode(): "opaque"| "blend" | "mask";
+
+  /**
+   * Sets the PhongMaterial's alpha cutoff value.
    *
    * This specifies the cutoff threshold when {@link PhongMaterial.alphaMode} equals "mask". If the alpha is greater than or equal to this value then it is rendered as fully
    * opaque, otherwise, it is rendered as fully transparent. A value greater than 1.0 will render the entire material as fully transparent. This value is ignored for other modes.
@@ -199,10 +308,17 @@ export declare class PhongMaterial extends Material {
    *
    * @type {Number}
    */
-  alphaCutoff: number;
+  set alphaCutoff(arg: number);
+
+  /**
+   * Gets the PhongMaterial's alpha cutoff value.
+   *
+   * @type {Number}
+   */
+  get alphaCutoff(): number;
 
   /**
-   * Whether backfaces are visible on attached {@link Mesh}es.
+   * Sets whether backfaces are visible on attached {@link Mesh}es.
    *
    * The backfaces will belong to {@link Geometry} compoents that are also attached to the {@link Mesh}es.
    *
@@ -210,128 +326,145 @@ export declare class PhongMaterial extends Material {
    *
    * @type {Boolean}
    */
-  backfaces: boolean;
+  set backfaces(arg: boolean);
+
+  /**
+   * Gets whether backfaces are visible on attached {@link Mesh}es.
+   *
+   * Default is ````false````.
+   *
+   * @type {Boolean}
+   */
+  get backfaces(): boolean;
+
+  /**
+   * Sets the winding direction of geometry front faces.
+   *
+   * Default is ````"ccw"````.
+   * @type {String}
+   */
+  set frontface(arg: "cw" | "ccw");
 
   /**
-   * Winding direction of geometry front faces.
+   * Gets the winding direction of front faces on attached {@link Mesh}es.
    *
    * Default is ````"ccw"````.
    * @type {String}
    */
-  frontface: "cw" | "ccw";
+  get frontface(): "cw" | "ccw";
 
   /**
-   * PhongMaterials's normal map {@link Texture}.
+   * Gets the PhongMaterials's normal map {@link Texture}.
    *
    * @type {Texture}
    */
-  readonly normalMap: Texture;
+  get normalMap(): Texture;
 
   /**
-   * PhongMaterials's ambient {@link Texture}.
+   * Gets the PhongMaterials's ambient {@link Texture}.
    *
    * Multiplies by {@link PhongMaterial.ambient}.
    *
    * @type {Texture}
    */
-  readonly ambientMap: Texture;
+  get ambientMap(): Texture;
 
   /**
-   * PhongMaterials's diffuse {@link Texture}.
+   * Gets the PhongMaterials's diffuse {@link Texture}.
    *
    * Multiplies by {@link PhongMaterial.diffuse}.
    *
    * @type {Texture}
    */
-  readonly diffuseMap: Texture;
+  get diffuseMap(): Texture;
 
   /**
-   * PhongMaterials's specular {@link Texture}.
+   * Gets the PhongMaterials's specular {@link Texture}.
    *
    * Multiplies by {@link PhongMaterial.specular}.
    *
    * @type {Texture}
    */
-  readonly specularMap: Texture;
+  get specularMap(): Texture;
 
   /**
-   * PhongMaterials's emissive {@link Texture}.
+   * Gets the PhongMaterials's emissive {@link Texture}.
    *
    * Multiplies by {@link PhongMaterial.emissive}.
    *
    * @type {Texture}
    */
-  readonly emissiveMap: Texture;
+  get emissiveMap(): Texture;
 
   /**
-   * PhongMaterials's alpha {@link Texture}.
+   * Gets the PhongMaterials's alpha {@link Texture}.
    *
    * Multiplies by {@link PhongMaterial.alpha}.
    *
    * @type {Texture}
    */
-  readonly alphaMap: Texture;
+  get alphaMap(): Texture;
 
   /**
-   * PhongMaterials's reflectivity {@link Texture}.
+   * Gets the PhongMaterials's reflectivity {@link Texture}.
    *
    * Multiplies by {@link PhongMaterial.reflectivity}.
    *
    * @type {Texture}
    */
-  readonly reflectivityMap: Texture;
+  get reflectivityMap(): Texture;
 
   /**
-   * PhongMaterials's ambient occlusion {@link Texture}.
+   * Gets the PhongMaterials's ambient occlusion {@link Texture}.
    *
    * @type {Texture}
    */
-  readonly occlusionMap: Texture;
+  get occlusionMap(): Texture;
 
   /**
-   * PhongMaterials's diffuse {@link Fresnel}.
+   * Gets the PhongMaterials's diffuse {@link Fresnel}.
    *
    * Applies to {@link PhongMaterial.diffuse}.
    *
    * @type {Fresnel}
    */
-  readonly diffuseFresnel: Fresnel;
+  get diffuseFresnel(): Fresnel;
 
   /**
-   * PhongMaterials's specular {@link Fresnel}.
+   * Gets the PhongMaterials's specular {@link Fresnel}.
    *
    * Applies to {@link PhongMaterial.specular}.
    *
    * @type {Fresnel}
    */
-  readonly specularFresnel: Fresnel;
+  get specularFresnel(): Fresnel;
 
   /**
-   * PhongMaterials's emissive {@link Fresnel}.
+   * Gets the PhongMaterials's emissive {@link Fresnel}.
    *
    * Applies to {@link PhongMaterial.emissive}.
    *
    * @type {Fresnel}
    */
-  readonly emissiveFresnel: Fresnel;
+  get emissiveFresnel(): Fresnel;
 
   /**
-   * PhongMaterials's alpha {@link Fresnel}.
+   * Gets the PhongMaterials's alpha {@link Fresnel}.
    *
    * Applies to {@link PhongMaterial.alpha}.
    *
    * @type {Fresnel}
    */
-  readonly alphaFresnel: Fresnel;
+  get alphaFresnel(): Fresnel;
 
   /**
-   * PhongMaterials's reflectivity {@link Fresnel}.
+   * Gets the PhongMaterials's reflectivity {@link Fresnel}.
    *
    * Applies to {@link PhongMaterial.reflectivity}.
    *
    * @type {Fresnel}
    */
-  readonly reflectivityFresnel: Fresnel;
+  get reflectivityFresnel(): Fresnel;
 
   /**
    * Destroys this PhongMaterial.

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

@@ -36,92 +36,173 @@ export declare class PointsMaterial extends Material {
   constructor(owner: Component, cfg?: PointsMaterialConfiguration);
 
   /**
-   * Available PointsMaterial presets.
+   * Gets available PointsMaterial presets.
    *
    * @type {Object}
    */
-  readonly presets: any;
+  get presets(): any;
 
   /**
-   * Preset ````PointsMaterial```` configuration.
+   * Selects a preset ````PointsMaterial```` configuration.
    *
    * Default value is ````"default"````.
    *
    * @type {String}
    */
-  preset: string;
+  set preset(arg: string);
 
   /**
-   * Point size.
+   * The current preset ````PointsMaterial```` configuration.
+   *
+   * Default value is ````"default"````.
+   *
+   * @type {String}
+   */
+  get preset(): string;
+
+  /**
+   * Sets point size.
+   *
+   * Default value is ````2.0```` pixels.
+   *
+   * @type {Number}
+   */
+  set pointSize(arg: number);
+
+  /**
+   * Gets point size.
    *
    * Default value is ````2.0```` pixels.
    *
    * @type {Number}
    */
-  pointSize: number;
+  get pointSize(): number;
+
+  /**
+   * Sets if points are round or square.
+   *
+   * Default is ````true```` to set points round.
+   *
+   * @type {Boolean}
+   */
+  set roundPoints(arg: boolean);
 
   /**
-   * Whether points are round or square.
+   * Gets if points are round or square.
    *
    * Default is ````true```` to set points round.
    *
    * @type {Boolean}
    */
-  roundPoints: boolean;
+  get roundPoints(): boolean;
 
   /**
-   * Whether rendered point size reduces with distance when {@link Camera.projection} is set to ````"perspective"````.
+   * Sets if rendered point size reduces with distance when {@link Camera.projection} is set to ````"perspective"````.
    *
    * Default is ````true````.
    *
    * @type {Boolean}
    */
-  perspectivePoints: boolean;
+  set perspectivePoints(arg: boolean);
+
+  /**
+   * Gets if rendered point size reduces with distance when {@link Camera.projection} is set to "perspective".
+   *
+   * Default is ````false````.
+   *
+   * @type {Boolean}
+   */
+  get perspectivePoints(): boolean;
 
   /**
-   * The minimum rendered size of points when {@link PointsMaterial.perspectivePoints} is ````true````.
+   * Sets the minimum rendered size of points when {@link PointsMaterial.perspectivePoints} is ````true````.
    *
    * Default value is ````1.0```` pixels.
    *
    * @type {Number}
    */
-  minPerspectivePointSize: number;
+  set minPerspectivePointSize(arg: number);
 
   /**
-   * The maximum rendered size of points when {@link PointsMaterial.perspectivePoints} is ````true````.
+   * Gets the minimum rendered size of points when {@link PointsMaterial.perspectivePoints} is ````true````.
+   *
+   * Default value is ````1.0```` pixels.
+   *
+   * @type {Number}
+   */
+  get minPerspectivePointSize(): number;
+
+  /**
+   * Sets the maximum rendered size of points when {@link PointsMaterial.perspectivePoints} is ````true````.
+   *
+   * Default value is ````6```` pixels.
+   *
+   * @type {Number}
+   */
+  set maxPerspectivePointSize(arg: number);
+
+  /**
+   * Gets the maximum rendered size of points when {@link PointsMaterial.perspectivePoints} is ````true````.
    *
    * Default value is ````6```` pixels.
    *
    * @type {Number}
    */
-  maxPerspectivePointSize: number;
+  get maxPerspectivePointSize(): number;
 
   /**
-   * Whether intensity filtering is enabled.
+   * Sets if rendered point size reduces with distance when {@link Camera.projection} is set to ````"perspective"````.
    *
    * Default is ````false````.
    *
    * @type {Boolean}
    */
-  filterIntensity: boolean;
+  set filterIntensity(arg: boolean);
 
   /**
-   * The minimum intensity when {@link PointsMaterial.filterIntensity} is ````true````.
+   * Gets if rendered point size reduces with distance when {@link Camera.projection} is set to "perspective".
+   *
+   * Default is ````false````.
+   *
+   * @type {Boolean}
+   */
+  get filterIntensity(): boolean;
+
+  /**
+   * Sets the minimum rendered size of points when {@link PointsMaterial.perspectivePoints} is ````true````.
+   *
+   * Default value is ````0````.
+   *
+   * @type {Number}
+   */
+  set minIntensity(arg: number);
+
+  /**
+   * Gets the minimum rendered size of points when {@link PointsMaterial.filterIntensity} is ````true````.
    *
    * Default value is ````0````.
    *
    * @type {Number}
    */
-  minIntensity: number;
+  get minIntensity(): number;
+
+  /**
+   * Sets the maximum rendered size of points when {@link PointsMaterial.filterIntensity} is ````true````.
+   *
+   * Default value is ````1````.
+   *
+   * @type {Number}
+   */
+  set maxIntensity(arg: number);
 
   /**
-   * The maximum intensity when {@link PointsMaterial.filterIntensity} is ````true````.
+   * Gets the maximum rendered size of points when {@link PointsMaterial.filterIntensity} is ````true````.
    *
    * Default value is ````1````.
    *
    * @type {Number}
    */
-  maxIntensity: number;
+  get maxIntensity(): number;
 
   /**
    * Destroys this ````PointsMaterial````.