Module type for ol.render.Feature

2018-04-20 14:53:56 +02:00
parent 3c0c4cd155
commit 7701c5fd3a
21 changed files with 105 additions and 128 deletions
--- a/src/ol/renderer/Layer.js
+++ b/src/ol/renderer/Layer.js
@@ -36,7 +36,7 @@ inherits(LayerRenderer, Observable);
 * @param {module:ol/coordinate~Coordinate} coordinate Coordinate.
 * @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), module:ol/layer/Layer~Layer): T}
+ * @param {function(this: S, (module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature), module:ol/layer/Layer~Layer): T}
 *     callback Feature callback.
 * @param {S} thisArg Value to use as `this` when executing `callback`.
 * @return {T|undefined} Callback result.
--- a/src/ol/renderer/Map.js
+++ b/src/ol/renderer/Map.js
@@ -111,7 +111,7 @@ function expireIconCache(map, frameState) {
 * @param {module:ol/coordinate~Coordinate} coordinate Coordinate.
 * @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),
+ * @param {function(this: S, (module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature),
 *     module:ol/layer/Layer~Layer): T} callback Feature callback.
 * @param {S} thisArg Value to use as `this` when executing `callback`.
 * @param {function(this: U, module:ol/layer/Layer~Layer): boolean} layerFilter Layer filter
