diff --git a/src/ol/format/filter/Filter.js b/src/ol/format/filter/Filter.js index 8f5a7265fa..6ffb6ac25c 100644 --- a/src/ol/format/filter/Filter.js +++ b/src/ol/format/filter/Filter.js @@ -9,7 +9,6 @@ * Base class for WFS GetFeature filters. * * @abstract - * @struct */ class Filter { /** @@ -18,16 +17,16 @@ class Filter { constructor(tagName) { /** - * @private - * @type {!string} - */ + * @private + * @type {!string} + */ this.tagName_ = tagName; } /** - * The XML tag name for a filter. - * @returns {!string} Name. - */ + * The XML tag name for a filter. + * @returns {!string} Name. + */ getTagName() { return this.tagName_; } diff --git a/src/ol/render/VectorContext.js b/src/ol/render/VectorContext.js index 1ed6f81497..c189528ecb 100644 --- a/src/ol/render/VectorContext.js +++ b/src/ol/render/VectorContext.js @@ -5,110 +5,108 @@ /** * Context for drawing geometries. A vector context is available on render * events and does not need to be constructed directly. - * @struct * @api */ class VectorContext { /** - * Render a geometry with a custom renderer. - * - * @param {module:ol/geom/SimpleGeometry} geometry Geometry. - * @param {module:ol/Feature|module:ol/render/Feature} feature Feature. - * @param {Function} renderer Renderer. - */ + * Render a geometry with a custom renderer. + * + * @param {module:ol/geom/SimpleGeometry} geometry Geometry. + * @param {module:ol/Feature|module:ol/render/Feature} feature Feature. + * @param {Function} renderer Renderer. + */ drawCustom(geometry, feature, renderer) {} /** - * Render a geometry. - * - * @param {module:ol/geom/Geometry} geometry The geometry to render. - */ + * Render a geometry. + * + * @param {module:ol/geom/Geometry} geometry The geometry to render. + */ drawGeometry(geometry) {} /** - * Set the rendering style. - * - * @param {module:ol/style/Style} style The rendering style. - */ + * Set the rendering style. + * + * @param {module:ol/style/Style} style The rendering style. + */ setStyle(style) {} /** - * @param {module:ol/geom/Circle} circleGeometry Circle geometry. - * @param {module:ol/Feature} feature Feature. - */ + * @param {module:ol/geom/Circle} circleGeometry Circle geometry. + * @param {module:ol/Feature} feature Feature. + */ drawCircle(circleGeometry, feature) {} /** - * @param {module:ol/Feature} feature Feature. - * @param {module:ol/style/Style} style Style. - */ + * @param {module:ol/Feature} feature Feature. + * @param {module:ol/style/Style} style Style. + */ drawFeature(feature, style) {} /** - * @param {module:ol/geom/GeometryCollection} geometryCollectionGeometry Geometry - * collection. - * @param {module:ol/Feature} feature Feature. - */ + * @param {module:ol/geom/GeometryCollection} geometryCollectionGeometry Geometry collection. + * @param {module:ol/Feature} feature Feature. + */ drawGeometryCollection(geometryCollectionGeometry, feature) {} /** - * @param {module:ol/geom/LineString|module:ol/render/Feature} lineStringGeometry Line string geometry. - * @param {module:ol/Feature|module:ol/render/Feature} feature Feature. - */ + * @param {module:ol/geom/LineString|module:ol/render/Feature} lineStringGeometry Line string geometry. + * @param {module:ol/Feature|module:ol/render/Feature} feature Feature. + */ drawLineString(lineStringGeometry, feature) {} /** - * @param {module:ol/geom/MultiLineString|module:ol/render/Feature} multiLineStringGeometry MultiLineString geometry. - * @param {module:ol/Feature|module:ol/render/Feature} feature Feature. - */ + * @param {module:ol/geom/MultiLineString|module:ol/render/Feature} multiLineStringGeometry MultiLineString geometry. + * @param {module:ol/Feature|module:ol/render/Feature} feature Feature. + */ drawMultiLineString(multiLineStringGeometry, feature) {} /** - * @param {module:ol/geom/MultiPoint|module:ol/render/Feature} multiPointGeometry MultiPoint geometry. - * @param {module:ol/Feature|module:ol/render/Feature} feature Feature. - */ + * @param {module:ol/geom/MultiPoint|module:ol/render/Feature} multiPointGeometry MultiPoint geometry. + * @param {module:ol/Feature|module:ol/render/Feature} feature Feature. + */ drawMultiPoint(multiPointGeometry, feature) {} /** - * @param {module:ol/geom/MultiPolygon} multiPolygonGeometry MultiPolygon geometry. - * @param {module:ol/Feature|module:ol/render/Feature} feature Feature. - */ + * @param {module:ol/geom/MultiPolygon} multiPolygonGeometry MultiPolygon geometry. + * @param {module:ol/Feature|module:ol/render/Feature} feature Feature. + */ drawMultiPolygon(multiPolygonGeometry, feature) {} /** - * @param {module:ol/geom/Point|module:ol/render/Feature} pointGeometry Point geometry. - * @param {module:ol/Feature|module:ol/render/Feature} feature Feature. - */ + * @param {module:ol/geom/Point|module:ol/render/Feature} pointGeometry Point geometry. + * @param {module:ol/Feature|module:ol/render/Feature} feature Feature. + */ drawPoint(pointGeometry, feature) {} /** - * @param {module:ol/geom/Polygon|module:ol/render/Feature} polygonGeometry Polygon geometry. - * @param {module:ol/Feature|module:ol/render/Feature} feature Feature. - */ + * @param {module:ol/geom/Polygon|module:ol/render/Feature} polygonGeometry Polygon geometry. + * @param {module:ol/Feature|module:ol/render/Feature} feature Feature. + */ drawPolygon(polygonGeometry, feature) {} /** - * @param {module:ol/geom/Geometry|module:ol/render/Feature} geometry Geometry. - * @param {module:ol/Feature|module:ol/render/Feature} feature Feature. - */ + * @param {module:ol/geom/Geometry|module:ol/render/Feature} geometry Geometry. + * @param {module:ol/Feature|module:ol/render/Feature} feature Feature. + */ drawText(geometry, feature) {} /** - * @param {module:ol/style/Fill} fillStyle Fill style. - * @param {module:ol/style/Stroke} strokeStyle Stroke style. - */ + * @param {module:ol/style/Fill} fillStyle Fill style. + * @param {module:ol/style/Stroke} strokeStyle Stroke style. + */ setFillStrokeStyle(fillStyle, strokeStyle) {} /** - * @param {module:ol/style/Image} imageStyle Image style. - * @param {module:ol/render/canvas~DeclutterGroup=} opt_declutterGroup Declutter. - */ + * @param {module:ol/style/Image} imageStyle Image style. + * @param {module:ol/render/canvas~DeclutterGroup=} opt_declutterGroup Declutter. + */ setImageStyle(imageStyle, opt_declutterGroup) {} /** - * @param {module:ol/style/Text} textStyle Text style. - * @param {module:ol/render/canvas~DeclutterGroup=} opt_declutterGroup Declutter. - */ + * @param {module:ol/style/Text} textStyle Text style. + * @param {module:ol/render/canvas~DeclutterGroup=} opt_declutterGroup Declutter. + */ setTextStyle(textStyle, opt_declutterGroup) {} } diff --git a/src/ol/render/canvas/ImageReplay.js b/src/ol/render/canvas/ImageReplay.js index 7b6a704423..7d013d3b41 100644 --- a/src/ol/render/canvas/ImageReplay.js +++ b/src/ol/render/canvas/ImageReplay.js @@ -12,112 +12,111 @@ class CanvasImageReplay extends CanvasReplay { * @param {number} pixelRatio Pixel ratio. * @param {boolean} overlaps The replay can have overlapping geometries. * @param {?} declutterTree Declutter tree. - * @struct */ constructor(tolerance, maxExtent, resolution, pixelRatio, overlaps, declutterTree) { super(tolerance, maxExtent, resolution, pixelRatio, overlaps, declutterTree); /** - * @private - * @type {module:ol/render/canvas~DeclutterGroup} - */ + * @private + * @type {module:ol/render/canvas~DeclutterGroup} + */ this.declutterGroup_ = null; /** - * @private - * @type {HTMLCanvasElement|HTMLVideoElement|HTMLImageElement} - */ + * @private + * @type {HTMLCanvasElement|HTMLVideoElement|HTMLImageElement} + */ this.hitDetectionImage_ = null; /** - * @private - * @type {HTMLCanvasElement|HTMLVideoElement|HTMLImageElement} - */ + * @private + * @type {HTMLCanvasElement|HTMLVideoElement|HTMLImageElement} + */ this.image_ = null; /** - * @private - * @type {number|undefined} - */ + * @private + * @type {number|undefined} + */ this.anchorX_ = undefined; /** - * @private - * @type {number|undefined} - */ + * @private + * @type {number|undefined} + */ this.anchorY_ = undefined; /** - * @private - * @type {number|undefined} - */ + * @private + * @type {number|undefined} + */ this.height_ = undefined; /** - * @private - * @type {number|undefined} - */ + * @private + * @type {number|undefined} + */ this.opacity_ = undefined; /** - * @private - * @type {number|undefined} - */ + * @private + * @type {number|undefined} + */ this.originX_ = undefined; /** - * @private - * @type {number|undefined} - */ + * @private + * @type {number|undefined} + */ this.originY_ = undefined; /** - * @private - * @type {boolean|undefined} - */ + * @private + * @type {boolean|undefined} + */ this.rotateWithView_ = undefined; /** - * @private - * @type {number|undefined} - */ + * @private + * @type {number|undefined} + */ this.rotation_ = undefined; /** - * @private - * @type {number|undefined} - */ + * @private + * @type {number|undefined} + */ this.scale_ = undefined; /** - * @private - * @type {boolean|undefined} - */ + * @private + * @type {boolean|undefined} + */ this.snapToPixel_ = undefined; /** - * @private - * @type {number|undefined} - */ + * @private + * @type {number|undefined} + */ this.width_ = undefined; } /** - * @param {Array.} flatCoordinates Flat coordinates. - * @param {number} offset Offset. - * @param {number} end End. - * @param {number} stride Stride. - * @private - * @return {number} My end. - */ + * @param {Array.} flatCoordinates Flat coordinates. + * @param {number} offset Offset. + * @param {number} end End. + * @param {number} stride Stride. + * @private + * @return {number} My end. + */ drawCoordinates_(flatCoordinates, offset, end, stride) { return this.appendFlatCoordinates(flatCoordinates, offset, end, stride, false, false); } /** - * @inheritDoc - */ + * @inheritDoc + */ drawPoint(pointGeometry, feature) { if (!this.image_) { return; @@ -145,8 +144,8 @@ class CanvasImageReplay extends CanvasReplay { } /** - * @inheritDoc - */ + * @inheritDoc + */ drawMultiPoint(multiPointGeometry, feature) { if (!this.image_) { return; @@ -175,8 +174,8 @@ class CanvasImageReplay extends CanvasReplay { } /** - * @inheritDoc - */ + * @inheritDoc + */ finish() { this.reverseHitDetectionInstructions(); // FIXME this doesn't really protect us against further calls to draw*Geometry @@ -196,8 +195,8 @@ class CanvasImageReplay extends CanvasReplay { } /** - * @inheritDoc - */ + * @inheritDoc + */ setImageStyle(imageStyle, declutterGroup) { const anchor = imageStyle.getAnchor(); const size = imageStyle.getSize(); diff --git a/src/ol/render/canvas/Immediate.js b/src/ol/render/canvas/Immediate.js index 4d63df1bb3..dd74c5943a 100644 --- a/src/ol/render/canvas/Immediate.js +++ b/src/ol/render/canvas/Immediate.js @@ -31,7 +31,6 @@ class CanvasImmediateRenderer extends VectorContext { * @param {module:ol/extent~Extent} extent Extent. * @param {module:ol/transform~Transform} transform Transform. * @param {number} viewRotation View rotation. - * @struct */ constructor(context, pixelRatio, extent, transform, viewRotation) { super(); diff --git a/src/ol/render/canvas/LineStringReplay.js b/src/ol/render/canvas/LineStringReplay.js index 9f0e970ad8..66c8406f3e 100644 --- a/src/ol/render/canvas/LineStringReplay.js +++ b/src/ol/render/canvas/LineStringReplay.js @@ -12,7 +12,6 @@ class CanvasLineStringReplay extends CanvasReplay { * @param {number} pixelRatio Pixel ratio. * @param {boolean} overlaps The replay can have overlapping geometries. * @param {?} declutterTree Declutter tree. - * @struct */ constructor(tolerance, maxExtent, resolution, pixelRatio, overlaps, declutterTree) { super(tolerance, maxExtent, resolution, pixelRatio, overlaps, declutterTree); diff --git a/src/ol/render/canvas/PolygonReplay.js b/src/ol/render/canvas/PolygonReplay.js index 64144c9519..6c0d898055 100644 --- a/src/ol/render/canvas/PolygonReplay.js +++ b/src/ol/render/canvas/PolygonReplay.js @@ -18,7 +18,6 @@ class CanvasPolygonReplay extends CanvasReplay { * @param {number} pixelRatio Pixel ratio. * @param {boolean} overlaps The replay can have overlapping geometries. * @param {?} declutterTree Declutter tree. - * @struct */ constructor(tolerance, maxExtent, resolution, pixelRatio, overlaps, declutterTree) { super(tolerance, maxExtent, resolution, pixelRatio, overlaps, declutterTree); diff --git a/src/ol/render/canvas/Replay.js b/src/ol/render/canvas/Replay.js index 20a2ec2971..e50d99e883 100644 --- a/src/ol/render/canvas/Replay.js +++ b/src/ol/render/canvas/Replay.js @@ -49,7 +49,6 @@ class CanvasReplay extends VectorContext { * @param {number} pixelRatio Pixel ratio. * @param {boolean} overlaps The replay can have overlapping geometries. * @param {?} declutterTree Declutter tree. - * @struct */ constructor(tolerance, maxExtent, resolution, pixelRatio, overlaps, declutterTree) { super(); diff --git a/src/ol/render/canvas/ReplayGroup.js b/src/ol/render/canvas/ReplayGroup.js index 3ebaaffa9f..731f114b95 100644 --- a/src/ol/render/canvas/ReplayGroup.js +++ b/src/ol/render/canvas/ReplayGroup.js @@ -40,10 +40,8 @@ class CanvasReplayGroup extends ReplayGroup { * @param {number} resolution Resolution. * @param {number} pixelRatio Pixel ratio. * @param {boolean} overlaps The replay group can have overlapping geometries. - * @param {?} declutterTree Declutter tree - * for declutter processing in postrender. + * @param {?} declutterTree Declutter tree for declutter processing in postrender. * @param {number=} opt_renderBuffer Optional rendering buffer. - * @struct */ constructor( tolerance, diff --git a/src/ol/render/canvas/TextReplay.js b/src/ol/render/canvas/TextReplay.js index 87cbaf8922..bed111ab37 100644 --- a/src/ol/render/canvas/TextReplay.js +++ b/src/ol/render/canvas/TextReplay.js @@ -22,7 +22,6 @@ class CanvasTextReplay extends CanvasReplay { * @param {number} pixelRatio Pixel ratio. * @param {boolean} overlaps The replay can have overlapping geometries. * @param {?} declutterTree Declutter tree. - * @struct */ constructor(tolerance, maxExtent, resolution, pixelRatio, overlaps, declutterTree) { super(tolerance, maxExtent, resolution, pixelRatio, overlaps, declutterTree); diff --git a/src/ol/render/webgl/CircleReplay.js b/src/ol/render/webgl/CircleReplay.js index 352af6b2c6..7b95dd085a 100644 --- a/src/ol/render/webgl/CircleReplay.js +++ b/src/ol/render/webgl/CircleReplay.js @@ -19,7 +19,6 @@ class WebGLCircleReplay extends WebGLReplay { /** * @param {number} tolerance Tolerance. * @param {module:ol/extent~Extent} maxExtent Max extent. - * @struct */ constructor(tolerance, maxExtent) { super(tolerance, maxExtent); diff --git a/src/ol/render/webgl/ImageReplay.js b/src/ol/render/webgl/ImageReplay.js index 9ce185dcbe..b1b22edfba 100644 --- a/src/ol/render/webgl/ImageReplay.js +++ b/src/ol/render/webgl/ImageReplay.js @@ -9,7 +9,6 @@ class WebGLImageReplay extends WebGLTextureReplay { /** * @param {number} tolerance Tolerance. * @param {module:ol/extent~Extent} maxExtent Max extent. - * @struct */ constructor(tolerance, maxExtent) { super(tolerance, maxExtent); diff --git a/src/ol/render/webgl/Immediate.js b/src/ol/render/webgl/Immediate.js index 6e5c258b4f..13a2845e43 100644 --- a/src/ol/render/webgl/Immediate.js +++ b/src/ol/render/webgl/Immediate.js @@ -17,7 +17,6 @@ class WebGLImmediateRenderer extends VectorContext { * @param {module:ol/size~Size} size Size. * @param {module:ol/extent~Extent} extent Extent. * @param {number} pixelRatio Pixel ratio. - * @struct */ constructor(context, center, resolution, rotation, size, extent, pixelRatio) { super(); diff --git a/src/ol/render/webgl/LineStringReplay.js b/src/ol/render/webgl/LineStringReplay.js index adce9c1c20..4851b5a7db 100644 --- a/src/ol/render/webgl/LineStringReplay.js +++ b/src/ol/render/webgl/LineStringReplay.js @@ -39,7 +39,6 @@ class WebGLLineStringReplay extends WebGLReplay { /** * @param {number} tolerance Tolerance. * @param {module:ol/extent~Extent} maxExtent Max extent. - * @struct */ constructor(tolerance, maxExtent) { super(tolerance, maxExtent); diff --git a/src/ol/render/webgl/PolygonReplay.js b/src/ol/render/webgl/PolygonReplay.js index 6de0fc4dfd..0b69e32a8e 100644 --- a/src/ol/render/webgl/PolygonReplay.js +++ b/src/ol/render/webgl/PolygonReplay.js @@ -40,7 +40,6 @@ class WebGLPolygonReplay extends WebGLReplay { /** * @param {number} tolerance Tolerance. * @param {module:ol/extent~Extent} maxExtent Max extent. - * @struct */ constructor(tolerance, maxExtent) { super(tolerance, maxExtent); diff --git a/src/ol/render/webgl/Replay.js b/src/ol/render/webgl/Replay.js index 3bd4af2ba6..5a74456316 100644 --- a/src/ol/render/webgl/Replay.js +++ b/src/ol/render/webgl/Replay.js @@ -19,178 +19,176 @@ class WebGLReplay extends VectorContext { /** * @param {number} tolerance Tolerance. * @param {module:ol/extent~Extent} maxExtent Max extent. - * @struct */ constructor(tolerance, maxExtent) { super(); /** - * @protected - * @type {number} - */ + * @protected + * @type {number} + */ this.tolerance = tolerance; /** - * @protected - * @const - * @type {module:ol/extent~Extent} - */ + * @protected + * @const + * @type {module:ol/extent~Extent} + */ this.maxExtent = maxExtent; /** - * The origin of the coordinate system for the point coordinates sent to - * the GPU. To eliminate jitter caused by precision problems in the GPU - * we use the "Rendering Relative to Eye" technique described in the "3D - * Engine Design for Virtual Globes" book. - * @protected - * @type {module:ol/coordinate~Coordinate} - */ + * The origin of the coordinate system for the point coordinates sent to + * the GPU. To eliminate jitter caused by precision problems in the GPU + * we use the "Rendering Relative to Eye" technique described in the "3D + * Engine Design for Virtual Globes" book. + * @protected + * @type {module:ol/coordinate~Coordinate} + */ this.origin = getCenter(maxExtent); /** - * @private - * @type {module:ol/transform~Transform} - */ + * @private + * @type {module:ol/transform~Transform} + */ this.projectionMatrix_ = createTransform(); /** - * @private - * @type {module:ol/transform~Transform} - */ + * @private + * @type {module:ol/transform~Transform} + */ this.offsetRotateMatrix_ = createTransform(); /** - * @private - * @type {module:ol/transform~Transform} - */ + * @private + * @type {module:ol/transform~Transform} + */ this.offsetScaleMatrix_ = createTransform(); /** - * @private - * @type {Array.} - */ + * @private + * @type {Array.} + */ this.tmpMat4_ = create(); /** - * @protected - * @type {Array.} - */ + * @protected + * @type {Array.} + */ this.indices = []; /** - * @protected - * @type {?module:ol/webgl/Buffer} - */ + * @protected + * @type {?module:ol/webgl/Buffer} + */ this.indicesBuffer = null; /** - * Start index per feature (the index). - * @protected - * @type {Array.} - */ + * Start index per feature (the index). + * @protected + * @type {Array.} + */ this.startIndices = []; /** - * Start index per feature (the feature). - * @protected - * @type {Array.} - */ + * Start index per feature (the feature). + * @protected + * @type {Array.} + */ this.startIndicesFeature = []; /** - * @protected - * @type {Array.} - */ + * @protected + * @type {Array.} + */ this.vertices = []; /** - * @protected - * @type {?module:ol/webgl/Buffer} - */ + * @protected + * @type {?module:ol/webgl/Buffer} + */ this.verticesBuffer = null; /** - * Optional parameter for PolygonReplay instances. - * @protected - * @type {module:ol/render/webgl/LineStringReplay|undefined} - */ + * Optional parameter for PolygonReplay instances. + * @protected + * @type {module:ol/render/webgl/LineStringReplay|undefined} + */ this.lineStringReplay = undefined; } /** - * @abstract - * @param {module:ol/webgl/Context} context WebGL context. - * @return {function()} Delete resources function. - */ + * @abstract + * @param {module:ol/webgl/Context} context WebGL context. + * @return {function()} Delete resources function. + */ getDeleteResourcesFunction(context) {} /** - * @abstract - * @param {module:ol/webgl/Context} context Context. - */ + * @abstract + * @param {module:ol/webgl/Context} context Context. + */ finish(context) {} /** - * @abstract - * @protected - * @param {WebGLRenderingContext} gl gl. - * @param {module:ol/webgl/Context} context Context. - * @param {module:ol/size~Size} size Size. - * @param {number} pixelRatio Pixel ratio. - * @return {module:ol/render/webgl/circlereplay/defaultshader/Locations| - module:ol/render/webgl/linestringreplay/defaultshader/Locations| - module:ol/render/webgl/polygonreplay/defaultshader/Locations| - module:ol/render/webgl/texturereplay/defaultshader/Locations} Locations. - */ + * @abstract + * @protected + * @param {WebGLRenderingContext} gl gl. + * @param {module:ol/webgl/Context} context Context. + * @param {module:ol/size~Size} size Size. + * @param {number} pixelRatio Pixel ratio. + * @return {module:ol/render/webgl/circlereplay/defaultshader/Locations| + module:ol/render/webgl/linestringreplay/defaultshader/Locations| + module:ol/render/webgl/polygonreplay/defaultshader/Locations| + module:ol/render/webgl/texturereplay/defaultshader/Locations} Locations. + */ setUpProgram(gl, context, size, pixelRatio) {} /** - * @abstract - * @protected - * @param {WebGLRenderingContext} gl gl. - * @param {module:ol/render/webgl/circlereplay/defaultshader/Locations| - module:ol/render/webgl/linestringreplay/defaultshader/Locations| - module:ol/render/webgl/polygonreplay/defaultshader/Locations| - module:ol/render/webgl/texturereplay/defaultshader/Locations} locations Locations. - */ + * @abstract + * @protected + * @param {WebGLRenderingContext} gl gl. + * @param {module:ol/render/webgl/circlereplay/defaultshader/Locations| + module:ol/render/webgl/linestringreplay/defaultshader/Locations| + module:ol/render/webgl/polygonreplay/defaultshader/Locations| + module:ol/render/webgl/texturereplay/defaultshader/Locations} locations Locations. + */ shutDownProgram(gl, locations) {} /** - * @abstract - * @protected - * @param {WebGLRenderingContext} gl gl. - * @param {module:ol/webgl/Context} context Context. - * @param {Object.} skippedFeaturesHash Ids of features to skip. - * @param {boolean} hitDetection Hit detection mode. - */ + * @abstract + * @protected + * @param {WebGLRenderingContext} gl gl. + * @param {module:ol/webgl/Context} context Context. + * @param {Object.} skippedFeaturesHash Ids of features to skip. + * @param {boolean} hitDetection Hit detection mode. + */ drawReplay(gl, context, skippedFeaturesHash, hitDetection) {} /** - * @abstract - * @protected - * @param {WebGLRenderingContext} gl gl. - * @param {module:ol/webgl/Context} context Context. - * @param {Object.} skippedFeaturesHash Ids of features to skip. - * @param {function((module:ol/Feature|module:ol/render/Feature)): T|undefined} featureCallback Feature callback. - * @param {module:ol/extent~Extent=} opt_hitExtent Hit extent: Only features intersecting this extent are checked. - * @return {T|undefined} Callback result. - * @template T - */ + * @abstract + * @protected + * @param {WebGLRenderingContext} gl gl. + * @param {module:ol/webgl/Context} context Context. + * @param {Object.} skippedFeaturesHash Ids of features to skip. + * @param {function((module:ol/Feature|module:ol/render/Feature)): T|undefined} featureCallback Feature callback. + * @param {module:ol/extent~Extent=} opt_hitExtent Hit extent: Only features intersecting this extent are checked. + * @return {T|undefined} Callback result. + * @template T + */ drawHitDetectionReplayOneByOne(gl, context, skippedFeaturesHash, featureCallback, opt_hitExtent) {} /** - * @protected - * @param {WebGLRenderingContext} gl gl. - * @param {module:ol/webgl/Context} context Context. - * @param {Object.} skippedFeaturesHash Ids of features to skip. - * @param {function((module:ol/Feature|module:ol/render/Feature)): T|undefined} featureCallback Feature callback. - * @param {boolean} oneByOne Draw features one-by-one for the hit-detecion. - * @param {module:ol/extent~Extent=} opt_hitExtent Hit extent: Only features intersecting - * this extent are checked. - * @return {T|undefined} Callback result. - * @template T - */ + * @protected + * @param {WebGLRenderingContext} gl gl. + * @param {module:ol/webgl/Context} context Context. + * @param {Object.} skippedFeaturesHash Ids of features to skip. + * @param {function((module:ol/Feature|module:ol/render/Feature)): T|undefined} featureCallback Feature callback. + * @param {boolean} oneByOne Draw features one-by-one for the hit-detecion. + * @param {module:ol/extent~Extent=} opt_hitExtent Hit extent: Only features intersecting this extent are checked. + * @return {T|undefined} Callback result. + * @template T + */ drawHitDetectionReplay(gl, context, skippedFeaturesHash, featureCallback, oneByOne, opt_hitExtent) { if (!oneByOne) { // draw all hit-detection features in "once" (by texture group) @@ -204,14 +202,14 @@ class WebGLReplay extends VectorContext { } /** - * @protected - * @param {WebGLRenderingContext} gl gl. - * @param {module:ol/webgl/Context} context Context. - * @param {Object.} skippedFeaturesHash Ids of features to skip. - * @param {function((module:ol/Feature|module:ol/render/Feature)): T|undefined} featureCallback Feature callback. - * @return {T|undefined} Callback result. - * @template T - */ + * @protected + * @param {WebGLRenderingContext} gl gl. + * @param {module:ol/webgl/Context} context Context. + * @param {Object.} skippedFeaturesHash Ids of features to skip. + * @param {function((module:ol/Feature|module:ol/render/Feature)): T|undefined} featureCallback Feature callback. + * @return {T|undefined} Callback result. + * @template T + */ drawHitDetectionReplayAll(gl, context, skippedFeaturesHash, featureCallback) { gl.clear(gl.COLOR_BUFFER_BIT | gl.DEPTH_BUFFER_BIT); this.drawReplay(gl, context, skippedFeaturesHash, true); @@ -225,21 +223,20 @@ class WebGLReplay extends VectorContext { } /** - * @param {module:ol/webgl/Context} context Context. - * @param {module:ol/coordinate~Coordinate} center Center. - * @param {number} resolution Resolution. - * @param {number} rotation Rotation. - * @param {module:ol/size~Size} size Size. - * @param {number} pixelRatio Pixel ratio. - * @param {number} opacity Global opacity. - * @param {Object.} skippedFeaturesHash Ids of features to skip. - * @param {function((module:ol/Feature|module:ol/render/Feature)): T|undefined} featureCallback Feature callback. - * @param {boolean} oneByOne Draw features one-by-one for the hit-detecion. - * @param {module:ol/extent~Extent=} opt_hitExtent Hit extent: Only features intersecting - * this extent are checked. - * @return {T|undefined} Callback result. - * @template T - */ + * @param {module:ol/webgl/Context} context Context. + * @param {module:ol/coordinate~Coordinate} center Center. + * @param {number} resolution Resolution. + * @param {number} rotation Rotation. + * @param {module:ol/size~Size} size Size. + * @param {number} pixelRatio Pixel ratio. + * @param {number} opacity Global opacity. + * @param {Object.} skippedFeaturesHash Ids of features to skip. + * @param {function((module:ol/Feature|module:ol/render/Feature)): T|undefined} featureCallback Feature callback. + * @param {boolean} oneByOne Draw features one-by-one for the hit-detecion. + * @param {module:ol/extent~Extent=} opt_hitExtent Hit extent: Only features intersecting this extent are checked. + * @return {T|undefined} Callback result. + * @template T + */ replay( context, center, @@ -339,12 +336,12 @@ class WebGLReplay extends VectorContext { } /** - * @protected - * @param {WebGLRenderingContext} gl gl. - * @param {module:ol/webgl/Context} context Context. - * @param {number} start Start index. - * @param {number} end End index. - */ + * @protected + * @param {WebGLRenderingContext} gl gl. + * @param {module:ol/webgl/Context} context Context. + * @param {number} start Start index. + * @param {number} end End index. + */ drawElements(gl, context, start, end) { const elementType = context.hasOESElementIndexUint ? UNSIGNED_INT : UNSIGNED_SHORT; diff --git a/src/ol/render/webgl/ReplayGroup.js b/src/ol/render/webgl/ReplayGroup.js index 62b15c5932..0891ec3f9f 100644 --- a/src/ol/render/webgl/ReplayGroup.js +++ b/src/ol/render/webgl/ReplayGroup.js @@ -37,7 +37,6 @@ class WebGLReplayGroup extends ReplayGroup { * @param {number} tolerance Tolerance. * @param {module:ol/extent~Extent} maxExtent Max extent. * @param {number=} opt_renderBuffer Render buffer. - * @struct */ constructor(tolerance, maxExtent, opt_renderBuffer) { super(); diff --git a/src/ol/render/webgl/TextReplay.js b/src/ol/render/webgl/TextReplay.js index 7ecc5c2357..93407d902d 100644 --- a/src/ol/render/webgl/TextReplay.js +++ b/src/ol/render/webgl/TextReplay.js @@ -26,7 +26,6 @@ class WebGLTextReplay extends WebGLTextureReplay { /** * @param {number} tolerance Tolerance. * @param {module:ol/extent~Extent} maxExtent Max extent. - * @struct */ constructor(tolerance, maxExtent) { super(tolerance, maxExtent); diff --git a/src/ol/render/webgl/TextureReplay.js b/src/ol/render/webgl/TextureReplay.js index ab1b3c22b8..60302eb5dc 100644 --- a/src/ol/render/webgl/TextureReplay.js +++ b/src/ol/render/webgl/TextureReplay.js @@ -14,7 +14,6 @@ class WebGLTextureReplay extends WebGLReplay { /** * @param {number} tolerance Tolerance. * @param {module:ol/extent~Extent} maxExtent Max extent. - * @struct */ constructor(tolerance, maxExtent) { super(tolerance, maxExtent); diff --git a/src/ol/renderer/Layer.js b/src/ol/renderer/Layer.js index 99b5c34e59..ebcd30fcb3 100644 --- a/src/ol/renderer/Layer.js +++ b/src/ol/renderer/Layer.js @@ -14,7 +14,6 @@ class LayerRenderer extends Observable { /** * @param {module:ol/layer/Layer} layer Layer. - * @struct */ constructor(layer) { diff --git a/src/ol/renderer/Map.js b/src/ol/renderer/Map.js index 2127802d60..e189d39074 100644 --- a/src/ol/renderer/Map.js +++ b/src/ol/renderer/Map.js @@ -16,7 +16,6 @@ class MapRenderer extends Disposable { /** * @param {module:ol/PluggableMap} map Map. - * @struct */ constructor(map) { super(); diff --git a/src/ol/structs/LRUCache.js b/src/ol/structs/LRUCache.js index ee431d8253..c631c08e77 100644 --- a/src/ol/structs/LRUCache.js +++ b/src/ol/structs/LRUCache.js @@ -24,7 +24,6 @@ class LRUCache extends EventTarget { * items from the cache is the responsibility of the user. * * @fires module:ol/events/Event~Event - * @struct * @template T * @param {number=} opt_highWaterMark High water mark. */ diff --git a/src/ol/structs/PriorityQueue.js b/src/ol/structs/PriorityQueue.js index 2bbd260cdc..c78cb3b3dc 100644 --- a/src/ol/structs/PriorityQueue.js +++ b/src/ol/structs/PriorityQueue.js @@ -23,7 +23,6 @@ class PriorityQueue { * * @param {function(T): number} priorityFunction Priority function. * @param {function(T): string} keyFunction Key function. - * @struct * @template T */ constructor(priorityFunction, keyFunction) { diff --git a/src/ol/structs/RBush.js b/src/ol/structs/RBush.js index 9cf1350187..1039171e97 100644 --- a/src/ol/structs/RBush.js +++ b/src/ol/structs/RBush.js @@ -22,7 +22,6 @@ class RBush { * * @param {number=} opt_maxEntries Max entries. * @see https://github.com/mourner/rbush - * @struct * @template T */ constructor(opt_maxEntries) { diff --git a/src/ol/style/Atlas.js b/src/ol/style/Atlas.js index d60ab4f387..b263266a96 100644 --- a/src/ol/style/Atlas.js +++ b/src/ol/style/Atlas.js @@ -31,7 +31,6 @@ class Atlas { * managed with the bin packing algorithm described in: * http://www.blackpawn.com/texts/lightmaps/ * - * @struct * @param {number} size The size in pixels of the sprite image. * @param {number} space The space in pixels between images. * Because texture coordinates are float values, the edges of diff --git a/src/ol/style/AtlasManager.js b/src/ol/style/AtlasManager.js index d2883ff301..29c21afdc0 100644 --- a/src/ol/style/AtlasManager.js +++ b/src/ol/style/AtlasManager.js @@ -54,7 +54,6 @@ class AtlasManager { * If an application uses many images or very large images, it is recommended * to set a higher `size` value to avoid the creation of too many atlases. * - * @struct * @api * @param {module:ol/style/AtlasManager~Options=} opt_options Options. */ diff --git a/src/ol/tilegrid/WMTS.js b/src/ol/tilegrid/WMTS.js index 04fe5e3838..4ea2359d18 100644 --- a/src/ol/tilegrid/WMTS.js +++ b/src/ol/tilegrid/WMTS.js @@ -51,7 +51,6 @@ class WMTSTileGrid extends TileGrid { * Set the grid pattern for sources accessing WMTS tiled-image servers. * * @param {module:ol/tilegrid/WMTS~Options} options WMTS options. - * @struct * @api */ constructor(options) {