zincjs 1.7.0 → 1.8.1

package/package.json

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

package/src/controls.js

@@ -70,6 +70,7 @@ const CameraControls = function ( object, domElement, renderer, scene ) {
 	this.touchZoomDistanceEnd = 0;
 	this.directionalLight = 0;
 	this.scrollRate = 50;
+	this.pixelHeight = 1;
 	let duration = 6000;
   let enabled = true;
 	let inbuildTime = 0;
@@ -224,6 +225,25 @@ const CameraControls = function ( object, domElement, renderer, scene ) {
         viewports[defaultViewport]);
 	}
 
+	this.getVisibleHeightAtZDepth = ( depth ) => {
+		// compensate for cameras not positioned at z=0
+		const cameraOffset = this.cameraObject.position.z;
+		if ( depth < cameraOffset ) depth -= cameraOffset;
+		else depth += cameraOffset;
+	
+		// vertical fov in radians
+		const vFOV = this.cameraObject.fov * Math.PI / 180; 
+	
+		// Math.abs to ensure the result is always positive
+		return 2 * Math.tan( vFOV / 2 ) * Math.abs( depth );
+	};
+
+	this.calculateHeightPerPixelAtZeroDepth = ( wHeight ) => {
+		const height = this.getVisibleHeightAtZDepth(0);
+		this.pixelHeight = height / wHeight;
+		return this.pixelHeight;
+	}
+
   /**
    * Get normalised coordinates from windows coordinates.
    * 
@@ -987,6 +1007,7 @@ const CameraControls = function ( object, domElement, renderer, scene ) {
 		} else {
 			this.cameraObject.lookAt( this.cameraObject.target );
 		}
+
 		return updated;
 	};
 	
@@ -1476,7 +1497,7 @@ const RayCaster = function (sceneIn, hostSceneIn, callbackFunctionIn, hoverCallb
 	const enabled = true;
 	const raycaster = new THREE.Raycaster();
 	raycaster.params.Line.threshold = 0.1;
-	raycaster.params.Points.threshold = 0.1;
+	raycaster.params.Points.threshold = 1;
   const mouse = new THREE.Vector2();
   let awaiting = false;
   let lastHoveredDate = new Date();

package/src/primitives/pointset.js

@@ -85,6 +85,19 @@ const Pointset = function () {
       this.morph.material.needsUpdate = true;
     }
   }
+
+    /**
+   * Turn size attenuation on/off based on the flag.
+   * 
+   * @param {Boolean} flag - Determin either size attenuation
+   * should be on or off.
+   */
+    this.render = (delta, playAnimation, cameraControls, options) => {
+      if (this.morph) {
+        this.morph.sizePerPixel = cameraControls.pixelHeight;
+      }
+      Pointset.prototype.render.call(this, delta, playAnimation, cameraControls, options);
+    }
 }
 
 Pointset.prototype = Object.create((require('./zincObject').ZincObject).prototype);

package/src/region.js

@@ -321,7 +321,11 @@ let Region = function (parentIn, sceneIn) {
       if (zincObject === zincObjects[i]) {
         group.remove(zincObject.getGroup());
         zincObjects.splice(i, 1);
+        if (scene) {
+          scene.triggerObjectRemovedCallback(zincObject);
+        }
         zincObject.dispose();
+        this.pickableUpdateRequired = true;
         return;
       }
     }

package/src/scene.js

