zincjs 3.0.0 → 3.0.2

package/src/primitives/lod.js

@@ -47,13 +47,13 @@ const LOD = function (parent) {
         morph: object,
         loaded: true,
         loading: false,
-        url: "",
+        url: '',
       };
       this.levels.splice(l, 0, levelObject);
       object.renderOrder = this._renderOrder;
       //this.add( object );
     }
-  }
+  };
 
   /*
    * This is called once an ondemand level is loaded
@@ -74,7 +74,7 @@ const LOD = function (parent) {
       this.checkTransparentMesh();
       this._parent?.requestRender?.();
     }
-  }
+  };
 
   this.addLevelFromURL = (loader, level, url, index, preload) => {
     this._loader = loader;
@@ -97,34 +97,33 @@ const LOD = function (parent) {
     if (preload) {
       this.loadLevel(l);
     }
-  }
+  };
 
   //load the mesh at index, return true if morph is not ready
   this.loadLevel = (index) => {
     const level = this.levels[index];
-    if (!level.morph && !level.loaded &&
-      !level.loading) {
+    if (!level.morph && !level.loaded && !level.loading) {
       level.loading = true;
-      this._loader.load(level.url, this.lodLoader(level.distance),
-        undefined, undefined, {index: level.index});
+      this._loader.load(level.url, this.lodLoader(level.distance), undefined, undefined, {
+        index: level.index,
+      });
     }
-    return (level.morph === undefined);
-  }
-
+    return level.morph === undefined;
+  };
 
   this.calculateDistance = function (level) {
     this._parent.getBoundingBox();
     const radius = this._parent.radius;
     let distance = 0;
-    if (level === "far") {
+    if (level === 'far') {
       distance = radius * 4.5;
-    } else if (level === "medium") {
+    } else if (level === 'medium') {
       distance = radius * 2.5;
-    } else if (level === "close") {
+    } else if (level === 'close') {
       distance = 0;
     }
     return distance;
-  }
+  };
 
   /**
    * Check if there are multiple levels.
@@ -134,7 +133,7 @@ const LOD = function (parent) {
       return true;
     }
     return false;
-  }
+  };
 
   /**
    * Check if material is transparent, create secondary mesh
@@ -156,8 +155,7 @@ const LOD = function (parent) {
         // THREE.Mesh - for utilities purpose such as rendering
         // transparent surfaces - one for front face and one for back face.
         if (!level.secondaryMesh) {
-          level.secondaryMesh = new THREE.Mesh(level.morph.geometry,
-            this._secondaryMaterial);
+          level.secondaryMesh = new THREE.Mesh(level.morph.geometry, this._secondaryMaterial);
           level.secondaryMesh.renderOrder = level.morph.renderOrder + 1;
           level.secondaryMesh.userData = level.morph.userData;
           level.secondaryMesh.name = level.morph.name;
@@ -184,7 +182,7 @@ const LOD = function (parent) {
         this._material.needsUpdate = true;
       }
     }
-  }
+  };
 
   this.dispose = () => {
     this._disposed = true;
@@ -199,11 +197,11 @@ const LOD = function (parent) {
     if (this._secondaryMaterial) {
       this._secondaryMaterial.dispose();
     }
-  }
+  };
 
   this.getCurrentLevel = () => {
     return this._currentLevel;
-  }
+  };
 
   this.getCurrentMorph = () => {
     const level = this.levels[this._currentLevel];
@@ -211,11 +209,11 @@ const LOD = function (parent) {
       return level.morph;
     }
     return this._parent.morph;
-  }
+  };
 
   /**
- * Loader for lod object
- */
+   * Loader for lod object
+   */
   this.lodLoader = function (distance) {
     return (geometryIn) => {
       if (this._disposed) {
@@ -227,7 +225,7 @@ const LOD = function (parent) {
         localTimeEnabled: this._parent.timeEnabled,
         localMorphColour: this._parent.morphColour,
         isLines: this._parent.isLines,
-      }
+      };
       const geometry = toBufferGeometry(geometryIn, options);
       let mesh = undefined;
       if (this._parent.isGeometry) {
@@ -240,7 +238,7 @@ const LOD = function (parent) {
       geometryIn.dispose();
       this.levelLoaded(mesh, distance);
     };
-  }
+  };
 
   this.updateMorphColorAttribute = (currentOnly) => {
     //Multilayers - set all
@@ -250,8 +248,11 @@ const LOD = function (parent) {
       //morph colour materials now (see applyMorphColorNode's callers), so
       //NodeMaterial doesn't multiply the blend by the static 'color'
       //attribute on top of it.
-      if (this._material.userData && this._material.userData.uniforms &&
-        this._material.userData.uniforms.morphColorMix) {
+      if (
+        this._material.userData &&
+        this._material.userData.uniforms &&
+        this._material.userData.uniforms.morphColorMix
+      ) {
         if (currentOnly) {
           const morph = this.getCurrentMorph();
           updateMorphColorAttribute(morph.geometry, morph);
@@ -264,7 +265,7 @@ const LOD = function (parent) {
         }
       }
     }
-  }
+  };
 
   this.setColour = (colour) => {
     this._material.color = colour;
@@ -272,7 +273,7 @@ const LOD = function (parent) {
       this._secondaryMaterial.color = colour;
     }
     updateGeometryColour();
-  }
+  };
 
   this.setFrustumCulled = (flag) => {
     this.levels.forEach((level) => {
@@ -283,18 +284,18 @@ const LOD = function (parent) {
         level.secondaryMesh.frustumCulled = flag;
       }
     });
-  }
+  };
 
   this.setMaterial = (material) => {
     if (material) {
-      if (!this._material || (this._material.id !== material.id)) {
+      if (!this._material || this._material.id !== material.id) {
         this._material = material;
         if (this._secondaryMaterial) {
           this._secondaryMaterial.dispose();
           this._secondaryMaterial = undefined;
         }
         if (material.transparent || this.levels.some((level) => level.secondaryMesh)) {
-          this._secondaryMaterial = material.clone()
+          this._secondaryMaterial = material.clone();
           this._secondaryMaterial.side = THREE.FrontSide;
           this._secondaryMaterial.transparent = true;
         }
@@ -311,7 +312,7 @@ const LOD = function (parent) {
         });
       }
     }
-  }
+  };
 
   this.setName = (name) => {
     this.levels.forEach((level) => {
@@ -322,7 +323,7 @@ const LOD = function (parent) {
         level.secondaryMesh.name = name;
       }
     });
-  }
+  };
 
   this.setRenderOrder = (order) => {
     this._renderOrder = order;
@@ -334,7 +335,7 @@ const LOD = function (parent) {
         level.secondaryMesh.renderOrder = order;
       }
     });
