ashatora/openlayers
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Module type for ol.Tile

Browse Source
This commit is contained in:
Frederic Junod
2018-03-19 11:54:05 +01:00
parent fe686ef915
commit 93b2fe0e95
12 changed files with 29 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
src/ol/renderer/Layer.js
View File

@@ -57,11 +57,9 @@ LayerRenderer.prototype.hasFeatureAtCoordinate = FALSE;
* Create a function that adds loaded tiles to the tile lookup.
* @param {ol.source.Tile} source Tile source.
* @param {module:ol/proj/Projection~Projection} projection Projection of the tiles.
* @param {Object.<number, Object.<string, ol.Tile>>} tiles Lookup of loaded
* tiles by zoom level.
* @param {Object.<number, Object.<string, module:ol/Tile~Tile>>} tiles Lookup of loaded tiles by zoom level.
* @return {function(number, module:ol/TileRange~TileRange):boolean} A function that can be
* called with a zoom level and a tile range to add loaded tiles to the
* lookup.
* called with a zoom level and a tile range to add loaded tiles to the lookup.
* @protected
*/
LayerRenderer.prototype.createLoadedTileFinder = function(source, projection, tiles) {
@@ -201,7 +199,7 @@ LayerRenderer.prototype.updateUsedTiles = function(usedTiles, tileSource, z, til
* @param {module:ol/extent~Extent} extent Extent.
* @param {number} currentZ Current Z.
* @param {number} preload Load low resolution tiles up to 'preload' levels.
* @param {function(this: T, ol.Tile)=} opt_tileCallback Tile callback.
* @param {function(this: T, module:ol/Tile~Tile)=} opt_tileCallback Tile callback.
* @param {T=} opt_this Object to use as `this` in `opt_tileCallback`.
* @protected
* @template T

8
src/ol/renderer/canvas/TileLayer.js
View File

@@ -48,7 +48,7 @@ const CanvasTileLayerRenderer = function(tileLayer) {
/**
* @protected
* @type {!Array.<ol.Tile>}
* @type {!Array.<module:ol/Tile~Tile>}
*/
this.renderedTiles = [];
@@ -105,7 +105,7 @@ CanvasTileLayerRenderer['create'] = function(mapRenderer, layer) {
/**
* @private
* @param {ol.Tile} tile Tile.
* @param {module:ol/Tile~Tile} tile Tile.
* @return {boolean} Tile is drawable.
*/
CanvasTileLayerRenderer.prototype.isDrawableTile_ = function(tile) {
@@ -151,7 +151,7 @@ CanvasTileLayerRenderer.prototype.prepareFrame = function(frameState, layerState
const tilePixelRatio = tileSource.getTilePixelRatio(pixelRatio);
/**
* @type {Object.<number, Object.<string, ol.Tile>>}
* @type {Object.<number, Object.<string, module:ol/Tile~Tile>>}
*/
const tilesToDrawByZ = {};
tilesToDrawByZ[z] = {};
@@ -298,7 +298,7 @@ CanvasTileLayerRenderer.prototype.prepareFrame = function(frameState, layerState
/**
* @param {ol.Tile} tile Tile.
* @param {module:ol/Tile~Tile} tile Tile.
* @param {module:ol/PluggableMap~FrameState} frameState Frame state.
* @param {module:ol/layer/Layer~State} layerState Layer state.
* @param {number} x Left of the tile.

8
src/ol/renderer/webgl/Map.js
View File

@@ -136,7 +136,7 @@ const WebGLMapRenderer = function(container, map) {
* @return {string} Key.
*/
function(element) {
return /** @type {ol.Tile} */ (element[0]).getKey();
return /** @type {module:ol/Tile~Tile} */ (element[0]).getKey();
});
@@ -151,7 +151,7 @@ const WebGLMapRenderer = function(container, map) {
if (!this.tileTextureQueue_.isEmpty()) {
this.tileTextureQueue_.reprioritize();
const element = this.tileTextureQueue_.dequeue();
const tile = /** @type {ol.Tile} */ (element[0]);
const tile = /** @type {module:ol/Tile~Tile} */ (element[0]);
const tileSize = /** @type {module:ol/size~Size} */ (element[3]);
const tileGutter = /** @type {number} */ (element[4]);
this.bindTileTexture(
@@ -195,7 +195,7 @@ WebGLMapRenderer['create'] = function(container, map) {
/**
* @param {ol.Tile} tile Tile.
* @param {module:ol/Tile~Tile} tile Tile.
* @param {module:ol/size~Size} tileSize Tile size.
* @param {number} tileGutter Tile gutter.
* @param {number} magFilter Mag filter.
@@ -409,7 +409,7 @@ WebGLMapRenderer.prototype.initializeGL_ = function() {
/**
* @param {ol.Tile} tile Tile.
* @param {module:ol/Tile~Tile} tile Tile.
* @return {boolean} Is tile texture loaded.
*/
WebGLMapRenderer.prototype.isTileTextureLoaded = function(tile) {

4
src/ol/renderer/webgl/TileLayer.js
View File

@@ -242,7 +242,7 @@ WebGLTileLayerRenderer.prototype.prepareFrame = function(frameState, layerState,
gl.uniform1i(this.locations_.u_texture, 0);
/**
* @type {Object.<number, Object.<string, ol.Tile>>}
* @type {Object.<number, Object.<string, module:ol/Tile~Tile>>}
*/
const tilesToDrawByZ = {};
tilesToDrawByZ[z] = {};
@@ -344,7 +344,7 @@ WebGLTileLayerRenderer.prototype.prepareFrame = function(frameState, layerState,
frameState, tileSource, tileGrid, pixelRatio, projection, extent, z,
tileLayer.getPreload(),
/**
* @param {ol.Tile} tile Tile.
* @param {module:ol/Tile~Tile} tile Tile.
*/
function(tile) {
if (tile.getState() == TileState.LOADED &&

4
src/ol/reproj/Tile.js
View File

@@ -18,7 +18,7 @@ import Triangulation from '../reproj/Triangulation.js';
* See {@link ol.source.TileImage}.
*
* @constructor
* @extends {ol.Tile}
* @extends {module:ol/Tile~Tile}
* @param {module:ol/proj/Projection~Projection} sourceProj Source projection.
* @param {module:ol/tilegrid/TileGrid~TileGrid} sourceTileGrid Source tile grid.
* @param {module:ol/proj/Projection~Projection} targetProj Target projection.
@@ -82,7 +82,7 @@ const ReprojTile = function(sourceProj, sourceTileGrid,
/**
* @private
* @type {!Array.<ol.Tile>}
* @type {!Array.<module:ol/Tile~Tile>}
*/
this.sourceTiles_ = [];

10
src/ol/source/Tile.js
View File

@@ -106,7 +106,7 @@ TileSource.prototype.expireCache = function(projection, usedTiles) {
* @param {module:ol/proj/Projection~Projection} projection Projection.
* @param {number} z Zoom level.
* @param {module:ol/TileRange~TileRange} tileRange Tile range.
* @param {function(ol.Tile):(boolean|undefined)} callback Called with each
* @param {function(module:ol/Tile~Tile):(boolean|undefined)} callback Called with each
* loaded tile. If the callback returns `false`, the tile will not be
* considered loaded.
* @return {boolean} The tile range is fully covered with loaded tiles.
@@ -124,7 +124,7 @@ TileSource.prototype.forEachLoadedTile = function(projection, z, tileRange, call
tileCoordKey = getKeyZXY(z, x, y);
loaded = false;
if (tileCache.containsKey(tileCoordKey)) {
tile = /** @type {!ol.Tile} */ (tileCache.get(tileCoordKey));
tile = /** @type {!module:ol/Tile~Tile} */ (tileCache.get(tileCoordKey));
loaded = tile.getState() === TileState.LOADED;
if (loaded) {
loaded = (callback(tile) !== false);
@@ -195,7 +195,7 @@ TileSource.prototype.getResolutions = function() {
* @param {number} y Tile coordinate y.
* @param {number} pixelRatio Pixel ratio.
* @param {module:ol/proj/Projection~Projection} projection Projection.
* @return {!ol.Tile} Tile.
* @return {!module:ol/Tile~Tile} Tile.
*/
TileSource.prototype.getTile = function(z, x, y, pixelRatio, projection) {};
@@ -316,7 +316,7 @@ TileSource.prototype.useTile = UNDEFINED;
* @extends {ol.events.Event}
* @implements {oli.source.Tile.Event}
* @param {string} type Type.
* @param {ol.Tile} tile The tile.
* @param {module:ol/Tile~Tile} tile The tile.
*/
export const TileSourceEvent = function(type, tile) {
@@ -324,7 +324,7 @@ export const TileSourceEvent = function(type, tile) {
/**
* The tile related to the event.
* @type {ol.Tile}
* @type {module:ol/Tile~Tile}
* @api
*/
this.tile = tile;

2
src/ol/source/TileDebug.js
View File

@@ -12,7 +12,7 @@ import {getKeyZXY} from '../tilecoord.js';
/**
* @constructor
* @extends {ol.Tile}
* @extends {module:ol/Tile~Tile}
* @param {module:ol/tilecoord~TileCoord} tileCoord Tile coordinate.
* @param {module:ol/size~Size} tileSize Tile size.
* @param {string} text Text.

6
src/ol/source/TileImage.js
View File

@@ -206,7 +206,7 @@ TileImage.prototype.getTileCacheForProjection = function(projection) {
* @param {number} pixelRatio Pixel ratio.
* @param {module:ol/proj/Projection~Projection} projection Projection.
* @param {string} key The key set on the tile.
* @return {!ol.Tile} Tile.
* @return {!module:ol/Tile~Tile} Tile.
* @private
*/
TileImage.prototype.createTile_ = function(z, x, y, pixelRatio, projection, key) {
@@ -243,7 +243,7 @@ TileImage.prototype.getTile = function(z, x, y, pixelRatio, projection) {
let tile;
const tileCoordKey = getKey(tileCoord);
if (cache.containsKey(tileCoordKey)) {
tile = /** @type {!ol.Tile} */ (cache.get(tileCoordKey));
tile = /** @type {!module:ol/Tile~Tile} */ (cache.get(tileCoordKey));
}
const key = this.getKey();
if (tile && tile.key == key) {
@@ -283,7 +283,7 @@ TileImage.prototype.getTile = function(z, x, y, pixelRatio, projection) {
* @param {number} y Tile coordinate y.
* @param {number} pixelRatio Pixel ratio.
* @param {!module:ol/proj/Projection~Projection} projection Projection.
* @return {!ol.Tile} Tile.
* @return {!module:ol/Tile~Tile} Tile.
* @protected
*/
TileImage.prototype.getTileInternal = function(z, x, y, pixelRatio, projection) {

4
src/ol/source/TileUTFGrid.js
View File

@@ -19,7 +19,7 @@ import {createXYZ, extentFromProjection} from '../tilegrid.js';
/**
* @constructor
* @extends {ol.Tile}
* @extends {module:ol/Tile~Tile}
* @param {module:ol/tilecoord~TileCoord} tileCoord Tile coordinate.
* @param {module:ol/TileState~TileState} state State.
* @param {string} src Image source URI.
@@ -449,7 +449,7 @@ UTFGrid.prototype.handleTileJSONResponse = function(tileJSON) {
UTFGrid.prototype.getTile = function(z, x, y, pixelRatio, projection) {
const tileCoordKey = getKeyZXY(z, x, y);
if (this.tileCache.containsKey(tileCoordKey)) {
return /** @type {!ol.Tile} */ (this.tileCache.get(tileCoordKey));
return /** @type {!module:ol/Tile~Tile} */ (this.tileCache.get(tileCoordKey));
} else {
const tileCoord = [z, x, y];
const urlTileCoord =

2
src/ol/source/UrlTile.js
View File

@@ -116,7 +116,7 @@ UrlTile.prototype.getUrls = function() {
* @protected
*/
UrlTile.prototype.handleTileChange = function(event) {
const tile = /** @type {ol.Tile} */ (event.target);
const tile = /** @type {module:ol/Tile~Tile} */ (event.target);
const uid = getUid(tile);
const tileState = tile.getState();
let type;

2
src/ol/source/VectorTile.js
View File

@@ -112,7 +112,7 @@ VectorTileSource.prototype.clear = function() {
VectorTileSource.prototype.getTile = function(z, x, y, pixelRatio, projection) {
const tileCoordKey = getKeyZXY(z, x, y);
if (this.tileCache.containsKey(tileCoordKey)) {
return /** @type {!ol.Tile} */ (this.tileCache.get(tileCoordKey));
return /** @type {!module:ol/Tile~Tile} */ (this.tileCache.get(tileCoordKey));
} else {
const tileCoord = [z, x, y];
const urlTileCoord = this.getTileCoordForTileUrlFunction(

2
src/ol/typedefs.js
View File

@@ -242,7 +242,7 @@ ol.ReprojImageFunctionType;
/**
* @typedef {function(number, number, number, number) : ol.Tile}
* @typedef {function(number, number, number, number) : module:ol/Tile~Tile}
*/
ol.ReprojTileFunctionType;