From 5e810ccc6aa526f96f0dbf28ff700ffdbf729731 Mon Sep 17 00:00:00 2001 From: Michael Kuenzli Date: Wed, 18 Apr 2018 10:39:05 +0200 Subject: [PATCH] Move olx.render.State to ol/render --- externs/olx.js | 46 ---------------------------------- src/ol/render.js | 12 +++++++++ src/ol/render/canvas/Replay.js | 2 +- src/ol/style/Style.js | 4 +-- 4 files changed, 15 insertions(+), 49 deletions(-) diff --git a/externs/olx.js b/externs/olx.js index 846ac32599..5f4c83b8e3 100644 --- a/externs/olx.js +++ b/externs/olx.js @@ -4,49 +4,3 @@ */ let olx; - -/** - * @typedef {{context: CanvasRenderingContext2D, - * feature: (module:ol/Feature~Feature|ol.render.Feature), - * geometry: module:ol/geom/SimpleGeometry~SimpleGeometry, - * pixelRatio: number, - * resolution: number, - * rotation: number}} - */ -olx.render.State; - - -/** - * Canvas context that the layer is being rendered to. - * @type {CanvasRenderingContext2D} - * @api - */ -olx.render.State.prototype.context; - - -/** - * Pixel ratio used by the layer renderer. - * @type {number} - * @api - */ -olx.render.State.prototype.pixelRatio; - - -/** - * Resolution that the render batch was created and optimized for. This is - * not the view's resolution that is being rendered. - * @type {number} - * @api - */ -olx.render.State.prototype.resolution; - - -/** - * Rotation of the rendered layer in radians. - * @type {number} - * @api - */ -olx.render.State.prototype.rotation; - - -/** \ No newline at end of file diff --git a/src/ol/render.js b/src/ol/render.js index b017ed3d56..12f0fd33c0 100644 --- a/src/ol/render.js +++ b/src/ol/render.js @@ -6,6 +6,18 @@ import {create as createTransform, scale as scaleTransform} from './transform.js import CanvasImmediateRenderer from './render/canvas/Immediate.js'; +/** + * @typedef {Object} State + * @property {CanvasRenderingContext2D} context Canvas context that the layer is being rendered to. + * @property {module:ol/Feature~Feature|module:ol/render/Feature~Feature} feature + * @property {module:ol/geom/SimpleGeometry~SimpleGeometry} geometry + * @property {number} pixelRatio Pixel ratio used by the layer renderer. + * @property {number} resolution Resolution that the render batch was created and optimized for. + * This is not the view's resolution that is being rendered. + * @property {number} rotation Rotation of the rendered layer in radians. + */ + + /** * A function to be used when sorting features before rendering. * It takes two instances of {@link module:ol/Feature} or diff --git a/src/ol/render/canvas/Replay.js b/src/ol/render/canvas/Replay.js index 7715e9a37e..09a44a0325 100644 --- a/src/ol/render/canvas/Replay.js +++ b/src/ol/render/canvas/Replay.js @@ -565,7 +565,7 @@ CanvasReplay.prototype.replay_ = function( const coordinateCache = this.coordinateCache_; const viewRotation = this.viewRotation_; - const state = /** @type {olx.render.State} */ ({ + const state = /** @type {module:ol/render~State} */ ({ context: context, pixelRatio: this.pixelRatio, resolution: this.resolution, diff --git a/src/ol/style/Style.js b/src/ol/style/Style.js index 61cf9189cc..656e2110e3 100644 --- a/src/ol/style/Style.js +++ b/src/ol/style/Style.js @@ -20,9 +20,9 @@ import Stroke from '../style/Stroke.js'; * Custom renderer function. Takes two arguments: * * 1. The pixel coordinates of the geometry in GeoJSON notation. - * 2. The {@link olx.render.State} of the layer renderer. + * 2. The {@link module:ol/render~State} of the layer renderer. * - * @typedef {function((module:ol/coordinate~Coordinate|Array|Array.>),olx.render.State)} + * @typedef {function((module:ol/coordinate~Coordinate|Array|Array.>),module:ol/render~State)} * RenderFunction */