-  }
+  };
 
   this.setVertexColors = (vertexColors) => {
     this._material.vertexColors = vertexColors;
@@ -342,7 +343,7 @@ const LOD = function (parent) {
     if (this._secondaryMaterial) {
       this._secondaryMaterial.vertexColors = vertexColors;
     }
-  }
+  };
 
   /* Update layers based on the */
   this.update = (camera, center) => {
@@ -363,8 +364,7 @@ const LOD = function (parent) {
             visibleIndex = i;
             levels[i].morph.visible = true;
             optimalIndex = -1;
-          }
-          else {
+          } else {
             optimalIndex = i;
           }
         } else {
@@ -393,7 +393,7 @@ const LOD = function (parent) {
         this._parent?.requestRender?.();
       }
     }
-  }
+  };
 
   this.toggleMarker = (marker, flag) => {
     this.levels.forEach((level) => {
@@ -405,7 +405,7 @@ const LOD = function (parent) {
         }
       }
     });
-  }
+  };
 
   const updateGeometryColour = () => {
     this.levels.forEach((level) => {
@@ -413,7 +413,7 @@ const LOD = function (parent) {
         level.morph.geometry.colorsNeedUpdate = true;
       }
     });
-  }
-}
+  };
+};
 
 export { LOD };

package/src/primitives/marker.js

