Use 'module:ol/PluggableMap~FrameState' instead of 'olx.FrameState'

src/ol/MapBrowserEvent.js

@@ -16,7 +16,7 @@ import MapEvent from './MapEvent.js';
  * @param {module:ol/PluggableMap~PluggableMap} map Map.
  * @param {Event} browserEvent Browser event.
  * @param {boolean=} opt_dragging Is the map currently being dragged?
- * @param {?olx.FrameState=} opt_frameState Frame state.
+ * @param {?module:ol/PluggableMap~FrameState=} opt_frameState Frame state.
  */
 const MapBrowserEvent = function(type, map, browserEvent, opt_dragging, opt_frameState) {
 

src/ol/PluggableMap.js

@@ -57,7 +57,7 @@ import {create as createTransform, apply as applyTransform} from './transform.js
 
 
 /**
- * @typedef {function(module:ol/PluggableMap~PluggableMap, ?olx.FrameState): boolean} PostRenderFunction
+ * @typedef {function(module:ol/PluggableMap~PluggableMap, ?module:ol/PluggableMap~FrameState): boolean} PostRenderFunction
  */
 
 
@@ -218,7 +218,7 @@ const PluggableMap = function(options) {
 
   /**
    * @private
-   * @type {?olx.FrameState}
+   * @type {?module:ol/PluggableMap~FrameState}
    */
   this.frameState_ = null;
 
@@ -1224,7 +1224,7 @@ PluggableMap.prototype.renderFrame_ = function(time) {
   const view = this.getView();
   const extent = createEmpty();
   const previousFrameState = this.frameState_;
-  /** @type {?olx.FrameState} */
+  /** @type {?module:ol/PluggableMap~FrameState} */
   let frameState = null;
   if (size !== undefined && hasArea(size) && view && view.isDef()) {
     const viewHints = view.getHints(this.frameState_ ? this.frameState_.viewHints : undefined);
@@ -1241,7 +1241,7 @@ PluggableMap.prototype.renderFrame_ = function(time) {
       focus[0] = Math.round(focus[0] / pixelResolution) * pixelResolution;
       focus[1] = Math.round(focus[1] / pixelResolution) * pixelResolution;
     }
-    frameState = /** @type {olx.FrameState} */ ({
+    frameState = /** @type {module:ol/PluggableMap~FrameState} */ ({
       animate: false,
       coordinateToPixelTransform: this.coordinateToPixelTransform_,
       extent: extent,

src/ol/control/Attribution.js

@@ -148,7 +148,7 @@ inherits(Attribution, Control);
 
 /**
  * Get a list of visible attributions.
- * @param {olx.FrameState} frameState Frame state.
+ * @param {module:ol/PluggableMap~FrameState} frameState Frame state.
  * @return {Array.<string>} Attributions.
  * @private
  */
@@ -219,7 +219,7 @@ export function render(mapEvent) {
 
 /**
  * @private
- * @param {?olx.FrameState} frameState Frame state.
+ * @param {?module:ol/PluggableMap~FrameState} frameState Frame state.
  */
 Attribution.prototype.updateElement_ = function(frameState) {
   if (!frameState) {

src/ol/render/Event.js

@@ -10,7 +10,7 @@ import Event from '../events/Event.js';
  * @implements {oli.render.Event}
  * @param {ol.render.EventType} type Type.
  * @param {ol.render.VectorContext=} opt_vectorContext Vector context.
- * @param {olx.FrameState=} opt_frameState Frame state.
+ * @param {module:ol/PluggableMap~FrameState=} opt_frameState Frame state.
  * @param {?CanvasRenderingContext2D=} opt_context Context.
  * @param {?ol.webgl.Context=} opt_glContext WebGL Context.
  */
@@ -29,7 +29,7 @@ const RenderEvent = function(
 
   /**
    * An object representing the current render frame state.
-   * @type {olx.FrameState|undefined}
+   * @type {module:ol/PluggableMap~FrameState|undefined}
    * @api
    */
   this.frameState = opt_frameState;

src/ol/renderer/Layer.js

@@ -34,7 +34,7 @@ inherits(LayerRenderer, Observable);
 
 /**
  * @param {module:ol/coordinate~Coordinate} coordinate Coordinate.
- * @param {olx.FrameState} frameState Frame state.
+ * @param {module:ol/PluggableMap~FrameState} frameState Frame state.
  * @param {number} hitTolerance Hit tolerance in pixels.
  * @param {function(this: S, (module:ol/Feature~Feature|ol.render.Feature), ol.layer.Layer): T}
  *     callback Feature callback.
@@ -47,7 +47,7 @@ LayerRenderer.prototype.forEachFeatureAtCoordinate = UNDEFINED;
 
 /**
  * @param {module:ol/coordinate~Coordinate} coordinate Coordinate.
- * @param {olx.FrameState} frameState Frame state.
+ * @param {module:ol/PluggableMap~FrameState} frameState Frame state.
  * @return {boolean} Is there a feature at the given coordinate?
  */
 LayerRenderer.prototype.hasFeatureAtCoordinate = FALSE;
@@ -137,7 +137,7 @@ LayerRenderer.prototype.renderIfReadyAndVisible = function() {
 
 
 /**
- * @param {olx.FrameState} frameState Frame state.
+ * @param {module:ol/PluggableMap~FrameState} frameState Frame state.
  * @param {ol.source.Tile} tileSource Tile source.
  * @protected
  */
@@ -146,7 +146,7 @@ LayerRenderer.prototype.scheduleExpireCache = function(frameState, tileSource) {
     /**
      * @param {ol.source.Tile} tileSource Tile source.
      * @param {ol.PluggableMap} map Map.
-     * @param {olx.FrameState} frameState Frame state.
+     * @param {module:ol/PluggableMap~FrameState} frameState Frame state.
      */
     const postRenderFunction = function(tileSource, map, frameState) {
       const tileSourceKey = getUid(tileSource).toString();
@@ -194,7 +194,7 @@ LayerRenderer.prototype.updateUsedTiles = function(usedTiles, tileSource, z, til
  * - registers idle tiles in frameState.wantedTiles so that they are not
  *   discarded by the tile queue
  * - enqueues missing tiles
- * @param {olx.FrameState} frameState Frame state.
+ * @param {module:ol/PluggableMap~FrameState} frameState Frame state.
  * @param {ol.source.Tile} tileSource Tile source.
  * @param {ol.tilegrid.TileGrid} tileGrid Tile grid.
  * @param {number} pixelRatio Pixel ratio.

src/ol/renderer/Map.js

@@ -48,7 +48,7 @@ inherits(MapRenderer, Disposable);
 
 
 /**
- * @param {olx.FrameState} frameState FrameState.
+ * @param {module:ol/PluggableMap~FrameState} frameState FrameState.
  * @protected
  */
 MapRenderer.prototype.calculateMatrices2D = function(frameState) {
@@ -79,7 +79,7 @@ MapRenderer.prototype.removeLayerRenderers = function() {
 
 /**
  * @param {ol.PluggableMap} map Map.
- * @param {olx.FrameState} frameState Frame state.
+ * @param {module:ol/PluggableMap~FrameState} frameState Frame state.
  */
 function expireIconCache(map, frameState) {
   iconImageCache.expire();
@@ -88,7 +88,7 @@ function expireIconCache(map, frameState) {
 
 /**
  * @param {module:ol/coordinate~Coordinate} coordinate Coordinate.
- * @param {olx.FrameState} frameState FrameState.
+ * @param {module:ol/PluggableMap~FrameState} frameState FrameState.
  * @param {number} hitTolerance Hit tolerance in pixels.
  * @param {function(this: S, (module:ol/Feature~Feature|ol.render.Feature),
  *     ol.layer.Layer): T} callback Feature callback.
@@ -158,7 +158,7 @@ MapRenderer.prototype.forEachFeatureAtCoordinate = function(coordinate, frameSta
 /**
  * @abstract
  * @param {module:ol~Pixel} pixel Pixel.
- * @param {olx.FrameState} frameState FrameState.
+ * @param {module:ol/PluggableMap~FrameState} frameState FrameState.
  * @param {function(this: S, ol.layer.Layer, (Uint8ClampedArray|Uint8Array)): T} callback Layer
  *     callback.
  * @param {S} thisArg Value to use as `this` when executing `callback`.
@@ -176,7 +176,7 @@ MapRenderer.prototype.forEachLayerAtPixel = function(pixel, frameState, callback
 
 /**
  * @param {module:ol/coordinate~Coordinate} coordinate Coordinate.
- * @param {olx.FrameState} frameState FrameState.
+ * @param {module:ol/PluggableMap~FrameState} frameState FrameState.
  * @param {number} hitTolerance Hit tolerance in pixels.
  * @param {function(this: U, ol.layer.Layer): boolean} layerFilter Layer filter
  *     function, only layers which are visible and for which this function
@@ -287,14 +287,14 @@ MapRenderer.prototype.removeLayerRendererByKey_ = function(layerKey) {
 
 /**
  * Render.
- * @param {?olx.FrameState} frameState Frame state.
+ * @param {?module:ol/PluggableMap~FrameState} frameState Frame state.
  */
 MapRenderer.prototype.renderFrame = UNDEFINED;
 
 
 /**
  * @param {ol.PluggableMap} map Map.
- * @param {olx.FrameState} frameState Frame state.
+ * @param {module:ol/PluggableMap~FrameState} frameState Frame state.
  * @private
  */
 MapRenderer.prototype.removeUnusedLayerRenderers_ = function(map, frameState) {
@@ -307,7 +307,7 @@ MapRenderer.prototype.removeUnusedLayerRenderers_ = function(map, frameState) {
 
 
 /**
- * @param {olx.FrameState} frameState Frame state.
+ * @param {module:ol/PluggableMap~FrameState} frameState Frame state.
  * @protected
  */
 MapRenderer.prototype.scheduleExpireIconCache = function(frameState) {
@@ -316,7 +316,7 @@ MapRenderer.prototype.scheduleExpireIconCache = function(frameState) {
 
 
 /**
- * @param {!olx.FrameState} frameState Frame state.
+ * @param {!module:ol/PluggableMap~FrameState} frameState Frame state.
  * @protected
  */
 MapRenderer.prototype.scheduleRemoveUnusedLayerRenderers = function(frameState) {

src/ol/renderer/canvas/ImageLayer.js

@@ -149,7 +149,7 @@ CanvasImageLayerRenderer.prototype.prepareFrame = function(frameState, layerStat
     const vectorRenderer = this.vectorRenderer_;
     if (vectorRenderer) {
       const context = vectorRenderer.context;
-      const imageFrameState = /** @type {olx.FrameState} */ (assign({}, frameState, {
+      const imageFrameState = /** @type {module:ol/PluggableMap~FrameState} */ (assign({}, frameState, {
         size: [
           getWidth(renderedExtent) / viewResolution,
           getHeight(renderedExtent) / viewResolution

src/ol/renderer/canvas/Layer.js

@@ -40,7 +40,7 @@ inherits(CanvasLayerRenderer, LayerRenderer);
 
 /**
  * @param {CanvasRenderingContext2D} context Context.
- * @param {olx.FrameState} frameState Frame state.
+ * @param {module:ol/PluggableMap~FrameState} frameState Frame state.
  * @param {module:ol/extent~Extent} extent Clip extent.
  * @protected
  */
@@ -74,7 +74,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 {module:ol/PluggableMap~FrameState} frameState Frame state.
  * @param {module:ol/transform~Transform=} opt_transform Transform.
  * @private
  */
@@ -100,7 +100,7 @@ CanvasLayerRenderer.prototype.dispatchComposeEvent_ = function(type, context, fr
 
 /**
  * @param {module:ol/coordinate~Coordinate} coordinate Coordinate.
- * @param {olx.FrameState} frameState FrameState.
+ * @param {module:ol/PluggableMap~FrameState} frameState FrameState.
  * @param {function(this: S, ol.layer.Layer, (Uint8ClampedArray|Uint8Array)): T} callback Layer
  *     callback.
  * @param {S} thisArg Value to use as `this` when executing `callback`.
@@ -120,7 +120,7 @@ CanvasLayerRenderer.prototype.forEachLayerAtCoordinate = function(coordinate, fr
 
 /**
  * @param {CanvasRenderingContext2D} context Context.
- * @param {olx.FrameState} frameState Frame state.
+ * @param {module:ol/PluggableMap~FrameState} frameState Frame state.
  * @param {module:ol/layer/Layer~State} layerState Layer state.
  * @param {module:ol/transform~Transform=} opt_transform Transform.
  * @protected
@@ -132,7 +132,7 @@ CanvasLayerRenderer.prototype.postCompose = function(context, frameState, layerS
 
 /**
  * @param {CanvasRenderingContext2D} context Context.
- * @param {olx.FrameState} frameState Frame state.
+ * @param {module:ol/PluggableMap~FrameState} frameState Frame state.
  * @param {module:ol/transform~Transform=} opt_transform Transform.
  * @protected
  */
@@ -143,7 +143,7 @@ CanvasLayerRenderer.prototype.preCompose = function(context, frameState, opt_tra
 
 /**
  * @param {CanvasRenderingContext2D} context Context.
- * @param {olx.FrameState} frameState Frame state.
+ * @param {module:ol/PluggableMap~FrameState} frameState Frame state.
  * @param {module:ol/transform~Transform=} opt_transform Transform.
  * @protected
  */
@@ -153,7 +153,7 @@ CanvasLayerRenderer.prototype.dispatchRenderEvent = function(context, frameState
 
 
 /**
- * @param {olx.FrameState} frameState Frame state.
+ * @param {module:ol/PluggableMap~FrameState} frameState Frame state.
  * @param {number} offsetX Offset on the x-axis in view coordinates.
  * @protected
  * @return {!module:ol/transform~Transform} Transform.
@@ -174,7 +174,7 @@ CanvasLayerRenderer.prototype.getTransform = function(frameState, offsetX) {
 
 /**
  * @abstract
- * @param {olx.FrameState} frameState Frame state.
+ * @param {module:ol/PluggableMap~FrameState} frameState Frame state.
  * @param {module:ol/layer/Layer~State} layerState Layer state.
  * @param {CanvasRenderingContext2D} context Context.
  */
@@ -182,7 +182,7 @@ CanvasLayerRenderer.prototype.composeFrame = function(frameState, layerState, co
 
 /**
  * @abstract
- * @param {olx.FrameState} frameState Frame state.
+ * @param {module:ol/PluggableMap~FrameState} frameState Frame state.
  * @param {module:ol/layer/Layer~State} layerState Layer state.
  * @return {boolean} whether composeFrame should be called.
  */

src/ol/renderer/canvas/Map.js

@@ -86,7 +86,7 @@ CanvasMapRenderer['create'] = function(container, map) {
 
 /**
  * @param {ol.render.EventType} type Event type.
- * @param {olx.FrameState} frameState Frame state.
+ * @param {module:ol/PluggableMap~FrameState} frameState Frame state.
  * @private
  */
 CanvasMapRenderer.prototype.dispatchComposeEvent_ = function(type, frameState) {
@@ -110,7 +110,7 @@ CanvasMapRenderer.prototype.dispatchComposeEvent_ = function(type, frameState) {
 
 
 /**
- * @param {olx.FrameState} frameState Frame state.
+ * @param {module:ol/PluggableMap~FrameState} frameState Frame state.
  * @protected
  * @return {!module:ol/transform~Transform} Transform.
  */

src/ol/renderer/canvas/TileLayer.js

@@ -299,7 +299,7 @@ CanvasTileLayerRenderer.prototype.prepareFrame = function(frameState, layerState
 
 /**
  * @param {ol.Tile} tile Tile.
- * @param {olx.FrameState} frameState Frame state.
+ * @param {module:ol/PluggableMap~FrameState} frameState Frame state.
  * @param {module:ol/layer/Layer~State} layerState Layer state.
  * @param {number} x Left of the tile.
  * @param {number} y Top of the tile.

src/ol/renderer/canvas/VectorTileLayer.js

@@ -151,7 +151,7 @@ CanvasVectorTileLayerRenderer.prototype.prepareFrame = function(frameState, laye
 
 /**
  * @param {ol.VectorImageTile} tile Tile.
- * @param {olx.FrameState} frameState Frame state.
+ * @param {module:ol/PluggableMap~FrameState} frameState Frame state.
  * @private
  */
 CanvasVectorTileLayerRenderer.prototype.createReplayGroup_ = function(tile, frameState) {
@@ -310,7 +310,7 @@ CanvasVectorTileLayerRenderer.prototype.forEachFeatureAtCoordinate = function(co
 
 /**
  * @param {ol.VectorTile} tile Tile.
- * @param {olx.FrameState} frameState Frame state.
+ * @param {module:ol/PluggableMap~FrameState} frameState Frame state.
  * @return {module:ol/transform~Transform} transform Transform.
  * @private
  */
@@ -475,7 +475,7 @@ CanvasVectorTileLayerRenderer.prototype.renderFeature = function(feature, square
 
 /**
  * @param {ol.VectorImageTile} tile Tile.
- * @param {olx.FrameState} frameState Frame state.
+ * @param {module:ol/PluggableMap~FrameState} frameState Frame state.
  * @param {module:ol/layer/Layer~State} layerState Layer state.
  * @private
  */

src/ol/renderer/webgl/Layer.js

@@ -91,7 +91,7 @@ inherits(WebGLLayerRenderer, LayerRenderer);
 
 
 /**
- * @param {olx.FrameState} frameState Frame state.
+ * @param {module:ol/PluggableMap~FrameState} frameState Frame state.
  * @param {number} framebufferDimension Framebuffer dimension.
  * @protected
  */
@@ -137,7 +137,7 @@ WebGLLayerRenderer.prototype.bindFramebuffer = function(frameState, framebufferD
 
 
 /**
- * @param {olx.FrameState} frameState Frame state.
+ * @param {module:ol/PluggableMap~FrameState} frameState Frame state.
  * @param {module:ol/layer/Layer~State} layerState Layer state.
  * @param {ol.webgl.Context} context Context.
  */
@@ -184,7 +184,7 @@ WebGLLayerRenderer.prototype.composeFrame = function(frameState, layerState, con
 /**
  * @param {ol.render.EventType} type Event type.
  * @param {ol.webgl.Context} context WebGL context.
- * @param {olx.FrameState} frameState Frame state.
+ * @param {module:ol/PluggableMap~FrameState} frameState Frame state.
  * @private
  */
 WebGLLayerRenderer.prototype.dispatchComposeEvent_ = function(type, context, frameState) {
@@ -243,7 +243,7 @@ WebGLLayerRenderer.prototype.handleWebGLContextLost = function() {
 
 /**
  * @abstract
- * @param {olx.FrameState} frameState Frame state.
+ * @param {module:ol/PluggableMap~FrameState} frameState Frame state.
  * @param {module:ol/layer/Layer~State} layerState Layer state.
  * @param {ol.webgl.Context} context Context.
  * @return {boolean} whether composeFrame should be called.
@@ -254,7 +254,7 @@ WebGLLayerRenderer.prototype.prepareFrame = function(frameState, layerState, con
 /**
  * @abstract
  * @param {module:ol~Pixel} pixel Pixel.
- * @param {olx.FrameState} frameState FrameState.
+ * @param {module:ol/PluggableMap~FrameState} frameState FrameState.
  * @param {function(this: S, ol.layer.Layer, (Uint8ClampedArray|Uint8Array)): T} callback Layer
  *     callback.
  * @param {S} thisArg Value to use as `this` when executing `callback`.

src/ol/renderer/webgl/Map.js

@@ -142,7 +142,7 @@ const WebGLMapRenderer = function(container, map) {
 
   /**
    * @param {ol.PluggableMap} map Map.
-   * @param {?olx.FrameState} frameState Frame state.
+   * @param {?module:ol/PluggableMap~FrameState} frameState Frame state.
    * @return {boolean} false.
    * @this {ol.renderer.webgl.Map}
    */
@@ -261,7 +261,7 @@ WebGLMapRenderer.prototype.bindTileTexture = function(tile, tileSize, tileGutter
 
 /**
  * @param {ol.render.EventType} type Event type.
- * @param {olx.FrameState} frameState Frame state.
+ * @param {module:ol/PluggableMap~FrameState} frameState Frame state.
  * @private
  */
 WebGLMapRenderer.prototype.dispatchComposeEvent_ = function(type, frameState) {
@@ -311,7 +311,7 @@ WebGLMapRenderer.prototype.disposeInternal = function() {
 
 /**
  * @param {ol.PluggableMap} map Map.
- * @param {olx.FrameState} frameState Frame state.
+ * @param {module:ol/PluggableMap~FrameState} frameState Frame state.
  * @private
  */
 WebGLMapRenderer.prototype.expireCache_ = function(map, frameState) {

src/ol/source/Raster.js

@@ -51,7 +51,7 @@ const RasterEventType = {
  * @extends {ol.events.Event}
  * @implements {oli.source.RasterEvent}
  * @param {string} type Type.
- * @param {olx.FrameState} frameState The frame state.
+ * @param {module:ol/PluggableMap~FrameState} frameState The frame state.
  * @param {Object} data An object made available to operations.
  */
 const RasterSourceEvent = function(type, frameState, data) {
@@ -145,7 +145,7 @@ const RasterSource = function(options) {
 
   /**
    * The most recently requested frame state.
-   * @type {olx.FrameState}
+   * @type {module:ol/PluggableMap~FrameState}
    * @private
    */
   this.requestedFrameState_;
@@ -165,7 +165,7 @@ const RasterSource = function(options) {
 
   /**
    * @private
-   * @type {olx.FrameState}
+   * @type {module:ol/PluggableMap~FrameState}
    */
   this.frameState_ = {
     animate: false,
@@ -225,12 +225,12 @@ RasterSource.prototype.setOperation = function(operation, opt_lib) {
  * @param {module:ol/extent~Extent} extent The view extent (in map units).
  * @param {number} resolution The view resolution.
  * @param {module:ol/proj/Projection~Projection} projection The view projection.
- * @return {olx.FrameState} The updated frame state.
+ * @return {module:ol/PluggableMap~FrameState} The updated frame state.
  * @private
  */
 RasterSource.prototype.updateFrameState_ = function(extent, resolution, projection) {
 
-  const frameState = /** @type {olx.FrameState} */ (assign({}, this.frameState_));
+  const frameState = /** @type {module:ol/PluggableMap~FrameState} */ (assign({}, this.frameState_));
 
   frameState.viewState = /** @type {olx.ViewState} */ (assign({}, frameState.viewState));
 
@@ -330,7 +330,7 @@ RasterSource.prototype.processSources_ = function() {
 
 /**
  * Called when pixel processing is complete.
- * @param {olx.FrameState} frameState The frame state.
+ * @param {module:ol/PluggableMap~FrameState} frameState The frame state.
  * @param {Error} err Any error during processing.
  * @param {ImageData} output The output image data.
  * @param {Object} data The user data.
@@ -378,7 +378,7 @@ let sharedContext = null;
 /**
  * Get image data from a renderer.
  * @param {ol.renderer.canvas.Layer} renderer Layer renderer.
- * @param {olx.FrameState} frameState The frame state.
+ * @param {module:ol/PluggableMap~FrameState} frameState The frame state.
  * @param {module:ol/layer/Layer~State} layerState The layer state.
  * @return {ImageData} The image data.
  */