From 48efd432505f7aaa3a09d8f985e2cadb0dae3283 Mon Sep 17 00:00:00 2001
From: ahocevar <andreas.hocevar@gmail.com>
Date: Mon, 29 Apr 2013 14:20:18 +0200
Subject: [PATCH] Bring back throttling for tile loading

In OpenLayers 2.12, only one tile was loaded per animation frame. This
change brings back something similar as part of the tile manager. But we
do not use requestAnimationFrame anymore, because @elemoine pointed out
that browsers may give requestAnimationFrame invoked functions a higher
priority than setTimeout invoked functions.

The reason for this change is
http://lists.osgeo.org/pipermail/openlayers-users/2013-April/028063.html.
---
 examples/fullScreen.js        |  1 +
 lib/OpenLayers/TileManager.js | 29 ++++++++++++++++++++++++++---
 2 files changed, 27 insertions(+), 3 deletions(-)

diff --git a/examples/fullScreen.js b/examples/fullScreen.js
index 754cabfadd..bd3ee3d57f 100644
--- a/examples/fullScreen.js
+++ b/examples/fullScreen.js
@@ -6,6 +6,7 @@ var urls = [
 
 var map = new OpenLayers.Map({
     div: "map",
+    tileManager: new OpenLayers.TileManager(),
     layers: [
         new OpenLayers.Layer.XYZ("OSM (with buffer)", urls, {
             transitionEffect: "resize", buffer: 2, sphericalMercator: true,
diff --git a/lib/OpenLayers/TileManager.js b/lib/OpenLayers/TileManager.js
index 4ef5031919..69cf29d5b9 100644
--- a/lib/OpenLayers/TileManager.js
+++ b/lib/OpenLayers/TileManager.js
@@ -33,6 +33,20 @@ OpenLayers.TileManager = OpenLayers.Class({
      */
     cacheSize: 256,
 
+    /**
+     * APIProperty: tilesPerFrame
+     * {Number} Number of queued tiles to load per frame (see <frameDelay>).
+     *     Default is 2.
+     */
+    tilesPerFrame: 2,
+
+    /**
+     * APIProperty: frameDelay
+     * {Number} Delay between tile loading frames (see <tilesPerFrame>) in
+     *     milliseconds. Default is 16.
+     */
+    frameDelay: 16,
+
     /**
      * APIProperty: moveDelay
      * {Number} Delay in milliseconds after a map's move event before loading
@@ -251,7 +265,9 @@ OpenLayers.TileManager = OpenLayers.Class({
     
     /**
      * Method: updateTimeout
-     * Applies the <moveDelay> or <zoomDelay> to the <drawTilesFromQueue> loop.
+     * Applies the <moveDelay> or <zoomDelay> to the <drawTilesFromQueue> loop,
+     * and schedules more queue processing after <frameDelay> if there are still
+     * tiles in the queue.
      *
      * Parameters:
      * map - {<OpenLayers.Map>} The map to update the timeout for
@@ -259,10 +275,14 @@ OpenLayers.TileManager = OpenLayers.Class({
      */
     updateTimeout: function(map, delay) {
         window.clearTimeout(this.tileQueueId[map.id]);
-        if (this.tileQueue[map.id].length) {
+        var tileQueue = this.tileQueue[map.id];
+        if (tileQueue.length) {
             this.tileQueueId[map.id] = window.setTimeout(
                 OpenLayers.Function.bind(function() {
                     this.drawTilesFromQueue(map);
+                    if (tileQueue.length) {
+                        this.updateTimeout(map, this.frameDelay);
+                    }
                 }, this), delay
             );
         }
@@ -341,8 +361,11 @@ OpenLayers.TileManager = OpenLayers.Class({
      */
     drawTilesFromQueue: function(map) {
         var tileQueue = this.tileQueue[map.id];
-        while (tileQueue.length) {
+        var limit = this.tilesPerFrame;
+        var animating = map.zoomTween && map.zoomTween.playing;
+        while (!animating && tileQueue.length && limit) {
             tileQueue.shift().draw(true);
+            --limit;
         }
     },