@xeokit/xeokit-sdk 2.6.32 → 2.6.34

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xeokit/xeokit-sdk",
-  "version": "2.6.32",
+  "version": "2.6.34",
   "description": "Web Programming Toolkit for 3D/2D BIM and AEC Graphics",
   "module": "./dist/xeokit-sdk.es.js",
   "main": "./dist/xeokit-sdk.cjs.js",

package/src/extras/PointerLens/PointerLens.js

@@ -65,20 +65,23 @@ export class PointerLens {
         this._lensCursorDiv.style.pointerEvents = "none";
 
         this._lensContainer = document.createElement('div');
+        this._lensContainerId = cfg.containerId || 'xeokit-lens';
+        this._lensContainer.setAttribute("id", this._lensContainerId);
+
         this._lensContainer.style.border = "1px solid black";
         this._lensContainer.style.background = "white";
     //    this._lensContainer.style.opacity = "0";
         this._lensContainer.style.borderRadius = "50%";
         this._lensContainer.style.width = "300px";
         this._lensContainer.style.height = "300px";
-        this._lensContainer.style.marginTop = "85px";
-        this._lensContainer.style.marginLeft = "25px";
+        
         this._lensContainer.style.zIndex = "15000";
         this._lensContainer.style.position = "absolute";
         this._lensContainer.style.pointerEvents = "none";
         this._lensContainer.style.visibility = "hidden";
 
         this._lensCanvas = document.createElement('canvas');
+        this._lensCanvas.id = `${this._lensContainerId}-canvas`;
         // this._lensCanvas.style.background = "darkblue";
         this._lensCanvas.style.borderRadius = "50%";
 
@@ -95,7 +98,12 @@ export class PointerLens {
 
         this._canvasPos = null;
         this._snappedCanvasPos = null;
-        this._lensPosToggle = true;
+        this._lensPosToggle = cfg.lensPosToggle || true;
+        this._lensPosToggleAmount = cfg.lensPosToggleAmount || 85;
+        this._lensPosMarginLeft = cfg.lensPosMarginLeft || 85;
+        this._lensPosMarginTop = cfg.lensPosMarginTop || 25;
+        this._lensContainer.style.marginTop = `${this._lensPosMarginTop}px`;
+        this._lensContainer.style.marginLeft = `${this._lensPosMarginLeft}px`;
 
         this._zoomLevel = cfg.zoomLevel || 2;
 
@@ -125,12 +133,12 @@ export class PointerLens {
         const pointerOnLens =
             this._canvasPos[0] < lensRect.right && this._canvasPos[0] > lensRect.left &&
             this._canvasPos[1] < lensRect.bottom && this._canvasPos[1] > lensRect.top;
-        this._lensContainer.style.marginLeft = `25px`;
+            this._lensContainer.style.marginLeft = `${this._lensPosMarginLeft}px`;
         if (pointerOnLens) {
             if (this._lensPosToggle) {
-                this._lensContainer.style.marginTop = `${canvasRect.bottom - canvasRect.top - this._lensCanvas.height - 85}px`;
+                this._lensContainer.style.marginTop = `${canvasRect.bottom - canvasRect.top - this._lensCanvas.height - this._lensPosToggleAmount}px`;
             } else {
-                this._lensContainer.style.marginTop = `85px`;
+                this._lensContainer.style.marginTop = `${this._lensPosMarginTop}px`;
             }
             this._lensPosToggle = !this._lensPosToggle;
         }

package/src/plugins/DistanceMeasurementsPlugin/DistanceMeasurement.js

@@ -6,6 +6,7 @@ import {Component} from "../../viewer/scene/Component.js";
 
 
 const distVec3 = math.vec3();
+const tmpVec3 = math.vec3();
 
 const lengthWire = (x1, y1, x2, y2) => {
     var a = x1 - x2;
@@ -316,6 +317,44 @@ class DistanceMeasurement extends Component {
         this.labelsVisible = cfg.labelsVisible;
         this.labelsOnWires = cfg.labelsOnWires;
         this.useRotationAdjustment = cfg.useRotationAdjustment;
+
+        /**
+         * @type {number[]}
+         */
+        this._axesBasis = [
+            1, 0, 0, 0,
+            0, 1, 0, 0,
+            0, 0, 1, 0,
+            0, 0, 0, 1,
+        ];
+    }
+
+    /**
+     * Sets the axes basis for the measurement.
+     * 
+     * The value is a 4x4 matrix where each column-vector defines an axis and must have unit length.
+     * 
+     * This is the ```identity``` matrix by default, meaning the measurement axes are the same as the world axes.
+     * 
+     * @param {number[]} value 
+     */
+    set axesBasis(value) {
+        this._axesBasis = value.slice();
+        this._wpDirty = true;
+        this._needUpdate(0); // No lag
+    }
+
+    /**
+     * Gets the axes basis for the measurement.
+     * 
+     * The value is a 4x4 matrix where each column-vector defines an axis and must have unit length.
+     * 
+     * This is the ```identity``` matrix by default, meaning the measurement axes are the same as the world axes.
+     * 
+     * @type {number[]}
+     */
+    get axesBasis() {
+        return this._axesBasis;
     }
 
     _update() {
@@ -351,19 +390,30 @@ class DistanceMeasurement extends Component {
                 this._wp[15] = 1.0;
             }
             else {
+                const delta = math.subVec3(
+                    this._targetWorld,
+                    this._originWorld,
+                    tmpVec3
+                );
+
+                /**
+                 * The length detected for each measurement axis.
+                 */
+                this._factors = math.transformVec3(this._axesBasis, delta);
+
                 this._wp[0] = this._originWorld[0];
                 this._wp[1] = this._originWorld[1];
                 this._wp[2] = this._originWorld[2];
                 this._wp[3] = 1.0;
 
-                this._wp[4] = this._targetWorld[0];
-                this._wp[5] = this._originWorld[1];
-                this._wp[6] = this._originWorld[2];
+                this._wp[4] = this._originWorld[0] + this._axesBasis[0]*this._factors[0];
+                this._wp[5] = this._originWorld[1] + this._axesBasis[4]*this._factors[0];
+                this._wp[6] = this._originWorld[2] + this._axesBasis[8]*this._factors[0];
                 this._wp[7] = 1.0;
 
-                this._wp[8] = this._targetWorld[0];
-                this._wp[9] = this._targetWorld[1];
-                this._wp[10] = this._originWorld[2];
+                this._wp[8] = this._originWorld[0] + this._axesBasis[0]*this._factors[0]+ this._axesBasis[1]*this._factors[1];
+                this._wp[9] = this._originWorld[1] + this._axesBasis[4]*this._factors[0]+ this._axesBasis[5]*this._factors[1];
+                this._wp[10] = this._originWorld[2] + this._axesBasis[8]*this._factors[0]+ this._axesBasis[9]*this._factors[1];;
                 this._wp[11] = 1.0;
 
                 this._wp[12] = this._targetWorld[0];
@@ -525,14 +575,14 @@ class DistanceMeasurement extends Component {
                 }
 
                 if (!this._xAxisLabelCulled) {
-                    this._xAxisLabel.setText(tilde + Math.abs((this._targetWorld[0] - this._originWorld[0]) * scale).toFixed(2) + unitAbbrev);
+                    this._xAxisLabel.setText(tilde + Math.abs(this._factors[0] * scale).toFixed(2) + unitAbbrev);
                     this._xAxisLabel.setCulled(!this.axisVisible);
                 } else {
                     this._xAxisLabel.setCulled(true);
                 }
 
                 if (!this._yAxisLabelCulled) {
-                    this._yAxisLabel.setText(tilde + Math.abs((this._targetWorld[1] - this._originWorld[1]) * scale).toFixed(2) + unitAbbrev);
+                    this._yAxisLabel.setText(tilde + Math.abs(this._factors[1] * scale).toFixed(2) + unitAbbrev);
                     this._yAxisLabel.setCulled(!this.axisVisible);
                 } else {
                     this._yAxisLabel.setCulled(true);
@@ -545,7 +595,7 @@ class DistanceMeasurement extends Component {
                     }
                     else {
                         this._zAxisLabel.setPrefix("Z");
-                        this._zAxisLabel.setText(tilde + Math.abs((this._targetWorld[2] - this._originWorld[2]) * scale).toFixed(2) + unitAbbrev);
+                        this._zAxisLabel.setText(tilde + Math.abs(this._factors[2] * scale).toFixed(2) + unitAbbrev);
                     }
                     this._zAxisLabel.setCulled(!this.axisVisible);
                 } else {

package/src/viewer/scene/math/MeshVolume.js

@@ -91,7 +91,7 @@ export class MeshVolume {
             volume += math.dotVec3(v1, v3);
         }
 
-        return volume;
+        return volume / 6;
     }
 }
 

package/src/viewer/scene/model/vbo/instancing/lines/VBOInstancingLinesLayer.js

@@ -244,7 +244,9 @@ class VBOInstancingLinesLayer {
             this._modelMatrixCol1 = [];
             this._modelMatrixCol2 = [];
         }
-        this._state.geometry = null;
+        if (!this.model.scene.readableGeometryEnabled) {
+            this._state.geometry = null;
+        }
         this._finalized = true;
     }
 

package/src/viewer/scene/model/vbo/instancing/triangles/VBOInstancingTrianglesLayer.js

@@ -36,7 +36,7 @@ export class VBOInstancingTrianglesLayer {
      */
     constructor(cfg) {
 
-      //   console.info("Creating VBOInstancingTrianglesLayer");
+        //   console.info("Creating VBOInstancingTrianglesLayer");
 
         /**
          * Owner model
@@ -378,7 +378,9 @@ export class VBOInstancingTrianglesLayer {
             && !!textureSet
             && !!textureSet.colorTexture;
 
-        this._state.geometry = null;
+        if (!this.model.scene.readableGeometryEnabled) {
+            this._state.geometry = null;
+        }
 
         this._finalized = true;
     }
@@ -705,11 +707,11 @@ export class VBOInstancingTrianglesLayer {
             this.model.error("portion not found: " + portionId);
             return;
         }
-        const positions = geometry.quantizedPositions;
+        const positions = geometry.positionsCompressed;
         const origin = state.origin;
-        const offsetX = origin[0] ;
-        const offsetY = origin[1] ;
-        const offsetZ = origin[2] ;
+        const offsetX = origin[0];
+        const offsetY = origin[1];
+        const offsetZ = origin[2];
         const worldPos = tempVec4a;
         const portionMatrix = portion.matrix;
         const sceneModelMatrix = this.model.matrix;
@@ -785,7 +787,7 @@ export class VBOInstancingTrianglesLayer {
             return;
         }
         this._updateBackfaceCull(renderFlags, frameCtx);
-        const useAlphaCutoff = this._state.textureSet && (typeof(this._state.textureSet.alphaCutoff) === "number");
+        const useAlphaCutoff = this._state.textureSet && (typeof (this._state.textureSet.alphaCutoff) === "number");
         if (frameCtx.withSAO && this.model.saoEnabled) {
             if (frameCtx.pbrEnabled && this.model.pbrEnabled && this._state.pbrSupported) {
                 if (this._renderers.pbrRendererWithSAO) {

package/types/extras/ContextMenu/ContextMenu.d.ts

@@ -7,6 +7,8 @@ export declare type ContextMenuConfiguration = {
   enabled?: boolean;
   /** Whether this ````ContextMenu```` automatically hides whenever we mouse-down or tap anywhere in the page. */
   hideOnMouseDown?: boolean;
+  /** Whether this ````ContextMenu```` automatically hides whenever we call its action. */
+  hideOnAction?: boolean;
 };
 
 /**

package/types/extras/PointerLens/PointerLens.d.ts

@@ -47,6 +47,11 @@ export class PointerLens {
     constructor(viewer: Viewer, cfg?: {
         active?: boolean;
         zoomFactor?: number;
+        containerId?: string;
+        lensPosToggle?: boolean,
+        lensPosToggleAmount?: number,
+        lensPosMarginLeft?: number,
+        lensPosMarginTop?: number;
     });
 
     /**
@@ -137,6 +142,48 @@ export class PointerLens {
      */
     get visible(): boolean;
 
+    /**
+     * Sets whether the pointer lens container should toggle position when mouse is over it.
+     *
+     * @param {boolean} lensPosToggle Whether we should toggle position.
+     */
+    set lensPosToggle(lensPosToggle: boolean);
+
+    /**
+     * Gets whether we should toggle position.
+     *
+     * @returns {boolean} Whether we should toggle position.
+     */
+    get lensPosToggle(): boolean;
+
+    /**
+     * Sets whether we toggle position in vertical or horizontal.
+     *
+     * @param {boolean} lensPosToggleVertical Vertical or horizontal change.
+     */
+    set lensPosToggleVertical(lensPosToggleVertical: boolean);
+
+    /**
+     * Gets whether we toggle position in vertical or horizontal.
+     *
+     * @returns {boolean} Vertical or horizontal change.
+     */
+    get lensPosToggleVertical(): boolean;
+
+    /**
+     * Sets amount of pixels we toggle position.
+     *
+     * @param {number} lensPosToggleAmount Amount of pixels we toggle position.
+     */
+    set lensPosToggleAmount(lensPosToggleAmount: number);
+
+    /**
+     * Gets amount of pixels we toggle position.
+     *
+     * @returns {number} Amount of pixels we toggle position.
+     */
+    get lensPosToggleAmount(): number;
+
     /**
      * Destroys this PointerLens.
      */

package/types/plugins/DistanceMeasurementsPlugin/DistanceMeasurement.d.ts

@@ -12,6 +12,24 @@ export declare class DistanceMeasurement extends Component {
    */
   plugin: DistanceMeasurementsPlugin;
 
+  /**
+   * Sets the axes basis for the measurement.
+   * 
+   * The value is a 4x4 matrix where each column-vector defines an axis and must have unit length.
+   * 
+   * This is the ```identity``` matrix by default, meaning the measurement axes are the same as the world axes.
+   */
+  set axesBasis(value: number[]);
+
+  /**
+   * Gets the axes basis for the measurement.
+   * 
+   * The value is a 4x4 matrix where each column-vector defines an axis and must have unit length.
+   * 
+   * This is the ```identity``` matrix by default, meaning the measurement axes are the same as the world axes.
+   */
+  get axesBasis(): number[];
+
   /**
    * Sets whether this DistanceMeasurement indicates that its measurement is approximate.
    *

package/types/plugins/DistanceMeasurementsPlugin/DistanceMeasurementsPlugin.d.ts

@@ -200,6 +200,18 @@ export declare class DistanceMeasurementsPlugin extends Plugin {
       labelsOnWires?: boolean;
   }): DistanceMeasurement;
   
+  /**
+   * Gets whether the distance measurement axis are visible.
+   * @returns {Boolean}
+   */
+  getAxisVisible(): boolean;
+
+  /**
+   * Sets whether the distance measurement axis are visible.
+   * @param {Boolean} axisVisible
+   */
+  setAxisVisible(axisVisible: boolean): void;
+
   /**
    * Destroys a {@link DistanceMeasurement}.
    *

package/types/plugins/DistanceMeasurementsPlugin/index.d.ts

@@ -1,5 +1,6 @@
 export * from "./DistanceMeasurement";
 export * from "./DistanceMeasurementsControl";
 export * from "./DistanceMeasurementsMouseControl";
+export * from "./DistanceMeasurementsTouchControl";
 export * from "./DistanceMeasurementsPlugin";
 

package/types/plugins/LASLoaderPlugin/LASLoaderPlugin.d.ts

@@ -32,6 +32,10 @@ export declare type LoadLASModel = {
   src?: string;
   /** The LAS file data, as an alternative to the ````src```` parameter. */
   las?: ArrayBuffer;
+  /** Create entity with this id */
+  entityId?: string;
+  /** Creates a MetaModel from json */
+  metaModelJSON?: any;
   /** Whether to load metadata for the LAS model. */
   loadMetadata?: boolean;
   /** The model's World-space double-precision 3D origin. Use this to position the model within xeokit's World coordinate system, using double-precision coordinates. */

package/types/plugins/NavCubePlugin/NavCubePlugin.d.ts

@@ -13,11 +13,11 @@ export declare type NavCubePluginConfiguration = {
   /** Whether the shadow of the cube is visible. */
   shadowVisible?: boolean;
   /** Whether the {@link Camera} flies or jumps to each selected axis or diagonal. */
-  cameraFly?: string;
+  cameraFly?: boolean;
   /** How much of the field-of-view, in degrees, that the 3D scene should fill the {@link Canvas} when the {@link Camera} moves to an axis or diagonal. */
-  cameraFitFOV?: string;
+  cameraFitFOV?: number;
   /** When flying the {@link Camera} to each new axis or diagonal, how long, in seconds, that the Camera takes to get there. */
-  cameraFlyDuration?: string;
+  cameraFlyDuration?: number;
   /** Custom uniform color for the faces of the NavCube. */
   color?: string;
   /** Custom color for the front face of the NavCube. Overrides ````color````. */
@@ -131,18 +131,18 @@ export declare class NavCubePlugin extends Plugin {
      *
      * Default is ````0.5````.
      *
-     * @param {Boolean} value Camera flight duration in seconds.
+     * @param {Number} value Camera flight duration in seconds.
      */
-    setCameraFlyDuration(value: boolean): void;
+    setCameraFlyDuration(value: number): void;
 
     /**
      * When flying the {@link Camera} to each new axis or diagonal, gets how long, in seconds, that the Camera takes to get there.
      *
      * Default is ````0.5````.
      *
-     * @returns {Boolean} Camera flight duration in seconds.
+     * @returns {Number} Camera flight duration in seconds.
      */
-    getCameraFlyDuration(): boolean;
+    getCameraFlyDuration(): number;
 
     /**
      * Sets whether the NavCube switches between perspective and orthographic projections in synchrony with

package/types/plugins/StoreyViewsPlugin/StoreyViewsPlugin.d.ts

@@ -6,6 +6,8 @@ import { StoreyMap } from "./StoreyMap";
 export declare type StoreyViewsPluginConfiguration = {
   /** Optional ID for this plugin, so that we can find it within {@link Viewer.plugins}. */
   id?: string;
+  /** Optional configuration, if enabled, the elements of each floor map image will be proportionally resized to encompass the entire image. This leads to varying scales among different floor map images. If disabled, each floor map image will display the model's extents, ensuring a consistent scale across all images */
+  fitStoreyMaps? : Boolean;
 };
 
 /**
@@ -116,6 +118,23 @@ export declare class StoreyViewsPlugin extends Plugin {
     */
   getStoreyContainingWorldPos(worldPos: number[]): string;
 
+  /**
+   * Gets the ID of the storey which's bounding box contains the y point of the world position
+   * 
+   * @param {Number[]} worldPos 3D World-space position.
+   * @returns {String} ID of the storey containing the position, or null if the position falls outside all the storeys.
+   */
+  getStoreyInVerticalRange(worldPos: number[]): string;
+
+
+  /**
+   * Gets the ID of the storey that contains the given 3D World-space position.
+   *.
+    * @param {Number[]} worldPos 3D World-space position.
+    * @returns {String} ID of the storey containing the position, or null if the position falls outside all the storeys.
+    */
+  isPositionAboveOrBelowBuilding(worldPos: number[]): string;
+
   /**
    * Converts a 3D World-space position to a 2D position within a StoreyMap image.
    *

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

@@ -10,6 +10,7 @@ import { VBOSceneModel } from "../models/VBOSceneModel/VBOSceneModel";
 import { Mesh } from "../mesh";
 import { Node } from "../nodes";
 import { Input } from "../input/input";
+import { SectionPlane } from "../sectionPlane/SectionPlane";
 
 export declare type TickEvent = {
   /** The ID of this Scene. */
@@ -74,6 +75,20 @@ export declare class Scene extends Component {
    */
    on(event: "tick", callback: (tickEvent: TickEvent) => void, scope?: any): string;
 
+   /**
+   * Fires when a section plane is created.
+   * @param {String} event The sectionPlaneCreated event
+   * @param {Function} callback Callback fired on the event
+   */
+   on(event: "sectionPlaneCreated", callback: (measurement: SectionPlane) => void): void;
+
+   /**
+    * Fires when a measurement is destroyed.
+    * @param {String} event The sectionPlaneDestroyed event
+    * @param {Function} callback Callback fired on the event
+    */
+   on(event: "sectionPlaneDestroyed", callback: (measurement: SectionPlane) => void): void;
+
   /**
    * The epoch time (in milliseconds since 1970) when this Scene was instantiated.
    */
@@ -96,6 +111,14 @@ export declare class Scene extends Component {
    */
   get objects(): {[key: string]: Entity};
 
+  /**
+   * Map of {@link SectionPlane}s that represent sliced section planes.
+   *
+   * Each {@link SectionPlane} is mapped here by {@link SectionPlane.id}.
+   * @type {{String:SectionPlane}}
+   */
+  get sectionPlanes(): { [key: string]: SectionPlane };
+
   /**
    * Map of currently visible {@link Entity}s that represent objects.
    *