zincjs 1.1.0 → 1.2.0

package/package.json

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

package/src/primitives/zincObject.js

@@ -50,6 +50,7 @@ const ZincObject = function() {
   this.anatomicalId = undefined;
   this.region = undefined;
   this.animationClip = undefined;
+  this.markerMode = "inherited";
   this.uuid = getUniqueId();
 }
 
@@ -565,12 +566,27 @@ ZincObject.prototype.dispose = function() {
   this.groupName = undefined;
 }
 
+/**
+ * Check if marker is enabled based on the objects settings with 
+ * the provided scene options.
+ * 
+ * @return {Boolean} 
+ */
+ZincObject.prototype.markerIsEnabled = function(options) {
+  if (this.markerMode === "on" || (options && options.displayMarkers &&
+    (this.markerMode === "inherited"))) {
+      
+      return true;
+  }
+  return false;
+}
+
 /**
  * Update the marker's position and size based on current viewport. 
  */
 ZincObject.prototype.updateMarker = function(playAnimation, options) {
   if ((playAnimation == false) &&
-    (options && options.displayMarkers))
+    (this.markerIsEnabled(options)))
   {
     if (this.groupName) {
       if (!this.marker) {
@@ -645,6 +661,29 @@ ZincObject.prototype.getClosestVertexDOMElementCoords = function(scene) {
   }
 }
 
+/**
+ * Set marker mode for this zinc object which determine rather the
+ * markers should be displayed or not.
+ *
+ * @param {string} mode - There are three options:
+ * "on" - marker is enabled regardless of settings of scene
+ * "off" - marker is disabled regardless of settings of scene
+ * "inherited" - Marker settings on scene will determine the visibility
+ *  of the marker.
+ * 
+ * @return {Boolean} 
+ */
+ ZincObject.prototype.setMarkerMode = function(mode) {
+  if (mode !== this.markerMode) {
+    if (mode === "on" || mode === "off") {
+      this.markerMode = mode;
+    } else {
+      this.markerMode = "inherited";
+    }
+    if (this.region) this.region.pickableUpdateRequired = true;
+  }
+}
+
 //Update the geometry and colours depending on the morph.
 ZincObject.prototype.render = function(delta, playAnimation, options) {
   if (playAnimation == true)

package/src/region.js

@@ -338,23 +338,19 @@ let Region = function (parentIn) {
   /**
    * Get all pickable objects.
    */
-  this.getPickableThreeJSObjects = (objectsList, pickMarkers, transverse) => {
+  this.getPickableThreeJSObjects = (objectsList,  transverse) => {
     zincObjects.forEach(zincObject => {
       if (zincObject.morph && zincObject.morph.visible) {
-        if (pickMarkers) {
-          let marker = zincObject.marker;
-          if (marker && marker.isEnabled()) {
-            objectsList.push(marker.morph);
-          }
-        } else {
-          objectsList.push(zincObject.morph);
+        let marker = zincObject.marker;
+        if (marker && marker.isEnabled()) {
+          objectsList.push(marker.morph);
         }
+        objectsList.push(zincObject.morph);
       }
     });
     if (transverse) {
       children.forEach(childRegion => {
-        childRegion.getPickableThreeJSObjects(objectsList, pickMarkers,
-          transverse);
+        childRegion.getPickableThreeJSObjects(objectsList, transverse);
       });
     }
     this.pickableUpdateRequired = false;

package/src/scene.js

@@ -867,8 +867,7 @@ exports.Scene = function (containerIn, rendererIn) {
    */
   this.updatePickableThreeJSObjects = () => {
     pickableObjectsList.splice(0, pickableObjectsList.length);
-    rootRegion.getPickableThreeJSObjects(pickableObjectsList,
-      this.displayMarkers, true);
+    rootRegion.getPickableThreeJSObjects(pickableObjectsList, true);
     this.forcePickableObjectsUpdate = false;
   }