OGC vector tile source

2021-08-29 15:34:29 -06:00
parent 791add0d73
commit 4099f60779
11 changed files with 1512 additions and 308 deletions
--- a/src/ol/source/OGCVectorTile.js
+++ b/src/ol/source/OGCVectorTile.js
@@ -0,0 +1,90 @@
+/**
+ * @module ol/source/OGCVectorTile
+ */
+
+import SourceState from './State.js';
+import VectorTile from './VectorTile.js';
+import {getTileSetInfo} from './ogcTileUtil.js';
+
+/**
+ * @typedef {Object} Options
+ * @property {string} url URL to the OGC Vector Tileset endpoint.
+ * @property {Object} [context] A lookup of values to use in the tile URL template.  The `{tileMatrix}`
+ * (zoom level), `{tileRow}`, and `{tileCol}` variables in the URL will always be provided by the source.
+ * @property {import("../format/Feature.js").default} format Feature parser for tiles.
+ * @property {string} [mediaType] The content type for the tiles (e.g. "application/vnd.mapbox-vector-tile").  If not provided,
+ * the source will try to find a link with rel="item" that uses a supported vector type.  The chosen media type
+ * must be parseable by the configured format.
+ * @property {import("./Source.js").AttributionLike} [attributions] Attributions.
+ * @property {boolean} [attributionsCollapsible=true] Attributions are collapsible.
+ * @property {number} [cacheSize] Initial tile cache size. Will auto-grow to hold at least twice the number of tiles in the viewport.
+ * @property {boolean} [overlaps=true] This source may have overlapping geometries. Setting this
+ * to `false` (e.g. for sources with polygons that represent administrative
+ * boundaries or TopoJSON sources) allows the renderer to optimise fill and
+ * stroke operations.
+ * @property {import("../proj.js").ProjectionLike} [projection='EPSG:3857'] Projection of the tile grid.
+ * @property {typeof import("../VectorTile.js").default} [tileClass] Class used to instantiate image tiles.
+ * Default is {@link module:ol/VectorTile}.
+ * @property {number} [transition] A duration for tile opacity
+ * transitions in milliseconds. A duration of 0 disables the opacity transition.
+ * @property {boolean} [wrapX=true] Whether to wrap the world horizontally.
+ * When set to `false`, only one world
+ * will be rendered. When set to `true`, tiles will be wrapped horizontally to
+ * render multiple worlds.
+ * @property {number|import("../array.js").NearestDirectionFunction} [zDirection=1]
+ * Choose whether to use tiles with a higher or lower zoom level when between integer
+ * zoom levels. See {@link module:ol/tilegrid/TileGrid~TileGrid#getZForResolution}.
+ */
+
+class OGCVectorTile extends VectorTile {
+  /**
+   * @param {Options} options OGC vector tile options.
+   */
+  constructor(options) {
+    super({
+      attributions: options.attributions,
+      attributionsCollapsible: options.attributionsCollapsible,
+      cacheSize: options.cacheSize,
+      format: options.format,
+      overlaps: options.overlaps,
+      projection: options.projection,
+      tileClass: options.tileClass,
+      transition: options.transition,
+      wrapX: options.wrapX,
+      zDirection: options.zDirection,
+      state: SourceState.LOADING,
+    });
+
+    const sourceInfo = {
+      url: options.url,
+      projection: this.getProjection(),
+      mediaType: options.mediaType,
+      context: options.context || null,
+    };
+
+    getTileSetInfo(sourceInfo)
+      .then(this.handleTileSetInfo_.bind(this))
+      .catch(this.handleError_.bind(this));
+  }
+
+  /**
+   * @param {import("./ogcTileUtil.js").TileSetInfo} tileSetInfo Tile set info.
+   * @private
+   */
+  handleTileSetInfo_(tileSetInfo) {
+    this.tileGrid = tileSetInfo.grid;
+    this.setTileUrlFunction(tileSetInfo.urlFunction, tileSetInfo.urlTemplate);
+    this.setState(SourceState.READY);
+  }
+
+  /**
+   * @private
+   * @param {Error} error The error.
+   */
+  handleError_(error) {
+  console.error(error); // eslint-disable-line
+    this.setState(SourceState.ERROR);
+  }
+}
+
+export default OGCVectorTile;