189 lines
4.9 KiB
JavaScript
189 lines
4.9 KiB
JavaScript
goog.provide('ol.source.TileImage');
|
|
|
|
goog.require('goog.asserts');
|
|
goog.require('goog.events');
|
|
goog.require('goog.events.EventType');
|
|
goog.require('ol.ImageTile');
|
|
goog.require('ol.TileCoord');
|
|
goog.require('ol.TileLoadFunctionType');
|
|
goog.require('ol.TileState');
|
|
goog.require('ol.TileUrlFunction');
|
|
goog.require('ol.TileUrlFunctionType');
|
|
goog.require('ol.source.Tile');
|
|
|
|
|
|
|
|
/**
|
|
* @classdesc
|
|
* Base class for sources providing images divided into a tile grid.
|
|
*
|
|
* @constructor
|
|
* @fires ol.source.TileEvent
|
|
* @extends {ol.source.Tile}
|
|
* @param {olx.source.TileImageOptions} options Image tile options.
|
|
* @api
|
|
*/
|
|
ol.source.TileImage = function(options) {
|
|
|
|
goog.base(this, {
|
|
attributions: options.attributions,
|
|
extent: options.extent,
|
|
logo: options.logo,
|
|
opaque: options.opaque,
|
|
projection: options.projection,
|
|
state: goog.isDef(options.state) ?
|
|
/** @type {ol.source.State} */ (options.state) : undefined,
|
|
tileGrid: options.tileGrid,
|
|
tilePixelRatio: options.tilePixelRatio,
|
|
wrapX: options.wrapX
|
|
});
|
|
|
|
/**
|
|
* @protected
|
|
* @type {ol.TileUrlFunctionType}
|
|
*/
|
|
this.tileUrlFunction = goog.isDef(options.tileUrlFunction) ?
|
|
options.tileUrlFunction :
|
|
ol.TileUrlFunction.nullTileUrlFunction;
|
|
|
|
/**
|
|
* @protected
|
|
* @type {?string}
|
|
*/
|
|
this.crossOrigin =
|
|
goog.isDef(options.crossOrigin) ? options.crossOrigin : null;
|
|
|
|
/**
|
|
* @protected
|
|
* @type {ol.TileLoadFunctionType}
|
|
*/
|
|
this.tileLoadFunction = goog.isDef(options.tileLoadFunction) ?
|
|
options.tileLoadFunction : ol.source.TileImage.defaultTileLoadFunction;
|
|
|
|
/**
|
|
* @protected
|
|
* @type {function(new: ol.ImageTile, ol.TileCoord, ol.TileState, string,
|
|
* ?string, ol.TileLoadFunctionType)}
|
|
*/
|
|
this.tileClass = goog.isDef(options.tileClass) ?
|
|
options.tileClass : ol.ImageTile;
|
|
|
|
};
|
|
goog.inherits(ol.source.TileImage, ol.source.Tile);
|
|
|
|
|
|
/**
|
|
* @param {ol.ImageTile} imageTile Image tile.
|
|
* @param {string} src Source.
|
|
*/
|
|
ol.source.TileImage.defaultTileLoadFunction = function(imageTile, src) {
|
|
imageTile.getImage().src = src;
|
|
};
|
|
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
ol.source.TileImage.prototype.getTile =
|
|
function(z, x, y, pixelRatio, projection) {
|
|
var tileCoordKey = this.getKeyZXY(z, x, y);
|
|
if (this.tileCache.containsKey(tileCoordKey)) {
|
|
return /** @type {!ol.Tile} */ (this.tileCache.get(tileCoordKey));
|
|
} else {
|
|
goog.asserts.assert(projection);
|
|
var tileCoord = [z, x, y];
|
|
var urlTileCoord = this.getWrapXTileCoord(tileCoord, projection);
|
|
var tileUrl = goog.isNull(urlTileCoord) ? undefined :
|
|
this.tileUrlFunction(urlTileCoord, pixelRatio, projection);
|
|
var tile = new this.tileClass(
|
|
tileCoord,
|
|
goog.isDef(tileUrl) ? ol.TileState.IDLE : ol.TileState.EMPTY,
|
|
goog.isDef(tileUrl) ? tileUrl : '',
|
|
this.crossOrigin,
|
|
this.tileLoadFunction);
|
|
goog.events.listen(tile, goog.events.EventType.CHANGE,
|
|
this.handleTileChange_, false, this);
|
|
|
|
this.tileCache.set(tileCoordKey, tile);
|
|
return tile;
|
|
}
|
|
};
|
|
|
|
|
|
/**
|
|
* @return {ol.TileLoadFunctionType} TileLoadFunction
|
|
* @api
|
|
*/
|
|
ol.source.TileImage.prototype.getTileLoadFunction = function() {
|
|
return this.tileLoadFunction;
|
|
};
|
|
|
|
|
|
/**
|
|
* @return {ol.TileUrlFunctionType} TileUrlFunction
|
|
* @api
|
|
*/
|
|
ol.source.TileImage.prototype.getTileUrlFunction = function() {
|
|
return this.tileUrlFunction;
|
|
};
|
|
|
|
|
|
/**
|
|
* Handle tile change events.
|
|
* @param {goog.events.Event} event Event.
|
|
* @private
|
|
*/
|
|
ol.source.TileImage.prototype.handleTileChange_ = function(event) {
|
|
var tile = /** @type {ol.Tile} */ (event.target);
|
|
switch (tile.getState()) {
|
|
case ol.TileState.LOADING:
|
|
this.dispatchEvent(
|
|
new ol.source.TileEvent(ol.source.TileEventType.TILELOADSTART, tile));
|
|
break;
|
|
case ol.TileState.LOADED:
|
|
this.dispatchEvent(
|
|
new ol.source.TileEvent(ol.source.TileEventType.TILELOADEND, tile));
|
|
break;
|
|
case ol.TileState.ERROR:
|
|
this.dispatchEvent(
|
|
new ol.source.TileEvent(ol.source.TileEventType.TILELOADERROR, tile));
|
|
break;
|
|
}
|
|
};
|
|
|
|
|
|
/**
|
|
* @param {ol.TileLoadFunctionType} tileLoadFunction Tile load function.
|
|
* @api
|
|
*/
|
|
ol.source.TileImage.prototype.setTileLoadFunction = function(tileLoadFunction) {
|
|
this.tileCache.clear();
|
|
this.tileLoadFunction = tileLoadFunction;
|
|
this.changed();
|
|
};
|
|
|
|
|
|
/**
|
|
* @param {ol.TileUrlFunctionType} tileUrlFunction Tile URL function.
|
|
* @api
|
|
*/
|
|
ol.source.TileImage.prototype.setTileUrlFunction = function(tileUrlFunction) {
|
|
// FIXME It should be possible to be more intelligent and avoid clearing the
|
|
// FIXME cache. The tile URL function would need to be incorporated into the
|
|
// FIXME cache key somehow.
|
|
this.tileCache.clear();
|
|
this.tileUrlFunction = tileUrlFunction;
|
|
this.changed();
|
|
};
|
|
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
ol.source.TileImage.prototype.useTile = function(z, x, y) {
|
|
var tileCoordKey = this.getKeyZXY(z, x, y);
|
|
if (this.tileCache.containsKey(tileCoordKey)) {
|
|
this.tileCache.get(tileCoordKey);
|
|
}
|
|
};
|