geojs 1.6.6 → 1.7.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "geojs",
-  "version": "1.6.6",
+  "version": "1.7.0",
   "description": "JavaScript Geo Visualization and Analysis Library",
   "homepage": "https://github.com/OpenGeoscience/geojs",
   "license": "Apache-2.0",

package/src/canvas/pixelmapFeature.js

@@ -4,6 +4,25 @@ var pixelmapFeature = require('../pixelmapFeature');
 var geo_event = require('../event');
 var util = require('../util');
 
+/**
+ * Pixelmap feature information record.
+ *
+ * @typedef {object} geo.pixelmapFeature.info
+ * @property {number} width The width of the source image.
+ * @property {number} height The width of the source image.
+ * @property {CanvasRenderingContext2D} context The HTMLCanvasElement context
+ *    used for handling the pixelmap.
+ * @property {ImageData} imageData The context's image data.
+ * @property {number[]} indices An array, one per pixel, of the index value in
+ *    the image.  This decodes the pixel value to the corresponding integer.
+ * @property number} area The number of pixels in the image.  This is
+ *    `width * height`.
+ * @property {object[]} mappedColors This has one entry for each distinct index
+ *    value.  Each entry has `first` and `last` with the first and last pixel
+ *    locations where that index occurs.  Note that last is the inclusive value
+ *    of the location (so its maximum possible value is `size - 1`).
+ */
+
 /**
  * Create a new instance of class pixelmapFeature.
  *
@@ -116,11 +135,13 @@ var canvas_pixelmapFeature = function (arg) {
         updateFirst, updateLast = -1, update, prepared;
 
     if (!m_this.m_info) {
+      m_this.indexModified(undefined, 'clear');
       if (!m_this._preparePixelmap()) {
         return;
       }
       prepared = true;
     }
+    m_this.indexModified(undefined, 'clear');
     mappedColors = m_this.m_info.mappedColors;
     updateFirst = m_this.m_info.area;
     for (idx in mappedColors) {

package/src/index.js

@@ -77,6 +77,7 @@ module.exports = $.extend({
   polygonFeature: require('./polygonFeature'),
   quadFeature: require('./quadFeature'),
   pixelmapFeature: require('./pixelmapFeature'),
+  pixelmapLayer: require('./pixelmapLayer'),
   renderer: require('./renderer'),
   sceneObject: require('./sceneObject'),
   textFeature: require('./textFeature'),

package/src/pixelmapFeature.js

@@ -30,25 +30,6 @@ var util = require('./util');
  *   transformations for those two triangles.
  */
 
-/**
- * Pixelmap feature information record.
- *
- * @typedef {object} geo.pixelmapFeature.info
- * @property {number} width The width of the source image.
- * @property {number} height The width of the source image.
- * @property {context} context The HTMLCanvasElement context used for handling
- *    the pixelmap.
- * @property {ImageData} imageData The context's image data.
- * @property {number[]} indices An array, one per pixel, of the index value in
- *    the image.  This decodes the pixel value to the corresponding integer.
- * @property number} area The number of pixels in the image.  This is
- *    `width * height`.
- * @property {object[]} mappedColors This has one entry for each distinct index
- *    value.  Each entry has `first` and `last` with the first and last pixel
- *    locations where that index occurs.  Note that last is the inclusive value
- *    of the location (so its maximum possible value is `size - 1`).
- */
-
 /**
  * Create a new instance of class pixelmapFeature
  *
@@ -72,6 +53,7 @@ var pixelmapFeature = function (arg) {
    */
   var m_this = this,
       s_update = this._update,
+      m_modifiedIndexRange,
       s_init = this._init;
 
   this.featureType = 'pixelmap';
@@ -134,6 +116,42 @@ var pixelmapFeature = function (arg) {
     return m_this;
   };
 