@@ -39,6 +39,8 @@ exports.Scene = function (containerIn, rendererIn) {
   let minimap = undefined;
   let zincObjectAddedCallbacks = {};
   let zincObjectAddedCallbacks_id = 0;
+  let zincObjectRemovedCallbacks = {};
+  let zincObjectRemovedCallbacks_id = 0;
   const scene = new THREE.Scene();
   const rootRegion = new (require('./region').Region)(undefined, this);
   scene.add(rootRegion.getGroup());
@@ -109,10 +111,12 @@ exports.Scene = function (containerIn, rendererIn) {
 
   //called from Renderer when panel has been resized
   this.onWindowResize = () => {
-    this.camera.aspect = getDrawingWidth() / getDrawingHeight();
+    const wHeight = getDrawingHeight();
+    this.camera.aspect = getDrawingWidth() / wHeight;
     this.camera.updateProjectionMatrix();
     this.minimapScissor.updateRequired = true;
     zincCameraControls.onResize();
+    zincCameraControls.calculateHeightPerPixelAtZeroDepth(wHeight);
   }
 
   /**
@@ -194,6 +198,7 @@ exports.Scene = function (containerIn, rendererIn) {
     if (boundingBox) {
       const viewport = zincCameraControls.getViewportFromBoundingBox(boundingBox, 1.0);
       zincCameraControls.setCurrentCameraSettings(viewport);
+      zincCameraControls.calculateHeightPerPixelAtZeroDepth(getDrawingHeight());
       markerCluster.markerUpdateRequired = true;
     }
   }
@@ -592,6 +597,9 @@ exports.Scene = function (containerIn, rendererIn) {
 			  if (0 == sceneLoader.toBeDownloaded) {
 				  zincCameraControls.setTime(currentTime);
 				  options.ndcToBeUpdated = zincCameraControls.update(0);
+          if (options.ndcToBeUpdated) {
+            zincCameraControls.calculateHeightPerPixelAtZeroDepth(getDrawingHeight());
+          }
           rootRegion.setMorphTime(currentTime, true);
           rootRegion.renderGeometries(0, 0, playAnimation, zincCameraControls, options, true);
 			  } else {
@@ -604,6 +612,9 @@ exports.Scene = function (containerIn, rendererIn) {
 	  } else {
 		  if (0 == sceneLoader.toBeDownloaded) {
         options.ndcToBeUpdated = zincCameraControls.update(delta);
+        if (options.ndcToBeUpdated) {
+          zincCameraControls.calculateHeightPerPixelAtZeroDepth(getDrawingHeight());
+        }
         rootRegion.renderGeometries(playRate, delta, playAnimation, zincCameraControls, options, true);
 		  } else {
 			  zincCameraControls.update(0);
@@ -968,6 +979,7 @@ exports.Scene = function (containerIn, rendererIn) {
     markerCluster.clear();
     rootRegion.clear(true);
     this.clearZincObjectAddedCallbacks();
+    this.clearZincObjectRemovedCallbacks();
     sceneLoader.toBeDwonloaded = 0;
     if (zincCameraControls) {
       zincCameraControls.calculateMaxAllowedDistance(this);
@@ -1126,6 +1138,18 @@ exports.Scene = function (containerIn, rendererIn) {
 		zincObjectAddedCallbacks[zincObjectAddedCallbacks_id] = callbackFunction;
 		return zincObjectAddedCallbacks_id;
 	}
+
+	/**
+	 * Add a callback function which will be called everytime zinc object is removed.
+	 * @param {Function} callbackFunction - callbackFunction to be added.
+	 * 
+	 * @return {Number}
+	 */
+	this.addZincObjectRemovedCallbacks = callbackFunction => {
+		zincObjectRemovedCallbacks_id = zincObjectRemovedCallbacks_id + 1;
+		zincObjectRemovedCallbacks[zincObjectRemovedCallbacks_id] = callbackFunction;
+		return zincObjectRemovedCallbacks_id;
+	}
 	
 	/**
 	 * Remove a callback function that is previously added to the scene.
@@ -1137,6 +1161,16 @@ exports.Scene = function (containerIn, rendererIn) {
 		}
 	}
 
+	/**
+	 * Remove a callback function that is previously added to the scene.
+	 * @param {Number} id - identifier of the previously added callback function.
+	 */
+	this.removeZincObjectRemovedCallbacks = id => {
+		if (id in zincObjectRemovedCallbacks_id) {
+   			delete zincObjectRemovedCallbacks[id];
+		}
+	}
+
   /**
 	 * Clear all zinc object callback function
 	 */
@@ -1145,6 +1179,14 @@ exports.Scene = function (containerIn, rendererIn) {
     zincObjectAddedCallbacks_id = 0;
 	}
 
+  /**
+	 * Clear all zinc object callback function
+	 */
+	this.clearZincObjectRemovedCallbacks = () => {
+		zincObjectRemovedCallbacks = {};
+    zincObjectRemovedCallbacks_id = 0;
+	}
+
   /**
 	 * Used to trigger zinc object added callback
 	 */
@@ -1156,6 +1198,17 @@ exports.Scene = function (containerIn, rendererIn) {
     }
   }
 
+  /**
+	 * Used to trigger zinc object removed callback
+	 */
+  this.triggerObjectRemovedCallback= (zincObject) => {
+    for (let key in zincObjectRemovedCallbacks) {
+      if (zincObjectRemovedCallbacks.hasOwnProperty(key)) {
+        zincObjectRemovedCallbacks[key](zincObject);
+      }
+    }
+  }
+
   /*
 	 * Add temporary points to the scene which can be removed
    * with clearTemporaryPrimitives method.

package/src/sceneLoader.js

@@ -422,6 +422,7 @@ exports.SceneLoader = function (sceneIn) {
           scene.viewAll();
         if (allCompletedCallback != undefined && (typeof allCompletedCallback == 'function'))
           allCompletedCallback();
+        
       }
     };
   };

package/src/three/Points.js

@@ -26,6 +26,7 @@ class Points extends Object3D {
 
 		this.geometry = geometry;
 		this.material = material;
+		this.sizePerPixel = 1;
 
 		this.updateMorphTargets();
 
@@ -64,7 +65,7 @@ class Points extends Object3D {
 		_inverseMatrix.copy( matrixWorld ).invert();
 		_ray.copy( raycaster.ray ).applyMatrix4( _inverseMatrix );
 
-		const localThreshold = threshold / ( ( this.scale.x + this.scale.y + this.scale.z ) / 3 );
+		const localThreshold = threshold / ( ( this.scale.x + this.scale.y + this.scale.z ) / 3 ) * this.material.size * this.sizePerPixel;
 		const localThresholdSq = localThreshold * localThreshold;
 
 		if ( geometry.isBufferGeometry ) {

package/src/zinc.js

@@ -18,6 +18,7 @@ const Zinc = function() {
   this.Glyph = require('./primitives/glyph').Glyph;
   this.Glyphset = require('./primitives/glyphset').Glyphset;
   this.Pointset = require('./primitives/pointset').Pointset;
+  this.Label = require('./primitives/label').Label;
   this.Lines = require('./primitives/lines').Lines;
   this.TextureArray = require('./texture/textureArray').TextureArray;
   this.TextureSlides = require('./primitives/textureSlides').TextureSlides;