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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xeokit/xeokit-sdk",
-  "version": "2.4.2-beta-9",
+  "version": "2.4.2-beta-10",
   "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/plugins/BCFViewpointsPlugin/BCFViewpointsPlugin.js

@@ -316,11 +316,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
@@ -509,11 +527,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;
@@ -792,7 +814,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;
+                                }
                             }
                         }));
                 });