zincjs 2.0.1 → 2.1.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zincjs",
-  "version": "2.0.1",
+  "version": "2.1.1",
   "description": "ZincJS (Web-based-Zinc-Visualisation)",
   "main": "build/zinc.js",
   "directories": {
@@ -48,7 +48,7 @@
     "@vitest/coverage-v8": "^1.6.1",
     "auto-changelog": "^2.4.0",
     "chai": "^4.1.0",
-    "gl": "^6.0.2",
+    "gl": "^8.1.6",
     "happy-dom": "^20.10.6",
     "jsdoc": "^4.0.2",
     "msw": "^2.14.6",

package/src/controls.js

@@ -1,5 +1,4 @@
 import * as THREE from 'three';
-import { resolveURL } from './utilities';
 
 /**
  * Object with containg viewport information used in ZincJS.
@@ -851,7 +850,7 @@ const CameraControls = function ( object, domElement, renderer, scene ) {
    * @param {requestCallback} finishCallback - The callback once the path is load.
    */
 	this.loadPathURL = (path_url, finishCallback) => {
-    const requestURL = resolveURL(path_url);
+    const requestURL = path_url;
     fetch(requestURL)
     .then((response) => {
       if (!response.ok) {

package/src/primitives/glyphset.js

@@ -27,6 +27,7 @@ const Glyphset = function () {
   let numberOfVertices = 0;
   let baseSize = [0, 0, 0];
   let offset = [0, 0, 0];
+  let labelsOn = false;
   let scaleFactors = [0, 0, 0];
   let repeat_mode = "NONE";
   this.ready = false;
@@ -407,13 +408,26 @@ const Glyphset = function () {
     return undefined;
   }
 
+  this.isLabelDisplayed = () => {
+    return labelsOn;
+  }
+
+  /**
+   * Check whether label can be shown
+   */
+  this.canShowLabel = () => {
+    return (glyphList?.length && (labels?.length || this.groupName));
+  }
 
   /**
    * Display the label of the glyphs in the glyphset.
    */
   this.showLabel = () => {
-    for (let i = 0; i < glyphList.length; i++) {
-      glyphList[i].showLabel(this.morph.material ? this.morph.material.color : undefined);
+    if (glyphList?.length) {
+      labelsOn = true;
+      for (let i = 0; i < glyphList.length; i++) {
+        glyphList[i].showLabel(this.morph.material ? this.morph.material.color : undefined);
+      }
     }
   }
 
@@ -424,6 +438,7 @@ const Glyphset = function () {
       for (let i = 0; i < glyphList.length; i++) {
         glyphList[i].hideLabel();
       }
+      labelsOn = false;
     }
 
   /**
@@ -445,7 +460,8 @@ const Glyphset = function () {
       glyphList[i] = glyph;
       this.morph.add(glyph.getGroup());
     }
-    if (displayLabels) {
+    //Only display labels if the label list is available
+    if (labels && displayLabels) {
       this.showLabel();
     }
     //Update the transformation of the glyphs.

package/src/primitives/texturePrimitive.js

@@ -1,4 +1,4 @@
-import { resolveURL } from '../utilities';
+
 import { TextureArray } from '../texture/textureArray';
 import { ZincObject } from './zincObject';
 /**
@@ -32,7 +32,7 @@ const TexturePrimitive = function (textureIn) {
         const texture = new TextureArray();
         const imgArray = [];
         textureData.images.source.forEach(img => {
-          imgArray.push(resolveURL(img));
+          imgArray.push(img);
         });
         const _this = this;
         texture.loadFromImages(imgArray).then(() => {

package/src/primitives/textureSlides.js

@@ -188,7 +188,7 @@ const TextureSlides = function (textureIn) {
   /**
    * Get  the array of slides, return them in an array
    *
-   * @return {Array} - Return an array of {@link THREE.Object)
+   * @return {Array} - Return an array of {@link THREE.Object}
    */
   this.getSlides = () => {
     if (this.morph) return [...this.morph.children];

package/src/primitives/zincObject.js

@@ -2,8 +2,7 @@ import * as THREE from 'three';
 import {
   createBufferGeometry,
   getBoundingBox,
-  removeVertexAtIndex,
-  resolveURL
+  removeVertexAtIndex
 } from '../utilities';
 import { LOD } from './lod';
 import { Marker } from './marker';
@@ -182,7 +181,7 @@ ZincObject.prototype.setMesh = function(mesh, localTimeEnabled, localMorphColour
       if (this.animationClip && (this.animationClip[0] != undefined)) {
         this.clipAction = this.mixer.clipAction(this.animationClip[0]).setDuration(
           this.duration);
-        this.clipAction.loop = THREE.loopOnce;
+        this.clipAction.loop = THREE.LoopOnce;
         this.clipAction.clampWhenFinished = true;
         this.clipAction.play();
       }
@@ -795,7 +794,7 @@ ZincObject.prototype.setPosition = function(x, y, z) {
 }
 
 ZincObject.prototype.loadAdditionalSources = function(primitivesLoader, sources) {
-  primitivesLoader.load(resolveURL(filename), meshloader(region, colour, opacity, localTimeEnabled, localMorphColour, undefined, undefined,
+  primitivesLoader.load(filename, meshloader(region, colour, opacity, localTimeEnabled, localMorphColour, undefined, undefined,
     undefined, undefined, finishCallback), this.onProgress(filename), this.onError(finishCallback));
 }
 

package/src/sceneLoader.js

@@ -9,7 +9,7 @@ import { Lines } from './primitives/lines';
 import { Pointset } from './primitives/pointset';
 import { TextureSlides } from './primitives/textureSlides';
 import { TubeLines } from './primitives/tubeLines';
-import { createNewURL, isRegionGroup, resolveURL } from './utilities';
+import { createNewURL, isRegionGroup } from './utilities';
 import Zinc from './zinc';
 
 /**
@@ -115,7 +115,7 @@ const SceneLoader = function (sceneIn) {
    */
   this.loadViewURL = (url, finishCallback) => {
     this.toBeDownloaded += 1;
-    const requestURL = resolveURL(url);
+    const requestURL = url;
     fetch(requestURL)
       .then((response) => {
         if (!response.ok) {
@@ -161,7 +161,7 @@ const SceneLoader = function (sceneIn) {
       let localMorphColour = 0;
       if (morphColour != undefined && morphColour[i] != undefined)
         localMorphColour = morphColour[i] ? true : false;
-      primitivesLoader.load(resolveURL(filename), meshloader(region, colour, opacity, localTimeEnabled, localMorphColour, undefined, undefined,
+      primitivesLoader.load(filename, meshloader(region, colour, opacity, localTimeEnabled, localMorphColour, undefined, undefined,
         undefined, undefined, finishCallback), this.onProgress(filename), this.onError(finishCallback));
     }
   }
@@ -175,7 +175,7 @@ const SceneLoader = function (sceneIn) {
    * @deprecated
    */
   this.loadFromViewURL = (targetRegion, jsonFilePrefix, finishCallback) => {
-    const requestURL = resolveURL(jsonFilePrefix + "_view.json");
+    const requestURL = jsonFilePrefix + "_view.json";
     fetch(requestURL)
     .then((response) => {
       if (!response.ok) {
@@ -284,7 +284,7 @@ const SceneLoader = function (sceneIn) {
       }
       let isInline  = (options && options.isInline) ? options.isInline : undefined;
       let anatomicalId = (options && options.anatomicalId) ? options.anatomicalId : undefined;
-      let displayLabels = (options && options.displayLabels) ? options.displayLabels : undefined;
+      let displayLabels = options?.displayLabels ? options.displayLabels : true;
       let renderOrder = (options && "renderOrder" in options) ? options.renderOrder : undefined;
       const newGlyphset = new Glyphset();
       newGlyphset.setDuration(scene.getDuration());
@@ -299,7 +299,7 @@ const SceneLoader = function (sceneIn) {
         newGlyphset.load(glyphsetData, glyphurl, myCallback, isInline, displayLabels);
       }
       else {
-        newGlyphset.load(glyphsetData, resolveURL(glyphurl), myCallback, isInline, displayLabels);
+        newGlyphset.load(glyphsetData, glyphurl, myCallback, isInline, displayLabels);
       }
       newGlyphset.setAnatomicalId(anatomicalId);
       newGlyphset.setRenderOrder(renderOrder);
@@ -349,7 +349,7 @@ const SceneLoader = function (sceneIn) {
 
       xmlhttp.onreadystatechange = onLoadGlyphsetReady(region, xmlhttp, glyphurl,
         groupName, finishCallback, options);
-      xmlhttp.open("GET", resolveURL(metaurl), true);
+      xmlhttp.open("GET", metaurl, true);
       xmlhttp.send();*/
     }
   }
@@ -401,7 +401,7 @@ const SceneLoader = function (sceneIn) {
     const opacity = Zinc.defaultOpacity;
     const loader = new STLLoader();
     loader.crossOrigin = "Anonymous";
-    loader.load(resolveURL(url), meshloader(region, colour, opacity, false,
+    loader.load(url, meshloader(region, colour, opacity, false,
       false, groupName, undefined, undefined, undefined, finishCallback));
   }
 
@@ -420,7 +420,7 @@ const SceneLoader = function (sceneIn) {
     const opacity = Zinc.defaultOpacity;
     const loader = new OBJLoader();
     loader.crossOrigin = "Anonymous";
-    loader.load(resolveURL(url), meshloader(region, colour, opacity, false,
+    loader.load(url, meshloader(region, colour, opacity, false,
       false, groupName, undefined, undefined, undefined, finishCallback));
   }
 
@@ -575,7 +575,7 @@ const SceneLoader = function (sceneIn) {
     if (isInline) {
       loadTexture(region, undefined, url, groupName, finishCallback, options);
     } else {
-      const requestURL = resolveURL(url);
+      const requestURL = url;
       fetch(requestURL)
       .then((response) => {
         if (!response.ok) {
@@ -760,9 +760,7 @@ const SceneLoader = function (sceneIn) {
           } else {
             newGeometryURL = item.Inline.GlyphGeometriesURL;
           }
-          if (item.DisplayLabels) {
-            options.displayLabels = true;
-          }
+          options.displayLabels = item.displayLabels ? item.displayLabels : true;
           options.loaderOptions.isGlyphsets = true;
           this.loadGlyphsetURL(region, newURL, newGeometryURL, groupName, finishCallback, options);
           break;
@@ -984,7 +982,7 @@ const SceneLoader = function (sceneIn) {
     * for each glyphset and geometry that has been written in.
     */
   this.loadMetadataURL = (targetRegion, url, finishCallback, allCompletedCallback, options) => {
-    const requestURL = resolveURL(url);
+    const requestURL = url;
     fetch(requestURL)
       .then((response) => {
         if (!response.ok) {

package/src/utilities.js

@@ -2,25 +2,8 @@ import * as THREE from 'three';
 import { Geometry as THREEGeometry } from './three/Geometry';
 import SpriteTextModule from 'three-spritetext';
 const SpriteText = SpriteTextModule.default || SpriteTextModule;
-import Zinc from './zinc';
 import discPNG from './assets/disc.png';
 
-function resolveURL(url) {
-	let actualURL = url;
-	let prefix = Zinc.modelPrefix;
-
-	if (prefix) {
-		if (prefix[prefix.length -1] != '/')
-			prefix = prefix + '/';
-		const r = new RegExp('^(?:[a-z]+:)?//', 'i');
-		if (!r.test(url)) {
-			actualURL =  prefix + url;
-		}
-	}
-
-	return actualURL;
-}
-
 function createNewURL(target, reference) {
   const getNewURL = (target, reference) => {
     try {
@@ -87,7 +70,7 @@ function getBoundingBox(mesh, cachedBox, b1, v1, v2) {
 //Convenient function
 function loadExternalFile(url, data, callback, errorCallback) {
     // Set up an asynchronous request
-  fetch(resolveURL(url))
+  fetch(url)
   .then((response) => {
     if (!response.ok) {
       throw new Error(`HTTP error! status: ${response.status}`);
@@ -858,7 +841,6 @@ export {
   mergeVertices,
   PhongToToon,
   removeVertexAtIndex,
-  resolveURL,
   updateMorphColorAttribute,
   toBufferGeometry,
  };

package/src/zinc.js

@@ -40,7 +40,6 @@ const Zinc = function() {
   this.Revision = version;
   this.defaultMaterialColor = 0xFFFFFF;
   this.defaultOpacity = 1.0;
-  this.modelPrefix = undefined;
   // Assign hoisted modules to the instance
   this.Geometry = Geometry;
   this.Glyph = Glyph;
@@ -48,8 +47,8 @@ const Zinc = function() {
   this.Pointset = Pointset;
   this.Label = Label;
   this.Lines = Lines;
-  this.TextureArray = TextureArray;
   this.TextureSlides = TextureSlides;
+  this.TextureArray = TextureArray;
   this.Renderer = Renderer;
   this.Scene = Scene;
   //this.GeometryCSG = GeometryCSG;