@xeokit/xeokit-sdk 2.2.5-beta-2 → 2.2.5-beta-3

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

@@ -50,9 +50,9 @@ export declare type PhongMaterialConfiguration = {
   alphaFresnel?: Fresnel;
   /** A reflectivity {@link Fresnel"}}Fresnel{{/crossLink}}. Must be within the same {@link Scene} as this PhongMaterial. */
   reflectivityFresnel?: Fresnel;
-  /** The alpha blend mode - accepted values are "opaque", "blend" and "mask". See the {@link PhongMaterial#alphaMode} property for more info. */
+  /** The alpha blend mode - accepted values are "opaque", "blend" and "mask". See the {@link PhongMaterial.alphaMode} property for more info. */
   alphaMode?: "opaque"| "blend" | "mask";
-  /** The alpha cutoff value. See the {@link PhongMaterial#alphaCutoff} property for more info. */
+  /** The alpha cutoff value. See the {@link PhongMaterial.alphaCutoff} property for more info. */
   alphaCutoff?: number;
   /** Whether to render geometry backfaces. */
   backfaces?: boolean;
@@ -91,7 +91,7 @@ export declare class PhongMaterial extends Material {
   /**
    * Sets the PhongMaterial's diffuse color.
    *
-   * Multiplies by {@link PhongMaterial#diffuseMap}.
+   * Multiplies by {@link PhongMaterial.diffuseMap}.
    *
    * Default value is ````[1.0, 1.0, 1.0]````.
    *
@@ -102,7 +102,7 @@ export declare class PhongMaterial extends Material {
   /**
    * Sets the PhongMaterial's diffuse color.
    *
-   * Multiplies by {@link PhongMaterial#diffuseMap}.
+   * Multiplies by {@link PhongMaterial.diffuseMap}.
    *
    * Default value is ````[1.0, 1.0, 1.0]````.
    *
@@ -113,7 +113,7 @@ export declare class PhongMaterial extends Material {
   /**
    * Sets the PhongMaterial's specular color.
    *
-   * Multiplies by {@link PhongMaterial#specularMap}.
+   * Multiplies by {@link PhongMaterial.specularMap}.
    * Default value is ````[1.0, 1.0, 1.0]````.
    * @type {Number[]}
    */
@@ -122,7 +122,7 @@ export declare class PhongMaterial extends Material {
   /**
    * Gets the PhongMaterial's specular color.
    *
-   * Multiplies by {@link PhongMaterial#specularMap}.
+   * Multiplies by {@link PhongMaterial.specularMap}.
    * Default value is ````[1.0, 1.0, 1.0]````.
    * @type {Number[]}
    */
@@ -131,7 +131,7 @@ export declare class PhongMaterial extends Material {
   /**
    * Sets the PhongMaterial's emissive color.
    *
-   * Multiplies by {@link PhongMaterial#emissiveMap}.
+   * Multiplies by {@link PhongMaterial.emissiveMap}.
    *
    * Default value is ````[0.0, 0.0, 0.0]````.
    * @type {Number[]}
@@ -141,7 +141,7 @@ export declare class PhongMaterial extends Material {
   /**
    * Gets the PhongMaterial's emissive color.
    *
-   * Multiplies by {@link PhongMaterial#emissiveMap}.
+   * Multiplies by {@link PhongMaterial.emissiveMap}.
    *
    * Default value is ````[0.0, 0.0, 0.0]````.
    * @type {Number[]}
@@ -155,7 +155,7 @@ export declare class PhongMaterial extends Material {
    *
    * A value of 0.0 indicates fully transparent, 1.0 is fully opaque.
    *
-   * Multiplies by {@link PhongMaterial#alphaMap}.
+   * Multiplies by {@link PhongMaterial.alphaMap}.
    *
    * Default value is ````1.0````.
    *
@@ -170,7 +170,7 @@ export declare class PhongMaterial extends Material {
    *
    * A value of 0.0 indicates fully transparent, 1.0 is fully opaque.
    *
-   * Multiplies by {@link PhongMaterial#alphaMap}.
+   * Multiplies by {@link PhongMaterial.alphaMap}.
    *
    * Default value is ````1.0````.
    *
@@ -215,7 +215,7 @@ export declare class PhongMaterial extends Material {
    *
    * The surface will be non-reflective when this is ````0````, and completely mirror-like when it is ````1.0````.
    *
-   * Multiplies by {@link PhongMaterial#reflectivityMap}.
+   * Multiplies by {@link PhongMaterial.reflectivityMap}.
    *
    * @type {Number}
    */
@@ -228,7 +228,7 @@ export declare class PhongMaterial extends Material {
    *
    * The surface will be non-reflective when this is ````0````, and completely mirror-like when it is ````1.0````.
    *
-   * Multiplies by {@link PhongMaterial#reflectivityMap}.
+   * Multiplies by {@link PhongMaterial.reflectivityMap}.
    *
    * @type {Number}
    */
@@ -277,7 +277,7 @@ export declare class PhongMaterial extends Material {
   /**
    * 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}.
+   * This governs how alpha is treated. Alpha is the combined result of {@link PhongMaterial.alpha} and {@link PhongMaterial.alphaMap}.
    *
    * Supported values are:
    *
@@ -299,10 +299,10 @@ export declare class PhongMaterial extends Material {
   /**
    * 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
+   * 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.
    *
-   * Alpha is the combined result of {@link PhongMaterial#alpha} and {@link PhongMaterial#alphaMap}.
+   * Alpha is the combined result of {@link PhongMaterial.alpha} and {@link PhongMaterial.alphaMap}.
    *
    * Default value is ````0.5````.
    *
@@ -363,7 +363,7 @@ export declare class PhongMaterial extends Material {
   /**
    * Gets the PhongMaterials's ambient {@link Texture}.
    *
-   * Multiplies by {@link PhongMaterial#ambient}.
+   * Multiplies by {@link PhongMaterial.ambient}.
    *
    * @type {Texture}
    */
@@ -372,7 +372,7 @@ export declare class PhongMaterial extends Material {
   /**
    * Gets the PhongMaterials's diffuse {@link Texture}.
    *
-   * Multiplies by {@link PhongMaterial#diffuse}.
+   * Multiplies by {@link PhongMaterial.diffuse}.
    *
    * @type {Texture}
    */
@@ -381,7 +381,7 @@ export declare class PhongMaterial extends Material {
   /**
    * Gets the PhongMaterials's specular {@link Texture}.
    *
-   * Multiplies by {@link PhongMaterial#specular}.
+   * Multiplies by {@link PhongMaterial.specular}.
    *
    * @type {Texture}
    */
@@ -390,7 +390,7 @@ export declare class PhongMaterial extends Material {
   /**
    * Gets the PhongMaterials's emissive {@link Texture}.
    *
-   * Multiplies by {@link PhongMaterial#emissive}.
+   * Multiplies by {@link PhongMaterial.emissive}.
    *
    * @type {Texture}
    */
@@ -399,7 +399,7 @@ export declare class PhongMaterial extends Material {
   /**
    * Gets the PhongMaterials's alpha {@link Texture}.
    *
-   * Multiplies by {@link PhongMaterial#alpha}.
+   * Multiplies by {@link PhongMaterial.alpha}.
    *
    * @type {Texture}
    */
@@ -408,7 +408,7 @@ export declare class PhongMaterial extends Material {
   /**
    * Gets the PhongMaterials's reflectivity {@link Texture}.
    *
-   * Multiplies by {@link PhongMaterial#reflectivity}.
+   * Multiplies by {@link PhongMaterial.reflectivity}.
    *
    * @type {Texture}
    */
@@ -424,7 +424,7 @@ export declare class PhongMaterial extends Material {
   /**
    * Gets the PhongMaterials's diffuse {@link Fresnel}.
    *
-   * Applies to {@link PhongMaterial#diffuse}.
+   * Applies to {@link PhongMaterial.diffuse}.
    *
    * @type {Fresnel}
    */
@@ -433,7 +433,7 @@ export declare class PhongMaterial extends Material {
   /**
    * Gets the PhongMaterials's specular {@link Fresnel}.
    *
-   * Applies to {@link PhongMaterial#specular}.
+   * Applies to {@link PhongMaterial.specular}.
    *
    * @type {Fresnel}
    */
@@ -442,7 +442,7 @@ export declare class PhongMaterial extends Material {
   /**
    * Gets the PhongMaterials's emissive {@link Fresnel}.
    *
-   * Applies to {@link PhongMaterial#emissive}.
+   * Applies to {@link PhongMaterial.emissive}.
    *
    * @type {Fresnel}
    */
@@ -451,7 +451,7 @@ export declare class PhongMaterial extends Material {
   /**
    * Gets the PhongMaterials's alpha {@link Fresnel}.
    *
-   * Applies to {@link PhongMaterial#alpha}.
+   * Applies to {@link PhongMaterial.alpha}.
    *
    * @type {Fresnel}
    */
@@ -460,7 +460,7 @@ export declare class PhongMaterial extends Material {
   /**
    * Gets the PhongMaterials's reflectivity {@link Fresnel}.
    *
-   * Applies to {@link PhongMaterial#reflectivity}.
+   * Applies to {@link PhongMaterial.reflectivity}.
    *
    * @type {Fresnel}
    */

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

@@ -8,7 +8,7 @@ export declare type PointsMaterialConfiguration = {
   pointSize?: number;
   /** Whether points are round (````true````) or square (````false````). */
   roundPoints?: boolean;
-  /** Whether apparent point size reduces with distance when {@link Camera#projection} is set to "perspective". */
+  /** Whether apparent point size reduces with distance when {@link Camera.projection} is set to "perspective". */
   perspectivePoints?: boolean;
   /** When ````perspectivePoints```` is ````true````, this is the minimum rendered size of each point in pixels. */
   minPerspectivePointSize?: number;
@@ -20,7 +20,7 @@ export declare type PointsMaterialConfiguration = {
   minIntensity?: number;
   /** When ````filterIntensity```` is ````true````, points with intensity above this value will not be rendered. */
   maxIntensity?: number;
-  /** Selects a preset PointsMaterial configuration - see {@link PointsMaterial#presets}. */
+  /** Selects a preset PointsMaterial configuration - see {@link PointsMaterial.presets}. */
   preset?: string;
 };
 
@@ -97,7 +97,7 @@ export declare class PointsMaterial extends Material {
   get roundPoints(): boolean;
 
   /**
-   * Sets if 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````.
    *
@@ -106,7 +106,7 @@ export declare class PointsMaterial extends Material {
   set perspectivePoints(arg: boolean);
 
   /**
-   * Gets if rendered point size reduces with distance when {@link Camera#projection} is set to "perspective".
+   * Gets if rendered point size reduces with distance when {@link Camera.projection} is set to "perspective".
    *
    * Default is ````false````.
    *
@@ -115,7 +115,7 @@ export declare class PointsMaterial extends Material {
   get perspectivePoints(): boolean;
 
   /**
-   * Sets 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.
    *
@@ -124,7 +124,7 @@ export declare class PointsMaterial extends Material {
   set minPerspectivePointSize(arg: number);
 
   /**
-   * Gets the minimum 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.
    *
@@ -133,7 +133,7 @@ export declare class PointsMaterial extends Material {
   get minPerspectivePointSize(): number;
 
   /**
-   * Sets the maximum rendered size of points when {@link PointsMaterial#perspectivePoints} is ````true````.
+   * Sets the maximum rendered size of points when {@link PointsMaterial.perspectivePoints} is ````true````.
    *
    * Default value is ````6```` pixels.
    *
@@ -142,7 +142,7 @@ export declare class PointsMaterial extends Material {
   set maxPerspectivePointSize(arg: number);
 
   /**
-   * Gets the maximum rendered size of points when {@link PointsMaterial#perspectivePoints} is ````true````.
+   * Gets the maximum rendered size of points when {@link PointsMaterial.perspectivePoints} is ````true````.
    *
    * Default value is ````6```` pixels.
    *
@@ -151,7 +151,7 @@ export declare class PointsMaterial extends Material {
   get maxPerspectivePointSize(): number;
 
   /**
-   * Sets if 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 ````false````.
    *
@@ -160,7 +160,7 @@ export declare class PointsMaterial extends Material {
   set filterIntensity(arg: boolean);
 
   /**
-   * Gets if rendered point size reduces with distance when {@link Camera#projection} is set to "perspective".
+   * Gets if rendered point size reduces with distance when {@link Camera.projection} is set to "perspective".
    *
    * Default is ````false````.
    *
@@ -169,7 +169,7 @@ export declare class PointsMaterial extends Material {
   get filterIntensity(): boolean;
 
   /**
-   * Sets 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 ````0````.
    *
@@ -178,7 +178,7 @@ export declare class PointsMaterial extends Material {
   set minIntensity(arg: number);
 
   /**
-   * Gets the minimum rendered size of points when {@link PointsMaterial#filterIntensity} is ````true````.
+   * Gets the minimum rendered size of points when {@link PointsMaterial.filterIntensity} is ````true````.
    *
    * Default value is ````0````.
    *
@@ -187,7 +187,7 @@ export declare class PointsMaterial extends Material {
   get minIntensity(): number;
 
   /**
-   * Sets the maximum rendered size of points when {@link PointsMaterial#filterIntensity} is ````true````.
+   * Sets the maximum rendered size of points when {@link PointsMaterial.filterIntensity} is ````true````.
    *
    * Default value is ````1````.
    *
@@ -196,7 +196,7 @@ export declare class PointsMaterial extends Material {
   set maxIntensity(arg: number);
 
   /**
-   * Gets the maximum rendered size of points when {@link PointsMaterial#filterIntensity} is ````true````.
+   * Gets the maximum rendered size of points when {@link PointsMaterial.filterIntensity} is ````true````.
    *
    * Default value is ````1````.
    *

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

@@ -2,15 +2,15 @@
  * @desc A 2D texture map.
  *
  * * Textures are attached to {@link Material}s, which are attached to {@link Mesh}es.
- * * To create a Texture from an image file, set {@link Texture#src} to the image file path.
- * * To create a Texture from an HTMLImageElement, set the Texture's {@link Texture#image} to the HTMLImageElement.
+ * * To create a Texture from an image file, set {@link Texture.src} to the image file path.
+ * * To create a Texture from an HTMLImageElement, set the Texture's {@link Texture.image} to the HTMLImageElement.
  *
  * ## Usage
  *
  * In this example we have a Mesh with a {@link PhongMaterial} which applies diffuse {@link Texture}, and a {@link buildTorusGeometry} which builds a {@link ReadableGeometry}.
  *
- * Note that xeokit will ignore {@link PhongMaterial#diffuse} and {@link PhongMaterial#specular}, since we override those
- * with {@link PhongMaterial#diffuseMap} and {@link PhongMaterial#specularMap}. The {@link Texture} pixel colors directly
+ * Note that xeokit will ignore {@link PhongMaterial.diffuse} and {@link PhongMaterial.specular}, since we override those
+ * with {@link PhongMaterial.diffuseMap} and {@link PhongMaterial.specularMap}. The {@link Texture} pixel colors directly
  * provide the diffuse and specular components for each fragment across the {@link ReadableGeometry} surface.
  *
  * [[Run this example](http://xeokit.github.io/xeokit-sdk/examples/#materials_Texture)]
@@ -52,20 +52,20 @@ export declare class Texture extends Component {
      * @param {Component} owner Owner component. When destroyed, the owner will destroy this Texture as well.
      * @param {*} [cfg] Configs
      * @param {String} [cfg.id] Optional ID for this Texture, unique among all components in the parent scene, generated automatically when omitted.
-     * @param {String} [cfg.src=null] Path to image file to load into this Texture. See the {@link Texture#src} property for more info.
-     * @param {HTMLImageElement} [cfg.image=null] HTML Image object to load into this Texture. See the {@link Texture#image} property for more info.
-     * @param {String} [cfg.minFilter="linearMipmapLinear"] How the texture is sampled when a texel covers less than one pixel. See the {@link Texture#minFilter} property for more info.
-     * @param {String} [cfg.magFilter="linear"] How the texture is sampled when a texel covers more than one pixel. See the {@link Texture#magFilter} property for more info.
-     * @param {String} [cfg.wrapS="repeat"] Wrap parameter for texture coordinate *S*. See the {@link Texture#wrapS} property for more info.
-     * @param {String} [cfg.wrapT="repeat"] Wrap parameter for texture coordinate *S*. See the {@link Texture#wrapT} property for more info.
+     * @param {String} [cfg.src=null] Path to image file to load into this Texture. See the {@link Texture.src} property for more info.
+     * @param {HTMLImageElement} [cfg.image=null] HTML Image object to load into this Texture. See the {@link Texture.image} property for more info.
+     * @param {String} [cfg.minFilter="linearMipmapLinear"] How the texture is sampled when a texel covers less than one pixel. See the {@link Texture.minFilter} property for more info.
+     * @param {String} [cfg.magFilter="linear"] How the texture is sampled when a texel covers more than one pixel. See the {@link Texture.magFilter} property for more info.
+     * @param {String} [cfg.wrapS="repeat"] Wrap parameter for texture coordinate *S*. See the {@link Texture.wrapS} property for more info.
+     * @param {String} [cfg.wrapT="repeat"] Wrap parameter for texture coordinate *S*. See the {@link Texture.wrapT} property for more info.
      * @param {Boolean} [cfg.flipY=false] Flips this Texture's source data along its vertical axis when true.
      * @param {Number[]} [cfg.translate=[0,0]] 2D translation vector that will be added to texture's *S* and *T* coordinates.
      * @param {Number[]} [cfg.scale=[1,1]] 2D scaling vector that will be applied to texture's *S* and *T* coordinates.
      * @param {Number} [cfg.rotate=0] Rotation, in degrees, that will be applied to texture's *S* and *T* coordinates.
-     * @param  {String} [cfg.encoding="linear"] Encoding format.  See the {@link Texture#encoding} property for more info.
+     * @param  {String} [cfg.encoding="linear"] Encoding format.  See the {@link Texture.encoding} property for more info.
      */
     constructor(owner: Component, cfg?: any);
-    _state: RenderState;
+    _state: any;
     _src: string;
     _image: any;
     _translate: any;
@@ -123,7 +123,7 @@ export declare class Texture extends Component {
     /**
      * Sets path to an image file to source this Texture from.
      *
-     * Sets {@link Texture#image} null.
+     * Sets {@link Texture.image} null.
      *
      * @type {String}
      */
@@ -139,7 +139,7 @@ export declare class Texture extends Component {
     /**
      * Sets an HTML DOM Image object to source this Texture from.
      *
-     * Sets {@link Texture#src} null.
+     * Sets {@link Texture.src} null.
      *
      * @type {HTMLImageElement}
      */
@@ -258,4 +258,3 @@ export declare class Texture extends Component {
     get encoding(): string;
 }
 import { Component } from "../Component.js";
-import { RenderState } from "../webgl/RenderState.js";

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

@@ -1,3 +1,4 @@
+export * from "./Material";
 export * from "./EdgeMaterial";
 export * from "./EmphasisMaterial";
 export * from "./LinesMaterial";

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

@@ -1,36 +1,36 @@
 declare const math: {
-  unglobalizeObjectId(modelId: string, globalId: string): string;
-  globalizeObjectId(modelId: string, objectId: string): string;
+    unglobalizeObjectId(modelId: string, globalId: string): string;
+    globalizeObjectId(modelId: string, objectId: string): string;
 
-  /**
-   * Returns a new, uninitialized two-element vector.
-   * @returns {Number[]}
-   */
-  vec2: (values?: number[])=> number[];
+    /**
+     * Returns a new, uninitialized two-element vector.
+     * @returns {Number[]}
+     */
+    vec2: (values?: number[]) => number[];
 
-  /**
-   * Returns a new, uninitialized three-element vector.
-   * @returns {Number[]}
-   */
-  vec3: (values?: number[])=> number[];
+    /**
+     * Returns a new, uninitialized three-element vector.
+     * @returns {Number[]}
+     */
+    vec3: (values?: number[]) => number[];
 
-  /**
-   * Returns a new, uninitialized four-element vector.
-   * @returns {Number[]}
-   */
-  vec4: (values?: number[])=> number[];
+    /**
+     * Returns a new, uninitialized four-element vector.
+     * @returns {Number[]}
+     */
+    vec4: (values?: number[]) => number[];
 
-  /**
-   * Gets the center of a 2D AABB.
-   * @returns {Number[]}
-   */
-  getAABB2Center(aabb: number[], dest?: (values?: number[])=> number[]);
+    /**
+     * Gets the center of a 2D AABB.
+     * @returns {Number[]}
+     */
+    getAABB2Center(aabb: number[], dest?: (values?: number[]) => number[]): number[];
 
-  /**
-   * Gets the center of an AABB.
-   * @returns {Number[]}
-   */
-  getAABB3Center(aabb: number[], dest?: (values?: number[])=> number[]);
+    /**
+     * Gets the center of an AABB.
+     * @returns {Number[]}
+     */
+    getAABB3Center(aabb: number[], dest?: (values?: number[]) => number[]): number[];
 };
 
-export { math };
+export {math};