fbdbbfb7a7
This change adds a stability value to the api annotation, with 'experimental' as default value. enum, typedef and event annotations are never exportable, but api annotations are needed there to make them appear in the docs. Nested typedefs are no longer inlined recursively, because the resulting tables get too wide with the current template.
172 lines
3.2 KiB
JavaScript
172 lines
3.2 KiB
JavaScript
goog.provide('ol.TileCoord');
|
|
|
|
goog.require('goog.array');
|
|
goog.require('goog.asserts');
|
|
|
|
|
|
/**
|
|
* @enum {number}
|
|
*/
|
|
ol.QuadKeyCharCode = {
|
|
ZERO: '0'.charCodeAt(0),
|
|
ONE: '1'.charCodeAt(0),
|
|
TWO: '2'.charCodeAt(0),
|
|
THREE: '3'.charCodeAt(0)
|
|
};
|
|
|
|
|
|
|
|
/**
|
|
* @constructor
|
|
* @param {number} z Zoom level.
|
|
* @param {number} x X.
|
|
* @param {number} y Y.
|
|
* @struct
|
|
*/
|
|
ol.TileCoord = function(z, x, y) {
|
|
|
|
/**
|
|
* Zoom level.
|
|
* @type {number}
|
|
*/
|
|
this.z = z;
|
|
|
|
/**
|
|
* @type {number}
|
|
*/
|
|
this.x = x;
|
|
|
|
/**
|
|
* @type {number}
|
|
*/
|
|
this.y = y;
|
|
|
|
};
|
|
|
|
|
|
/**
|
|
* @param {string} quadKey Quad key.
|
|
* @return {ol.TileCoord} Tile coordinate.
|
|
*/
|
|
ol.TileCoord.createFromQuadKey = function(quadKey) {
|
|
var z = quadKey.length, x = 0, y = 0;
|
|
var mask = 1 << (z - 1);
|
|
var i;
|
|
for (i = 0; i < z; ++i) {
|
|
switch (quadKey.charCodeAt(i)) {
|
|
case ol.QuadKeyCharCode.ONE:
|
|
x += mask;
|
|
break;
|
|
case ol.QuadKeyCharCode.TWO:
|
|
y += mask;
|
|
break;
|
|
case ol.QuadKeyCharCode.THREE:
|
|
x += mask;
|
|
y += mask;
|
|
break;
|
|
}
|
|
mask >>= 1;
|
|
}
|
|
return new ol.TileCoord(z, x, y);
|
|
};
|
|
|
|
|
|
/**
|
|
* @param {string} str String that follows pattern “z/x/y” where x, y and z are
|
|
* numbers.
|
|
* @return {ol.TileCoord} Tile coord.
|
|
*/
|
|
ol.TileCoord.createFromString = function(str) {
|
|
var v = str.split('/');
|
|
v = goog.array.map(v, function(e, i, a) {
|
|
return parseInt(e, 10);
|
|
});
|
|
return new ol.TileCoord(v[0], v[1], v[2]);
|
|
};
|
|
|
|
|
|
/**
|
|
* @param {number} z Z.
|
|
* @param {number} x X.
|
|
* @param {number} y Y.
|
|
* @param {ol.TileCoord|undefined} tileCoord Tile coordinate.
|
|
* @return {ol.TileCoord} Tile coordinate.
|
|
*/
|
|
ol.TileCoord.createOrUpdate = function(z, x, y, tileCoord) {
|
|
if (goog.isDef(tileCoord)) {
|
|
tileCoord.z = z;
|
|
tileCoord.x = x;
|
|
tileCoord.y = y;
|
|
return tileCoord;
|
|
} else {
|
|
return new ol.TileCoord(z, x, y);
|
|
}
|
|
};
|
|
|
|
|
|
/**
|
|
* @param {number} z Z.
|
|
* @param {number} x X.
|
|
* @param {number} y Y.
|
|
* @return {string} Key.
|
|
*/
|
|
ol.TileCoord.getKeyZXY = function(z, x, y) {
|
|
return z + '/' + x + '/' + y;
|
|
};
|
|
|
|
|
|
/**
|
|
* @param {Array.<number>=} opt_result Optional array to reuse.
|
|
* @return {Array.<number>} Array of z, x, y.
|
|
* @todo api
|
|
*/
|
|
ol.TileCoord.prototype.getZXY = function(opt_result) {
|
|
if (goog.isDef(opt_result)) {
|
|
goog.asserts.assert(opt_result.length == 3);
|
|
opt_result[0] = this.z;
|
|
opt_result[1] = this.x;
|
|
opt_result[2] = this.y;
|
|
return opt_result;
|
|
} else {
|
|
return [this.z, this.x, this.y];
|
|
}
|
|
};
|
|
|
|
|
|
/**
|
|
* @return {number} Hash.
|
|
*/
|
|
ol.TileCoord.prototype.hash = function() {
|
|
return (this.x << this.z) + this.y;
|
|
};
|
|
|
|
|
|
/**
|
|
* @return {string} Quad key.
|
|
*/
|
|
ol.TileCoord.prototype.quadKey = function() {
|
|
var digits = new Array(this.z);
|
|
var mask = 1 << (this.z - 1);
|
|
var i, charCode;
|
|
for (i = 0; i < this.z; ++i) {
|
|
charCode = ol.QuadKeyCharCode.ZERO;
|
|
if (this.x & mask) {
|
|
charCode += 1;
|
|
}
|
|
if (this.y & mask) {
|
|
charCode += 2;
|
|
}
|
|
digits[i] = String.fromCharCode(charCode);
|
|
mask >>= 1;
|
|
}
|
|
return digits.join('');
|
|
};
|
|
|
|
|
|
/**
|
|
* @return {string} String.
|
|
*/
|
|
ol.TileCoord.prototype.toString = function() {
|
|
return ol.TileCoord.getKeyZXY(this.z, this.x, this.y);
|
|
};
|