zincjs 1.11.7 → 1.12.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zincjs",
-  "version": "1.11.7",
+  "version": "1.12.1",
   "description": "ZincJS (Web-based-Zinc-Visualisation)",
   "main": "build/zinc.js",
   "directories": {

package/src/primitives/glyph.js

@@ -24,6 +24,7 @@ const Glyph = function (geometry, materialIn, idIn, glyphsetIn) {
   let label = undefined;
   let labelString = undefined;
   this.isGlyph = true;
+  let _position = [0, 0, 0];
 
   /**
    * Create a glyph using mesh
@@ -64,8 +65,6 @@ const Glyph = function (geometry, materialIn, idIn, glyphsetIn) {
       if (this.morph)
         this.morph.name = text;
     }
-    if (label)
-      this.showLabel();
   }
 
   /**
@@ -75,19 +74,30 @@ const Glyph = function (geometry, materialIn, idIn, glyphsetIn) {
    */
   this.showLabel = (colour) => {
     if (label) {
-      position = label.getPosition();
+      _position = label.getPosition();
       this.group.remove(label.getSprite());
       label.dispose();
       label = undefined;
     }
     if (labelString && (typeof labelString === 'string' || labelString instanceof String)) {
-      let position = [0, 0, 0];
       label = new (require('./label').Label)(labelString, colour);
-      label.setPosition(position[0], position[1], position[2]);
+      label.setPosition(_position[0], _position[1], _position[2]);
       this.group.add(label.getSprite());
     }
   }
 
+  /**
+   * Hide label with the choosen colour.
+   */
+  this.hideLabel = () => {
+    if (label) {
+      _position = label.getPosition();
+      this.group.remove(label.getSprite());
+      label.dispose();
+      label = undefined;
+    }
+  }
+
   /**
    * Get the label of this glyph
    * @return {Label}
@@ -135,8 +145,10 @@ const Glyph = function (geometry, materialIn, idIn, glyphsetIn) {
       this.morph.matrix.elements[15] = 1.0;
       this.morph.matrixAutoUpdate = false;
     }
-    if (label)
+    _position = [...position];
+    if (label) {
       label.setPosition(position[0], position[1], position[2]);
+    }
   }
 
   /**
@@ -149,7 +161,9 @@ const Glyph = function (geometry, materialIn, idIn, glyphsetIn) {
       label.setColour(color);
     if (this.secondaryMesh && this.secondaryMesh.material)
       this.secondaryMesh.material.color = colour;
-    this.geometry.colorsNeedUpdate = true;
+    if (this.geometry) {
+      this.geometry.colorsNeedUpdate = true;
+    }
   }
 
   /**

package/src/primitives/glyphset.js

@@ -45,6 +45,7 @@ const Glyphset = function () {
   const _current_scales = [];
   const _current_colors = [];
   const _glyph_axis_array = [];
+  this.globalScale = 1;
   for (let i = 0; i < 8; i++) {
     _points[i] = new THREE.Vector3();
   }
@@ -113,7 +114,7 @@ const Glyphset = function () {
       const mirrored_point = [0.0, 0.0, 0.0];
       for (var j = 0; j < 3; j++) {
         var sign = (scale[j] < 0.0) ? -1.0 : 1.0;
-        axis_scale[j] = sign * baseSize[j] + scale[j] * scaleFactors[j];
+        axis_scale[j] = (sign * baseSize[j] + scale[j] * scaleFactors[j]) * this.globalScale;
       }
       for (var j = 0; j < 3; j++) {
         final_axis1[j] = axis1[j] * axis_scale[0];
@@ -168,7 +169,7 @@ const Glyphset = function () {
       let final_point = [0.0, 0.0, 0.0];
       for (var j = 0; j < 3; j++) {
         var sign = (scale[j] < 0.0) ? -1.0 : 1.0;
-        axis_scale[j] = sign * baseSize[0] + scale[j] * scaleFactors[0];
+        axis_scale[j] = (sign * baseSize[0] + scale[j] * scaleFactors[0]) * this.globalScale;
       }
       for (var j = 0; j < 3; j++) {
         final_point[j] = point[j]
@@ -196,7 +197,7 @@ const Glyphset = function () {
           use_axis1 = axis3;
           use_axis2 = axis1;
         }
-        const final_scale1 = baseSize[0] + use_scale * scaleFactors[0];
+        const final_scale1 = (baseSize[0] + use_scale * scaleFactors[0]) * this.globalScale;
         final_axis1[0] = use_axis1[0] * final_scale1;
         final_axis1[1] = use_axis1[1] * final_scale1;
         final_axis1[2] = use_axis1[2] * final_scale1;
@@ -205,7 +206,7 @@ const Glyphset = function () {
         final_axis3[2] = final_axis1[0] * use_axis2[1] - final_axis1[1] * use_axis2[0];
         let magnitude = Math.sqrt(final_axis3[0] * final_axis3[0] + final_axis3[1] * final_axis3[1] + final_axis3[2] * final_axis3[2]);
         if (0.0 < magnitude) {
-          let scaling = (baseSize[2] + use_scale * scaleFactors[2]) / magnitude;
+          let scaling = (baseSize[2] + use_scale * scaleFactors[2]) * this.globalScale / magnitude;
           if ((repeat_mode == "AXES_2D") && (k > 0)) {
             scaling *= -1.0;
           }
@@ -219,7 +220,7 @@ const Glyphset = function () {
         final_axis2[2] = final_axis3[0] * final_axis1[1] - final_axis3[1] * final_axis1[0];
         magnitude = Math.sqrt(final_axis2[0] * final_axis2[0] + final_axis2[1] * final_axis2[1] + final_axis2[2] * final_axis2[2]);
         if (0.0 < magnitude) {
-          var scaling = (baseSize[1] + use_scale * scaleFactors[1]) / magnitude;
+          var scaling = (baseSize[1] + use_scale * scaleFactors[1]) * this.globalScale / magnitude;
           final_axis2[0] *= scaling;
           final_axis2[1] *= scaling;
           final_axis2[2] *= scaling;
@@ -282,9 +283,10 @@ const Glyphset = function () {
           _transformMatrix.elements[15] = 1.0;
           this.morph.setMatrixAt(current_glyph_index, _transformMatrix);
           const glyph = glyphList[current_glyph_index];
-          if (glyph)
+          if (glyph) {
             glyph.setTransformation(arrays[j][0], arrays[j][1],
               arrays[j][2], arrays[j][3]);
+          }
           current_glyph_index++;
         }
       }
@@ -323,12 +325,12 @@ const Glyphset = function () {
    * the internal time has been updated.
    */
   const updateMorphGlyphsets = () => {
-    const current_positions = _current_positions;
-    const current_axis1s = _current_axis1s;
-    const current_axis2s = _current_axis2s;
-    const current_axis3s = _current_axis3s;
-    const current_scales = _current_scales;
-    const current_colors = _current_colors;
+    let current_positions = _current_positions;
+    let current_axis1s = _current_axis1s;
+    let current_axis2s = _current_axis2s;
+    let current_axis3s = _current_axis3s;
+    let current_scales = _current_scales;
+    let current_colors = _current_colors;
 
     const current_time = this.inbuildTime / this.duration * (numberOfTimeSteps - 1);
     const bottom_frame = Math.floor(current_time);
@@ -402,27 +404,36 @@ const Glyphset = function () {
     }
   }
 
+  /**
+   * Hide label with the choosen colour.
+   */
+    this.hideLabel = () => {
+      for (let i = 0; i < glyphList.length; i++) {
+        glyphList[i].hideLabel();
+      }
+    }
+
   /**
    * Create the glyphs in the glyphset.
    * 
    * @param {Boolean} displayLabels -Flag to determine either the labels should be display or not.
    */
   const createGlyphs = (displayLabels) => {
-    if ((labels != undefined) && displayLabels) {
-      for (let i = 0; i < numberOfVertices; i++) {
-        const glyph = new (require('./glyph').Glyph)(undefined, undefined, i, this);
-        if (labels != undefined && labels[i] != undefined) {
-          glyph.setLabel(labels[i]);
-        }
-        if (numberOfTimeSteps > 0) {
-          glyph.setFrustumCulled(false);
-        }
-        glyphList[i] = glyph;
-        this.morph.add(glyph.getGroup());
+    for (let i = 0; i < numberOfVertices; i++) {
+      const glyph = new (require('./glyph').Glyph)(undefined, undefined, i, this);
+      let label = labels ? labels[i] : undefined;
+      label = label ? label : this.groupName;
+      if (label) {
+        glyph.setLabel(label);
+      }
+      if (numberOfTimeSteps > 0) {
+        glyph.setFrustumCulled(false);
       }
+      glyphList[i] = glyph;
+      this.morph.add(glyph.getGroup());
     }
-    if ((labels != undefined) && displayLabels) {
-      this.showLabel(this.morph.material ? this.morph.material.color : undefined);
+    if (displayLabels) {
+      this.showLabel();
     }
     //Update the transformation of the glyphs.
     updateGlyphsetTransformation(positions["0"], axis1s["0"],
@@ -624,6 +635,15 @@ const Glyphset = function () {
     return this.inbuildTime;
   }
 
+  /**
+   * Set the objects scale.
+   * 
+   * @return {THREE.Box3}.
+   */
+  this.setScaleAll = function(scale) {
+    this.globalScale = scale;
+    updateMorphGlyphsets();
+  }
 
   /**
    * Clear this glyphset and its list of glyphs which will release them from the memory.

package/src/primitives/label.js

@@ -73,7 +73,7 @@ exports.Label = function (textIn, colour) {
    * Free up the memory
    */
   this.dispose = () => {
-    sprite.dispose();
+    //sprite.dispose();
   }
 
   /**

package/src/primitives/zincObject.js

@@ -707,8 +707,6 @@ ZincObject.prototype.addVertices = function(coords) {
 
 /**
  * Set the objects position.
- * 
- * @return {THREE.Box3}.
  */
 ZincObject.prototype.setPosition = function(x, y, z) {
   const group = this.getGroup();
@@ -726,8 +724,6 @@ ZincObject.prototype.loadAdditionalSources = function(primitivesLoader, sources)
 
 /**
  * Set the objects scale.
- * 
- * @return {THREE.Box3}.
  */
 ZincObject.prototype.setScaleAll = function(scale) {
   const group = this.getGroup();

package/src/scene.js

@@ -465,9 +465,11 @@ exports.Scene = function (containerIn, rendererIn) {
    * @param {String} url - Location of the metafile
    * @param {Function} finishCallback - Callback function which will be called
    * for each glyphset and geometry that has been written in.
+   * @param {options} Optional settings, it can be used to ignore some regions/groups
+    * in the metadata file. Only supports version 1 at this moment.
    */
-  this.loadMetadataURL = (url, finishCallback, allCompletedCallback) => {
-    sceneLoader.loadMetadataURL(rootRegion, url, finishCallback, allCompletedCallback);
+  this.loadMetadataURL = (url, finishCallback, allCompletedCallback, options) => {
+    sceneLoader.loadMetadataURL(rootRegion, url, finishCallback, allCompletedCallback, options);
   }
 
   /**

package/src/sceneLoader.js

@@ -1,6 +1,7 @@
 const THREE = require('three');
 const resolveURL = require('./utilities').resolveURL;
 const createNewURL = require('./utilities').createNewURL;
+const isRegionGroup = require('./utilities').isRegionGroup;
 
 const STLLoader = require('./loaders/STLLoader').STLLoader;
 const OBJLoader = require('./loaders/OBJLoader').OBJLoader;
@@ -803,6 +804,48 @@ exports.SceneLoader = function (sceneIn) {
     }
   }
 
+  let filterPrimitivesArray = (array, options) => {
+    let newArray = array;
+    const include = options?.enabled?.include;
+    const exclude = options?.enabled?.exclude;
+    if (include?.length || exclude?.length) {
+      if (include) {
+        newArray = array.filter((item) => {
+          if (item.Type === "View") {
+            return true;
+          }
+          for (let i = 0; i < include.length; i++) {
+            if (isRegionGroup(item.RegionPath, item.GroupName, include[i])) {
+              return true;
+            }
+          }
+          return false;
+        });
+      }
+      if (exclude) {
+        newArray = newArray.filter((item) => {
+          if (item.Type === "View") {
+            return true;
+          }
+          for (let i = 0; i < exclude.length; i++) {
+            if (isRegionGroup(item.RegionPath, item.GroupName, exclude[i])) {
+              return false;
+            }
+          }
+          return true;
+        });
+      }
+    }
+    return newArray;
+  }
+
+  let filterMetadataInArray = (metadata, options) => {
+    if (Array.isArray(metadata)) {
+      return filterPrimitivesArray(metadata, options);
+    }
+    return metadata;
+  }
+
   let getNumberOfDownloadsInArray = (array, includeViews) => {
     if (Array.isArray(array)) {
       let count = 0;
@@ -853,15 +896,16 @@ exports.SceneLoader = function (sceneIn) {
     readPrimitivesItem(targetRegion, referenceURL, item, order * 2, callback);
   }
 
-  let loadVersionOne = (targetRegion, metadata, referenceURL, finishCallback, allCompletedCallback) => {
-    let numberOfObjects = getNumberOfObjects(metadata);
+  let loadVersionOne = (targetRegion, metadata, referenceURL, finishCallback, allCompletedCallback, options) => {
+    const filteredMetada = filterMetadataInArray(metadata, options);
+    let numberOfObjects = getNumberOfObjects(filteredMetada);
     // view file does not receive callback
     let callback = new metaFinishCallback(numberOfObjects, finishCallback, allCompletedCallback);
     // Prioritise the view file and settings before loading anything else
     for (let i = 0; i < metadata.length; i++)
-      readViewAndSettingsItem(referenceURL, metadata[i], callback);
+      readViewAndSettingsItem(referenceURL, filteredMetada[i], callback);
     for (let i = 0; i < metadata.length; i++) {
-      readVersionOneRegionPath(targetRegion, referenceURL, metadata[i], i, callback);
+      readVersionOneRegionPath(targetRegion, referenceURL, filteredMetada[i], i, callback);
     }
   }
 
@@ -881,11 +925,13 @@ exports.SceneLoader = function (sceneIn) {
     * Load a metadata file from the provided URL into this scene. Once
     * succssful scene proceeds to read each items into scene for visualisations.
     * 
-    * @param {String} url - Location of the metafile
+    * @param {String} url - Location of the metadata file
     * @param {Function} finishCallback - Callback function which will be called
+    * @param {options} Optional settings, it can be used to ignore some regions/groups
+    * in the metadata file. Only supports version 1 at this moment.
     * for each glyphset and geometry that has been written in.
     */
-  this.loadMetadataURL = (targetRegion, url, finishCallback, allCompletedCallback) => {
+  this.loadMetadataURL = (targetRegion, url, finishCallback, allCompletedCallback, options) => {
     const xmlhttp = new XMLHttpRequest();
     const requestURL = resolveURL(url);
     xmlhttp.onreadystatechange = () => {
@@ -898,7 +944,7 @@ exports.SceneLoader = function (sceneIn) {
           referenceURL = (new URL(requestURL)).href;
         const metadata = JSON.parse(xmlhttp.responseText);
         if (Array.isArray(metadata)) {
-          loadVersionOne(targetRegion, metadata, referenceURL, finishCallback, allCompletedCallback);
+          loadVersionOne(targetRegion, metadata, referenceURL, finishCallback, allCompletedCallback, options);
         } else if (typeof metadata === "object" && metadata !== null) {
           if (metadata.Version == "2.0") {
             loadVersionTwo(targetRegion, metadata, referenceURL, finishCallback, allCompletedCallback);

package/src/utilities.js

@@ -472,6 +472,40 @@ function createNewSpriteText(text, height, colour, font, pixel, weight) {
   return sprite;
 }
 
+/*
+ * Check if the compare path match with the region or/and group.
+ * comparePath should be in the form of regionPath/Group.
+ * * can be used as wildcard.
+ * comparePath will be used to compare both region and group if it
+ * is a single string without /
+ */
+function isRegionGroup(regionPath, groupName, comparePath) {
+  if (comparePath) {
+    const region = regionPath ? regionPath : "";
+    const group = groupName ? groupName : "";
+    const n = comparePath.lastIndexOf('/');
+    if (n > -1) {
+      let r = undefined;
+      let g = undefined;
+      r = comparePath.substring(0, n);
+      g = comparePath.substring(n + 1);
+      if (r === "*" || r === "**" || r.toLowerCase() === region.toLowerCase()) {
+        if (g === "*" || g === "**" || g.toLowerCase() === group.toLowerCase()) {
+          return true;
+        }
+      }
+    } else {
+      //one single value if one of the region / group matches
+      if (region.toLowerCase() === comparePath.toLowerCase() ||
+        group.toLowerCase() === comparePath.toLowerCase()) {
+        return true;
+      }
+    }
+  }
+
+  return false;
+}
+
 exports.getBoundingBox = getBoundingBox;
 exports.createNewURL = createNewURL;
 exports.createBufferGeometry = createBufferGeometry;
@@ -481,3 +515,4 @@ exports.loadExternalFile = loadExternalFile;
 exports.loadExternalFiles = loadExternalFiles;
 exports.PhongToToon = PhongToToon;
 exports.createNewSpriteText = createNewSpriteText;
+exports.isRegionGroup = isRegionGroup;