From fe86d2e7f73834ec467c392a347e293b590c18f3 Mon Sep 17 00:00:00 2001
From: Guillaume Beraudo <guillaume.beraudo@camptocamp.com>
Date: Thu, 2 Aug 2018 17:12:41 +0200
Subject: [PATCH] Expose original getGutter

TileWMS objects take a gutter option but do not have a public getter
for it. This makes it convoluted for user code to recreate the object
(ex: in the case of serialization/deserialization).

- the getGutterInternal() method is renamed to getGutter;
- the getGutter(projection) method is renamed to getGutterForProjection,
  which is also more explicit.

The getGutter method was not API and is only used by the renderer.
---
 src/ol/renderer/canvas/TileLayer.js   | 2 +-
 src/ol/renderer/webgl/TileLayer.js    | 2 +-
 src/ol/source/Tile.js                 | 2 +-
 src/ol/source/TileImage.js            | 9 ++++-----
 src/ol/source/TileWMS.js              | 2 +-
 test/rendering/ol/reproj/tile.test.js | 2 +-
 6 files changed, 9 insertions(+), 10 deletions(-)

diff --git a/src/ol/renderer/canvas/TileLayer.js b/src/ol/renderer/canvas/TileLayer.js
index c7a332a280..d5e391b26a 100644
--- a/src/ol/renderer/canvas/TileLayer.js
+++ b/src/ol/renderer/canvas/TileLayer.js
@@ -259,7 +259,7 @@ class CanvasTileLayerRenderer extends IntermediateCanvasRenderer {
         currentTilePixelSize = tileSource.getTilePixelSize(currentZ, pixelRatio, projection);
         currentResolution = tileGrid.getResolution(currentZ);
         currentScale = currentResolution / tileResolution;
-        tileGutter = tilePixelRatio * tileSource.getGutter(projection);
+        tileGutter = tilePixelRatio * tileSource.getGutterForProjection(projection);
         tilesToDraw = tilesToDrawByZ[currentZ];
         for (const tileCoordKey in tilesToDraw) {
           tile = tilesToDraw[tileCoordKey];
diff --git a/src/ol/renderer/webgl/TileLayer.js b/src/ol/renderer/webgl/TileLayer.js
index 67cd173116..da7339a522 100644
--- a/src/ol/renderer/webgl/TileLayer.js
+++ b/src/ol/renderer/webgl/TileLayer.js
@@ -161,7 +161,7 @@ class WebGLTileLayerRenderer extends WebGLLayerRenderer {
     const pixelRatio = tilePixelSize[0] /
         toSize(tileGrid.getTileSize(z), this.tmpSize_)[0];
     const tilePixelResolution = tileResolution / pixelRatio;
-    const tileGutter = tileSource.getTilePixelRatio(pixelRatio) * tileSource.getGutter(projection);
+    const tileGutter = tileSource.getTilePixelRatio(pixelRatio) * tileSource.getGutterForProjection(projection);
 
     const center = viewState.center;
     const extent = frameState.extent;
diff --git a/src/ol/source/Tile.js b/src/ol/source/Tile.js
index 678cf772b3..40ab0bc247 100644
--- a/src/ol/source/Tile.js
+++ b/src/ol/source/Tile.js
@@ -151,7 +151,7 @@ class TileSource extends Source {
    * @param {module:ol/proj/Projection} projection Projection.
    * @return {number} Gutter.
    */
-  getGutter(projection) {
+  getGutterForProjection(projection) {
     return 0;
   }
 
diff --git a/src/ol/source/TileImage.js b/src/ol/source/TileImage.js
index 5f3f433110..8698b3c42e 100644
--- a/src/ol/source/TileImage.js
+++ b/src/ol/source/TileImage.js
@@ -164,20 +164,19 @@ class TileImage extends UrlTile {
   /**
    * @inheritDoc
    */
-  getGutter(projection) {
+  getGutterForProjection(projection) {
     if (ENABLE_RASTER_REPROJECTION &&
         this.getProjection() && projection && !equivalent(this.getProjection(), projection)) {
       return 0;
     } else {
-      return this.getGutterInternal();
+      return this.getGutter();
     }
   }
 
   /**
-   * @protected
    * @return {number} Gutter.
    */
-  getGutterInternal() {
+  getGutter() {
     return 0;
   }
 
@@ -289,7 +288,7 @@ class TileImage extends UrlTile {
           sourceProjection, sourceTileGrid,
           projection, targetTileGrid,
           tileCoord, wrappedTileCoord, this.getTilePixelRatio(pixelRatio),
-          this.getGutterInternal(),
+          this.getGutter(),
           function(z, x, y, pixelRatio) {
             return this.getTileInternal(z, x, y, pixelRatio, sourceProjection);
           }.bind(this), this.reprojectionErrorThreshold_,
diff --git a/src/ol/source/TileWMS.js b/src/ol/source/TileWMS.js
index 66d8765b8c..e34cf6492d 100644
--- a/src/ol/source/TileWMS.js
+++ b/src/ol/source/TileWMS.js
@@ -214,7 +214,7 @@ class TileWMS extends TileImage {
   /**
    * @inheritDoc
    */
-  getGutterInternal() {
+  getGutter() {
     return this.gutter_;
   }
 
diff --git a/test/rendering/ol/reproj/tile.test.js b/test/rendering/ol/reproj/tile.test.js
index 8cfaf79fa8..259bb64c72 100644
--- a/test/rendering/ol/reproj/tile.test.js
+++ b/test/rendering/ol/reproj/tile.test.js
@@ -12,7 +12,7 @@ describe('ol.rendering.reproj.Tile', function() {
   function testSingleTile(source, targetProjection, targetTileGrid, z, x, y,
     pixelRatio, expectedUrl, expectedRequests, done) {
     const sourceProjection = source.getProjection();
-    const sourceGutter = source.getGutter(sourceProjection);
+    const sourceGutter = source.getGutterForProjection(sourceProjection);
 
     let tilesRequested = 0;