# all files / ol/ tilegrid.js

100% Statements 58/58
100% Branches 16/16
100% Functions 7/7
100% Lines 58/58

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
    96
    97
    98
    99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    1581×

    1×
    1×
    1×
    1×
    1×
    1×
    1×
    1×

    1×
    43×
    43×
    4×
    4×

    43×

    1×
    271×
    271×
    271×
    271×
    14×
    14×
    14×
    14×

    257×

    1×
    64×

    64×

    64×

    1×
    144×
    144×

    144×
    50×

    144×

    144×

    144×

    1×
    208×

    208×
    208×

    208×

    208×

    208×
    208×
    208×
    6542×

    208×

    1×
    59×
    59×

    1×
    434×
    434×
    434×
    4×

    4×

    434×

     goog.provide('ol.tilegrid');

    goog.require('ol');
    goog.require('ol.size');
    goog.require('ol.extent');
    goog.require('ol.extent.Corner');
    goog.require('ol.obj');
    goog.require('ol.proj');
    goog.require('ol.proj.Units');
    goog.require('ol.tilegrid.TileGrid');

    /**
     * @param {ol.proj.Projection} projection Projection.
     * @return {!ol.tilegrid.TileGrid} Default tile grid for the passed projection.
     */
    ol.tilegrid.getForProjection = function(projection) {
      var tileGrid = projection.getDefaultTileGrid();
      if (!tileGrid) {
        tileGrid = ol.tilegrid.createForProjection(projection);
        projection.setDefaultTileGrid(tileGrid);
      }
      return tileGrid;
    };

    /**
     * @param {ol.tilegrid.TileGrid} tileGrid Tile grid.
     * @param {ol.TileCoord} tileCoord Tile coordinate.
     * @param {ol.proj.Projection} projection Projection.
     * @return {ol.TileCoord} Tile coordinate.
     */
    ol.tilegrid.wrapX = function(tileGrid, tileCoord, projection) {
      var z = tileCoord[0];
      var center = tileGrid.getTileCoordCenter(tileCoord);
      var projectionExtent = ol.tilegrid.extentFromProjection(projection);
      if (!ol.extent.containsCoordinate(projectionExtent, center)) {
        var worldWidth = ol.extent.getWidth(projectionExtent);
        var worldsAway = Math.ceil((projectionExtent[0] - center[0]) / worldWidth);
        center[0] += worldWidth * worldsAway;
        return tileGrid.getTileCoordForCoordAndZ(center, z);
      } else {
        return tileCoord;
      }
    };

    /**
     * @param {ol.Extent} extent Extent.
     * @param {number=} opt_maxZoom Maximum zoom level (default is
     *     ol.DEFAULT_MAX_ZOOM).
     * @param {number|ol.Size=} opt_tileSize Tile size (default uses
     *     ol.DEFAULT_TILE_SIZE).
     * @param {ol.extent.Corner=} opt_corner Extent corner (default is
     *     ol.extent.Corner.TOP_LEFT).
     * @return {!ol.tilegrid.TileGrid} TileGrid instance.
     */
    ol.tilegrid.createForExtent = function(extent, opt_maxZoom, opt_tileSize, opt_corner) {
      var corner = opt_corner !== undefined ?
        opt_corner : ol.extent.Corner.TOP_LEFT;

      var resolutions = ol.tilegrid.resolutionsFromExtent(
          extent, opt_maxZoom, opt_tileSize);

      return new ol.tilegrid.TileGrid({
        extent: extent,
        origin: ol.extent.getCorner(extent, corner),
        resolutions: resolutions,
        tileSize: opt_tileSize
      });
    };

    /**
     * Creates a tile grid with a standard XYZ tiling scheme.
     * @param {olx.tilegrid.XYZOptions=} opt_options Tile grid options.
     * @return {!ol.tilegrid.TileGrid} Tile grid instance.
     * @api
     */
    ol.tilegrid.createXYZ = function(opt_options) {
      var options = /** @type {olx.tilegrid.TileGridOptions} */ ({});
      ol.obj.assign(options, opt_options !== undefined ?
        opt_options : /** @type {olx.tilegrid.XYZOptions} */ ({}));
      if (options.extent === undefined) {
        options.extent = ol.proj.get('EPSG:3857').getExtent();
      }
      options.resolutions = ol.tilegrid.resolutionsFromExtent(
          options.extent, options.maxZoom, options.tileSize);
      delete options.maxZoom;

      return new ol.tilegrid.TileGrid(options);
    };

    /**
     * Create a resolutions array from an extent.  A zoom factor of 2 is assumed.
     * @param {ol.Extent} extent Extent.
     * @param {number=} opt_maxZoom Maximum zoom level (default is
     *     ol.DEFAULT_MAX_ZOOM).
     * @param {number|ol.Size=} opt_tileSize Tile size (default uses
     *     ol.DEFAULT_TILE_SIZE).
     * @return {!Array.<number>} Resolutions array.
     */
    ol.tilegrid.resolutionsFromExtent = function(extent, opt_maxZoom, opt_tileSize) {
      var maxZoom = opt_maxZoom !== undefined ?
        opt_maxZoom : ol.DEFAULT_MAX_ZOOM;

      var height = ol.extent.getHeight(extent);
      var width = ol.extent.getWidth(extent);

      var tileSize = ol.size.toSize(opt_tileSize !== undefined ?
        opt_tileSize : ol.DEFAULT_TILE_SIZE);
      var maxResolution = Math.max(
          width / tileSize[0], height / tileSize[1]);

      var length = maxZoom + 1;
      var resolutions = new Array(length);
      for (var z = 0; z < length; ++z) {
        resolutions[z] = maxResolution / Math.pow(2, z);
      }
      return resolutions;
    };

    /**
     * @param {ol.ProjectionLike} projection Projection.
     * @param {number=} opt_maxZoom Maximum zoom level (default is
     *     ol.DEFAULT_MAX_ZOOM).
     * @param {number|ol.Size=} opt_tileSize Tile size (default uses
     *     ol.DEFAULT_TILE_SIZE).
     * @param {ol.extent.Corner=} opt_corner Extent corner (default is
     *     ol.extent.Corner.BOTTOM_LEFT).
     * @return {!ol.tilegrid.TileGrid} TileGrid instance.
     */
    ol.tilegrid.createForProjection = function(projection, opt_maxZoom, opt_tileSize, opt_corner) {
      var extent = ol.tilegrid.extentFromProjection(projection);
      return ol.tilegrid.createForExtent(
          extent, opt_maxZoom, opt_tileSize, opt_corner);
    };

    /**
     * Generate a tile grid extent from a projection.  If the projection has an
     * extent, it is used.  If not, a global extent is assumed.
     * @param {ol.ProjectionLike} projection Projection.
     * @return {ol.Extent} Extent.
     */
    ol.tilegrid.extentFromProjection = function(projection) {
      projection = ol.proj.get(projection);
      var extent = projection.getExtent();
      if (!extent) {
        var half = 180 * ol.proj.METERS_PER_UNIT[ol.proj.Units.DEGREES] /
            projection.getMetersPerUnit();
        extent = ol.extent.createOrUpdate(-half, -half, half, half);
      }
      return extent;
    };