+  /**
+   * Mark that an index's data value (and hence its color) has changed without
+   * marking all of the data array as changed.  If this function is called
+   * without any parameters, it clears the tracked changes.
+   *
+   * @param {number} [idx] The lowest data index that has changed.  If
+   *    `undefined`, return the current tracked changed range.
+   * @param {number|'clear'} [idx2] If an index was specified in `idx` and
+   *    this is specified, the highest index (inclusive) that has changed.  If
+   *    returning the tracked changed range and this is `clear`, clear the
+   *    tracked range.
+   * @returns {this|number[]} When returning a range, this is the lowest and
+   *    highest index values that have changed (inclusive), so their range is
+   *    `[0, data.length)`.
+   */
+  this.indexModified = function (idx, idx2) {
+    if (idx === undefined) {
+      const range = m_modifiedIndexRange;
+      if (idx2 === 'clear') {
+        m_modifiedIndexRange = undefined;
+      }
+      return range;
+    }
+    m_this.modified();
+    if (m_modifiedIndexRange === undefined) {
+      m_modifiedIndexRange = [idx, idx];
+    }
+    if (idx < m_modifiedIndexRange[0]) {
+      m_modifiedIndexRange[0] = idx;
+    }
+    if ((idx2 || idx) > m_modifiedIndexRange[1]) {
+      m_modifiedIndexRange[1] = (idx2 || idx);
+    }
+    return m_this;
+  };
+
   /**
    * Update.
    *
@@ -192,7 +210,6 @@ var pixelmapFeature = function (arg) {
      * drawing a quad, which can trigger a full layer update, which in turn
      * checks if this feature is built.  Setting the build time avoids calling
      * this a second time. */
-    m_this.buildTime().modified();
     if (!m_this.m_srcImage) {
       var src = m_this.style.get('url')();
       if (util.isReadyImage(src)) {
@@ -243,6 +260,7 @@ var pixelmapFeature = function (arg) {
     } else if (m_this.m_info) {
       m_this._computePixelmap();
     }
+    m_this.buildTime().modified();
     return m_this;
   };
 
@@ -282,6 +300,10 @@ var pixelmapFeature = function (arg) {
     }
     m_this.style(style);
     m_this.dataTime().modified();
+    if (arg.quadFeature) {
+      m_this.m_srcImage = true;
+      m_this._computePixelmap();
+    }
 
     return m_this;
   };
