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

package/src/viewer/scene/LineSet/LineSet.js

@@ -66,7 +66,7 @@ class LineSet extends Component {
      * @param {String} [cfg.id] Optional ID, unique among all components in the parent {@link Scene}, generated automatically when omitted.
      * @param {Number[]} cfg.positions World-space 3D vertex positions.
      * @param {Number[]} [cfg.indices] Indices to connect ````positions```` into line segments. Note that these are separate line segments, not a polyline.
-     * @param {Number[]} [cfg.color=[0,0,0]] The color of this ````LineSet````. This is both emissive and diffuse.
+     * @param {Number[]} [cfg.color=[1,1,1]] The color of this ````LineSet````. This is both emissive and diffuse.
      * @param {Boolean} [cfg.visible=true] Indicates whether or not this ````LineSet```` is visible.
      * @param {Number} [cfg.opacity=1.0] ````LineSet````'s initial opacity factor.
      */
@@ -86,6 +86,9 @@ class LineSet extends Component {
             }
         }
 
+        this._color = cfg.color || [1, 1, 1];
+        this._opacity = cfg.opacity || 1.0;
+
         this._sceneModel = new SceneModel(this, {
             isModel: false // Don't register in Scene.models
         });
@@ -94,7 +97,9 @@ class LineSet extends Component {
             id: "linesMesh",
             primitive: "lines",
             positions: this._positions,
-            indices: this._indices
+            indices: this._indices,
+            color: this._color,
+            opacity: this._opacity,
         })
 
         this._sceneModel.createEntity({

package/src/viewer/scene/camera/CameraFlightAnimation.js

@@ -330,7 +330,7 @@ class CameraFlightAnimation extends Component {
         this.fire("started", params, true);
 
         this._time1 = Date.now();
-        this._time2 = this._time1 + (params.duration ? params.duration * 1000 : this._duration);
+        this._time2 = this._time1 + (Number.isFinite(params.duration) ? params.duration * 1000 : this._duration);
 
         this._flying = true; // False as soon as we stop
 
@@ -566,7 +566,7 @@ class CameraFlightAnimation extends Component {
      * @param {Number} value New duration value.
      */
     set duration(value) {
-        this._duration = value ? (value * 1000.0) : 500;
+        this._duration = Number.isFinite(value) ? (value * 1000.0) : 500;
         this.stop();
     }
 

package/src/viewer/scene/canvas/Canvas.js

@@ -1,7 +1,7 @@
 
-import {math} from '../math/math.js';
-import {Component} from '../Component.js';
-import {Spinner} from './Spinner.js';
+import { Component } from '../Component.js';
+import { math } from '../math/math.js';
+import { Spinner } from './Spinner.js';
 
 const WEBGL_CONTEXT_NAMES = [
     "webgl2",
@@ -482,9 +482,12 @@ class Canvas extends Component {
         // Memory leak avoidance
         this.canvas.removeEventListener("webglcontextlost", this._webglcontextlostListener);
         this.canvas.removeEventListener("webglcontextrestored", this._webglcontextrestoredListener);
+        
+        this.gl.getExtension("WEBGL_lose_context").loseContext();
         this.gl = null;
+        
         super.destroy();
     }
 }
 
-export {Canvas};
+export { Canvas };

package/src/viewer/scene/index.js

@@ -13,7 +13,6 @@ export * from "./nodes/index.js";
 export * from "./paths/index.js";
 export * from "./model/index.js";
 export * from "./sectionPlane/index.js";
-export * from "./skybox/index.js";
 export * from "./utils/index.js";
 export * from "./Component.js";
 export * from "./utils.js";

package/src/viewer/scene/model/dtx/triangles/renderers/DTXTrianglesColorRenderer.js

@@ -601,6 +601,11 @@ export class DTXTrianglesColorRenderer {
         if (scene.logarithmicDepthBufferEnabled) {
              src.push("    gl_FragDepth = isPerspective == 0.0 ? gl_FragCoord.z : log2( vFragDepth ) * logDepthBufFC * 0.5;");
             //src.push("    gl_FragDepth = log2( vFragDepth ) * logDepthBufFC * 0.5;");
+        } else {
+            src.push("    float dx = dFdx(gl_FragCoord.z);")
+            src.push("    float dy = dFdy(gl_FragCoord.z);")
+            src.push("    float diff = sqrt(dx*dx+dy*dy);");
+            src.push("    gl_FragDepth = gl_FragCoord.z + diff;");
         }
 
         if (this._withSAO) {

package/src/viewer/scene/model/vbo/batching/triangles/renderers/TrianglesColorRenderer.js

@@ -225,6 +225,11 @@ export class TrianglesColorRenderer extends TrianglesBatchingRenderer {
             src.push("    float dy = dFdy(vFragDepth);")
             src.push("    float diff = sqrt(dx*dx+dy*dy);");
             src.push("    gl_FragDepth = isPerspective == 0.0 ? gl_FragCoord.z : log2( vFragDepth + diff ) * logDepthBufFC * 0.5;");
+        } else {
+            src.push("    float dx = dFdx(gl_FragCoord.z);")
+            src.push("    float dy = dFdy(gl_FragCoord.z);")
+            src.push("    float diff = sqrt(dx*dx+dy*dy);");
+            src.push("    gl_FragDepth = gl_FragCoord.z + diff;");
         }
 
         if (this._withSAO) {

package/src/viewer/scene/model/vbo/batching/triangles/renderers/TrianglesFlatColorRenderer.js

@@ -233,6 +233,11 @@ export class TrianglesFlatColorRenderer extends TrianglesBatchingRenderer {
 
         if (scene.logarithmicDepthBufferEnabled) {
             src.push("    gl_FragDepth = isPerspective == 0.0 ? gl_FragCoord.z : log2( vFragDepth ) * logDepthBufFC * 0.5;");
+        } else {
+            src.push("    float dx = dFdx(gl_FragCoord.z);")
+            src.push("    float dy = dFdy(gl_FragCoord.z);")
+            src.push("    float diff = sqrt(dx*dx+dy*dy);");
+            src.push("    gl_FragDepth = gl_FragCoord.z + diff;");
         }
 
         src.push("}");

package/src/viewer/scene/model/vbo/instancing/triangles/renderers/TrianglesColorRenderer.js

@@ -238,6 +238,11 @@ class TrianglesColorRenderer extends TrianglesInstancingRenderer {
             src.push("    float dy = dFdy(vFragDepth);")
             src.push("    float diff = sqrt(dx*dx+dy*dy);");
             src.push("    gl_FragDepth = isPerspective == 0.0 ? gl_FragCoord.z : log2( vFragDepth + diff ) * logDepthBufFC * 0.5;");
+        } else {
+            src.push("    float dx = dFdx(gl_FragCoord.z);")
+            src.push("    float dy = dFdy(gl_FragCoord.z);")
+            src.push("    float diff = sqrt(dx*dx+dy*dy);");
+            src.push("    gl_FragDepth = gl_FragCoord.z + diff;");
         }
 
         // Doing SAO blend in the main solid fill draw shader just so that edge lines can be drawn over the top

package/src/viewer/scene/model/vbo/instancing/triangles/renderers/TrianglesFlatColorRenderer.js

@@ -242,6 +242,11 @@ export class TrianglesFlatColorRenderer extends TrianglesInstancingRenderer {
 
         if (scene.logarithmicDepthBufferEnabled) {
             src.push("    gl_FragDepth = isPerspective == 0.0 ? gl_FragCoord.z : log2( vFragDepth ) * logDepthBufFC * 0.5;");
+        } else {
+            src.push("    float dx = dFdx(gl_FragCoord.z);")
+            src.push("    float dy = dFdy(gl_FragCoord.z);")
+            src.push("    float diff = sqrt(dx*dx+dy*dy);");
+            src.push("    gl_FragDepth = gl_FragCoord.z + diff;");
         }
 
         src.push("}");

package/types/plugins/FastNavPlugin/FastNavPlugin.d.ts

@@ -1,6 +1,9 @@
 import { Plugin } from "../../viewer/Plugin";
 import { Viewer } from "../../viewer/Viewer";
 
+type OnStopped = () => void;
+type OnMoved = () => OnStopped;
+
 export declare type FastNavPluginConfiguration = {
   /** Optional ID for this plugin, so that we can find it within {@link Viewer.plugins}. */
   id?: string;
@@ -22,6 +25,8 @@ export declare type FastNavPluginConfiguration = {
   delayBeforeRestore?: boolean;
   /** Delay in seconds before restoring normal rendering after we stop interacting with the Viewer. */
   delayBeforeRestoreSeconds?: number;
+  /** Optional callback function fired during moving mode, should return the callback function that will be fired when the interaction stops. */
+  onMoved?: OnMoved;
 };
 
 /**

package/types/plugins/index.d.ts

@@ -12,7 +12,6 @@ export * from "./LASLoaderPlugin";
 export * from "./NavCubePlugin";
 export * from "./OBJLoaderPlugin";
 export * from "./SectionPlanesPlugin";
-export * from "./SkyboxesPlugin";
 export * from "./STLLoaderPlugin";
 export * from "./StoreyViewsPlugin";
 export * from "./TreeViewPlugin";

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

@@ -1,5 +1,6 @@
 import { Component } from "../Component";
 import { Entity } from "../Entity";
+import { Material } from "../materials";
 import { PickResult } from "../webgl/PickResult";
 
 /**
@@ -24,6 +25,9 @@ export declare class CameraControl extends Component {
   AXIS_VIEW_FRONT: number;
   AXIS_VIEW_TOP: number;
   AXIS_VIEW_BOTTOM: number;
+  MOUSE_PAN: number;
+  MOUSE_ROTATE: number;
+  MOUSE_DOLLY: number;
 
   /**
    * Fires when the model is loaded
@@ -240,6 +244,65 @@ export declare class CameraControl extends Component {
    */
   get active(): boolean;
 
+  /**
+   * Sets whether the pointer snap to vertex.
+   *
+   * @param {boolean} arg
+   */
+  set snapToVertex(arg: boolean);
+
+  /**
+   * Gets whether the pointer snap to vertex.
+   *
+   * @returns {boolean}
+   */
+  get snapToVertex(): boolean;
+
+  /**
+   * Sets whether the pointer snap to edge.
+   *
+   * @param {boolean} arg
+   */
+  set snapToEdge(arg: boolean);
+
+  /**
+   * Gets whether the pointer snap to edge.
+   *
+   * @returns {boolean}
+   */
+  get snapToEdge(): boolean;
+
+  /**
+   * Sets the current snap radius for "hoverSnapOrSurface" events, to specify whether the radius
+   * within which the pointer snaps to the nearest vertex or the nearest edge.
+   *
+   * Default value is 30 pixels.
+   *
+   * @param {Number} arg The snap radius.
+   */
+  set snapRadius(arg: number);
+
+  /**
+   * Gets the current snap radius.
+   *
+   * @returns {Number} The snap radius.
+   */
+  get snapRadius(): number;
+
+  /**
+   * If `true`, the keyboard shortcuts are enabled ONLY if the mouse is over the canvas.
+   * 
+   * @param {boolean} arg
+   */
+  set keyboardEnabledOnlyIfMouseover(arg: boolean);
+
+  /**
+   * Gets whether the keyboard shortcuts are enabled ONLY if the mouse is over the canvas or ALWAYS.
+   * 
+   * @returns {boolean}
+   */
+  get keyboardEnabledOnlyIfMouseover(): boolean;
+
   /**
    * Sets whether the {@link Camera} follows the mouse/touch pointer.
    *
@@ -502,6 +565,47 @@ export declare class CameraControl extends Component {
    */
   get panInertia(): number;
 
+  /**
+   * Sets the keyboard layout.
+   *
+   * Supported layouts are:
+   *
+   * * ````"qwerty"```` (default)
+   * * ````"azerty"````
+   *
+   * @deprecated
+   * @param {String} arg Selects the keyboard layout.
+   */
+  set keyboardLayout(arg: string);
+
+  /**
+   * Gets the keyboard layout.
+   *
+   * Supported layouts are:
+   *
+   * * ````"qwerty"```` (default)
+   * * ````"azerty"````
+   *
+   * @deprecated
+   * @returns {String} The current keyboard layout.
+   */
+  get keyboardLayout(): string;
+
+  /**
+   * Sets a sphere as the representation of the pivot position.
+   *
+   * @param {Object} [cfg] Sphere configuration.
+   * @param {String} [cfg.size=1] Optional size factor of the sphere. Defaults to 1.
+   * @param {String} [cfg.material=PhongMaterial] Optional size factor of the sphere. Defaults to a red opaque material.
+   */
+  enablePivotSphere(cfg: {size: number, material: Material}): void;
+
+  /**
+   * Remove the sphere as the representation of the pivot position.
+   *
+   */
+  disablePivotSphere(): void;
+
   /**
    * Sets whether mouse and touch input is enabled.
    *
@@ -646,6 +750,34 @@ export declare class CameraControl extends Component {
    */
   get panToPointer(): boolean;
 
+  /**
+   * Sets whether this ````CameraControl```` is in plan-view mode.
+   *
+   * When in plan-view mode, rotation is disabled.
+   *
+   * Default is ````false````.
+   *
+   * Deprecated - use {@link CameraControl#navMode} instead.
+   *
+   * @param {Boolean} arg Set ````true```` to enable plan-view mode.
+   * @deprecated
+   */
+  set planView(arg: boolean);
+
+  /**
+   * Gets whether this ````CameraControl```` is in plan-view mode.
+   *
+   * When in plan-view mode, rotation is disabled.
+   *
+   * Default is ````false````.
+   *
+   * Deprecated - use {@link CameraControl#navMode} instead.
+   *
+   * @returns {Boolean} Returns ````true```` if plan-view mode is enabled.
+   * @deprecated
+   */
+  get planView(): boolean;
+
   /**
    * Sets whether this ````CameraControl```` is in first-person mode.
    *
@@ -701,4 +833,40 @@ export declare class CameraControl extends Component {
    * @returns {Boolean} Returns ````true```` when pivoting by default about the selected point on the virtual sphere, or ````false```` when pivoting by default about {@link Camera.look}.
    */
   get smartPivot(): boolean;
+
+  /**
+   * Sets the double click time frame length in milliseconds.
+   * 
+   * If two mouse click events occur within this time frame, it is considered a double click. 
+   * 
+   * Default is ````250````
+   * 
+   * @param {Number} arg New double click time frame.
+   */
+  set doubleClickTimeFrame(arg: number);
+
+  /**
+   * Gets the double click time frame length in milliseconds.
+   *  
+   * Default is ````250````
+   * 
+   * @returns {Number} Current double click time frame.
+   */
+  get doubleClickTimeFrame(): number;
+
+  /**
+   * Sets whether to zoom the camera on mouse wheel
+   *
+   * Default is ````true````
+   *
+   * @param {Boolean} arg
+   */
+  set zoomOnMouseWheel(arg: boolean);
+
+  /**
+   * Gets whether to zoom the camera on mouse wheel
+   *
+   * @returns {Boolean}
+   */
+  get zoomOnMouseWheel(): boolean;
 }

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

@@ -66,7 +66,7 @@ export declare class LineSet extends Component {
      * @param {string} [cfg.id] Optional ID, unique among all components in the parent {@link Scene}, generated automatically when omitted.
      * @param {number[]} cfg.positions World-space 3D vertex positions.
      * @param {number[]} [cfg.indices] Indices to connect ````positions```` into line segments. Note that these are separate line segments, not a polyline.
-     * @param {number[]} [cfg.color=[0,0,0]] The color of this ````LineSet````. This is both emissive and diffuse.
+     * @param {number[]} [cfg.color=[1,1,1]] The color of this ````LineSet````. This is both emissive and diffuse.
      * @param {boolean} [cfg.visible=true] Indicates whether or not this ````LineSet```` is visible.
      * @param {number} [cfg.opacity=1.0] ````LineSet````'s initial opacity factor.
      */

package/types/viewer/scene/camera/CameraPath.d.ts

@@ -1,4 +1,5 @@
 import { Component } from "../Component";
+import { SplineCurve } from '../paths/SplineCurve';
 
 export declare type Frame = {
   t: number;
@@ -19,10 +20,89 @@ export declare type CameraPathConfiguration = {
  *
  */
 export declare class CameraPath extends Component {
-    /**
-     * @constructor
-     * @param {Component} [owner]  Owner component. When destroyed, the owner will destroy this CameraPath as well.
-     * @param {CameraPathConfiguration} [cfg] Configuration
-     */
-    constructor(owner?: Component, cfg?: CameraPathConfiguration);
+  /**
+   * @constructor
+   * @param {Component} [owner]  Owner component. When destroyed, the owner will destroy this CameraPath as well.
+   * @param {CameraPathConfiguration} [cfg] Configuration
+   */
+  constructor(owner?: Component, cfg?: CameraPathConfiguration);
+
+  /**
+   * Gets the camera frames in this CameraPath.
+   *
+   * @returns {{t:Number, eye:Object, look:Object, up: Object}[]} The frames on this CameraPath.
+   */
+  get frames(): Frame[];
+
+  /**
+   * Gets the {@link SplineCurve} along which {@link Camera#eye} travels.
+   * @returns {SplineCurve} The SplineCurve for {@link Camera#eye}.
+   */
+  get eyeCurve(): SplineCurve;
+
+  /**
+   * Gets the {@link SplineCurve} along which {@link Camera#look} travels.
+   * @returns {SplineCurve} The SplineCurve for {@link Camera#look}.
+   */
+  get lookCurve(): SplineCurve;
+
+  /**
+   * Gets the {@link SplineCurve} along which {@link Camera#up} travels.
+   * @returns {SplineCurve} The SplineCurve for {@link Camera#up}.
+   */
+  get upCurve(): SplineCurve;
+
+  /**
+   * Adds a frame to this CameraPath, given as the current position of the {@link Camera}.
+   *
+   * @param {Number} t Time instant for the new frame.
+   */
+  saveFrame(t: number): void;
+
+  /**
+   * Adds a frame to this CameraPath, specified as values for eye, look and up vectors at a given time instant.
+   *
+   * @param {Number} t Time instant for the new frame.
+   * @param {Number[]} eye A three-element vector specifying the eye position for the new frame.
+   * @param {Number[]} look A three-element vector specifying the look position for the new frame.
+   * @param {Number[]} up A three-element vector specifying the up vector for the new frame.
+   */
+  addFrame(t: number, eye: number, look: number[], up: number[]): void;
+
+  /**
+   * Adds multiple frames to this CameraPath, each frame specified as a set of values for eye, look and up vectors at a given time instant.
+   *
+   * @param {{t:Number, eye:Object, look:Object, up: Object}[]} frames Frames to add to this CameraPath.
+   */
+  addFrames(frames: Frame[]): void;
+
+  /**
+   * Sets the position of the {@link Camera} to a position interpolated within this CameraPath at the given time instant.
+   *
+   * @param {Number} t Time instant.
+   */
+  loadFrame(t: number): void;
+
+  /**
+   * Gets eye, look and up vectors on this CameraPath at a given instant.
+   *
+   * @param {Number} t Time instant.
+   * @param {Number[]} eye The eye position to update.
+   * @param {Number[]} look The look position to update.
+   * @param {Number[]} up The up vector to update.
+   */
+  sampleFrame(t: number, eye: number[], look: number[], up: number[]): void;
+
+  /**
+   * Given a total duration (in seconds) for this CameraPath, recomputes the time instant at each frame so that,
+   * when animated by {@link CameraPathAnimation}, the {@link Camera} will move along the path at a constant rate.
+   *
+   * @param {Number} duration The total duration for this CameraPath.
+   */
+  smoothFrameTimes(duration: number): void;
+
+   /**
+   * Removes all frames from this CameraPath.
+   */
+   clearFrames(): void;
 }

package/types/viewer/scene/camera/CameraPathAnimation.d.ts

@@ -91,5 +91,7 @@ export declare class CameraPathAnimation extends Component {
      * Stops playing this CameraPathAnimation.
      */
     stop(): void;
+
+    destroy(): void;
 }
 

package/types/viewer/scene/geometry/ReadableGeometry.d.ts

@@ -88,8 +88,22 @@ export declare class ReadableGeometry extends Geometry {
    */
   get obb(): number[];
 
+  /**
+   * Returns the surface area of this Mesh.
+   * @returns {number}
+   */
+  get surfaceArea(): number;
+
+  /**
+   * Returns the centroid of this Mesh.
+   * @returns {number}
+   */
+  get centroid(): number;
+
   /**
    * Approximate number of triangles in this ReadableGeometry.
    */
   get numTriangles(): number;
+
+  destroy(): void;
 }

package/types/viewer/scene/geometry/VBOGeometry.d.ts

@@ -60,4 +60,6 @@ export declare class VBOGeometry extends Geometry {
    * Will be zero if {@link VBOGeometry#primitive} is not 'triangles', 'triangle-strip' or 'triangle-fan'.
    */
   get numTriangles(): Number;
+
+  destroy(): void;
 }

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

@@ -1,3 +1,4 @@
 export * from "./ReadableGeometry";
 export * from "./VBOGeometry";
-export * from "./builders";
+export * from "./builders";
+export * from "./loaders";

package/types/viewer/scene/geometry/loaders/index.d.ts

@@ -0,0 +1,2 @@
+export * from './load3DSGeometry';
+export * from './loadOBJGeometry';

package/types/viewer/scene/geometry/loaders/load3DSGeometry.d.ts

@@ -0,0 +1,17 @@
+import {Scene} from '../../scene/Scene';
+
+export declare type load3DSGeometryConfiguration = {
+    /** Path to 3DS file. */
+    src?: string;
+}
+
+export declare type Geometry3DSData = {
+    src?: string;
+    primitive: string;
+    positions: number[];
+    normals: number[] | null;
+    uv: number[];
+    indices: number[];
+}
+
+export function load3DSGeometry(scene: Scene, cfg?: load3DSGeometryConfiguration) : Promise<Geometry3DSData>;

package/types/viewer/scene/geometry/loaders/loadOBJGeometry.d.ts

@@ -0,0 +1,18 @@
+import {Scene} from '../../scene/Scene';
+
+export declare type LoadObjGeometryConfiguration = {
+    /** Path to OBJ file. */
+    src?: string;
+}
+
+export declare type ObjGeometryData = {
+    src?: string;
+    primitive: string;
+    positions: number[];
+    normals: number[] | null;
+    autoNormals: number[] | null;
+    uv: number[];
+    indices: number[]
+}
+
+export function loadOBJGeometry(scene: Scene, cfg?: LoadObjGeometryConfiguration) : Promise<ObjGeometryData>;

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

@@ -12,6 +12,7 @@ export * from "./math/math";
 export * from "./mementos";
 export * from "./mesh";
 export * from "./nodes";
+export * from './paths';
 export * from "./models";
 export * from "./scene/Scene";
 export * from "./sectionPlane";