Get rid of olx.js and typedef.js typedefs for ol

This commit is contained in:
Andreas Hocevar
2018-03-08 18:42:57 +01:00
parent 8f0ffe2043
commit 95d6251dbb
198 changed files with 2262 additions and 2698 deletions

View File

@@ -33,7 +33,7 @@ inherits(LayerRenderer, Observable);
/**
* @param {ol.Coordinate} coordinate Coordinate.
* @param {module:ol/coordinate~Coordinate} coordinate Coordinate.
* @param {olx.FrameState} frameState Frame state.
* @param {number} hitTolerance Hit tolerance in pixels.
* @param {function(this: S, (ol.Feature|ol.render.Feature), ol.layer.Layer): T}
@@ -46,7 +46,7 @@ LayerRenderer.prototype.forEachFeatureAtCoordinate = UNDEFINED;
/**
* @param {ol.Coordinate} coordinate Coordinate.
* @param {module:ol/coordinate~Coordinate} coordinate Coordinate.
* @param {olx.FrameState} frameState Frame state.
* @return {boolean} Is there a feature at the given coordinate?
*/
@@ -157,7 +157,7 @@ LayerRenderer.prototype.scheduleExpireCache = function(frameState, tileSource) {
}.bind(null, tileSource);
frameState.postRenderFunctions.push(
/** @type {ol.PostRenderFunction} */ (postRenderFunction)
/** @type {module:ol/PluggableMap~PostRenderFunction} */ (postRenderFunction)
);
}
};
@@ -199,7 +199,7 @@ LayerRenderer.prototype.updateUsedTiles = function(usedTiles, tileSource, z, til
* @param {ol.tilegrid.TileGrid} tileGrid Tile grid.
* @param {number} pixelRatio Pixel ratio.
* @param {ol.proj.Projection} projection Projection.
* @param {ol.Extent} extent Extent.
* @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.

View File

@@ -38,7 +38,7 @@ const MapRenderer = function(container, map) {
/**
* @private
* @type {Object.<string, ol.EventsKey>}
* @type {Object.<string, module:ol/events~EventsKey>}
*/
this.layerRendererListeners_ = {};
@@ -87,7 +87,7 @@ function expireIconCache(map, frameState) {
/**
* @param {ol.Coordinate} coordinate Coordinate.
* @param {module:ol/coordinate~Coordinate} coordinate Coordinate.
* @param {olx.FrameState} frameState FrameState.
* @param {number} hitTolerance Hit tolerance in pixels.
* @param {function(this: S, (ol.Feature|ol.render.Feature),
@@ -157,7 +157,7 @@ MapRenderer.prototype.forEachFeatureAtCoordinate = function(coordinate, frameSta
/**
* @abstract
* @param {ol.Pixel} pixel Pixel.
* @param {module:ol~Pixel} pixel Pixel.
* @param {olx.FrameState} frameState FrameState.
* @param {function(this: S, ol.layer.Layer, (Uint8ClampedArray|Uint8Array)): T} callback Layer
* callback.
@@ -175,7 +175,7 @@ MapRenderer.prototype.forEachLayerAtPixel = function(pixel, frameState, callback
/**
* @param {ol.Coordinate} coordinate Coordinate.
* @param {module:ol/coordinate~Coordinate} coordinate Coordinate.
* @param {olx.FrameState} frameState FrameState.
* @param {number} hitTolerance Hit tolerance in pixels.
* @param {function(this: U, ol.layer.Layer): boolean} layerFilter Layer filter
@@ -311,7 +311,7 @@ MapRenderer.prototype.removeUnusedLayerRenderers_ = function(map, frameState) {
* @protected
*/
MapRenderer.prototype.scheduleExpireIconCache = function(frameState) {
frameState.postRenderFunctions.push(/** @type {ol.PostRenderFunction} */ (expireIconCache));
frameState.postRenderFunctions.push(/** @type {module:ol/PluggableMap~PostRenderFunction} */ (expireIconCache));
};
@@ -323,7 +323,7 @@ MapRenderer.prototype.scheduleRemoveUnusedLayerRenderers = function(frameState)
for (const layerKey in this.layerRenderers_) {
if (!(layerKey in frameState.layerStates)) {
frameState.postRenderFunctions.push(
/** @type {ol.PostRenderFunction} */ (this.removeUnusedLayerRenderers_.bind(this))
/** @type {module:ol/PluggableMap~PostRenderFunction} */ (this.removeUnusedLayerRenderers_.bind(this))
);
return;
}
@@ -332,8 +332,8 @@ MapRenderer.prototype.scheduleRemoveUnusedLayerRenderers = function(frameState)
/**
* @param {ol.LayerState} state1 First layer state.
* @param {ol.LayerState} state2 Second layer state.
* @param {module:ol/layer/Layer~State} state1 First layer state.
* @param {module:ol/layer/Layer~State} state2 Second layer state.
* @return {number} The zIndex difference.
*/
export function sortByZIndex(state1, state2) {

View File

@@ -33,7 +33,7 @@ const CanvasImageLayerRenderer = function(imageLayer) {
/**
* @private
* @type {ol.Transform}
* @type {module:ol/transform~Transform}
*/
this.imageTransform_ = createTransform();

View File

@@ -21,7 +21,7 @@ const IntermediateCanvasRenderer = function(layer) {
/**
* @protected
* @type {ol.Transform}
* @type {module:ol/transform~Transform}
*/
this.coordinateToCanvasPixelTransform = createTransform();
@@ -52,7 +52,7 @@ IntermediateCanvasRenderer.prototype.composeFrame = function(frameState, layerSt
!containsExtent(extent, frameState.extent) &&
intersects(extent, frameState.extent);
if (clipped) {
this.clip(context, frameState, /** @type {ol.Extent} */ (extent));
this.clip(context, frameState, /** @type {module:ol/extent~Extent} */ (extent));
}
const imageTransform = this.getImageTransform();
@@ -90,7 +90,7 @@ IntermediateCanvasRenderer.prototype.getImage = function() {};
/**
* @abstract
* @return {!ol.Transform} Image transform.
* @return {!module:ol/transform~Transform} Image transform.
*/
IntermediateCanvasRenderer.prototype.getImageTransform = function() {};

View File

@@ -29,7 +29,7 @@ const CanvasLayerRenderer = function(layer) {
/**
* @private
* @type {ol.Transform}
* @type {module:ol/transform~Transform}
*/
this.transform_ = createTransform();
@@ -41,7 +41,7 @@ inherits(CanvasLayerRenderer, LayerRenderer);
/**
* @param {CanvasRenderingContext2D} context Context.
* @param {olx.FrameState} frameState Frame state.
* @param {ol.Extent} extent Clip extent.
* @param {module:ol/extent~Extent} extent Clip extent.
* @protected
*/
CanvasLayerRenderer.prototype.clip = function(context, frameState, extent) {
@@ -49,10 +49,10 @@ CanvasLayerRenderer.prototype.clip = function(context, frameState, extent) {
const width = frameState.size[0] * pixelRatio;
const height = frameState.size[1] * pixelRatio;
const rotation = frameState.viewState.rotation;
const topLeft = getTopLeft(/** @type {ol.Extent} */ (extent));
const topRight = getTopRight(/** @type {ol.Extent} */ (extent));
const bottomRight = getBottomRight(/** @type {ol.Extent} */ (extent));
const bottomLeft = getBottomLeft(/** @type {ol.Extent} */ (extent));
const topLeft = getTopLeft(/** @type {module:ol/extent~Extent} */ (extent));
const topRight = getTopRight(/** @type {module:ol/extent~Extent} */ (extent));
const bottomRight = getBottomRight(/** @type {module:ol/extent~Extent} */ (extent));
const bottomLeft = getBottomLeft(/** @type {module:ol/extent~Extent} */ (extent));
applyTransform(frameState.coordinateToPixelTransform, topLeft);
applyTransform(frameState.coordinateToPixelTransform, topRight);
@@ -75,7 +75,7 @@ CanvasLayerRenderer.prototype.clip = function(context, frameState, extent) {
* @param {ol.render.EventType} type Event type.
* @param {CanvasRenderingContext2D} context Context.
* @param {olx.FrameState} frameState Frame state.
* @param {ol.Transform=} opt_transform Transform.
* @param {module:ol/transform~Transform=} opt_transform Transform.
* @private
*/
CanvasLayerRenderer.prototype.dispatchComposeEvent_ = function(type, context, frameState, opt_transform) {
@@ -99,7 +99,7 @@ CanvasLayerRenderer.prototype.dispatchComposeEvent_ = function(type, context, fr
/**
* @param {ol.Coordinate} coordinate Coordinate.
* @param {module:ol/coordinate~Coordinate} coordinate Coordinate.
* @param {olx.FrameState} frameState FrameState.
* @param {function(this: S, ol.layer.Layer, (Uint8ClampedArray|Uint8Array)): T} callback Layer
* callback.
@@ -121,8 +121,8 @@ CanvasLayerRenderer.prototype.forEachLayerAtCoordinate = function(coordinate, fr
/**
* @param {CanvasRenderingContext2D} context Context.
* @param {olx.FrameState} frameState Frame state.
* @param {ol.LayerState} layerState Layer state.
* @param {ol.Transform=} opt_transform Transform.
* @param {module:ol/layer/Layer~State} layerState Layer state.
* @param {module:ol/transform~Transform=} opt_transform Transform.
* @protected
*/
CanvasLayerRenderer.prototype.postCompose = function(context, frameState, layerState, opt_transform) {
@@ -133,7 +133,7 @@ CanvasLayerRenderer.prototype.postCompose = function(context, frameState, layerS
/**
* @param {CanvasRenderingContext2D} context Context.
* @param {olx.FrameState} frameState Frame state.
* @param {ol.Transform=} opt_transform Transform.
* @param {module:ol/transform~Transform=} opt_transform Transform.
* @protected
*/
CanvasLayerRenderer.prototype.preCompose = function(context, frameState, opt_transform) {
@@ -144,7 +144,7 @@ CanvasLayerRenderer.prototype.preCompose = function(context, frameState, opt_tra
/**
* @param {CanvasRenderingContext2D} context Context.
* @param {olx.FrameState} frameState Frame state.
* @param {ol.Transform=} opt_transform Transform.
* @param {module:ol/transform~Transform=} opt_transform Transform.
* @protected
*/
CanvasLayerRenderer.prototype.dispatchRenderEvent = function(context, frameState, opt_transform) {
@@ -156,7 +156,7 @@ CanvasLayerRenderer.prototype.dispatchRenderEvent = function(context, frameState
* @param {olx.FrameState} frameState Frame state.
* @param {number} offsetX Offset on the x-axis in view coordinates.
* @protected
* @return {!ol.Transform} Transform.
* @return {!module:ol/transform~Transform} Transform.
*/
CanvasLayerRenderer.prototype.getTransform = function(frameState, offsetX) {
const viewState = frameState.viewState;
@@ -175,7 +175,7 @@ CanvasLayerRenderer.prototype.getTransform = function(frameState, offsetX) {
/**
* @abstract
* @param {olx.FrameState} frameState Frame state.
* @param {ol.LayerState} layerState Layer state.
* @param {module:ol/layer/Layer~State} layerState Layer state.
* @param {CanvasRenderingContext2D} context Context.
*/
CanvasLayerRenderer.prototype.composeFrame = function(frameState, layerState, context) {};
@@ -183,7 +183,7 @@ CanvasLayerRenderer.prototype.composeFrame = function(frameState, layerState, co
/**
* @abstract
* @param {olx.FrameState} frameState Frame state.
* @param {ol.LayerState} layerState Layer state.
* @param {module:ol/layer/Layer~State} layerState Layer state.
* @return {boolean} whether composeFrame should be called.
*/
CanvasLayerRenderer.prototype.prepareFrame = function(frameState, layerState) {};

View File

@@ -54,7 +54,7 @@ const CanvasMapRenderer = function(container, map) {
/**
* @private
* @type {ol.Transform}
* @type {module:ol/transform~Transform}
*/
this.transform_ = createTransform();
@@ -112,7 +112,7 @@ CanvasMapRenderer.prototype.dispatchComposeEvent_ = function(type, frameState) {
/**
* @param {olx.FrameState} frameState Frame state.
* @protected
* @return {!ol.Transform} Transform.
* @return {!module:ol/transform~Transform} Transform.
*/
CanvasMapRenderer.prototype.getTransform = function(frameState) {
const viewState = frameState.viewState;

View File

@@ -36,7 +36,7 @@ const CanvasTileLayerRenderer = function(tileLayer) {
/**
* @private
* @type {ol.Extent}
* @type {module:ol/extent~Extent}
*/
this.renderedExtent_ = null;
@@ -54,7 +54,7 @@ const CanvasTileLayerRenderer = function(tileLayer) {
/**
* @protected
* @type {ol.Extent}
* @type {module:ol/extent~Extent}
*/
this.tmpExtent = createEmpty();
@@ -66,7 +66,7 @@ const CanvasTileLayerRenderer = function(tileLayer) {
/**
* @private
* @type {ol.Transform}
* @type {module:ol/transform~Transform}
*/
this.imageTransform_ = createTransform();
@@ -300,7 +300,7 @@ CanvasTileLayerRenderer.prototype.prepareFrame = function(frameState, layerState
/**
* @param {ol.Tile} tile Tile.
* @param {olx.FrameState} frameState Frame state.
* @param {ol.LayerState} layerState Layer state.
* @param {module:ol/layer/Layer~State} layerState Layer state.
* @param {number} x Left of the tile.
* @param {number} y Top of the tile.
* @param {number} w Width of the tile.

View File

@@ -52,7 +52,7 @@ const CanvasVectorLayerRenderer = function(vectorLayer) {
/**
* @private
* @type {ol.Extent}
* @type {module:ol/extent~Extent}
*/
this.renderedExtent_ = createEmpty();
@@ -140,7 +140,7 @@ CanvasVectorLayerRenderer.prototype.composeFrame = function(frameState, layerSta
const clipExtent = layerState.extent;
const clipped = clipExtent !== undefined;
if (clipped) {
this.clip(context, frameState, /** @type {ol.Extent} */ (clipExtent));
this.clip(context, frameState, /** @type {module:ol/extent~Extent} */ (clipExtent));
}
const replayGroup = this.replayGroup_;
if (replayGroup && !replayGroup.isEmpty()) {

View File

@@ -83,7 +83,7 @@ const CanvasVectorTileLayerRenderer = function(layer) {
/**
* @private
* @type {ol.Transform}
* @type {module:ol/transform~Transform}
*/
this.tmpTransform_ = createTransform();
@@ -159,7 +159,7 @@ CanvasVectorTileLayerRenderer.prototype.createReplayGroup_ = function(tile, fram
const pixelRatio = frameState.pixelRatio;
const projection = frameState.viewState.projection;
const revision = layer.getRevision();
const renderOrder = /** @type {ol.RenderOrderFunction} */ (layer.getRenderOrder()) || null;
const renderOrder = /** @type {module:ol/render~OrderFunction} */ (layer.getRenderOrder()) || null;
const replayState = tile.getReplayState(layer);
if (!replayState.dirty && replayState.renderedRevision == revision &&
@@ -311,7 +311,7 @@ CanvasVectorTileLayerRenderer.prototype.forEachFeatureAtCoordinate = function(co
/**
* @param {ol.VectorTile} tile Tile.
* @param {olx.FrameState} frameState Frame state.
* @return {ol.Transform} transform Transform.
* @return {module:ol/transform~Transform} transform Transform.
* @private
*/
CanvasVectorTileLayerRenderer.prototype.getReplayTransform_ = function(tile, frameState) {
@@ -476,7 +476,7 @@ CanvasVectorTileLayerRenderer.prototype.renderFeature = function(feature, square
/**
* @param {ol.VectorImageTile} tile Tile.
* @param {olx.FrameState} frameState Frame state.
* @param {ol.LayerState} layerState Layer state.
* @param {module:ol/layer/Layer~State} layerState Layer state.
* @private
*/
CanvasVectorTileLayerRenderer.prototype.renderTileImage_ = function(

View File

@@ -50,7 +50,7 @@ const WebGLImageLayerRenderer = function(mapRenderer, imageLayer) {
/**
* @private
* @type {?ol.Transform}
* @type {?module:ol/transform~Transform}
*/
this.hitTransformationMatrix_ = null;
@@ -176,7 +176,7 @@ WebGLImageLayerRenderer.prototype.prepareFrame = function(frameState, layerState
}
}.bind(null, gl, this.texture);
frameState.postRenderFunctions.push(
/** @type {ol.PostRenderFunction} */ (postRenderFunction)
/** @type {module:ol/PluggableMap~PostRenderFunction} */ (postRenderFunction)
);
}
}
@@ -209,10 +209,10 @@ WebGLImageLayerRenderer.prototype.prepareFrame = function(frameState, layerState
* @param {number} canvasWidth Canvas width.
* @param {number} canvasHeight Canvas height.
* @param {number} pixelRatio Pixel ratio.
* @param {ol.Coordinate} viewCenter View center.
* @param {module:ol/coordinate~Coordinate} viewCenter View center.
* @param {number} viewResolution View resolution.
* @param {number} viewRotation View rotation.
* @param {ol.Extent} imageExtent Image extent.
* @param {module:ol/extent~Extent} imageExtent Image extent.
* @private
*/
WebGLImageLayerRenderer.prototype.updateProjectionMatrix_ = function(canvasWidth, canvasHeight, pixelRatio,
@@ -306,9 +306,9 @@ WebGLImageLayerRenderer.prototype.forEachLayerAtPixel = function(pixel, frameSta
/**
* The transformation matrix to get the pixel on the image for a
* pixel on the map.
* @param {ol.Size} mapSize The map size.
* @param {ol.Size} imageSize The image size.
* @return {ol.Transform} The transformation matrix.
* @param {module:ol/size~Size} mapSize The map size.
* @param {module:ol/size~Size} imageSize The image size.
* @return {module:ol/transform~Transform} The transformation matrix.
* @private
*/
WebGLImageLayerRenderer.prototype.getHitTransformationMatrix_ = function(mapSize, imageSize) {

View File

@@ -63,13 +63,13 @@ const WebGLLayerRenderer = function(mapRenderer, layer) {
/**
* @protected
* @type {ol.Transform}
* @type {module:ol/transform~Transform}
*/
this.texCoordMatrix = createTransform();
/**
* @protected
* @type {ol.Transform}
* @type {module:ol/transform~Transform}
*/
this.projectionMatrix = createTransform();
@@ -114,7 +114,7 @@ WebGLLayerRenderer.prototype.bindFramebuffer = function(frameState, framebufferD
}.bind(null, gl, this.framebuffer, this.texture);
frameState.postRenderFunctions.push(
/** @type {ol.PostRenderFunction} */ (postRenderFunction)
/** @type {module:ol/PluggableMap~PostRenderFunction} */ (postRenderFunction)
);
const texture = createEmptyTexture(
@@ -138,7 +138,7 @@ WebGLLayerRenderer.prototype.bindFramebuffer = function(frameState, framebufferD
/**
* @param {olx.FrameState} frameState Frame state.
* @param {ol.LayerState} layerState Layer state.
* @param {module:ol/layer/Layer~State} layerState Layer state.
* @param {ol.webgl.Context} context Context.
*/
WebGLLayerRenderer.prototype.composeFrame = function(frameState, layerState, context) {
@@ -208,7 +208,7 @@ WebGLLayerRenderer.prototype.dispatchComposeEvent_ = function(type, context, fra
/**
* @return {!ol.Transform} Matrix.
* @return {!module:ol/transform~Transform} Matrix.
*/
WebGLLayerRenderer.prototype.getTexCoordMatrix = function() {
return this.texCoordMatrix;
@@ -224,7 +224,7 @@ WebGLLayerRenderer.prototype.getTexture = function() {
/**
* @return {!ol.Transform} Matrix.
* @return {!module:ol/transform~Transform} Matrix.
*/
WebGLLayerRenderer.prototype.getProjectionMatrix = function() {
return this.projectionMatrix;
@@ -244,7 +244,7 @@ WebGLLayerRenderer.prototype.handleWebGLContextLost = function() {
/**
* @abstract
* @param {olx.FrameState} frameState Frame state.
* @param {ol.LayerState} layerState Layer state.
* @param {module:ol/layer/Layer~State} layerState Layer state.
* @param {ol.webgl.Context} context Context.
* @return {boolean} whether composeFrame should be called.
*/
@@ -253,7 +253,7 @@ WebGLLayerRenderer.prototype.prepareFrame = function(frameState, layerState, con
/**
* @abstract
* @param {ol.Pixel} pixel Pixel.
* @param {module:ol~Pixel} pixel Pixel.
* @param {olx.FrameState} frameState FrameState.
* @param {function(this: S, ol.layer.Layer, (Uint8ClampedArray|Uint8Array)): T} callback Layer
* callback.

View File

@@ -109,7 +109,7 @@ const WebGLMapRenderer = function(container, map) {
/**
* @private
* @type {ol.Coordinate}
* @type {module:ol/coordinate~Coordinate}
*/
this.focus_ = null;
@@ -124,7 +124,7 @@ const WebGLMapRenderer = function(container, map) {
* @this {ol.renderer.webgl.Map}
*/
(function(element) {
const tileCenter = /** @type {ol.Coordinate} */ (element[1]);
const tileCenter = /** @type {module:ol/coordinate~Coordinate} */ (element[1]);
const tileResolution = /** @type {number} */ (element[2]);
const deltaX = tileCenter[0] - this.focus_[0];
const deltaY = tileCenter[1] - this.focus_[1];
@@ -152,7 +152,7 @@ const WebGLMapRenderer = function(container, map) {
this.tileTextureQueue_.reprioritize();
const element = this.tileTextureQueue_.dequeue();
const tile = /** @type {ol.Tile} */ (element[0]);
const tileSize = /** @type {ol.Size} */ (element[3]);
const tileSize = /** @type {module:ol/size~Size} */ (element[3]);
const tileGutter = /** @type {number} */ (element[4]);
this.bindTileTexture(
tile, tileSize, tileGutter, LINEAR, LINEAR);
@@ -196,7 +196,7 @@ WebGLMapRenderer['create'] = function(container, map) {
/**
* @param {ol.Tile} tile Tile.
* @param {ol.Size} tileSize Tile size.
* @param {module:ol/size~Size} tileSize Tile size.
* @param {number} tileGutter Tile gutter.
* @param {number} magFilter Mag filter.
* @param {number} minFilter Min filter.
@@ -444,7 +444,7 @@ WebGLMapRenderer.prototype.renderFrame = function(frameState) {
this.dispatchComposeEvent_(RenderEventType.PRECOMPOSE, frameState);
/** @type {Array.<ol.LayerState>} */
/** @type {Array.<module:ol/layer/Layer~State>} */
const layerStatesToDraw = [];
const layerStatesArray = frameState.layerStatesArray;
stableSort(layerStatesArray, sortByZIndex);
@@ -492,7 +492,7 @@ WebGLMapRenderer.prototype.renderFrame = function(frameState) {
if (this.textureCache_.getCount() - this.textureCacheFrameMarkerCount_ >
WEBGL_TEXTURE_CACHE_HIGH_WATER_MARK) {
frameState.postRenderFunctions.push(
/** @type {ol.PostRenderFunction} */ (this.expireCache_.bind(this))
/** @type {module:ol/PluggableMap~PostRenderFunction} */ (this.expireCache_.bind(this))
);
}

View File

@@ -74,7 +74,7 @@ const WebGLTileLayerRenderer = function(mapRenderer, tileLayer) {
/**
* @private
* @type {ol.Extent}
* @type {module:ol/extent~Extent}
*/
this.renderedFramebufferExtent_ = null;
@@ -86,7 +86,7 @@ const WebGLTileLayerRenderer = function(mapRenderer, tileLayer) {
/**
* @private
* @type {ol.Size}
* @type {module:ol/size~Size}
*/
this.tmpSize_ = [0, 0];

View File

@@ -42,7 +42,7 @@ const WebGLVectorLayerRenderer = function(mapRenderer, vectorLayer) {
/**
* @private
* @type {ol.Extent}
* @type {module:ol/extent~Extent}
*/
this.renderedExtent_ = createEmpty();
@@ -61,7 +61,7 @@ const WebGLVectorLayerRenderer = function(mapRenderer, vectorLayer) {
/**
* The last layer state.
* @private
* @type {?ol.LayerState}
* @type {?module:ol/layer/Layer~State}
*/
this.layerState_ = null;