zincjs 1.16.0 → 1.16.2

package/package.json

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

package/src/primitives/label.js

@@ -1,12 +1,12 @@
 const SpriteText = require('three-spritetext').default;
 
 /**
- * Bitmap labels, this is used with {@link Glyph} to 
+ * Bitmap labels, this is used with {@link Glyph} to
  * provide labels.
- * 
+ *
  * @param {String} textIn - Text to be displayed dwith the label.
  * @param {THREE.Color} colour - Colour to be set for the label.
- * 
+ *
  * @class
  * @author Alan Wu
  * @return {Label}
@@ -28,7 +28,7 @@ exports.Label = function (textIn, colour) {
   /**
    * Get the current position in an array containing the x, y and z
    * coordinates.
-   * 
+   *
    * @return {Array}
    */
   this.getPosition = () => {
@@ -39,7 +39,7 @@ exports.Label = function (textIn, colour) {
 
   /**
    * Set the position of the label in  3D coordinates.
-   * 
+   *
    * @param {Number} x - x coordinate to be set.
    * @param {Number} y - y coordinate to be set.
    * @param {Number} z - z coordinate to be set.
@@ -52,16 +52,19 @@ exports.Label = function (textIn, colour) {
 
   /**
    * Set the colour of the label
-   * 
+   *
    * @param {THREE.Color} colour - colour to be set
    */
   this.setColour = colour => {
-    sprite.color = colour.getStyle();
+    console.log(sprite)
+    if (colour) {
+      sprite.color = colour.getStyle();
+    }
   }
 
   /**
    * Scale the label.
-   * 
+   *
    * @param {Number} scaling - Scale to be set.
    */
   this.setScale = scaling => {
@@ -78,7 +81,7 @@ exports.Label = function (textIn, colour) {
 
   /**
    * Get the intrnal sprite.
-   * 
+   *
    * @return {THREE.Sprite}
    */
   this.getSprite = () => {
@@ -87,7 +90,7 @@ exports.Label = function (textIn, colour) {
 
   /**
    * Get the text.
-   * 
+   *
    * @return {String}
    */
   this.getString = () => {

package/src/primitives/pointset.js

@@ -8,7 +8,7 @@ const Label = require('./label').Label;
  * Provides an object which stores points and provides method which controls its position.
  * This is created when a valid json file containing point is read into a {@link Zinc.Scene}
  * object.
- * 
+ *
  * @class
  * @author Alan Wu
  * @return {Pointset}
@@ -20,7 +20,7 @@ const Pointset = function () {
 
   /**
    * Create the pointsets using geometry and material.
-   * 
+   *
    * @param {THREE.Geomtry} geometryIn - Geometry of points to be rendered.
    * @param {THREE.Material} materialIn - Material to be set for the lines.
    * @param {Object} options - Provide various options
@@ -35,7 +35,7 @@ const Pointset = function () {
       const texture = getCircularTexture();
       materialIn.map = texture;
       let point = new Points(geometry, materialIn);
-      this.setMesh(point, options.localTimeEnabled, 
+      this.setMesh(point, options.localTimeEnabled,
         options.localMorphColour);
     }
   }
@@ -78,7 +78,7 @@ const Pointset = function () {
       }
       let end = current + coords.length;
       let index = 0;
-      if ((Array.isArray(labels) && labels.length === coords.length) || 
+      if ((Array.isArray(labels) && labels.length === coords.length) ||
         (typeof labels === "string")) {
         for (current; current + index < end;) {
           const labelText = typeof labels === "string" ? labels : labels[index];
@@ -90,9 +90,40 @@ const Pointset = function () {
     }
   }
 
+    /**
+   * Set the colour of the pointset and its label using the hex value
+   *
+   * @param {Number} hex - hex value of color to be set
+   */
+  this.setColourHex = function(hex) {
+    this._lod._material.color.setHex(hex);
+    if (this._lod._secondaryMaterial) {
+      this._lod._secondaryMaterial.color.setHex(hex);
+    }
+    for (let i = 0; i < labelSets.length; i++) {
+      if (labelSets[i]) {
+        labelSets[i].setColour(this._lod._material.color);
+      }
+    }
+  }
+
+  /**
+   * Set the colour of the pointset and its label
+   *
+   * @param {THREE.Color} colour - colour to be set
+   */
+  this.setColour = (colour) => {
+    this._lod.setColour(colour);
+    for (let i = 0; i < labelSets.length; i++) {
+      if (labelSets[i]) {
+        labelSets[i].setColour(this._lod._material.color);
+      }
+    }
+  }
+
   /**
    * Set the size of the points.
-   * 
+   *
    * @param {Number} size - size to be set.
    */
   this.setSize = size => {
@@ -104,7 +135,7 @@ const Pointset = function () {
 
   /**
    * Turn size attenuation on/off based on the flag.
-   * 
+   *
    * @param {Boolean} flag - Determin either size attenuation
    * should be on or off.
    */
@@ -121,7 +152,7 @@ const Pointset = function () {
   this.getVerticesByIndex = function(index) {
     if (index >= 0 && this.drawRange > index) {
       const positionAttribute = this.getMorph().geometry.getAttribute( 'position' );
-      return [ 
+      return [
         positionAttribute.getX(index),
         positionAttribute.getY(index),
         positionAttribute.getZ(index)
@@ -148,7 +179,7 @@ const Pointset = function () {
             label.setPosition(coord[0], coord[1], coord[2]);
           }
           positionAttribute.setXYZ(index++, coord[0], coord[1], coord[2]);
-          
+
         });
         positionAttribute.needsUpdate = true;
         this.boundingBoxUpdateRequired = true;
@@ -158,7 +189,7 @@ const Pointset = function () {
 
   /**
  * Turn size attenuation on/off based on the flag.
- * 
+ *
  * @param {Boolean} flag - Determin either size attenuation
  * should be on or off.
  */

package/src/primitives/texturePrimitive.js

@@ -2,7 +2,7 @@ const THREE = require('three');
 const resolveURL = require('../utilities').resolveURL;
 /**
  * Provides a base class object which stores textures and rendering object.
- * 
+ *
  * @class
  * @author Alan Wu
  * @return {TexturePrimitive}
@@ -14,7 +14,7 @@ const TexturePrimitive = function (textureIn) {
 
   /**
    * Load texture data into this primitves.
-   * 
+   *
    * @param {Object} textureData - contains the informations about the textures.
    * @param {Function} finishCallback - User's function to be called once texture's
    *  is loaded.
@@ -39,7 +39,7 @@ const TexturePrimitive = function (textureIn) {
   /**
    * Initialise a texture based on the provided textureData, this should be used
    * internally only.
-   * 
+   *
    * @param {Object} textureData - contains the informations about the textures.
    * @param {Function} finishCallback - User's function to be called once texture's
    *  is loaded.

package/src/primitives/textureSlides.js

@@ -3,10 +3,10 @@ const shader = require("../shaders/textureSlide.js");
 /**
  * Provides a class which create a texture stacks in a block
  * with shaders allowing slices of texture to be displayed.
- * 
+ *
  * @param {TextureArray} textureIn - An object of texture array
  * holding texture information.
- * 
+ *
  * @class
  * @author Alan Wu
  * @return {TextureSlides}
@@ -29,13 +29,13 @@ const TextureSlides = function (textureIn) {
     direction the slide should be facing.
     @property {Number} value - Normalised value of the location on direction.
     @property {String} id - ID of the mesh, it is only available if the settings
-    is returned from {@link TextureSlides.createSlide} or 
+    is returned from {@link TextureSlides.createSlide} or
     {@link TextureSlides.getTextureSettings}.
    */
   /**
    * Create the slides required for visualisation based on the slide settings.
    * The slides themselves are {THREE.PlanGeometry} objects.
-   * 
+   *
    * @param {SLIDE_SETTINGS} slideSettings - An array to each slide settings.
    */
   this.createSlides = slideSettings => {
@@ -114,7 +114,7 @@ const TextureSlides = function (textureIn) {
         uniforms.diffuse.value = this.texture.impl;
         uniforms.depth.value = this.texture.size.depth;
         uniforms.flipY.value = flipY;
-        
+
         const options = {
           fs: shader.fs,
           vs: shader.vs,
@@ -259,7 +259,7 @@ const TextureSlides = function (textureIn) {
    * Get the bounding box of this slides.
    * It uses the max and min of the slides position and the
    * transformation to calculate the position of the box.
-   * 
+   *
    * @return {THREE.Box3}.
    */
   this.getBoundingBox = () => {

package/src/primitives/tubeLines.js

@@ -101,7 +101,7 @@ const TubeLines = function () {
         if (smooth) {
             const curve = new THREE.CatmullRomCurve3(vertices);
             finalGeometry = new THREE.TubeGeometry(curve, vertices.length, radius, radialSegments, false);
-        } else {           
+        } else {
             const geometries = [];
             for (let i = 0; i + 1 < vertices.length; i = i + 2) {
                 const curve = new THREE.LineCurve3(vertices[i], vertices[i+1]);

package/src/sceneLoader.js

@@ -10,7 +10,7 @@ const PrimitivesLoader = require('./loaders/primitivesLoader').PrimitivesLoader;
 /**
  * A helper class to help with reading / importing primitives and
  * settings into a {@link Scene}.
- * 
+ *
  * @class
  * @param {Object} containerIn - Container to create the renderer on.
  * @author Alan Wu
@@ -27,7 +27,7 @@ exports.SceneLoader = function (sceneIn) {
    * This function returns a three component array, which contains
    * [totalsize, totalLoaded and errorDownload] of all the downloads happening
    * in this scene.
-   * @returns {Array} 
+   * @returns {Array}
    */
   this.getDownloadProgress = () => {
     let totalSize = 0;
@@ -134,7 +134,7 @@ exports.SceneLoader = function (sceneIn) {
 /**
    * Load a legacy model(s) format with the provided URLs and parameters. This only loads the geometry
    * without any of the metadata. Therefore, extra parameters should be provided.
-   * 
+   *
    * @deprecated
    */
   this.loadModelsURL = (region, urls, colours, opacities, timeEnabled, morphColour, finishCallback) => {
@@ -160,10 +160,10 @@ exports.SceneLoader = function (sceneIn) {
   }
 
    /**
-   * Load a legacy file format containing the viewport and its meta file from an external 
+   * Load a legacy file format containing the viewport and its meta file from an external
    * location provided by the url. Use the new metadata format with
    * {@link Zinc.SceneLoader.#loadMetadataURL} instead.
-   * 
+   *
    * @param {String} URL - address to the file containing viewport and model information.
    * @deprecated
    */
@@ -223,11 +223,11 @@ exports.SceneLoader = function (sceneIn) {
       if (finishCallback != undefined && (typeof finishCallback == 'function'))
         finishCallback(newLines);
     };
-  } 
+  }
 
   /**
    * Load lines into this scene object.
-   * 
+   *
    * @param {Boolean} timeEnabled - Indicate if  morphing is enabled.
    * @param {Boolean} morphColour - Indicate if color morphing is enabled.
    * @param {STRING} groupName - name to assign the pointset's groupname to.
@@ -251,7 +251,7 @@ exports.SceneLoader = function (sceneIn) {
       (linesloader(region, localTimeEnabled, localMorphColour, groupName, anatomicalId,
         renderOrder, options.lod, tubeLines, finishCallback))( object.geometry, object.materials );
     } else {
-      primitivesLoader.load(url, linesloader(region, localTimeEnabled, localMorphColour, groupName, 
+      primitivesLoader.load(url, linesloader(region, localTimeEnabled, localMorphColour, groupName,
         anatomicalId, renderOrder, options.lod, tubeLines, finishCallback), this.onProgress(url), this.onError(finishCallback),
         options.loaderOptions);
     }
@@ -326,8 +326,8 @@ exports.SceneLoader = function (sceneIn) {
 
   /**
    * Read a STL file into this scene, the geometry will be presented as
-   * {@link Zinc.Geometry}. 
-   * 
+   * {@link Zinc.Geometry}.
+   *
    * @param {STRING} url - location to the STL file.
    * @param {STRING} groupName - name to assign the geometry's groupname to.
    * @param {Function} finishCallback - Callback function which will be called
@@ -345,8 +345,8 @@ exports.SceneLoader = function (sceneIn) {
 
   /**
    * Read a OBJ file into this scene, the geometry will be presented as
-   * {@link Zinc.Geometry}. 
-   * 
+   * {@link Zinc.Geometry}.
+   *
    * @param {STRING} url - location to the STL file.
    * @param {STRING} groupName - name to assign the geometry's groupname to.
    * @param {Function} finishCallback - Callback function which will be called
@@ -363,10 +363,10 @@ exports.SceneLoader = function (sceneIn) {
   }
 
   /**
-   * Load a geometry into this scene, this is a subsequent called from 
+   * Load a geometry into this scene, this is a subsequent called from
    * {@link Zinc.Scene#loadMetadataURL}, although it can be used to read
    * in geometry into the scene externally.
-   * 
+   *
    * @param {String} url - regular json model file providing geometry.
    * @param {Boolean} timeEnabled - Indicate if geometry morphing is enabled.
    * @param {Boolean} morphColour - Indicate if color morphing is enabled.
@@ -432,14 +432,14 @@ exports.SceneLoader = function (sceneIn) {
           if (zincCameraControls) {
             zincCameraControls.calculateMaxAllowedDistance(scene);
           }
-        }        
+        }
       }
     };
   };
 
   /**
    * Load a pointset into this scene object.
-   * 
+   *
    * @param {Boolean} timeEnabled - Indicate if  morphing is enabled.
    * @param {Boolean} morphColour - Indicate if color morphing is enabled.
    * @param {STRING} groupName - name to assign the pointset's groupname to.
@@ -487,6 +487,8 @@ exports.SceneLoader = function (sceneIn) {
       if (newTexture) {
         newTexture.groupName = groupName;
         let myCallback = () => {
+          //Add zincObject after it has sort out all the required download
+          region.addZincObject(newTexture);
           --this.toBeDownloaded;
           if (finishCallback != undefined && (typeof finishCallback == 'function'))
             finishCallback(newTexture);
@@ -495,7 +497,6 @@ exports.SceneLoader = function (sceneIn) {
         newTexture.load(textureData, myCallback, isInline);
         newTexture.setAnatomicalId(anatomicalId);
         newTexture.setRenderOrder(renderOrder);
-        region.addZincObject(newTexture);
       }
     }
   };
@@ -513,7 +514,7 @@ exports.SceneLoader = function (sceneIn) {
 
   /**
    * Load a texture into this scene object.
-   * 
+   *
    * @param {STRING} groupName - name to assign the pointset's groupname to.
    * @param {Function} finishCallback - Callback function which will be called
    * once the glyphset is succssfully load in.
@@ -533,8 +534,8 @@ exports.SceneLoader = function (sceneIn) {
 
   /**
    * Load a glyphset into this scene object.
-   * 
-   * @param {String} metaurl - Provide informations such as transformations, colours 
+   *
+   * @param {String} metaurl - Provide informations such as transformations, colours
    * and others for each of the glyph in the glyphsset.
    * @param {String} glyphurl - regular json model file providing geometry of the glyph.
    * @param {String} groupName - name to assign the glyphset's groupname to.
@@ -556,7 +557,7 @@ exports.SceneLoader = function (sceneIn) {
 
  /**
    * Add a user provided {THREE.Geometry} into  the scene as zinc geometry.
-   * 
+   *
    * @param {Three.Geometry} geometry - The threejs geometry to be added as {@link Zinc.Geometry}.
    * @param {THREE.Color} color - Colour to be assigned to this geometry, overrided if materialIn is provided.
    * @param {Number} opacity - Opacity to be set for this geometry, overrided if materialIn is provided.
@@ -565,7 +566,7 @@ exports.SceneLoader = function (sceneIn) {
    * @param {Boolean} external - Set this to true if morph geometry is present, overrided if materialIn is provided.
    * @param {Function} finishCallback - Callback once the geometry has been added succssfully.
    * @param {THREE.Material} materialIn - Material to be set for this geometry if it is present.
-   * 
+   *
    * @returns {Zinc.Geometry}
    */
   const addZincGeometry = (
@@ -621,7 +622,7 @@ exports.SceneLoader = function (sceneIn) {
       if (materials && materials[0]) {
         material = materials[0];
       }
-      const zincGeometry = addZincGeometry(region, geometry, colour, opacity, 
+      const zincGeometry = addZincGeometry(region, geometry, colour, opacity,
         localTimeEnabled, localMorphColour, undefined, material, groupName, renderOrder, anatomicalId);
       if (options.lod && options.lod.levels) {
         for (const [key, value] of Object.entries(options.lod.levels)) {
@@ -639,7 +640,7 @@ exports.SceneLoader = function (sceneIn) {
   //Turn ISO 8601 duration string into an array.
   const parseDuration = (durationString) => {
     const regex = /P(?:(\d+)Y)?(?:(\d+)M)?(?:(\d+)W)?(?:(\d+)D)?(?:T(?:(\d+)H)?(?:(\d+)M)?(?:(\d+)S)?)?$/;
-    const [, years, months, weeks, days, hours, mins, secs] = 
+    const [, years, months, weeks, days, hours, mins, secs] =
       durationString.match(regex);
     return {years: years,months: months, weeks: weeks, days: days,
             hours: hours, mins: mins, secs: secs };
@@ -708,7 +709,7 @@ exports.SceneLoader = function (sceneIn) {
         lod: lod,
         renderOrder: order
       };
-      
+
       switch (item.Type) {
         case "Surfaces":
           loadSurfaceURL(region, newURL, item.MorphVertices, item.MorphColours, groupName, finishCallback, options);
@@ -776,7 +777,7 @@ exports.SceneLoader = function (sceneIn) {
 
   /**
    * Load GLTF into this scene object.
-   * 
+   *
    * @param {String} url - URL to the GLTF file
    * @param {Function} finishCallback - Callback function which will be called
    * once the glyphset is succssfully load in.
@@ -879,7 +880,7 @@ exports.SceneLoader = function (sceneIn) {
   }
 
   let getNumberOfObjectsInRegions = (regionJson) => {
-    let counts = regionJson.Primitives ? 
+    let counts = regionJson.Primitives ?
       getNumberOfDownloadsInArray(regionJson.Primitives, false) : 0;
     if (regionJson.Children) {
       Object.values(regionJson.Children).forEach(childRegion => {
@@ -936,7 +937,7 @@ 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 metadata file
     * @param {Function} finishCallback - Callback function which will be called
     * @param {options} Optional settings, it can be used to ignore some regions/groups