@xeokit/xeokit-sdk 2.6.108 → 2.6.111

package/package.json

@@ -1,28 +1,19 @@
 {
   "name": "@xeokit/xeokit-sdk",
-  "version": "2.6.108",
+  "version": "2.6.111",
   "description": "3D BIM IFC Viewer SDK for AEC engineering applications. Open Source JavaScript Toolkit based on pure WebGL for top performance, real-world coordinates and full double precision",
   "module": "./dist/xeokit-sdk.es.js",
   "main": "./dist/xeokit-sdk.cjs.js",
   "types": "./types/index.d.ts",
   "scripts": {
-    "build": "rollup --config rollup.config.js; rollup --config rollup.minified.config.js",
-    "dev-build": "rollup --config rollup.dev.config.js",
-    "docs": "rm -Rf ./docs/*; ./node_modules/.bin/esdoc && node docs/.scripts/fix-doc-links.mjs",
-    "typedocs": "rm -Rf ./docs/*; typedoc --tsconfig tsconfig.json",
-    "changelog": "git fetch; auto-changelog --commit-limit false --package --template changelog-template.hbs",
-    "test": "npx percy exec -- npx playwright test"
+    "build":     "node -e \"console.error('WARNING: \\'npm run {build,dev-build,test}\\' scripts and \\'devDependencies\\' are soon going to be deprecated. Install a build tool and execute it directly.\\n');\"; rollup --config rollup.config.js; rollup --config rollup.minified.config.js",
+    "dev-build": "node -e \"console.error('WARNING: \\'npm run {build,dev-build,test}\\' scripts and \\'devDependencies\\' are soon going to be deprecated. Install a build tool and execute it directly.\\n');\"; rollup --config rollup.dev.config.js",
+    "test":      "node -e \"console.error('WARNING: \\'npm run {build,dev-build,test}\\' scripts and \\'devDependencies\\' are soon going to be deprecated. Install a test tool and execute it directly.\\n');\"; npx percy exec -- npx playwright test"
   },
   "repository": {
     "type": "git",
     "url": "https://github.com/xeokit/xeokit-sdk.git"
   },
-  "auto-changelog": {
-    "output": "CHANGELOG.md",
-    "template": "keepachangelog",
-    "unreleased": true,
-    "commitLimit": false
-  },
   "keywords": [
     "ifc-viewer",
     "bim-viewer",
@@ -58,27 +49,16 @@
     "html2canvas": "1.4.1"
   },
   "devDependencies": {
-    "@babel/core": "^7.18.6",
-    "@babel/preset-env": "^7.18.6",
-    "@percy/cli": "^1.30.7",
-    "@percy/playwright": "^1.0.7",
-    "@playwright/test": "^1.49.1",
+    "@babel/core": "^7.29.0",
+    "@babel/preset-env": "^7.29.2",
+    "@percy/cli": "^1.31.11",
+    "@percy/playwright": "^1.1.0",
+    "@playwright/test": "^1.59.1",
     "@rollup/plugin-babel": "^5.3.1",
     "@rollup/plugin-node-resolve": "^13.2.1",
-    "@types/node": "^22.10.6",
-    "auto-changelog": "^2.4.0",
-    "dotenv": "^16.4.7",
-    "esdoc": "1.1.0",
-    "esdoc-custom-theme": "1.4.2",
-    "esdoc-ecmascript-proposal-plugin": "1.0.0",
-    "esdoc-publish-html-plugin": "1.1.2",
-    "esdoc-standard-plugin": "1.0.0",
-    "eslint": "^8.13.0",
-    "parse5": "^7.0.0",
     "rollup": "^2.70.2",
     "rollup-plugin-banner": "^0.2.1",
-    "rollup-plugin-terser": "^7.0.2",
-    "typedoc": "^0.22.15"
+    "rollup-plugin-terser": "^7.0.2"
   },
   "files": [
     "/src",

package/src/plugins/AngleMeasurementsPlugin/AngleMeasurementsPlugin.js

@@ -251,7 +251,7 @@ export class AngleMeasurementsPlugin extends Plugin {
      * @param {Viewer} viewer The Viewer.
      * @param {Object} [cfg]  Plugin configuration.
      * @param {String} [cfg.id="AngleMeasurements"] Optional ID for this plugin, so that we can find it within {@link Viewer#plugins}.
-     * @param {HTMLElement} [cfg.container] Container DOM element for markers and labels. Defaults to ````document.body````.
+     * @param {HTMLElement} [cfg.container] Container DOM element for markers and labels. Defaults to ````document.body````, but different element should be specified to capture it with {@link Viewer.getSnapshotWithPlugins}.
      * @param {string} [cfg.defaultColor=null] The default color of the dots, wire and label.
      * @param {boolean} [cfg.defaultLabelsVisible=true] The default value of {@link AngleMeasurement.labelsVisible}.
      * @param {number} [cfg.zIndex] If set, the wires, dots and labels will have this zIndex (+1 for dots and +2 for labels).

package/src/plugins/AnnotationsPlugin/AnnotationsPlugin.js

@@ -375,7 +375,7 @@ class AnnotationsPlugin extends Plugin {
      * @param {String} [cfg.id="Annotations"] Optional ID for this plugin, so that we can find it within {@link Viewer#plugins}.
      * @param {String} [cfg.markerHTML] HTML text template for Annotation markers. Defaults to ````<div></div>````. Ignored on {@link Annotation}s configured with a ````markerElementId````.
      * @param {String} [cfg.labelHTML] HTML text template for Annotation labels. Defaults to ````<div></div>````.  Ignored on {@link Annotation}s configured with a ````labelElementId````.
-     * @param {HTMLElement} [cfg.container] Container DOM element for markers and labels. Defaults to ````document.body````.
+     * @param {HTMLElement} [cfg.container] Container DOM element for markers and labels. Defaults to ````document.body````, but different element should be specified to capture it with {@link Viewer.getSnapshotWithPlugins}.
      * @param {{String:(String|Number)}} [cfg.values={}] Map of default values to insert into the HTML templates for the marker and label.
      * @param {Number}  [cfg.surfaceOffset=0.3] The amount by which each {@link Annotation} is offset from the surface of
      * its {@link Entity} when we create the Annotation by supplying a {@link PickResult} to {@link AnnotationsPlugin#createAnnotation}.

package/src/plugins/DistanceMeasurementsPlugin/DistanceMeasurementsPlugin.js

@@ -269,7 +269,7 @@ class DistanceMeasurementsPlugin extends Plugin {
    * @param {Object} [cfg]  Plugin configuration.
    * @param {String} [cfg.id="DistanceMeasurements"] Optional ID for this plugin, so that we can find it within {@link Viewer#plugins}.
    * @param {Number} [cfg.labelMinAxisLength=25] The minimum length, in pixels, of an axis wire beyond which its label is shown.
-   * @param {HTMLElement} [cfg.container] Container DOM element for markers and labels. Defaults to ````document.body````.
+   * @param {HTMLElement} [cfg.container] Container DOM element for markers and labels. Defaults to ````document.body````, but different element should be specified to capture it with {@link Viewer.getSnapshotWithPlugins}.
    * @param {boolean} [cfg.defaultVisible=true] The default value of the DistanceMeasurements `visible` property.
    * @param {boolean} [cfg.defaultOriginVisible=true] The default value of the DistanceMeasurements `originVisible` property.
    * @param {boolean} [cfg.defaultTargetVisible=true] The default value of the DistanceMeasurements `targetVisible` property.

package/src/plugins/GLTFLoaderPlugin/GLTFSceneModelLoader.js

@@ -18,6 +18,13 @@ import {
     RepeatWrapping
 } from "../../viewer/scene/constants/constants.js";
 
+const iota = n => {
+    const ret = [ ];
+    for (let i = 0; i < n; ++i)
+        ret.push(i);
+    return ret;
+};
+
 /**
  * @private
  */
@@ -590,6 +597,51 @@ function parseNodeMesh(node, ctx, matrix, meshIds) {
                 meshCfg.color = new Float32Array([1.0, 1.0, 1.0]);
                 meshCfg.opacity = 1.0;
             }
+            const POSITION = primitive.attributes.POSITION;
+            if (!POSITION) {
+                continue;
+            }
+            meshCfg.localPositions = POSITION.value;
+            meshCfg.positions = new Float64Array(meshCfg.localPositions.length);
+            if (primitive.attributes.NORMAL) {
+                meshCfg.normals = primitive.attributes.NORMAL.value;
+            }
+            if (primitive.attributes.TEXCOORD_0) {
+                meshCfg.uv = primitive.attributes.TEXCOORD_0.value;
+            }
+            if (primitive.indices) {
+                meshCfg.indices = primitive.indices.value;
+            }
+            if (matrix) {
+                math.transformPositions3(matrix, meshCfg.localPositions, meshCfg.positions);
+            } else { // eqiv to math.transformPositions3(math.identityMat4(), meshCfg.localPositions, meshCfg.positions);
+                meshCfg.positions.set(meshCfg.localPositions);
+            }
+            const linearize = closeLoop => {
+                const indices = meshCfg.indices || iota(meshCfg.localPositions.length / 3);
+                const len = indices.length;
+                const cnt = closeLoop ? len : (len - 1);
+                const linesIndices = new Uint32Array(cnt * 2);
+                for (let i = 0; i < cnt; ++i) {
+                    const idx = i * 2;
+                    linesIndices[idx]   = indices[i];
+                    linesIndices[idx+1] = indices[(i+1) % len];
+                }
+                meshCfg.indices = linesIndices;
+            };
+            const triangularize = getFirstPoint => {
+                const indices = meshCfg.indices || iota(meshCfg.localPositions.length / 3);
+                const len = indices.length;
+                const cnt = len - 2;
+                const trianglesIndices = new Uint32Array(cnt * 3);
+                for (let i = 0; i < cnt; ++i) {
+                    const idx = i * 3;
+                    trianglesIndices[idx]   = getFirstPoint(indices, i);
+                    trianglesIndices[idx+1] = indices[(i+1) % len];
+                    trianglesIndices[idx+2] = indices[(i+2) % len];
+                }
+                meshCfg.indices = trianglesIndices;
+            };
             const backfaces = ((ctx.backfaces !== false) || (material && material.doubleSided !== false));
             switch (primitive.mode) {
                 case 0: // POINTS
@@ -600,42 +652,26 @@ function parseNodeMesh(node, ctx, matrix, meshIds) {
                     break;
                 case 2: // LINE_LOOP
                     meshCfg.primitive = "lines";
+                    linearize(true);
                     break;
                 case 3: // LINE_STRIP
                     meshCfg.primitive = "lines";
+                    linearize(false);
                     break;
                 case 4: // TRIANGLES
                     meshCfg.primitive = backfaces ? "triangles" : "solid";
                     break;
                 case 5: // TRIANGLE_STRIP
                     meshCfg.primitive = backfaces ? "triangles" : "solid";
+                    triangularize((indices, i) => indices[i]);
                     break;
                 case 6: // TRIANGLE_FAN
                     meshCfg.primitive = backfaces ? "triangles" : "solid";
+                    triangularize((indices, i) => indices[0]);
                     break;
                 default:
                     meshCfg.primitive = backfaces ? "triangles" : "solid";
             }
-            const POSITION = primitive.attributes.POSITION;
-            if (!POSITION) {
-                continue;
-            }
-            meshCfg.localPositions = POSITION.value;
-            meshCfg.positions = new Float64Array(meshCfg.localPositions.length);
-            if (primitive.attributes.NORMAL) {
-                meshCfg.normals = primitive.attributes.NORMAL.value;
-            }
-            if (primitive.attributes.TEXCOORD_0) {
-                meshCfg.uv = primitive.attributes.TEXCOORD_0.value;
-            }
-            if (primitive.indices) {
-                meshCfg.indices = primitive.indices.value;
-            }
-            if (matrix) {
-                math.transformPositions3(matrix, meshCfg.localPositions, meshCfg.positions);
-            } else { // eqiv to math.transformPositions3(math.identityMat4(), meshCfg.localPositions, meshCfg.positions);
-                meshCfg.positions.set(meshCfg.localPositions);
-            }
             const origin = math.vec3();
             const rtcNeeded = worldToRTCPositions(meshCfg.positions, meshCfg.positions, origin); // Small cellsize guarantees better accuracy
             if (rtcNeeded) {

package/src/plugins/XKTLoaderPlugin/XKTLoaderPlugin.js

@@ -896,6 +896,7 @@ class XKTLoaderPlugin extends Plugin {
      * @param {ArrayBuffer} [params.xkt] The *````.xkt````* file data, as an alternative to the ````src```` parameter.
      * @param {String} [params.metaModelSrc] Path or URL to an optional metadata file, as an alternative to the ````metaModelData```` parameter.
      * @param {*} [params.metaModelData] JSON model metadata, as an alternative to the ````metaModelSrc```` parameter.
+     * @param {Boolean} [params.loadIntoMetaScene=true] Whether to load metadata into MetaScene, otherwise expose as SceneModel::metadata.
      * @param {String} [params.manifestSrc] Path or URL to a JSON manifest file that provides paths to ````.xkt```` files to load as parts of the model. Use this option to load models that have been split into
      * multiple XKT files. See [tutorial](https://xeokit.io/blog/automatically-splitting-large-models-for-better-performance) for more info.
      * @param {Object} [params.manifest] A JSON manifest object (as an alternative to a path or URL) that provides paths to ````.xkt```` files to load as parts of the model. Use this option to load models that have been split into
@@ -991,10 +992,30 @@ class XKTLoaderPlugin extends Plugin {
 
         const modelId = sceneModel.id;  // In case ID was auto-generated
 
-        const metaModel = new MetaModel({
-            metaScene: this.viewer.metaScene,
-            id: modelId
-        });
+        const loadIntoMetaScene = (! ("loadIntoMetaScene" in params)) || params.loadIntoMetaScene;
+        const metaModel = (loadIntoMetaScene
+                           ? new MetaModel({
+                               id: modelId,
+                               metaScene: this.viewer.metaScene
+                           })
+                           : (function() {
+                               let firstMetadata = null;
+                               let modelMetadata = null;
+                               return {
+                                   loadData: metadata => {
+                                       if (! firstMetadata) {
+                                           firstMetadata = metadata;
+                                       } else {
+                                           if (! modelMetadata) {
+                                               modelMetadata = { };
+                                               Object.entries(firstMetadata).forEach(([ k, v ]) => modelMetadata[k] = Array.isArray(v) ? v.slice(0) : v);
+                                           }
+                                           Object.entries(metadata).forEach(([ k, v ]) => { if (Array.isArray(v)) { v.forEach(e => modelMetadata[k].push(e)); } });
+                                       }
+                                   },
+                                   finalize: () => sceneModel.metadata = modelMetadata || firstMetadata
+                               };
+                           })());
 
         this.viewer.scene.canvas.spinner.processes++;
 
@@ -1007,7 +1028,7 @@ class XKTLoaderPlugin extends Plugin {
             metaModel.finalize();
             this.viewer.scene.canvas.spinner.processes--;
             sceneModel.once("destroyed", () => {
-                this.viewer.metaScene.destroyMetaModel(metaModel.id);
+                loadIntoMetaScene && this.viewer.metaScene.destroyMetaModel(metaModel.id);
             });
             this.scheduleTask(() => {
                 if (sceneModel.destroyed) {

package/src/viewer/scene/CameraControl/lib/CameraUpdater.js

@@ -117,26 +117,18 @@ class CameraUpdater {
 
             if (updates.rotateDeltaY !== 0 || updates.rotateDeltaX !== 0) {
 
-                if ((!configs.firstPerson) && configs.followPointer && pivotController.getPivoting()) {
-                    pivotController.continuePivot(updates.rotateDeltaY, updates.rotateDeltaX);
-                    pivotController.showPivot();
-
-                } else {
-
+                if (configs.firstPerson) {
                     if (updates.rotateDeltaX !== 0) {
-                        if (configs.firstPerson) {
-                            camera.pitch(-updates.rotateDeltaX);
-                        } else {
-                            camera.orbitPitch(updates.rotateDeltaX);
-                        }
+                        camera.pitch(-updates.rotateDeltaX);
                     }
-
                     if (updates.rotateDeltaY !== 0) {
-                        if (configs.firstPerson) {
-                            camera.yaw(updates.rotateDeltaY);
-                        } else {
-                            camera.orbitYaw(updates.rotateDeltaY);
-                        }
+                        camera.yaw(updates.rotateDeltaY);
+                    }
+                }
+                else {
+                    if (configs.followPointer && pivotController.getPivoting()){
+                        pivotController.continuePivot(updates.rotateDeltaY, updates.rotateDeltaX);
+                        pivotController.showPivot();
                     }
                 }
 

package/src/viewer/scene/model/SceneModel.js

@@ -2998,7 +2998,7 @@ export class SceneModel extends Component {
         const positionsDecodeHash = posDecode ? this._createHashStringFromMatrix(posDecode) : "-";
         const textureSetId = cfg.textureSetId || "-";
         const geometryId = instancing ? cfg.geometryId : "-";
-        const layerId = (instancing ? "instancing" : "batching") + `.${Math.round(origin[0])}.${Math.round(origin[1])}.${Math.round(origin[2])}.${primitive}.${positionsDecodeHash}.${textureSetId}.${geometryId}`;
+        const layerId = (instancing ? "instancing" : "batching") + `.${Math.round(origin[0])}.${Math.round(origin[1])}.${Math.round(origin[2])}.${primitive}.${positionsDecodeHash}.${textureSetId}.${geometryId}.${((cfg.normalsCompressed || cfg.normals || [ ]).length > 0) ? "n" : "-"}`;
 
         if ((! instancing) && (layerId in this._vboLayers)) {
             const layer = this._vboLayers[layerId];

package/src/viewer/scene/model/layer/DTXLayer.js

@@ -586,17 +586,6 @@ export class DTXLayer extends Layer {
         };
 
         return {
-            edgesColorOpaqueAllowed: () => {
-                if (scene.logarithmicDepthBufferEnabled) {
-                    if (!scene._loggedWarning) {
-                        console.log("Edge enhancement for SceneModel data texture layers currently disabled with logarithmic depth buffer");
-                        scene._loggedWarning = true;
-                    }
-                    return false;
-                } else {
-                    return true;
-                }
-            },
             sortId: sortId,
             setClippableFlags: setFlags2,
             setFlags: (portionId, flags, transparent, deferred = false) => {

package/src/viewer/scene/model/layer/Layer.js

@@ -617,9 +617,7 @@ export class Layer {
     }
 
     drawEdgesColorOpaque(renderFlags, frameCtx) {
-        if (this._compiledPortions.edgesColorOpaqueAllowed()) {
-            this.__drawVertexEdges(renderFlags, frameCtx, RENDER_PASSES.EDGES_COLOR_OPAQUE);
-        }
+        this.__drawVertexEdges(renderFlags, frameCtx, RENDER_PASSES.EDGES_COLOR_OPAQUE);
     }
 
     drawEdgesColorTransparent(renderFlags, frameCtx) {

package/src/viewer/scene/model/layer/VBOLayer.js

@@ -570,7 +570,6 @@ export class VBOLayer extends Layer {
 
         const solid = (primitive === "solid");
         return {
-            edgesColorOpaqueAllowed: () => true,
             solid: solid,
             sortId: (((primitive === "points") ? "Points" : ((primitive === "lines") ? "Lines" : "Triangles"))
                      + (instancing ? "Instancing" : "Batching") + "Layer" +

package/types/plugins/AngleMeasurementsPlugin/AngleMeasurementsPlugin.d.ts

@@ -7,7 +7,7 @@ export declare type AngleMeasurementsPluginConfiguration = {
   /** Optional ID for this plugin, so that we can find it within {@link Viewer.plugins}. */
   id?: string;
 
-  /** Container DOM element for markers and labels. Defaults to ````document.body````. */
+  /** Container DOM element for markers and labels. Defaults to ````document.body````, but different element should be specified to capture it with {@link Viewer.getSnapshotWithPlugins}. */
   container?: HTMLElement;
 
   /** The default color of the dots, wire and label. */

package/types/plugins/AnnotationsPlugin/AnnotationsPlugin.d.ts

@@ -9,7 +9,7 @@ export declare type AnnotationsPluginConfiguration = {
   markerHTML?: string;
   /** HTML text template for Annotation labels. Defaults to ````<div></div>````.  Ignored on {@link Annotation}s configured with a ````labelElementId````. */
   labelHTML?: string;
-  /** Container DOM element for markers and labels. Defaults to ````document.body````. */
+  /** Container DOM element for markers and labels. Defaults to ````document.body````, but different element should be specified to capture it with {@link Viewer.getSnapshotWithPlugins}. */
   container?: HTMLElement;
   /** Map of default values to insert into the HTML templates for the marker and label. */
   values?: { [key: string]: string | number };

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

@@ -10,7 +10,7 @@ export declare type DistanceMeasurementsPluginConfiguration = {
   /** The minimum length, in pixels, of an axis wire beyond which its label is shown. */
   labelMinAxisLength?: number;
 
-  /** Container DOM element for markers and labels. Defaults to ````document.body````. */
+  /** Container DOM element for markers and labels. Defaults to ````document.body````, but different element should be specified to capture it with {@link Viewer.getSnapshotWithPlugins}. */
   container?: HTMLElement;
 
   /** The default value of the DistanceMeasurements `visible` property. */

package/types/plugins/XKTLoaderPlugin/XKTLoaderPlugin.d.ts

@@ -32,6 +32,8 @@ export declare type LoadXKTModel = {
     metaModelSrc?: string;
     /** JSON model metadata, as an alternative to the ````metaModelSrc```` parameter. */
     metaModelData?: any;
+    /** Whether to load metadata into MetaScene, otherwise expose as SceneModel::metadata. Defaults to `true`. */
+    loadIntoMetaScene?: boolean;
     /** Path or URL to a JSON manifest file that provides paths or URLs to ````.xkt```` files to load as parts of the model. Use this option to load models that have been split into multiple XKT files. See [tutorial](https://xeokit.io/blog/automatically-splitting-large-models-for-better-performance) for more info.*/
     manifestSrc?: any;
     /** A JSON manifest object (as an alternative to a path or URL) that provides paths or URLs to ````.xkt```` files to load as parts of the model. Use this option to load models that have been split into multiple XKT files. See [tutorial](https://xeokit.io/blog/automatically-splitting-large-models-for-better-performance) for more info. */

package/types/plugins/lib/ui/index.d.ts

@@ -2,8 +2,8 @@ import { Viewer } from "../../../viewer";
 import { PointerCircle } from "../../../extras/PointerCircle";
 import { CameraControl } from "../../../viewer/scene/CameraControl/CameraControl";
 
-type Vec2 = number[]
-type Vec3 = number[]
+type Vec2 = number[];
+type Vec3 = number[];
 type Ray2WorldPos<T> = (origin: Vec3, direction: Vec3) => T | null;
 
 type Cleanup = () => void;
@@ -15,6 +15,6 @@ type OnCommit<T> = (canvasPos: Vec2, worldPos: T | null) => void;
 
 declare function touchPointSelector<T>(viewer: Viewer, pointerCircle: PointerCircle, ray2WorldPos: Ray2WorldPos<T>): (onCancel: OnCancel, onChange: OnChange<T>, onCommit: OnCommit<T>) => Cleanup;
 
-export declare addMousePressListener(element: HTMLElement, onChange: (canvasPos: Vec2 | null) => void);
+export declare function addMousePressListener(element: HTMLElement, onChange: (canvasPos: Vec2 | null) => void): Cleanup;
 
-export declare addTouchPressListener(element: HTMLElement, cameraControl: CameraControl, pointerCircle: PointerCircle, onChange: (canvasPos: Vec2 | null) => void);
+export declare function addTouchPressListener(element: HTMLElement, cameraControl: CameraControl, pointerCircle: PointerCircle, onChange: (canvasPos: Vec2 | null) => void): Cleanup;