@xeokit/xeokit-sdk 2.4.2-beta-8 → 2.4.2-beta-10

package/dist/xeokit-sdk.cjs.js

@@ -47356,11 +47356,29 @@ class BCFViewpointsPlugin extends Plugin {
      * @param {String} [cfg.id="BCFViewpoints"] Optional ID for this plugin, so that we can find it within {@link Viewer#plugins}.
      * @param {String} [cfg.originatingSystem] Identifies the originating system for BCF records.
      * @param {String} [cfg.authoringTool] Identifies the authoring tool for BCF records.
+     * @param {Boolean} [cfg.xrayAsZeroAlpha=false] Specifies how xeokit's X-ray emphasis effect is handled in BCF viewpoints. See {@link BCFViewpointsPlugin#xrayAsZeroAlpha} for details.
      */
     constructor(viewer, cfg = {}) {
 
         super("BCFViewpoints", viewer, cfg);
 
+        /**
+         * Specifies how xeokit's X-ray emphasis effect is handled in BCF viewpoints.
+         *
+         * When `xrayAsZeroAlpha` is `true`:
+         *
+         * * when saving a viewpoint, set the `A` channel of each `coloring` component to `0` for each X-rayed object, and
+         * * when loading a viewpoint saved from a xeokit application (i.e. when the viewpoint's `originating_system == "xeokit.io"`), set an object X-rayed if the `A` channel of its corresponding `coloring` component equals `0`
+         *
+         * When `xrayAsZeroAlpha` is `false`:
+         *
+         * * don't save any X-ray information in viewpoints, and
+         * * reset all objects as not X-rayed whenever loading a viewpoint.
+         *
+         * @type {boolean}
+         */
+        this.xrayAsZeroAlpha = !!cfg.xrayAsZeroAlpha;
+
         /**
          * Identifies the originating system to include in BCF viewpoints saved by this plugin.
          * @property originatingSystem
@@ -47549,11 +47567,15 @@ class BCFViewpointsPlugin extends Plugin {
                 let alpha;
 
                 if (entity.xrayed) {
-                    if (scene.xrayMaterial.fillAlpha === 0.0 && scene.xrayMaterial.edgeAlpha !== 0.0) {
-                        // BCF can't deal with edges. If xRay is implemented only with edges, set an arbitrary opacity
-                        alpha = 0.1;
+                    if (this.xrayAsZeroAlpha) {
+                        alpha = 0;
                     } else {
-                        alpha = scene.xrayMaterial.fillAlpha;
+                        if (scene.xrayMaterial.fillAlpha === 0.0 && scene.xrayMaterial.edgeAlpha !== 0.0) {
+                            // BCF can't deal with edges. If xRay is implemented only with edges, set an arbitrary opacity
+                            alpha = 0.1;
+                        } else {
+                            alpha = scene.xrayMaterial.fillAlpha;
+                        }
                     }
                     alpha = Math.round(alpha * 255).toString(16).padStart(2, "0");
                     color = alpha + color;
@@ -47830,7 +47852,16 @@ class BCFViewpointsPlugin extends Plugin {
                         this._withBCFComponent(options, component, entity => {
                             entity.colorize = colorize;
                             if (alphaDefined) {
-                                entity.opacity = alpha;
+                                if (alpha === 0 && this.xrayAsZeroAlpha) {
+                                    const savedFromXeokit = (component.originating_system === this.originatingSystem);
+                                    if (savedFromXeokit) {
+                                        entity.xrayed = true;
+                                    } else {
+                                        entity.opacity = alpha;
+                                    }
+                                } else {
+                                    entity.opacity = alpha;
+                                }
                             }
                         }));
                 });
@@ -66193,28 +66224,33 @@ class TrianglesInstancingLayer {
         if (!this._finalized) {
             throw "Not finalized";
         }
-            var offset = portionId * 4;
 
-            tempFloat32Vec4$2[0] = matrix[0];
-            tempFloat32Vec4$2[1] = matrix[4];
-            tempFloat32Vec4$2[2] = matrix[8];
-            tempFloat32Vec4$2[3] = matrix[12];
+        ////////////////////////////////////////
+        // TODO: Update portion matrix
+        ////////////////////////////////////////
+
+        var offset = portionId * 4;
 
-            this._state.modelMatrixCol0Buf.setData(tempFloat32Vec4$2, offset);
+        tempFloat32Vec4$2[0] = matrix[0];
+        tempFloat32Vec4$2[1] = matrix[4];
+        tempFloat32Vec4$2[2] = matrix[8];
+        tempFloat32Vec4$2[3] = matrix[12];
 
-            tempFloat32Vec4$2[0] = matrix[1];
-            tempFloat32Vec4$2[1] = matrix[5];
-            tempFloat32Vec4$2[2] = matrix[9];
-            tempFloat32Vec4$2[3] = matrix[13];
+        this._state.modelMatrixCol0Buf.setData(tempFloat32Vec4$2, offset);
 
-            this._state.modelMatrixCol1Buf.setData(tempFloat32Vec4$2, offset);
+        tempFloat32Vec4$2[0] = matrix[1];
+        tempFloat32Vec4$2[1] = matrix[5];
+        tempFloat32Vec4$2[2] = matrix[9];
+        tempFloat32Vec4$2[3] = matrix[13];
 
-            tempFloat32Vec4$2[0] = matrix[2];
-            tempFloat32Vec4$2[1] = matrix[6];
-            tempFloat32Vec4$2[2] = matrix[10];
-            tempFloat32Vec4$2[3] = matrix[14];
+        this._state.modelMatrixCol1Buf.setData(tempFloat32Vec4$2, offset);
 
-            this._state.modelMatrixCol2Buf.setData(tempFloat32Vec4$2, offset);
+        tempFloat32Vec4$2[0] = matrix[2];
+        tempFloat32Vec4$2[1] = matrix[6];
+        tempFloat32Vec4$2[2] = matrix[10];
+        tempFloat32Vec4$2[3] = matrix[14];
+
+        this._state.modelMatrixCol2Buf.setData(tempFloat32Vec4$2, offset);
     }
 
     // ---------------------- COLOR RENDERING -----------------------------------
@@ -68559,6 +68595,11 @@ class LinesInstancingLayer {
     }
 
     setMatrix(portionId, matrix) {
+
+        ////////////////////////////////////////
+        // TODO: Update portion matrix
+        ////////////////////////////////////////
+
         if (!this._finalized) {
             throw "Not finalized";
         }
@@ -71946,6 +71987,10 @@ class PointsInstancingLayer {
     }
 
     // setMatrix(portionId, matrix) {
+
+    ////////////////////////////////////////
+    // TODO: Update portion matrix
+    ////////////////////////////////////////
     //
     //     if (!this._finalized) {
     //         throw "Not finalized";
@@ -90953,8 +90998,7 @@ class MetaModel {
      * @property rootMetaObject
      * @type {MetaObject|null}
      */
-    get rootMetaObject()
-    {
+    get rootMetaObject() {
         if (this.rootMetaObjects.length == 1) {
             return this.rootMetaObjects[0];
         }
@@ -90974,6 +91018,7 @@ class MetaModel {
         this._globalizeIDs(metaModelData, options);
 
         const metaScene = this.metaScene;
+        const propertyLookup = metaModelData.properties;
 
         // Create global Property Sets
 
@@ -90982,6 +91027,9 @@ class MetaModel {
                 const propertySetData = metaModelData.propertySets[i];
                 let propertySet = metaScene.propertySets[propertySetData.id];
                 if (!propertySet) {
+                    if (propertyLookup) {
+                        this._decompressProperties(propertyLookup, propertySetData.properties);
+                    }
                     propertySet = new PropertySet({
                         id: propertySetData.id,
                         originalSystemId: propertySetData.originalSystemId || propertySetData.id,
@@ -91027,6 +91075,18 @@ class MetaModel {
         }
     }
 
+    _decompressProperties(propertyLookup, properties) {
+        for (let i = 0, len = properties.length; i < len; i++) {
+            const property = properties[i];
+            if (Number.isInteger(property)) {
+                const lookupProperty = propertyLookup[property];
+                if (lookupProperty) {
+                    properties[i] = lookupProperty;
+                }
+            }
+        }
+    }
+
     finalize() {
 
         if (this.finalized) {

package/dist/xeokit-sdk.es.js

@@ -47352,11 +47352,29 @@ class BCFViewpointsPlugin extends Plugin {
      * @param {String} [cfg.id="BCFViewpoints"] Optional ID for this plugin, so that we can find it within {@link Viewer#plugins}.
      * @param {String} [cfg.originatingSystem] Identifies the originating system for BCF records.
      * @param {String} [cfg.authoringTool] Identifies the authoring tool for BCF records.
+     * @param {Boolean} [cfg.xrayAsZeroAlpha=false] Specifies how xeokit's X-ray emphasis effect is handled in BCF viewpoints. See {@link BCFViewpointsPlugin#xrayAsZeroAlpha} for details.
      */
     constructor(viewer, cfg = {}) {
 
         super("BCFViewpoints", viewer, cfg);
 
+        /**
+         * Specifies how xeokit's X-ray emphasis effect is handled in BCF viewpoints.
+         *
+         * When `xrayAsZeroAlpha` is `true`:
+         *
+         * * when saving a viewpoint, set the `A` channel of each `coloring` component to `0` for each X-rayed object, and
+         * * when loading a viewpoint saved from a xeokit application (i.e. when the viewpoint's `originating_system == "xeokit.io"`), set an object X-rayed if the `A` channel of its corresponding `coloring` component equals `0`
+         *
+         * When `xrayAsZeroAlpha` is `false`:
+         *
+         * * don't save any X-ray information in viewpoints, and
+         * * reset all objects as not X-rayed whenever loading a viewpoint.
+         *
+         * @type {boolean}
+         */
+        this.xrayAsZeroAlpha = !!cfg.xrayAsZeroAlpha;
+
         /**
          * Identifies the originating system to include in BCF viewpoints saved by this plugin.
          * @property originatingSystem
@@ -47545,11 +47563,15 @@ class BCFViewpointsPlugin extends Plugin {
                 let alpha;
 
                 if (entity.xrayed) {
-                    if (scene.xrayMaterial.fillAlpha === 0.0 && scene.xrayMaterial.edgeAlpha !== 0.0) {
-                        // BCF can't deal with edges. If xRay is implemented only with edges, set an arbitrary opacity
-                        alpha = 0.1;
+                    if (this.xrayAsZeroAlpha) {
+                        alpha = 0;
                     } else {
-                        alpha = scene.xrayMaterial.fillAlpha;
+                        if (scene.xrayMaterial.fillAlpha === 0.0 && scene.xrayMaterial.edgeAlpha !== 0.0) {
+                            // BCF can't deal with edges. If xRay is implemented only with edges, set an arbitrary opacity
+                            alpha = 0.1;
+                        } else {
+                            alpha = scene.xrayMaterial.fillAlpha;
+                        }
                     }
                     alpha = Math.round(alpha * 255).toString(16).padStart(2, "0");
                     color = alpha + color;
@@ -47826,7 +47848,16 @@ class BCFViewpointsPlugin extends Plugin {
                         this._withBCFComponent(options, component, entity => {
                             entity.colorize = colorize;
                             if (alphaDefined) {
-                                entity.opacity = alpha;
+                                if (alpha === 0 && this.xrayAsZeroAlpha) {
+                                    const savedFromXeokit = (component.originating_system === this.originatingSystem);
+                                    if (savedFromXeokit) {
+                                        entity.xrayed = true;
+                                    } else {
+                                        entity.opacity = alpha;
+                                    }
+                                } else {
+                                    entity.opacity = alpha;
+                                }
                             }
                         }));
                 });
@@ -66189,28 +66220,33 @@ class TrianglesInstancingLayer {
         if (!this._finalized) {
             throw "Not finalized";
         }
-            var offset = portionId * 4;
 
-            tempFloat32Vec4$2[0] = matrix[0];
-            tempFloat32Vec4$2[1] = matrix[4];
-            tempFloat32Vec4$2[2] = matrix[8];
-            tempFloat32Vec4$2[3] = matrix[12];
+        ////////////////////////////////////////
+        // TODO: Update portion matrix
+        ////////////////////////////////////////
+
+        var offset = portionId * 4;
 
-            this._state.modelMatrixCol0Buf.setData(tempFloat32Vec4$2, offset);
+        tempFloat32Vec4$2[0] = matrix[0];
+        tempFloat32Vec4$2[1] = matrix[4];
+        tempFloat32Vec4$2[2] = matrix[8];
+        tempFloat32Vec4$2[3] = matrix[12];
 
-            tempFloat32Vec4$2[0] = matrix[1];
-            tempFloat32Vec4$2[1] = matrix[5];
-            tempFloat32Vec4$2[2] = matrix[9];
-            tempFloat32Vec4$2[3] = matrix[13];
+        this._state.modelMatrixCol0Buf.setData(tempFloat32Vec4$2, offset);
 
-            this._state.modelMatrixCol1Buf.setData(tempFloat32Vec4$2, offset);
+        tempFloat32Vec4$2[0] = matrix[1];
+        tempFloat32Vec4$2[1] = matrix[5];
+        tempFloat32Vec4$2[2] = matrix[9];
+        tempFloat32Vec4$2[3] = matrix[13];
 
-            tempFloat32Vec4$2[0] = matrix[2];
-            tempFloat32Vec4$2[1] = matrix[6];
-            tempFloat32Vec4$2[2] = matrix[10];
-            tempFloat32Vec4$2[3] = matrix[14];
+        this._state.modelMatrixCol1Buf.setData(tempFloat32Vec4$2, offset);
 
-            this._state.modelMatrixCol2Buf.setData(tempFloat32Vec4$2, offset);
+        tempFloat32Vec4$2[0] = matrix[2];
+        tempFloat32Vec4$2[1] = matrix[6];
+        tempFloat32Vec4$2[2] = matrix[10];
+        tempFloat32Vec4$2[3] = matrix[14];
+
+        this._state.modelMatrixCol2Buf.setData(tempFloat32Vec4$2, offset);
     }
 
     // ---------------------- COLOR RENDERING -----------------------------------
@@ -68555,6 +68591,11 @@ class LinesInstancingLayer {
     }
 
     setMatrix(portionId, matrix) {
+
+        ////////////////////////////////////////
+        // TODO: Update portion matrix
+        ////////////////////////////////////////
+
         if (!this._finalized) {
             throw "Not finalized";
         }
@@ -71942,6 +71983,10 @@ class PointsInstancingLayer {
     }
 
     // setMatrix(portionId, matrix) {
+
+    ////////////////////////////////////////
+    // TODO: Update portion matrix
+    ////////////////////////////////////////
     //
     //     if (!this._finalized) {
     //         throw "Not finalized";
@@ -90949,8 +90994,7 @@ class MetaModel {
      * @property rootMetaObject
      * @type {MetaObject|null}
      */
-    get rootMetaObject()
-    {
+    get rootMetaObject() {
         if (this.rootMetaObjects.length == 1) {
             return this.rootMetaObjects[0];
         }
@@ -90970,6 +91014,7 @@ class MetaModel {
         this._globalizeIDs(metaModelData, options);
 
         const metaScene = this.metaScene;
+        const propertyLookup = metaModelData.properties;
 
         // Create global Property Sets
 
@@ -90978,6 +91023,9 @@ class MetaModel {
                 const propertySetData = metaModelData.propertySets[i];
                 let propertySet = metaScene.propertySets[propertySetData.id];
                 if (!propertySet) {
+                    if (propertyLookup) {
+                        this._decompressProperties(propertyLookup, propertySetData.properties);
+                    }
                     propertySet = new PropertySet({
                         id: propertySetData.id,
                         originalSystemId: propertySetData.originalSystemId || propertySetData.id,
@@ -91023,6 +91071,18 @@ class MetaModel {
         }
     }
 
+    _decompressProperties(propertyLookup, properties) {
+        for (let i = 0, len = properties.length; i < len; i++) {
+            const property = properties[i];
+            if (Number.isInteger(property)) {
+                const lookupProperty = propertyLookup[property];
+                if (lookupProperty) {
+                    properties[i] = lookupProperty;
+                }
+            }
+        }
+    }
+
     finalize() {
 
         if (this.finalized) {