333 lines
8.1 KiB
JavaScript
333 lines
8.1 KiB
JavaScript
goog.provide('ol.source.Tile');
|
|
|
|
goog.require('ol');
|
|
goog.require('ol.TileCache');
|
|
goog.require('ol.TileState');
|
|
goog.require('ol.events.Event');
|
|
goog.require('ol.proj');
|
|
goog.require('ol.size');
|
|
goog.require('ol.source.Source');
|
|
goog.require('ol.tilecoord');
|
|
goog.require('ol.tilegrid');
|
|
|
|
|
|
/**
|
|
* @classdesc
|
|
* Abstract base class; normally only used for creating subclasses and not
|
|
* instantiated in apps.
|
|
* Base class for sources providing images divided into a tile grid.
|
|
*
|
|
* @constructor
|
|
* @abstract
|
|
* @extends {ol.source.Source}
|
|
* @param {ol.SourceTileOptions} options Tile source options.
|
|
* @api
|
|
*/
|
|
ol.source.Tile = function(options) {
|
|
|
|
ol.source.Source.call(this, {
|
|
attributions: options.attributions,
|
|
extent: options.extent,
|
|
logo: options.logo,
|
|
projection: options.projection,
|
|
state: options.state,
|
|
wrapX: options.wrapX
|
|
});
|
|
|
|
/**
|
|
* @private
|
|
* @type {boolean}
|
|
*/
|
|
this.opaque_ = options.opaque !== undefined ? options.opaque : false;
|
|
|
|
/**
|
|
* @private
|
|
* @type {number}
|
|
*/
|
|
this.tilePixelRatio_ = options.tilePixelRatio !== undefined ?
|
|
options.tilePixelRatio : 1;
|
|
|
|
/**
|
|
* @protected
|
|
* @type {ol.tilegrid.TileGrid}
|
|
*/
|
|
this.tileGrid = options.tileGrid !== undefined ? options.tileGrid : null;
|
|
|
|
/**
|
|
* @protected
|
|
* @type {ol.TileCache}
|
|
*/
|
|
this.tileCache = new ol.TileCache(options.cacheSize);
|
|
|
|
/**
|
|
* @protected
|
|
* @type {ol.Size}
|
|
*/
|
|
this.tmpSize = [0, 0];
|
|
|
|
/**
|
|
* @private
|
|
* @type {string}
|
|
*/
|
|
this.key_ = '';
|
|
|
|
/**
|
|
* @protected
|
|
* @type {olx.TileOptions}
|
|
*/
|
|
this.tileOptions = {transition: options.transition};
|
|
|
|
};
|
|
ol.inherits(ol.source.Tile, ol.source.Source);
|
|
|
|
|
|
/**
|
|
* @return {boolean} Can expire cache.
|
|
*/
|
|
ol.source.Tile.prototype.canExpireCache = function() {
|
|
return this.tileCache.canExpireCache();
|
|
};
|
|
|
|
|
|
/**
|
|
* @param {ol.proj.Projection} projection Projection.
|
|
* @param {Object.<string, ol.TileRange>} usedTiles Used tiles.
|
|
*/
|
|
ol.source.Tile.prototype.expireCache = function(projection, usedTiles) {
|
|
var tileCache = this.getTileCacheForProjection(projection);
|
|
if (tileCache) {
|
|
tileCache.expireCache(usedTiles);
|
|
}
|
|
};
|
|
|
|
|
|
/**
|
|
* @param {ol.proj.Projection} projection Projection.
|
|
* @param {number} z Zoom level.
|
|
* @param {ol.TileRange} tileRange Tile range.
|
|
* @param {function(ol.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.
|
|
*/
|
|
ol.source.Tile.prototype.forEachLoadedTile = function(projection, z, tileRange, callback) {
|
|
var tileCache = this.getTileCacheForProjection(projection);
|
|
if (!tileCache) {
|
|
return false;
|
|
}
|
|
|
|
var covered = true;
|
|
var tile, tileCoordKey, loaded;
|
|
for (var x = tileRange.minX; x <= tileRange.maxX; ++x) {
|
|
for (var y = tileRange.minY; y <= tileRange.maxY; ++y) {
|
|
tileCoordKey = ol.tilecoord.getKeyZXY(z, x, y);
|
|
loaded = false;
|
|
if (tileCache.containsKey(tileCoordKey)) {
|
|
tile = /** @type {!ol.Tile} */ (tileCache.get(tileCoordKey));
|
|
loaded = tile.getState() === ol.TileState.LOADED;
|
|
if (loaded) {
|
|
loaded = (callback(tile) !== false);
|
|
}
|
|
}
|
|
if (!loaded) {
|
|
covered = false;
|
|
}
|
|
}
|
|
}
|
|
return covered;
|
|
};
|
|
|
|
|
|
/**
|
|
* @param {ol.proj.Projection} projection Projection.
|
|
* @return {number} Gutter.
|
|
*/
|
|
ol.source.Tile.prototype.getGutter = function(projection) {
|
|
return 0;
|
|
};
|
|
|
|
|
|
/**
|
|
* Return the key to be used for all tiles in the source.
|
|
* @return {string} The key for all tiles.
|
|
* @protected
|
|
*/
|
|
ol.source.Tile.prototype.getKey = function() {
|
|
return this.key_;
|
|
};
|
|
|
|
|
|
/**
|
|
* Set the value to be used as the key for all tiles in the source.
|
|
* @param {string} key The key for tiles.
|
|
* @protected
|
|
*/
|
|
ol.source.Tile.prototype.setKey = function(key) {
|
|
if (this.key_ !== key) {
|
|
this.key_ = key;
|
|
this.changed();
|
|
}
|
|
};
|
|
|
|
|
|
/**
|
|
* @param {ol.proj.Projection} projection Projection.
|
|
* @return {boolean} Opaque.
|
|
*/
|
|
ol.source.Tile.prototype.getOpaque = function(projection) {
|
|
return this.opaque_;
|
|
};
|
|
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
ol.source.Tile.prototype.getResolutions = function() {
|
|
return this.tileGrid.getResolutions();
|
|
};
|
|
|
|
|
|
/**
|
|
* @abstract
|
|
* @param {number} z Tile coordinate z.
|
|
* @param {number} x Tile coordinate x.
|
|
* @param {number} y Tile coordinate y.
|
|
* @param {number} pixelRatio Pixel ratio.
|
|
* @param {ol.proj.Projection} projection Projection.
|
|
* @return {!ol.Tile} Tile.
|
|
*/
|
|
ol.source.Tile.prototype.getTile = function(z, x, y, pixelRatio, projection) {};
|
|
|
|
|
|
/**
|
|
* Return the tile grid of the tile source.
|
|
* @return {ol.tilegrid.TileGrid} Tile grid.
|
|
* @api
|
|
*/
|
|
ol.source.Tile.prototype.getTileGrid = function() {
|
|
return this.tileGrid;
|
|
};
|
|
|
|
|
|
/**
|
|
* @param {ol.proj.Projection} projection Projection.
|
|
* @return {!ol.tilegrid.TileGrid} Tile grid.
|
|
*/
|
|
ol.source.Tile.prototype.getTileGridForProjection = function(projection) {
|
|
if (!this.tileGrid) {
|
|
return ol.tilegrid.getForProjection(projection);
|
|
} else {
|
|
return this.tileGrid;
|
|
}
|
|
};
|
|
|
|
|
|
/**
|
|
* @param {ol.proj.Projection} projection Projection.
|
|
* @return {ol.TileCache} Tile cache.
|
|
* @protected
|
|
*/
|
|
ol.source.Tile.prototype.getTileCacheForProjection = function(projection) {
|
|
var thisProj = this.getProjection();
|
|
if (thisProj && !ol.proj.equivalent(thisProj, projection)) {
|
|
return null;
|
|
} else {
|
|
return this.tileCache;
|
|
}
|
|
};
|
|
|
|
|
|
/**
|
|
* Get the tile pixel ratio for this source. Subclasses may override this
|
|
* method, which is meant to return a supported pixel ratio that matches the
|
|
* provided `pixelRatio` as close as possible.
|
|
* @param {number} pixelRatio Pixel ratio.
|
|
* @return {number} Tile pixel ratio.
|
|
*/
|
|
ol.source.Tile.prototype.getTilePixelRatio = function(pixelRatio) {
|
|
return this.tilePixelRatio_;
|
|
};
|
|
|
|
|
|
/**
|
|
* @param {number} z Z.
|
|
* @param {number} pixelRatio Pixel ratio.
|
|
* @param {ol.proj.Projection} projection Projection.
|
|
* @return {ol.Size} Tile size.
|
|
*/
|
|
ol.source.Tile.prototype.getTilePixelSize = function(z, pixelRatio, projection) {
|
|
var tileGrid = this.getTileGridForProjection(projection);
|
|
var tilePixelRatio = this.getTilePixelRatio(pixelRatio);
|
|
var tileSize = ol.size.toSize(tileGrid.getTileSize(z), this.tmpSize);
|
|
if (tilePixelRatio == 1) {
|
|
return tileSize;
|
|
} else {
|
|
return ol.size.scale(tileSize, tilePixelRatio, this.tmpSize);
|
|
}
|
|
};
|
|
|
|
|
|
/**
|
|
* Returns a tile coordinate wrapped around the x-axis. When the tile coordinate
|
|
* is outside the resolution and extent range of the tile grid, `null` will be
|
|
* returned.
|
|
* @param {ol.TileCoord} tileCoord Tile coordinate.
|
|
* @param {ol.proj.Projection=} opt_projection Projection.
|
|
* @return {ol.TileCoord} Tile coordinate to be passed to the tileUrlFunction or
|
|
* null if no tile URL should be created for the passed `tileCoord`.
|
|
*/
|
|
ol.source.Tile.prototype.getTileCoordForTileUrlFunction = function(tileCoord, opt_projection) {
|
|
var projection = opt_projection !== undefined ?
|
|
opt_projection : this.getProjection();
|
|
var tileGrid = this.getTileGridForProjection(projection);
|
|
if (this.getWrapX() && projection.isGlobal()) {
|
|
tileCoord = ol.tilegrid.wrapX(tileGrid, tileCoord, projection);
|
|
}
|
|
return ol.tilecoord.withinExtentAndZ(tileCoord, tileGrid) ? tileCoord : null;
|
|
};
|
|
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
ol.source.Tile.prototype.refresh = function() {
|
|
this.tileCache.clear();
|
|
this.changed();
|
|
};
|
|
|
|
|
|
/**
|
|
* Marks a tile coord as being used, without triggering a load.
|
|
* @param {number} z Tile coordinate z.
|
|
* @param {number} x Tile coordinate x.
|
|
* @param {number} y Tile coordinate y.
|
|
* @param {ol.proj.Projection} projection Projection.
|
|
*/
|
|
ol.source.Tile.prototype.useTile = ol.nullFunction;
|
|
|
|
|
|
/**
|
|
* @classdesc
|
|
* Events emitted by {@link ol.source.Tile} instances are instances of this
|
|
* type.
|
|
*
|
|
* @constructor
|
|
* @extends {ol.events.Event}
|
|
* @implements {oli.source.Tile.Event}
|
|
* @param {string} type Type.
|
|
* @param {ol.Tile} tile The tile.
|
|
*/
|
|
ol.source.Tile.Event = function(type, tile) {
|
|
|
|
ol.events.Event.call(this, type);
|
|
|
|
/**
|
|
* The tile related to the event.
|
|
* @type {ol.Tile}
|
|
* @api
|
|
*/
|
|
this.tile = tile;
|
|
|
|
};
|
|
ol.inherits(ol.source.Tile.Event, ol.events.Event);
|