@@ -307,7 +329,9 @@ pixelmapFeature.create = function (layer, spec) {
 
 pixelmapFeature.capabilities = {
   /* core feature name -- support in any manner */
-  feature: 'pixelmap'
+  feature: 'pixelmap',
+  /* support for image-based lookup */
+  lookup: 'pixelmap.lookup'
 };
 
 inherit(pixelmapFeature, feature);

package/src/pixelmapLayer.js

@@ -0,0 +1,145 @@
+var $ = require('jquery');
+var inherit = require('./inherit');
+var tileLayer = require('./tileLayer');
+var registry = require('./registry');
+var quadFeature = require('./quadFeature');
+var pixelmapFeature = require('./pixelmapFeature');
+
+/**
+ * Object specification for a pixelmap layer.
+ *
+ * @typedef {geo.tileLayer.spec} geo.pixelmapLayer.spec
+ * @extends {geo.tileLayer.spec}
+ * @property {geo.geoColor|function} [color] The color that should be used
+ *   for each data element.  Data elements correspond to the indices in the
+ *   pixel map. If an index is larger than the number of data elements, it will
+ *   be transparent.  If there is more data than there are indices, it is
+ *   ignored.
+ * @property {object} [style] An optional style object that could contain
+ *   `color` or other style values.
+ * @property {array} [data] A new data array.
+ * @property {string} [crossDomain='anonymous'] Image CORS attribute.  This is
+ *   used for the `crossorigin` property when loading images.
+ */
+
+/**
+ * Create a new instance of pixelmapLayer.  This is a {@link geo.tileLayer} with
+ * an OSM url and attribution defaults and with the tiles centered on the
+ * origin.
+ *
+ * @class
+ * @alias geo.pixelmapLayer
+ * @extends geo.tileLayer
+ *
+ * @param {geo.pixelmapLayer.spec} [arg] Specification for the layer.
+ */
+var pixelmapLayer = function (arg) {
+
+  var imageTile = require('./imageTile');
+
+  if (!(this instanceof pixelmapLayer)) {
+    return new pixelmapLayer(arg);
+  }
+  arg = arg || {};
+  arg = $.extend(
+    true,
+    {},
+    this.constructor.defaults,
+    arg);
+  tileLayer.call(this, arg);
+
+  var s_init = this._init,
+      m_pixelmapFeature,
+      m_this = this;
+
+  /**
+   * Returns an instantiated imageTile object with the given indices.  This
+   * method always returns a new tile object.  Use `_getTileCached` to use
+   * the caching layer.
+   *
+   * @param {object} index The tile index.
+   * @param {number} index.x
+   * @param {number} index.y
+   * @param {number} index.level
+   * @param {object} source The tile index used for constructing the url.
+   * @param {number} source.x
+   * @param {number} source.y
+   * @param {number} source.level
+   * @returns {geo.tile}
+   */
+  this._getTile = function (index, source) {
+    var urlParams = source || index;
+    return imageTile({
+      index: index,
+      size: {x: m_this._options.tileWidth, y: m_this._options.tileHeight},
+      queue: m_this._queue,
+      overlap: m_this._options.tileOverlap,
+      scale: m_this._options.tileScale,
+      url: m_this._options.url.call(
+        m_this, urlParams.x, urlParams.y, urlParams.level || 0,
+        m_this._options.subdomains),
+      crossDomain: m_this._options.crossDomain
+    });
+  };
+
+  /**
+   * Initialize.
+   *
+   * @returns {this} The current layer.
+   */
+  this._init = function () {
+    // Call super class init
+    s_init.apply(m_this, arguments);
+
+    const pixelmapArgs = {quadFeature: m_this.features()[0]};
+    if (arg.style) {
+      pixelmapArgs.style = arg.style;
+    }
+    if (arg.color) {
+      pixelmapArgs.color = arg.color;
+    }
+    m_pixelmapFeature = m_this.createFeature('pixelmap', pixelmapArgs);
+    if (arg.data) {
+      m_pixelmapFeature.data(arg.data);
+    }
+    m_this.style = m_pixelmapFeature.style;
+    m_this.data = m_pixelmapFeature.data;
+    m_this.indexModified = m_pixelmapFeature.indexModified;
+    const s_dataTimeModified = m_this.dataTime().modified;
+    m_this.dataTime().modified = () => {
+      m_pixelmapFeature.dataTime().modified();
+      return s_dataTimeModified();
+    };
+    ['modified', 'geoOn', 'geoOff', 'geoOnce'].forEach((funcName) => {
+      const superFunc = m_this[funcName];
+      m_this[funcName] = function () {
+        m_pixelmapFeature[funcName].apply(this, arguments);
+        return superFunc.apply(this, arguments);
+      };
+    });
+    return m_this;
+  };
+
+  return m_this;
+};
+
+/**
+ * This object contains the default options used to initialize the
+ * pixelmapLayer.
+ */
+pixelmapLayer.defaults = $.extend({}, tileLayer.defaults, {
+  features: [quadFeature.capabilities.image, pixelmapFeature.capabilities.lookup],
+  tileOffset : function (level) {
+    var s = Math.pow(2, level - 1) * 256;
+    return {x: s, y: s};
+  },
+  url: ''
+});
+
+inherit(pixelmapLayer, tileLayer);
+/* By default, ask to support image quads.  If the user needs full
+ * reprojection, they will need to require the
+ * quadFeature.capabilities.imageFull feature */
+registry.registerLayer('pixelmap', pixelmapLayer, [quadFeature.capabilities.image]);
+
+module.exports = pixelmapLayer;

package/src/tileLayer.js

@@ -676,7 +676,7 @@ var tileLayer = function (arg) {
   this._getTiles = function (maxLevel, bounds, sorted, onlyIfChanged) {
     var i, j, tiles = [], index, nTilesLevel,
         start, end, indexRange, source, center, changed = false, old, level,
-        minLevel = (m_this._options.keepLower ? m_this._options.minLevel : maxLevel);
+        minLevel = (m_this._options.keepLower ? m_this._options.minLevel : Math.max(maxLevel, m_this._options.minLevel));
     if (maxLevel < minLevel) {
       maxLevel = minLevel;
     }
@@ -1532,7 +1532,8 @@ var tileLayer = function (arg) {
        * finished, purge all but the current layer.  This is important for
        * semi-transparent layers. */
       if ((doneLoading || m_this._isCovered(tile)) &&
-          zoom !== tile.index.level) {
+          zoom !== tile.index.level &&
+          (zoom >= m_this._options.minLevel || tile.index.level !== m_this._options.minLevel)) {
         return true;
       }
     }

package/src/webgl/pixelmapFeature.js

@@ -28,6 +28,7 @@ var webgl_pixelmapFeature = function (arg) {
   const fragmentShader = require('./pixelmapFeature.frag');
 
   var m_quadFeature,
+      m_quadFeatureInit,
       s_exit = this._exit,
       m_lookupTable,
       m_this = this;
@@ -46,25 +47,28 @@ var webgl_pixelmapFeature = function (arg) {
   this.pointSearch = function (geo, gcs) {
     if (m_quadFeature && m_this.m_info) {
       let result = m_quadFeature.pointSearch(geo, gcs);
-      if (result.index.length === 1 &&
-          result.extra && result.extra[result.index[0]].basis &&
-          result.extra[result.index[0]]._quad &&
-          result.extra[result.index[0]]._quad.image) {
-        const img = result.extra[result.index[0]]._quad.image;
-        const basis = result.extra[result.index[0]].basis;
-        const x = Math.floor(basis.x * img.width);
-        const y = Math.floor(basis.y * img.height);
-        const canvas = document.createElement('canvas');
-        canvas.width = canvas.height = 1;
-        const context = canvas.getContext('2d');
-        context.drawImage(img, x, y, 1, 1, 0, 0, 1, 1);
-        const pixel = context.getImageData(0, 0, 1, 1).data;
-        const idx = pixel[0] + pixel[1] * 256 + pixel[2] * 256 * 256;
-        result = {
-          index: [idx],
-          found: [m_this.data()[idx]]
-        };
-        return result;
+      // use the last index by preference, since for tile layers, this is the
+      // topmosttile
+      let idxIdx = result.index.length - 1;
+      for (; idxIdx >= 0; idxIdx -= 1) {
+        if (result.extra[result.index[idxIdx]]._quad &&
+            result.extra[result.index[idxIdx]]._quad.image) {
+          const img = result.extra[result.index[idxIdx]]._quad.image;
+          const basis = result.extra[result.index[idxIdx]].basis;
+          const x = Math.floor(basis.x * img.width);
+          const y = Math.floor(basis.y * img.height);
+          const canvas = document.createElement('canvas');
+          canvas.width = canvas.height = 1;
+          const context = canvas.getContext('2d');
+          context.drawImage(img, x, y, 1, 1, 0, 0, 1, 1);
+          const pixel = context.getImageData(0, 0, 1, 1).data;
+          const idx = pixel[0] + pixel[1] * 256 + pixel[2] * 256 * 256;
+          result = {
+            index: [idx],
+            found: [m_this.data()[idx]]
+          };
+          return result;
+        }
       }
     }
     return {index: [], found: []};
@@ -78,34 +82,49 @@ var webgl_pixelmapFeature = function (arg) {
     var data = m_this.data() || [],
         colorFunc = m_this.style.get('color');
 
+    let indexRange = m_this.indexModified(undefined, 'clear');
+    let fullUpdate = m_this.dataTime().timestamp() >= m_this.buildTime().timestamp() || indexRange === undefined;
     if (!m_lookupTable) {
       m_lookupTable = lookupTable2D();
       m_lookupTable.setTextureUnit(1);
+      fullUpdate = true;
     }
     let clrLen = Math.max(1, data.length);
     const maxWidth = m_lookupTable.maxWidth();
     if (clrLen > maxWidth && clrLen % maxWidth) {
       clrLen += maxWidth - (clrLen % maxWidth);
     }
-    const colors = new Uint8Array(clrLen * 4);
-    data.forEach((d, i) => {
+
+    let colors;
+    if (!fullUpdate) {
+      colors = m_lookupTable.colorTable();
+      fullUpdate = colors.length !== clrLen * 4;
+      indexRange[0] = Math.max(0, indexRange[0]);
+      indexRange[1] = Math.min(data.length, indexRange[1] + 1);
+    }
+    if (fullUpdate) {
+      colors = new Uint8Array(clrLen * 4);
+      indexRange = [0, data.length];
+    }
+    for (let i = indexRange[0]; i < indexRange[1]; i += 1) {
+      const d = data[i];
       const color = util.convertColor(colorFunc.call(m_this, d, i));
       colors[i * 4] = color.r * 255;
       colors[i * 4 + 1] = color.g * 255;
       colors[i * 4 + 2] = color.b * 255;
       colors[i * 4 + 3] = color.a === undefined ? 255 : (color.a * 255);
-    });
+    }
     m_this.m_info = {colors: colors};
     // check if colors haven't changed
     var oldcolors = m_lookupTable.colorTable();
     if (oldcolors && oldcolors.length === colors.length) {
-      let idx = 0;
-      for (; idx < colors.length; idx += 1) {
+      let idx = indexRange[0] * 4;
+      for (; idx < indexRange[1] * 4; idx += 1) {
         if (colors[idx] !== oldcolors[idx]) {
           break;
         }
       }
-      if (idx === colors.length) {
+      if (idx === indexRange[1] * 4) {
         return;
       }
     }
@@ -117,6 +136,9 @@ var webgl_pixelmapFeature = function (arg) {
         gcs: m_this.gcs(),
         visible: m_this.visible(undefined, true)
       });
+      m_quadFeatureInit = false;
+    }
+    if (!m_quadFeatureInit) {
       m_this.dependentFeatures([m_quadFeature]);
       m_quadFeature.setShader('image_fragment', fragmentShader);
       m_quadFeature._hookBuild = (prog) => {
@@ -138,11 +160,14 @@ var webgl_pixelmapFeature = function (arg) {
         });
         m_lookupTable.bind(renderState, quads);
       };
-      m_quadFeature.style({
-        image: m_this.m_srcImage,
-        position: m_this.style.get('position')})
-      .data([{}])
-      .draw();
+      if (m_quadFeatureInit === false) {
+        m_quadFeature.style({
+          image: m_this.m_srcImage,
+          position: m_this.style.get('position')})
+        .data([{}])
+        .draw();
+      }
+      m_quadFeatureInit = true;
     }
   };
 
@@ -161,6 +186,9 @@ var webgl_pixelmapFeature = function (arg) {
     return m_this;
   };
 
+  if (arg.quadFeature) {
+    m_quadFeature = arg.quadFeature;
+  }
   this._init(arg);
   return this;
 };
@@ -168,5 +196,8 @@ var webgl_pixelmapFeature = function (arg) {
 inherit(webgl_pixelmapFeature, pixelmapFeature);
 
 // Now register it
-registerFeature('webgl', 'pixelmap', webgl_pixelmapFeature);
+var capabilities = {};
+capabilities[pixelmapFeature.capabilities.lookup] = true;
+
+registerFeature('webgl', 'pixelmap', webgl_pixelmapFeature, capabilities);
 module.exports = webgl_pixelmapFeature;

package/src/webgl/quadFeature.js

@@ -371,7 +371,9 @@ var webgl_quadFeature = function (arg) {
         return;
       }
       quad.texture.bind(renderState);
-      if (context.getError() === context.OUT_OF_MEMORY) {
+      // only check if the context is out of memory when using modestly large
+      // textures.  The check is slow.
+      if ((quad.image.width > 4096 || quad.image.height > 4096 || quad.image.width * quad.image.height > 4194304) && context.getError() === context.OUT_OF_MEMORY) {
         console.log('Insufficient GPU memory for texture');
       }
       if (quad.opacity !== opacity) {