@@ -129,7 +129,7 @@ MapRenderer.prototype.forEachFeatureAtCoordinate = function(coordinate, frameSta
  const viewResolution = viewState.resolution;

  /**
-   * @param {module:ol/Feature~Feature|ol.render.Feature} feature Feature.
+   * @param {module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature} feature Feature.
   * @param {module:ol/layer/Layer~Layer} layer Layer.
   * @return {?} Callback result.
   */
--- a/src/ol/renderer/canvas/IntermediateCanvas.js
+++ b/src/ol/renderer/canvas/IntermediateCanvas.js
@@ -107,9 +107,9 @@ IntermediateCanvasRenderer.prototype.forEachFeatureAtCoordinate = function(coord
  return source.forEachFeatureAtCoordinate(
    coordinate, resolution, rotation, hitTolerance, skippedFeatureUids,
    /**
-       * @param {module:ol/Feature~Feature|ol.render.Feature} feature Feature.
-       * @return {?} Callback result.
-       */
+     * @param {module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature} feature Feature.
+     * @return {?} Callback result.
+     */
    function(feature) {
      return callback.call(thisArg, feature, layer);
    });
--- a/src/ol/renderer/canvas/VectorLayer.js
+++ b/src/ol/renderer/canvas/VectorLayer.js
@@ -255,7 +255,7 @@ CanvasVectorLayerRenderer.prototype.forEachFeatureAtCoordinate = function(coordi
    const features = {};
    const result = this.replayGroup_.forEachFeatureAtCoordinate(coordinate, resolution, rotation, hitTolerance, {},
      /**
-       * @param {module:ol/Feature~Feature|ol.render.Feature} feature Feature.
+       * @param {module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature} feature Feature.
       * @return {?} Callback result.
       */
      function(feature) {
--- a/src/ol/renderer/canvas/VectorTileLayer.js
+++ b/src/ol/renderer/canvas/VectorTileLayer.js
@@ -195,7 +195,7 @@ CanvasVectorTileLayerRenderer.prototype.createReplayGroup_ = function(tile, fram
    const squaredTolerance = getSquaredRenderTolerance(resolution, pixelRatio);

    /**
-     * @param {module:ol/Feature~Feature|ol.render.Feature} feature Feature.
+     * @param {module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature} feature Feature.
     * @this {ol.renderer.canvas.VectorTileLayer}
     */
    const render = function(feature) {
@@ -290,7 +290,7 @@ CanvasVectorTileLayerRenderer.prototype.forEachFeatureAtCoordinate = function(co
      replayGroup = sourceTile.getReplayGroup(layer, tile.tileCoord.toString());
      found = found || replayGroup.forEachFeatureAtCoordinate(coordinate, resolution, rotation, hitTolerance, {},
        /**
-         * @param {module:ol/Feature~Feature|ol.render.Feature} feature Feature.
+         * @param {module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature} feature Feature.
         * @return {?} Callback result.
         */
        function(feature) {
@@ -444,10 +444,9 @@ CanvasVectorTileLayerRenderer.prototype.postCompose = function(context, frameSta


 /**
- * @param {module:ol/Feature~Feature|ol.render.Feature} feature Feature.
+ * @param {module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature} feature Feature.
 * @param {number} squaredTolerance Squared tolerance.
- * @param {(module:ol/style/Style~Style|Array.<module:ol/style/Style~Style>)} styles The style or array of
- *     styles.
+ * @param {(module:ol/style/Style~Style|Array.<module:ol/style/Style~Style>)} styles The style or array of styles.
 * @param {ol.render.canvas.ReplayGroup} replayGroup Replay group.
 * @return {boolean} `true` if an image is loading.
 */
--- a/src/ol/renderer/vector.js
+++ b/src/ol/renderer/vector.js
@@ -33,8 +33,8 @@ const GEOMETRY_RENDERERS = {


 /**
- * @param {module:ol/Feature~Feature|ol.render.Feature} feature1 Feature 1.
- * @param {module:ol/Feature~Feature|ol.render.Feature} feature2 Feature 2.
+ * @param {module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature} feature1 Feature 1.
+ * @param {module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature} feature2 Feature 2.
 * @return {number} Order.
 */
 export function defaultOrder(feature1, feature2) {
@@ -88,7 +88,7 @@ function renderCircleGeometry(replayGroup, geometry, style, feature) {

 /**
 * @param {ol.render.ReplayGroup} replayGroup Replay group.
- * @param {module:ol/Feature~Feature|ol.render.Feature} feature Feature.
+ * @param {module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature} feature Feature.
 * @param {module:ol/style/Style~Style} style Style.
 * @param {number} squaredTolerance Squared tolerance.
 * @param {function(this: T, module:ol/events/Event~Event)} listener Listener function.
@@ -120,7 +120,7 @@ export function renderFeature(replayGroup, feature, style, squaredTolerance, lis

 /**
 * @param {ol.render.ReplayGroup} replayGroup Replay group.
- * @param {module:ol/Feature~Feature|ol.render.Feature} feature Feature.
+ * @param {module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature} feature Feature.
 * @param {module:ol/style/Style~Style} style Style.
 * @param {number} squaredTolerance Squared tolerance.
 */
@@ -144,7 +144,7 @@ function renderFeatureInternal(replayGroup, feature, style, squaredTolerance) {
 * @param {ol.render.ReplayGroup} replayGroup Replay group.
 * @param {module:ol/geom/Geometry~Geometry} geometry Geometry.
 * @param {module:ol/style/Style~Style} style Style.
- * @param {module:ol/Feature~Feature|ol.render.Feature} feature Feature.
+ * @param {module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature} feature Feature.
 */
 function renderGeometry(replayGroup, geometry, style, feature) {
  if (geometry.getType() == GeometryType.GEOMETRY_COLLECTION) {
@@ -178,9 +178,9 @@ function renderGeometryCollectionGeometry(replayGroup, geometry, style, feature)

 /**
 * @param {ol.render.ReplayGroup} replayGroup Replay group.
- * @param {module:ol/geom/LineString~LineString|ol.render.Feature} geometry Geometry.
+ * @param {module:ol/geom/LineString~LineString|module:ol/render/Feature~RenderFeature} geometry Geometry.
 * @param {module:ol/style/Style~Style} style Style.
- * @param {module:ol/Feature~Feature|ol.render.Feature} feature Feature.
+ * @param {module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature} feature Feature.
 */
 function renderLineStringGeometry(replayGroup, geometry, style, feature) {
  const strokeStyle = style.getStroke();
@@ -200,9 +200,9 @@ function renderLineStringGeometry(replayGroup, geometry, style, feature) {

 /**
 * @param {ol.render.ReplayGroup} replayGroup Replay group.
- * @param {module:ol/geom/MultiLineString~MultiLineString|ol.render.Feature} geometry Geometry.
+ * @param {module:ol/geom/MultiLineString~MultiLineString|module:ol/render/Feature~RenderFeature} geometry Geometry.
 * @param {module:ol/style/Style~Style} style Style.
- * @param {module:ol/Feature~Feature|ol.render.Feature} feature Feature.
+ * @param {module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature} feature Feature.
 */
 function renderMultiLineStringGeometry(replayGroup, geometry, style, feature) {
  const strokeStyle = style.getStroke();
@@ -245,9 +245,9 @@ function renderMultiPolygonGeometry(replayGroup, geometry, style, feature) {

 /**
 * @param {ol.render.ReplayGroup} replayGroup Replay group.
- * @param {module:ol/geom/Point~Point|ol.render.Feature} geometry Geometry.
+ * @param {module:ol/geom/Point~Point|module:ol/render/Feature~RenderFeature} geometry Geometry.
 * @param {module:ol/style/Style~Style} style Style.
- * @param {module:ol/Feature~Feature|ol.render.Feature} feature Feature.
+ * @param {module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature} feature Feature.
 */
 function renderPointGeometry(replayGroup, geometry, style, feature) {
  const imageStyle = style.getImage();
@@ -270,9 +270,9 @@ function renderPointGeometry(replayGroup, geometry, style, feature) {

 /**
 * @param {ol.render.ReplayGroup} replayGroup Replay group.
- * @param {module:ol/geom/MultiPoint~MultiPoint|ol.render.Feature} geometry Geometry.
+ * @param {module:ol/geom/MultiPoint~MultiPoint|module:ol/render/Feature~RenderFeature} geometry Geometry.
 * @param {module:ol/style/Style~Style} style Style.
- * @param {module:ol/Feature~Feature|ol.render.Feature} feature Feature.
+ * @param {module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature} feature Feature.
 */
 function renderMultiPointGeometry(replayGroup, geometry, style, feature) {
  const imageStyle = style.getImage();
@@ -295,9 +295,9 @@ function renderMultiPointGeometry(replayGroup, geometry, style, feature) {

 /**
 * @param {ol.render.ReplayGroup} replayGroup Replay group.
- * @param {module:ol/geom/Polygon~Polygon|ol.render.Feature} geometry Geometry.
+ * @param {module:ol/geom/Polygon~Polygon|module:ol/render/Feature~RenderFeature} geometry Geometry.
 * @param {module:ol/style/Style~Style} style Style.
- * @param {module:ol/Feature~Feature|ol.render.Feature} feature Feature.
+ * @param {module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature} feature Feature.
 */
 function renderPolygonGeometry(replayGroup, geometry, style, feature) {
  const fillStyle = style.getFill();
--- a/src/ol/renderer/webgl/ImageLayer.js
+++ b/src/ol/renderer/webgl/ImageLayer.js
@@ -113,7 +113,7 @@ WebGLImageLayerRenderer.prototype.forEachFeatureAtCoordinate = function(coordina
    coordinate, resolution, rotation, hitTolerance, skippedFeatureUids,

    /**
-       * @param {module:ol/Feature~Feature|ol.render.Feature} feature Feature.
+       * @param {module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature} feature Feature.
       * @return {?} Callback result.
       */
    function(feature) {
--- a/src/ol/renderer/webgl/VectorLayer.js
+++ b/src/ol/renderer/webgl/VectorLayer.js
@@ -148,9 +148,9 @@ WebGLVectorLayerRenderer.prototype.forEachFeatureAtCoordinate = function(coordin
      frameState.size, frameState.pixelRatio, layerState.opacity,
      {},
      /**
-         * @param {module:ol/Feature~Feature|ol.render.Feature} feature Feature.
-         * @return {?} Callback result.
-         */
+       * @param {module:ol/Feature~Feature|module:ol/render/Feature~RenderFeature} feature Feature.
+       * @return {?} Callback result.
+       */
      function(feature) {
        const key = getUid(feature).toString();
        if (!(key in features)) {