@@ -15,7 +15,7 @@ const spriteMaterial = new THREE.SpriteMaterial({
   transparent: true,
   depthTest: false,
   depthWrite: false,
-  sizeAttenuation: false
+  sizeAttenuation: false,
 });
 
 /**
@@ -27,7 +27,7 @@ const spriteMaterial = new THREE.SpriteMaterial({
  * @author Alan Wu
  * @return {Marker}
  */
-const Marker = function(zincObject) {
+const Marker = function (zincObject) {
   if (Object.getPrototypeOf(this) !== ZincObject.prototype) {
     Object.setPrototypeOf(Marker.prototype, ZincObject.prototype);
   }
@@ -49,7 +49,7 @@ const Marker = function(zincObject) {
   let number = undefined;
   let label = undefined;
 
-	let initialise = () => {
+  let initialise = () => {
     sprite = new THREE.Sprite(spriteMaterial);
     sprite.center.set(0.5, 0);
     this.morph.add(sprite);
@@ -57,24 +57,24 @@ const Marker = function(zincObject) {
     this.morph.renderOrder = 10000;
     sprite.scale.set(size[0], size[1], size[2]);
     sprite.userData = this;
-  }
+  };
 
   this.updateVisual = (min, max) => {
     let scale = 1;
     let porportion = 0;
     if (min !== max) {
-      porportion = (1 - (this.ndc.z - min) / (max - min));
-      scale = 0.6 +  porportion * 0.4;
+      porportion = 1 - (this.ndc.z - min) / (max - min);
+      scale = 0.6 + porportion * 0.4;
     }
     this.setSpriteSize(scale);
-  }
+  };
 
-  this.updateNDC = camera => {
+  this.updateNDC = (camera) => {
     this.ndc.copy(this.morph.position);
     this.ndc.project(camera);
     this.ndc.z = Math.min(Math.max(this.ndc.z, 0), 1);
     return this.ndc;
-  }
+  };
 
   /**
    * Set the position of the marker.
@@ -85,17 +85,17 @@ const Marker = function(zincObject) {
    */
   this.setPosition = (x, y, z) => {
     this.morph.position.set(x, y, z);
-  }
+  };
 
   /**
    * Set the size of the marker.
    *
    * @param {Number} size - size to be set.
    */
-  this.setSpriteSize = size => {
+  this.setSpriteSize = (size) => {
     sprite.scale.set(0.015, 0.02, 1);
     sprite.scale.multiplyScalar(size);
-  }
+  };
 
   this.setUserSprite = () => {
     if (userSprite) {
@@ -108,7 +108,7 @@ const Marker = function(zincObject) {
         defaultDisplay = false;
       }
     }
-  }
+  };
 
   this.setImageForUserSprite = (image, size) => {
     if (userSprite) {
@@ -126,17 +126,17 @@ const Marker = function(zincObject) {
       transparent: true,
       depthTest: false,
       depthWrite: false,
-      sizeAttenuation: false
+      sizeAttenuation: false,
     });
     if (!size) {
-      size =  [0.05, 0.05, 1];
+      size = [0.05, 0.05, 1];
     }
     userSprite = new THREE.Sprite(userMaterial);
     userSprite.center.set(0.5, 0);
     userSprite.scale.set(size[0], size[1], size[2]);
     userSprite.userData = this;
     this.setUserSprite();
-  }
+  };
 
   this.setDefaultSprite = () => {
     if (!defaultDisplay) {
@@ -145,14 +145,14 @@ const Marker = function(zincObject) {
       if (userSprite) this.morph.remove(userSprite);
       if (label) this.morph.add(label);
     }
-  }
+  };
 
   this.loadUserSprite = (url, size) => {
     if (url) {
       if (url !== userUrl) {
         userUrl = url;
         const userImage = new Image(128, 128);
-        userImage.crossOrigin = "anonymous"
+        userImage.crossOrigin = 'anonymous';
         userImage.onload = () => {
           this.setImageForUserSprite(userImage, size);
           this.parent?.requestRender?.();
@@ -162,7 +162,7 @@ const Marker = function(zincObject) {
         this.setUserSprite();
       }
     }
-  }
+  };
 
   /**
    * Clean up this object,
@@ -181,14 +181,14 @@ const Marker = function(zincObject) {
       label.material.dispose();
       label = undefined;
     }
-  }
+  };
 
   this.isEnabled = () => {
     return enabled;
-  }
+  };
 
   this.setNumber = (numberIn) => {
-    if (!numberIn || (number != numberIn)) {
+    if (!numberIn || number != numberIn) {
       //remove label
       if (label) {
         this.morph.remove(label);
@@ -199,29 +199,29 @@ const Marker = function(zincObject) {
       }
     }
     if (!label && numberIn) {
-      label = createNewSpriteText(numberIn, 0.012, "black", "Asap", 120, 700);
+      label = createNewSpriteText(numberIn, 0.012, 'black', 'Asap', 120, 700);
       label.renderOrder = 10001;
       this.morph.add(label);
     }
     number = numberIn;
-  }
+  };
 
   this.getNumber = () => {
     return number ? number : 1;
-  }
+  };
 
   /**
    * Set the visibility of this Geometry.
    *
    * @param {Boolean} visible - a boolean flag indicate the visibility to be set
    */
-  this.setVisibility = function(visible) {
+  this.setVisibility = function (visible) {
     if (visible !== this.visible) {
       this.visible = visible;
       this.group.visible = visible;
       if (this.parent.region) this.parent.region.pickableUpdateRequired = true;
     }
-  }
+  };
 
   /**
    * Enable and visualise the marker.
@@ -230,7 +230,7 @@ const Marker = function(zincObject) {
     enabled = true;
     this.morph.visible = true;
     this.visible = true;
-  }
+  };
 
   /**
    * Disable and hide the marker.
@@ -239,10 +239,9 @@ const Marker = function(zincObject) {
     enabled = false;
     this.morph.visible = false;
     this.visible = false;
-  }
-
-	initialise();
+  };
 
-}
+  initialise();
+};
 
 export { Marker };

package/src/primitives/markerCluster.js

@@ -15,7 +15,7 @@ const spriteMaterial = new THREE.SpriteMaterial({
   transparent: true,
   depthTest: false,
   depthWrite: false,
-  sizeAttenuation: false
+  sizeAttenuation: false,
 });
 
 /**
@@ -26,7 +26,7 @@ const spriteMaterial = new THREE.SpriteMaterial({
  * @author Alan Wu
  * @return {Marker}
  */
-const MarkerCluster = function(sceneIn) {
+const MarkerCluster = function (sceneIn) {
   ZincObject.call(this);
   this.texture = texture;
   let sprite = undefined;
@@ -47,15 +47,15 @@ const MarkerCluster = function(sceneIn) {
    *
    * @param {Number} size - size to be set.
    */
-  this.setSpriteSize = sizeIn => {
+  this.setSpriteSize = (sizeIn) => {
     sprite.scale.set(0.015, 0.02, 1);
     sprite.scale.multiplyScalar(sizeIn);
-  }
+  };
 
   this.clear = () => {
     this.group.clear();
     this.markers = {};
-  }
+  };
 
   /**
    * Clean up this object,
@@ -65,7 +65,7 @@ const MarkerCluster = function(sceneIn) {
     if (this.morph) {
       this.morph.clear();
     }
-  }
+  };
 
   const createNewSprite = (index) => {
     //Group is needed to set the position after scaling
@@ -81,35 +81,33 @@ const MarkerCluster = function(sceneIn) {
     localGroup.add(sprite);
     this.group.add(localGroup);
     return {
-      "group": localGroup,
-      "marker": sprite,
-      "label": undefined,
-      "number": 0,
-      "min": [0, 0, 0],
-      "max": [1, 1, 1],
+      group: localGroup,
+      marker: sprite,
+      label: undefined,
+      number: 0,
+      min: [0, 0, 0],
+      max: [1, 1, 1],
     };
-  }
+  };
 
   const activateSpriteForCluster = (sprite, cluster, number) => {
     sprite.group.visible = true;
-    sprite.group.position.set(
-      cluster.coords[0], cluster.coords[1], cluster.coords[2]
-    );
-    if (sprite.label === undefined || (number !== sprite.number)) {
+    sprite.group.position.set(cluster.coords[0], cluster.coords[1], cluster.coords[2]);
+    if (sprite.label === undefined || number !== sprite.number) {
       if (sprite.label) {
         sprite.group.remove(sprite.label);
         releaseTextSprite(sprite.label);
         sprite.label.material.map.dispose();
         sprite.label.material.dispose();
       }
-      sprite.label = createNewSpriteText(number, 0.012, "black", "Asap", 120, 700);
+      sprite.label = createNewSpriteText(number, 0.012, 'black', 'Asap', 120, 700);
       sprite.label.renderOrder = 10001;
       sprite.number = number;
       sprite.group.add(sprite.label);
     }
     sprite.min = cluster.min;
     sprite.max = cluster.max;
-  }
+  };
 
   const drawClusters = (clusters) => {
     let currentIndex = 0;
@@ -133,13 +131,13 @@ const MarkerCluster = function(sceneIn) {
     for (currentIndex; currentIndex < sprites.length; currentIndex++) {
       sprites[currentIndex].group.visible = false;
     }
-  }
+  };
 
   //Get clusters based on the ndc coordinate for each cluster.
   const getCluster = (markersObj, clusters) => {
     let first = true;
-    let newCluster = {members: [], coords: [0,0,0], min: [0, 0, 0], max: [1, 1, 1]};
-    let dist = 0
+    let newCluster = { members: [], coords: [0, 0, 0], min: [0, 0, 0], max: [1, 1, 1] };
+    let dist = 0;
     for (let prop in markersObj) {
       if (first) {
         _v21.set(markersObj[prop].ndc.x, markersObj[prop].ndc.y);
@@ -150,7 +148,7 @@ const MarkerCluster = function(sceneIn) {
           markersObj[prop].morph.position.x,
           markersObj[prop].morph.position.y,
           markersObj[prop].morph.position.z,
-        ]
+        ];
         clusters.push(newCluster);
         delete markersObj[prop];
       } else {
@@ -172,25 +170,25 @@ const MarkerCluster = function(sceneIn) {
     if (first !== true) {
       getCluster(markersObj, clusters);
     }
-  }
+  };
 
   this.calculate = () => {
     if (enabled) {
       const current = Date.now();
-      if ((current - start) > 500) {
+      if (current - start > 500) {
         let clusters = [];
-        getCluster({...this.markers}, clusters);
+        getCluster({ ...this.markers }, clusters);
         drawClusters(clusters);
         scene?.invalidate?.();
         start = Date.now();
         this.markerUpdateRequired = false;
       }
     }
-  }
+  };
 
   this.isEnabled = () => {
     return enabled;
-  }
+  };
 
   /**
    * Enable and visualise the marker.
@@ -198,7 +196,7 @@ const MarkerCluster = function(sceneIn) {
   this.enable = () => {
     enabled = true;
     this.morph.visible = true;
-  }
+  };
 
   /**
    * Disable and hide the marker.
@@ -208,12 +206,11 @@ const MarkerCluster = function(sceneIn) {
     this.morph.visible = false;
     //turn all markers back on
     for (let prop in this.markers) {
-      if (this.markers[prop]?.isMarker &&
-        this.markers[prop].isEnabled()) {
+      if (this.markers[prop]?.isMarker && this.markers[prop].isEnabled()) {
         this.markers[prop].setVisibility(true);
       }
     }
-  }
+  };
 
   this.zoomToCluster = (index) => {
     if (index !== undefined && index > -1) {
@@ -227,7 +224,7 @@ const MarkerCluster = function(sceneIn) {
       }
     }
     return false;
-  }
+  };
 
   this.clusterIsVisible = (index) => {
     if (index !== undefined && index > -1) {
@@ -236,8 +233,8 @@ const MarkerCluster = function(sceneIn) {
       }
     }
     return false;
-  }
-}
+  };
+};
 
 MarkerCluster.prototype = Object.create(ZincObject.prototype);
 export { MarkerCluster };