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

Module type for ol.renderer.*

Browse Source
This commit is contained in:
Frederic Junod
2018-04-25 14:07:56 +02:00
parent d8e0212833
commit 11d9f6de83
15 changed files with 64 additions and 64 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/ol/PluggableMap.js
View File

@@ -336,7 +336,7 @@ const PluggableMap = function(options) {
this.overlayIdIndex_ = {};
/**
* @type {module:ol/renderer/Map~Map}
* @type {module:ol/renderer/Map}
* @private
*/
this.renderer_ = this.createRenderer(this.viewport_, this);
@@ -831,7 +831,7 @@ PluggableMap.prototype.getPixelFromCoordinate = function(coordinate) {
/**
* Get the map renderer.
* @return {module:ol/renderer/Map~Map} Renderer
* @return {module:ol/renderer/Map} Renderer
*/
PluggableMap.prototype.getRenderer = function() {
return this.renderer_;

10
src/ol/renderer/Map.js
View File

@@ -30,7 +30,7 @@ const MapRenderer = function(map) {
/**
* @private
* @type {!Object.<string, ol.renderer.Layer>}
* @type {!Object.<string, module:ol/renderer/Layer>}
*/
this.layerRenderers_ = {};
@@ -219,7 +219,7 @@ MapRenderer.prototype.hasFeatureAtCoordinate = function(coordinate, frameState,
/**
* @param {module:ol/layer/Layer} layer Layer.
* @protected
* @return {ol.renderer.Layer} Layer renderer.
* @return {module:ol/renderer/Layer} Layer renderer.
*/
MapRenderer.prototype.getLayerRenderer = function(layer) {
const layerKey = getUid(layer).toString();
@@ -249,7 +249,7 @@ MapRenderer.prototype.getLayerRenderer = function(layer) {
/**
* @param {string} layerKey Layer key.
* @protected
* @return {ol.renderer.Layer} Layer renderer.
* @return {module:ol/renderer/Layer} Layer renderer.
*/
MapRenderer.prototype.getLayerRendererByKey = function(layerKey) {
return this.layerRenderers_[layerKey];
@@ -258,7 +258,7 @@ MapRenderer.prototype.getLayerRendererByKey = function(layerKey) {
/**
* @protected
* @return {Object.<string, ol.renderer.Layer>} Layer renderers.
* @return {Object.<string, module:ol/renderer/Layer>} Layer renderers.
*/
MapRenderer.prototype.getLayerRenderers = function() {
return this.layerRenderers_;
@@ -284,7 +284,7 @@ MapRenderer.prototype.handleLayerRendererChange_ = function() {
/**
* @param {string} layerKey Layer key.
* @return {ol.renderer.Layer} Layer renderer.
* @return {module:ol/renderer/Layer} Layer renderer.
* @private
*/
MapRenderer.prototype.removeLayerRendererByKey_ = function(layerKey) {

10
src/ol/renderer/canvas/ImageLayer.js
View File

@@ -15,7 +15,7 @@ import {create as createTransform, compose as composeTransform} from '../../tran
/**
* @constructor
* @extends {ol.renderer.canvas.IntermediateCanvas}
* @extends {module:ol/renderer/canvas/IntermediateCanvas}
* @param {module:ol/layer/Image} imageLayer Single image layer.
* @api
*/
@@ -42,7 +42,7 @@ const CanvasImageLayerRenderer = function(imageLayer) {
/**
* @private
* @type {ol.renderer.canvas.VectorLayer}
* @type {module:ol/renderer/canvas/VectorLayer}
*/
this.vectorRenderer_ = null;
@@ -65,9 +65,9 @@ CanvasImageLayerRenderer['handles'] = function(layer) {
/**
* Create a layer renderer.
* @param {ol.renderer.Map} mapRenderer The map renderer.
* @param {module:ol/renderer/Map} mapRenderer The map renderer.
* @param {module:ol/layer/Layer} layer The layer to be rendererd.
* @return {ol.renderer.canvas.ImageLayer} The layer renderer.
* @return {module:ol/renderer/canvas/ImageLayer} The layer renderer.
*/
CanvasImageLayerRenderer['create'] = function(mapRenderer, layer) {
const renderer = new CanvasImageLayerRenderer(/** @type {module:ol/layer/Image} */ (layer));
@@ -216,7 +216,7 @@ CanvasImageLayerRenderer.prototype.forEachFeatureAtCoordinate = function(coordin
/**
* @param {ol.renderer.canvas.VectorLayer} renderer Vector renderer.
* @param {module:ol/renderer/canvas/VectorLayer} renderer Vector renderer.
*/
CanvasImageLayerRenderer.prototype.setVectorRenderer = function(renderer) {
if (this.vectorRenderer_) {

2
src/ol/renderer/canvas/IntermediateCanvas.js
View File

@@ -12,7 +12,7 @@ import {create as createTransform, apply as applyTransform} from '../../transfor
/**
* @constructor
* @abstract
* @extends {ol.renderer.canvas.Layer}
* @extends {module:ol/renderer/canvas/Layer}
* @param {module:ol/layer/Layer} layer Layer.
*/
const IntermediateCanvasRenderer = function(layer) {

2
src/ol/renderer/canvas/Layer.js
View File

@@ -14,7 +14,7 @@ import {create as createTransform, apply as applyTransform, compose as composeTr
/**
* @constructor
* @abstract
* @extends {ol.renderer.Layer}
* @extends {module:ol/renderer/Layer}
* @param {module:ol/layer/Layer} layer Layer.
*/
const CanvasLayerRenderer = function(layer) {

6
src/ol/renderer/canvas/Map.js
View File

@@ -16,7 +16,7 @@ import SourceState from '../../source/State.js';
/**
* @constructor
* @extends {ol.renderer.Map}
* @extends {module:ol/renderer/Map}
* @param {module:ol/PluggableMap} map Map.
* @api
*/
@@ -146,7 +146,7 @@ CanvasMapRenderer.prototype.renderFrame = function(frameState) {
for (i = 0, ii = layerStatesArray.length; i < ii; ++i) {
layerState = layerStatesArray[i];
layer = layerState.layer;
layerRenderer = /** @type {ol.renderer.canvas.Layer} */ (this.getLayerRenderer(layer));
layerRenderer = /** @type {module:ol/renderer/canvas/Layer} */ (this.getLayerRenderer(layer));
if (!visibleAtResolution(layerState, viewResolution) ||
layerState.sourceState != SourceState.READY) {
continue;
@@ -192,7 +192,7 @@ CanvasMapRenderer.prototype.forEachLayerAtPixel = function(pixel, frameState, ca
const layerState = layerStates[i];
const layer = layerState.layer;
if (visibleAtResolution(layerState, viewResolution) && layerFilter.call(thisArg2, layer)) {
const layerRenderer = /** @type {ol.renderer.canvas.Layer} */ (this.getLayerRenderer(layer));
const layerRenderer = /** @type {module:ol/renderer/canvas/Layer} */ (this.getLayerRenderer(layer));
result = layerRenderer.forEachLayerAtCoordinate(
coordinate, frameState, callback, thisArg);
if (result) {

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

@@ -13,7 +13,7 @@ import {create as createTransform, compose as composeTransform} from '../../tran
/**
* @constructor
* @extends {ol.renderer.canvas.IntermediateCanvas}
* @extends {module:ol/renderer/canvas/IntermediateCanvas}
* @param {module:ol/layer/Tile|module:ol/layer/VectorTile~VectorTile} tileLayer Tile layer.
* @api
*/
@@ -92,9 +92,9 @@ CanvasTileLayerRenderer['handles'] = function(layer) {
/**
* Create a layer renderer.
* @param {ol.renderer.Map} mapRenderer The map renderer.
* @param {module:ol/renderer/Map} mapRenderer The map renderer.
* @param {module:ol/layer/Layer} layer The layer to be rendererd.
* @return {ol.renderer.canvas.TileLayer} The layer renderer.
* @return {module:ol/renderer/canvas/TileLayer} The layer renderer.
*/
CanvasTileLayerRenderer['create'] = function(mapRenderer, layer) {
return new CanvasTileLayerRenderer(/** @type {module:ol/layer/Tile} */ (layer));

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

@@ -17,7 +17,7 @@ import {defaultOrder as defaultRenderOrder, getTolerance as getRenderTolerance,
/**
* @constructor
* @extends {ol.renderer.canvas.Layer}
* @extends {module:ol/renderer/canvas/Layer}
* @param {module:ol/layer/Vector} vectorLayer Vector layer.
* @api
*/
@@ -97,9 +97,9 @@ CanvasVectorLayerRenderer['handles'] = function(layer) {
/**
* Create a layer renderer.
* @param {ol.renderer.Map} mapRenderer The map renderer.
* @param {module:ol/renderer/Map} mapRenderer The map renderer.
* @param {module:ol/layer/Layer} layer The layer to be rendererd.
* @return {ol.renderer.canvas.VectorLayer} The layer renderer.
* @return {module:ol/renderer/canvas/VectorLayer} The layer renderer.
*/
CanvasVectorLayerRenderer['create'] = function(mapRenderer, layer) {
return new CanvasVectorLayerRenderer(/** @type {module:ol/layer/Vector} */ (layer));
@@ -357,7 +357,7 @@ CanvasVectorLayerRenderer.prototype.prepareFrame = function(frameState, layerSta
vectorSource.loadFeatures(extent, resolution, projection);
/**
* @param {module:ol/Feature} feature Feature.
* @this {ol.renderer.canvas.VectorLayer}
* @this {module:ol/renderer/canvas/VectorLayer}
*/
const render = function(feature) {
let styles;

10
src/ol/renderer/canvas/VectorTileLayer.js
View File

@@ -49,7 +49,7 @@ const VECTOR_REPLAYS = {
/**
* @constructor
* @extends {ol.renderer.canvas.TileLayer}
* @extends {module:ol/renderer/canvas/TileLayer}
* @param {module:ol/layer/VectorTile~VectorTile} layer VectorTile layer.
* @api
*/
@@ -108,9 +108,9 @@ CanvasVectorTileLayerRenderer['handles'] = function(layer) {
/**
* Create a layer renderer.
* @param {ol.renderer.Map} mapRenderer The map renderer.
* @param {module:ol/renderer/Map} mapRenderer The map renderer.
* @param {module:ol/layer/Layer} layer The layer to be rendererd.
* @return {ol.renderer.canvas.VectorTileLayer} The layer renderer.
* @return {module:ol/renderer/canvas/VectorTileLayer} The layer renderer.
*/
CanvasVectorTileLayerRenderer['create'] = function(mapRenderer, layer) {
return new CanvasVectorTileLayerRenderer(/** @type {module:ol/layer/VectorTile~VectorTile} */ (layer));
@@ -195,8 +195,8 @@ CanvasVectorTileLayerRenderer.prototype.createReplayGroup_ = function(tile, fram
const squaredTolerance = getSquaredRenderTolerance(resolution, pixelRatio);
/**
* @param {module:ol/Feature|module:ol/render/Feature} feature Feature.
* @this {ol.renderer.canvas.VectorTileLayer}
* @param {module:ol/Feature|module:ol/render/Feature~RenderFeature} feature Feature.
* @this {module:ol/renderer/canvas/VectorTileLayer}
*/
const render = function(feature) {
let styles;

10
src/ol/renderer/webgl/ImageLayer.js
View File

@@ -24,8 +24,8 @@ import {createTexture} from '../../webgl/Context.js';
/**
* @constructor
* @extends {ol.renderer.webgl.Layer}
* @param {ol.renderer.webgl.Map} mapRenderer Map renderer.
* @extends {module:ol/renderer/webgl/Layer}
* @param {module:ol/renderer/webgl/Map} mapRenderer Map renderer.
* @param {module:ol/layer/Image} imageLayer Tile layer.
* @api
*/
@@ -69,13 +69,13 @@ WebGLImageLayerRenderer['handles'] = function(layer) {
/**
* Create a layer renderer.
* @param {ol.renderer.Map} mapRenderer The map renderer.
* @param {module:ol/renderer/Map} mapRenderer The map renderer.
* @param {module:ol/layer/Layer} layer The layer to be rendererd.
* @return {ol.renderer.webgl.ImageLayer} The layer renderer.
* @return {module:ol/renderer/webgl/ImageLayer} The layer renderer.
*/
WebGLImageLayerRenderer['create'] = function(mapRenderer, layer) {
return new WebGLImageLayerRenderer(
/** @type {ol.renderer.webgl.Map} */ (mapRenderer),
/** @type {module:ol/renderer/webgl/Map} */ (mapRenderer),
/** @type {module:ol/layer/Image} */ (layer)
);
};

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

@@ -18,8 +18,8 @@ import {createEmptyTexture} from '../../webgl/Context.js';
/**
* @constructor
* @abstract
* @extends {ol.renderer.Layer}
* @param {ol.renderer.webgl.Map} mapRenderer Map renderer.
* @extends {module:ol/renderer/Layer}
* @param {module:ol/renderer/webgl/Map} mapRenderer Map renderer.
* @param {module:ol/layer/Layer} layer Layer.
*/
const WebGLLayerRenderer = function(mapRenderer, layer) {
@@ -28,7 +28,7 @@ const WebGLLayerRenderer = function(mapRenderer, layer) {
/**
* @protected
* @type {ol.renderer.webgl.Map}
* @type {module:ol/renderer/webgl/Map}
*/
this.mapRenderer = mapRenderer;
@@ -81,7 +81,7 @@ const WebGLLayerRenderer = function(mapRenderer, layer) {
/**
* @private
* @type {ol.renderer.webgl.defaultmapshader.Locations}
* @type {module:ol/renderer/webgl/defaultmapshader/Locations}
*/
this.defaultLocations_ = null;

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

@@ -40,7 +40,7 @@ const WEBGL_TEXTURE_CACHE_HIGH_WATER_MARK = 1024;
/**
* @constructor
* @extends {ol.renderer.Map}
* @extends {module:ol/renderer/Map}
* @param {module:ol/PluggableMap} map Map.
* @api
*/
@@ -128,7 +128,7 @@ const WebGLMapRenderer = function(map) {
/**
* @param {Array.<*>} element Element.
* @return {number} Priority.
* @this {ol.renderer.webgl.Map}
* @this {module:ol/renderer/webgl/Map}
*/
function(element) {
const tileCenter = /** @type {module:ol/coordinate~Coordinate} */ (element[1]);
@@ -153,7 +153,7 @@ const WebGLMapRenderer = function(map) {
* @param {module:ol/PluggableMap} map Map.
* @param {?module:ol/PluggableMap~FrameState} frameState Frame state.
* @return {boolean} false.
* @this {ol.renderer.webgl.Map}
* @this {module:ol/renderer/webgl/Map}
*/
this.loadNextTileTexture_ =
function(map, frameState) {
@@ -357,7 +357,7 @@ WebGLMapRenderer.prototype.handleWebGLContextLost = function(event) {
const renderers = this.getLayerRenderers();
for (const id in renderers) {
const renderer = /** @type {ol.renderer.webgl.Layer} */ (renderers[id]);
const renderer = /** @type {module:ol/renderer/webgl/Layer} */ (renderers[id]);
renderer.handleWebGLContextLost();
}
};
@@ -435,7 +435,7 @@ WebGLMapRenderer.prototype.renderFrame = function(frameState) {
layerState = layerStatesArray[i];
if (visibleAtResolution(layerState, viewResolution) &&
layerState.sourceState == SourceState.READY) {
layerRenderer = /** @type {ol.renderer.webgl.Layer} */ (this.getLayerRenderer(layerState.layer));
layerRenderer = /** @type {module:ol/renderer/webgl/Layer} */ (this.getLayerRenderer(layerState.layer));
if (layerRenderer.prepareFrame(frameState, layerState, context)) {
layerStatesToDraw.push(layerState);
}
@@ -458,7 +458,7 @@ WebGLMapRenderer.prototype.renderFrame = function(frameState) {
for (i = 0, ii = layerStatesToDraw.length; i < ii; ++i) {
layerState = layerStatesToDraw[i];
layerRenderer = /** @type {ol.renderer.webgl.Layer} */ (this.getLayerRenderer(layerState.layer));
layerRenderer = /** @type {module:ol/renderer/webgl/Layer} */ (this.getLayerRenderer(layerState.layer));
layerRenderer.composeFrame(frameState, layerState, context);
}
@@ -574,7 +574,7 @@ WebGLMapRenderer.prototype.forEachLayerAtPixel = function(pixel, frameState, cal
const layer = layerState.layer;
if (visibleAtResolution(layerState, viewState.resolution) &&
layerFilter.call(thisArg, layer)) {
const layerRenderer = /** @type {ol.renderer.webgl.Layer} */ (this.getLayerRenderer(layer));
const layerRenderer = /** @type {module:ol/renderer/webgl/Layer} */ (this.getLayerRenderer(layer));
result = layerRenderer.forEachLayerAtPixel(
pixel, frameState, callback, thisArg);
if (result) {

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

@@ -27,8 +27,8 @@ import WebGLBuffer from '../../webgl/Buffer.js';
/**
* @constructor
* @extends {ol.renderer.webgl.Layer}
* @param {ol.renderer.webgl.Map} mapRenderer Map renderer.
* @extends {module:ol/renderer/webgl/Layer}
* @param {module:ol/renderer/webgl/Map} mapRenderer Map renderer.
* @param {module:ol/layer/Tile} tileLayer Tile layer.
* @api
*/
@@ -50,7 +50,7 @@ const WebGLTileLayerRenderer = function(mapRenderer, tileLayer) {
/**
* @private
* @type {ol.renderer.webgl.tilelayershader.Locations}
* @type {module:ol/renderer/webgl/tilelayershader/Locations}
*/
this.locations_ = null;
@@ -106,13 +106,13 @@ WebGLTileLayerRenderer['handles'] = function(layer) {
/**
* Create a layer renderer.
* @param {ol.renderer.Map} mapRenderer The map renderer.
* @param {module:ol/renderer/Map} mapRenderer The map renderer.
* @param {module:ol/layer/Layer} layer The layer to be rendererd.
* @return {ol.renderer.webgl.TileLayer} The layer renderer.
* @return {module:ol/renderer/webgl/TileLayer} The layer renderer.
*/
WebGLTileLayerRenderer['create'] = function(mapRenderer, layer) {
return new WebGLTileLayerRenderer(
/** @type {ol.renderer.webgl.Map} */ (mapRenderer),
/** @type {module:ol/renderer/webgl/Map} */ (mapRenderer),
/** @type {module:ol/layer/Tile} */ (layer)
);
};

12
src/ol/renderer/webgl/VectorLayer.js
View File

@@ -12,8 +12,8 @@ import {apply as applyTransform} from '../../transform.js';
/**
* @constructor
* @extends {ol.renderer.webgl.Layer}
* @param {ol.renderer.webgl.Map} mapRenderer Map renderer.
* @extends {module:ol/renderer/webgl/Layer}
* @param {module:ol/renderer/webgl/Map} mapRenderer Map renderer.
* @param {module:ol/layer/Vector} vectorLayer Vector layer.
* @api
*/
@@ -81,13 +81,13 @@ WebGLVectorLayerRenderer['handles'] = function(layer) {
/**
* Create a layer renderer.
* @param {ol.renderer.Map} mapRenderer The map renderer.
* @param {module:ol/renderer/Map} mapRenderer The map renderer.
* @param {module:ol/layer/Layer} layer The layer to be rendererd.
* @return {ol.renderer.webgl.VectorLayer} The layer renderer.
* @return {module:ol/renderer/webgl/VectorLayer} The layer renderer.
*/
WebGLVectorLayerRenderer['create'] = function(mapRenderer, layer) {
return new WebGLVectorLayerRenderer(
/** @type {ol.renderer.webgl.Map} */ (mapRenderer),
/** @type {module:ol/renderer/webgl/Map} */ (mapRenderer),
/** @type {module:ol/layer/Vector} */ (layer)
);
};
@@ -260,7 +260,7 @@ WebGLVectorLayerRenderer.prototype.prepareFrame = function(frameState, layerStat
vectorSource.loadFeatures(extent, resolution, projection);
/**
* @param {module:ol/Feature} feature Feature.
* @this {ol.renderer.webgl.VectorLayer}
* @this {module:ol/renderer/webgl/VectorLayer}
*/
const render = function(feature) {
let styles;

14
src/ol/source/Raster.js
View File

@@ -156,7 +156,7 @@ const RasterSource = function(options) {
/**
* @private
* @type {Array.<ol.renderer.canvas.Layer>}
* @type {Array.<module:ol/renderer/canvas/Layer>}
*/
this.renderers_ = createRenderers(options.sources);
@@ -415,7 +415,7 @@ let sharedContext = null;
/**
* Get image data from a renderer.
* @param {ol.renderer.canvas.Layer} renderer Layer renderer.
* @param {module:ol/renderer/canvas/Layer} renderer Layer renderer.
* @param {module:ol/PluggableMap~FrameState} frameState The frame state.
* @param {module:ol/layer/Layer~State} layerState The layer state.
* @return {ImageData} The image data.
@@ -443,7 +443,7 @@ function getImageData(renderer, frameState, layerState) {
/**
* Get a list of layer states from a list of renderers.
* @param {Array.<ol.renderer.canvas.Layer>} renderers Layer renderers.
* @param {Array.<module:ol/renderer/canvas/Layer>} renderers Layer renderers.
* @return {Array.<module:ol/layer/Layer~State>} The layer states.
*/
function getLayerStatesArray(renderers) {
@@ -456,7 +456,7 @@ function getLayerStatesArray(renderers) {
/**
* Create renderers for all sources.
* @param {Array.<module:ol/source/Source>} sources The sources.
* @return {Array.<ol.renderer.canvas.Layer>} Array of layer renderers.
* @return {Array.<module:ol/renderer/canvas/Layer>} Array of layer renderers.
*/
function createRenderers(sources) {
const len = sources.length;
@@ -471,7 +471,7 @@ function createRenderers(sources) {
/**
* Create a renderer for the provided source.
* @param {module:ol/source/Source} source The source.
* @return {ol.renderer.canvas.Layer} The renderer.
* @return {module:ol/renderer/canvas/Layer} The renderer.
*/
function createRenderer(source) {
let renderer = null;
@@ -487,7 +487,7 @@ function createRenderer(source) {
/**
* Create an image renderer for the provided source.
* @param {module:ol/source/Image} source The source.
* @return {ol.renderer.canvas.Layer} The renderer.
* @return {module:ol/renderer/canvas/Layer} The renderer.
*/
function createImageRenderer(source) {
const layer = new ImageLayer({source: source});
@@ -498,7 +498,7 @@ function createImageRenderer(source) {
/**
* Create a tile renderer for the provided source.
* @param {module:ol/source/Tile} source The source.
* @return {ol.renderer.canvas.Layer} The renderer.
* @return {module:ol/renderer/canvas/Layer} The renderer.
*/
function createTileRenderer(source) {
const layer = new TileLayer({source: source});