zincjs 1.8.4 → 1.9.0

package/package.json

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

package/src/controls.js

@@ -1508,6 +1508,7 @@ const RayCaster = function (sceneIn, hostSceneIn, callbackFunctionIn, hoverCallb
   let timeDiff = 0;
   let pickedObjects = new Array();
   let lastPosition = { zincCamera: undefined, x: -1 ,y: -1};
+	let pickableObjects = undefined;
 
 	this.enable = () => {
 		enable = true;
@@ -1517,22 +1518,44 @@ const RayCaster = function (sceneIn, hostSceneIn, callbackFunctionIn, hoverCallb
 		enable = false;
 	}
 
-	const getIntersectsObject = (zincCamera, x, y) => {
-    zincCamera.getNDCFromDocumentCoords(x, y, mouse);
+	this.getIntersectsObject = (zincCamera) => {
     if (hostScene !== scene) {
       const threejsScene = scene.getThreeJSScene();
       renderer.render(threejsScene, zincCamera.cameraObject);
     }
-    raycaster.setFromCamera( mouse, zincCamera.cameraObject);
-    let objects = scene.getPickableThreeJSObjects();
+    let objects = pickableObjects ? pickableObjects : scene.getPickableThreeJSObjects();
     //Reset pickedObjects array 
     pickedObjects.length = 0;
 		return raycaster.intersectObjects( objects, true, pickedObjects );
+	}
+
+	this.setPickableObjects = (zincObjects) => {
+		if (zincObjects === undefined) {
+			pickableObjects = undefined;
+		} else {
+			pickableObjects = [];
+			zincObjects.forEach(zincObject => {
+				if (zincObject.getGroup() && zincObject.getGroup().visible) {
+					pickableObjects.push(zincObject.getGroup());
+				}
+			});
+		}
+	}
+
+	this.getIntersectsObjectWithOrigin = (zincCamera, origin, direction) => {
+		raycaster.set(origin, direction);
+		return this.getIntersectsObject(zincCamera);
+	}
+
+	this.getIntersectsObjectWithCamera = (zincCamera, x, y) => {
+    zincCamera.getNDCFromDocumentCoords(x, y, mouse);
+		raycaster.setFromCamera(mouse, zincCamera.cameraObject);
+		return this.getIntersectsObject(zincCamera);
 	};
 	
 	this.pick = (zincCamera, x, y) => { 
 		if (enabled && renderer && scene && zincCamera && callbackFunction) {
-			getIntersectsObject(zincCamera, x, y);
+			this.getIntersectsObjectWithCamera(zincCamera, x, y);
 			const length = pickedObjects.length;
 			for (let i = 0; i < length; i++) {
 				let zincObject = pickedObjects[i].object ? pickedObjects[i].object.userData : undefined;
@@ -1548,7 +1571,7 @@ const RayCaster = function (sceneIn, hostSceneIn, callbackFunctionIn, hoverCallb
   
   let hovered = (zincCamera, x, y) => {
     if (enabled && renderer && scene && zincCamera && hoverCallbackFunction) {
-      getIntersectsObject(zincCamera, x, y);
+      this.getIntersectsObjectWithCamera(zincCamera, x, y);
       lastHoveredDate.setTime(Date.now());
       if (pickedObjects.length === 0) {
         //skip hovered callback if the previous one is empty

package/src/primitives/label.js

@@ -42,8 +42,9 @@ exports.Label = function (textIn, colour) {
    * @param {Number} z - z coordinate to be set.
    */
   this.setPosition = (x, y, z) => {
-    if (sprite)
+    if (sprite) {
       sprite.position.set(x, y, z);
+    }
   }
 
   /**

package/src/primitives/lines2.js

@@ -1,5 +1,4 @@
 const THREE = require('three');
-const createBufferGeometry = require('../utilities').createBufferGeometry;
 const toBufferGeometry = require('../utilities').toBufferGeometry;
 const LineSegments2 = require("../three/line/LineSegments2").LineSegments2;
 const LineMaterial = require("../three/line/LineMaterial").LineMaterial;
@@ -115,7 +114,7 @@ const Lines2 = function () {
   /**
    * Edit Vertice in index.
    */
-  this.editVertice = function(coords, i) {
+  this.editVertices = function(coords, i) {
     if (coords && coords.length) {
       let mesh = this.getMorph();
       const maxIndex = i + coords.length - 1;
@@ -142,7 +141,6 @@ const Lines2 = function () {
     return positions;
   }
 
-
   /**
    * Add new lines to existing lines if it exists, otherwise
    * create a new one and add to it.

package/src/primitives/pointset.js

@@ -2,6 +2,7 @@ const THREE = require('three');
 const Points = require('../three/Points').Points;
 const toBufferGeometry = require('../utilities').toBufferGeometry;
 const getCircularTexture = require('../utilities').getCircularTexture;
+const Label = require('./label').Label;
 
 /**
  * Provides an object which stores points and provides method which controls its position.
@@ -15,6 +16,7 @@ const getCircularTexture = require('../utilities').getCircularTexture;
 const Pointset = function () {
   (require('./zincObject').ZincObject).call(this);
   this.isPointset = true;
+  const labelSets = [];
 
   /**
    * Create the pointsets using geometry and material.
@@ -38,16 +40,33 @@ const Pointset = function () {
     }
   }
 
+  const addLabel = (index, coord, labelText, colourHex) => {
+    if (labelText) {
+      const colour = new THREE.Color(colourHex);
+      const label = new Label(labelText, colour);
+      label.setPosition(coord[0], coord[1], coord[2]);
+      const sprite  = label.getSprite();
+      sprite.material.sizeAttenuation = false;
+      sprite.material.alphaTest = 0.5;
+      sprite.material.transparent = true;
+      sprite.material.depthWrite = false;
+      sprite.material.depthTest = false;
+      this.group.add(sprite);
+      labelSets[index] = label;
+    }
+  }
+
   /**
    * Add points to existing mesh if it exists, otherwise
    * create a new one and add to it.
    * @param {Array} coords  -An array of three components coordinates.
-   * @param {Array} labels - An array of strings, these are only added
+   * @param {Array|String} labels - An array of strings, these are only added
    * if the number of coords equals to the number labels provided.
    * @param {Number} colour - A hex value of the colour for the points
    */
   this.addPoints = (coords, labels, colour) => {
     if (coords && coords.length > 0) {
+      let current = this.drawRange - 1;
       const geometry = this.addVertices(coords);
       let mesh = this.getMorph();
       if (!mesh) {
@@ -57,6 +76,16 @@ const Pointset = function () {
         geometry.colorsNeedUpdate = true;
         this.createMesh(geometry, material, options);
       }
+      let end = current + coords.length;
+      let index = 0;
+      if ((Array.isArray(labels) && labels.length === coords.length) || 
+        (typeof labels === "string")) {
+        for (current; current + index < end;) {
+          const labelText = typeof labels === "string" ? labels : labels[index];
+          addLabel(index, coords[index], labelText, colour);
+          index++;
+        }
+      }
       if (this.region) this.region.pickableUpdateRequired = true;
     }
   }
@@ -86,18 +115,59 @@ const Pointset = function () {
     }
   }
 
-    /**
-   * Turn size attenuation on/off based on the flag.
-   * 
-   * @param {Boolean} flag - Determin either size attenuation
-   * should be on or off.
+  /**
+   * Get vertices at index
+   */
+  this.getVerticesByIndex = function(index) {
+    if (index >= 0 && this.drawRange > index) {
+      const positionAttribute = this.getMorph().geometry.getAttribute( 'position' );
+      return [ 
+        positionAttribute.getX(index),
+        positionAttribute.getY(index),
+        positionAttribute.getZ(index)
+      ];
+    }
+    return undefined;
+  }
+
+  /**
+   * Edit Vertice in index.
    */
-    this.render = (delta, playAnimation, cameraControls, options) => {
-      if (this.morph) {
-        this.morph.sizePerPixel = cameraControls.pixelHeight;
+  this.editVertices = function(coords, i) {
+    if (coords && coords.length) {
+      let mesh = this.getMorph();
+      const maxIndex = i + coords.length - 1;
+      if (!mesh || 0 > i || maxIndex >= this.drawRange) {
+        return;
+      } else {
+        const positionAttribute = mesh.geometry.getAttribute( 'position' );
+        let index = i;
+        coords.forEach(coord => {
+          const label = labelSets[index];
+          if (label) {
+            label.setPosition(coord[0], coord[1], coord[2]);
+          }
+          positionAttribute.setXYZ(index++, coord[0], coord[1], coord[2]);
+          
+        });
+        positionAttribute.needsUpdate = true;
+        this.boundingBoxUpdateRequired = true;
       }
-      Pointset.prototype.render.call(this, delta, playAnimation, cameraControls, options);
     }
+  }
+
+  /**
+ * 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 && cameraControls) {
+      this.morph.sizePerPixel = cameraControls.pixelHeight;
+    }
+    Pointset.prototype.render.call(this, delta, playAnimation, cameraControls, options);
+  }
 }
 
 Pointset.prototype = Object.create((require('./zincObject').ZincObject).prototype);