From 68fbdc7bebe5dcd988ab93738bc76db8c4bc4539 Mon Sep 17 00:00:00 2001
From: Ian Gilman <ian@iangilman.com>
Date: Thu, 20 Nov 2014 15:33:13 -0800
Subject: [PATCH] * Overlays appear in the DOM immediately on open or
 addOverlay (#507)

---
 changelog.txt                 |  1 +
 src/viewer.js                 | 29 +++++++++++++++++------------
 test/demo/collections/main.js |  8 --------
 test/modules/overlays.js      | 33 ++++++++++++++++++++++++++++++++-
 4 files changed, 50 insertions(+), 21 deletions(-)

diff --git a/changelog.txt b/changelog.txt
index 547646c4..028c3300 100644
--- a/changelog.txt
+++ b/changelog.txt
@@ -37,6 +37,7 @@ OPENSEADRAGON CHANGELOG
     * Viewport.open supports positioning config properties
 * Margins option to push the home region in from the edges of the Viewer (#505)
 * Rect and Point toString() functions are now consistent: rounding values to nearest hundredth
+* Overlays appear in the DOM immediately on open or addOverlay (#507)
 
 1.2.0: (in progress)
 
diff --git a/src/viewer.js b/src/viewer.js
index b7879013..2f1684de 100644
--- a/src/viewer.js
+++ b/src/viewer.js
@@ -622,6 +622,8 @@ $.extend( $.Viewer.prototype, $.EventSource.prototype, $.ControlDock.prototype,
                         _this.currentOverlays[ i ] = getOverlayObject( _this, _this.overlays[ i ] );
                     }
 
+                    _this._drawOverlays();
+
                     /**
                      * Raised when the viewer has opened and loaded one or more TileSources.
                      *
@@ -1776,8 +1778,11 @@ $.extend( $.Viewer.prototype, $.EventSource.prototype, $.ControlDock.prototype,
             // they're trying to add a duplicate overlay
             return this;
         }
-        this.currentOverlays.push( getOverlayObject( this, options ) );
-        THIS[ this.hash ].forceRedraw = true;
+
+        var overlay = getOverlayObject( this, options);
+        this.currentOverlays.push(overlay);
+        overlay.drawHTML( this.overlaysContainer, this.viewport );
+
         /**
          * Raised when an overlay is added to the viewer (see {@link OpenSeadragon.Viewer#addOverlay}).
          *
@@ -1984,8 +1989,16 @@ $.extend( $.Viewer.prototype, $.EventSource.prototype, $.ControlDock.prototype,
             default:
                 return this.gestureSettingsUnknown;
         }
-    }
+    },
 
+    // private
+    _drawOverlays: function() {
+        var i,
+            length = this.currentOverlays.length;
+        for ( i = 0; i < length; i++ ) {
+            this.currentOverlays[ i ].drawHTML( this.overlaysContainer, this.viewport );
+        }
+    }
 });
 
 
@@ -2143,14 +2156,6 @@ function getOverlayIndex( overlays, element ) {
     return -1;
 }
 
-function drawOverlays( viewport, overlays, container ) {
-    var i,
-        length = overlays.length;
-    for ( i = 0; i < length; i++ ) {
-        overlays[ i ].drawHTML( container, viewport );
-    }
-}
-
 ///////////////////////////////////////////////////////////////////////////////
 // Schedulers provide the general engine for animation
 ///////////////////////////////////////////////////////////////////////////////
@@ -2674,7 +2679,7 @@ function updateOnce( viewer ) {
 
     if ( animated || THIS[ viewer.hash ].forceRedraw || viewer.world.needsUpdate() ) {
         updateWorld( viewer );
-        drawOverlays( viewer.viewport, viewer.currentOverlays, viewer.overlaysContainer );
+        viewer._drawOverlays();
         if( viewer.navigator ){
             viewer.navigator.update( viewer.viewport );
         }
diff --git a/test/demo/collections/main.js b/test/demo/collections/main.js
index 155634e0..669d4fdb 100644
--- a/test/demo/collections/main.js
+++ b/test/demo/collections/main.js
@@ -92,14 +92,6 @@
 
             if (testInitialOpen) {
                 this.viewer.addHandler( "open", function() {
-                    // setTimeout(function() {
-                    //     // console.log(self.viewer.viewport.contentSize);
-                    //     var $el = $('#overlay1').click(function() {
-                    //         console.log('foo');
-                    //     });
-
-                    //     console.log($el.length, $el.css('background'));
-                    // }, 1000);
                 });
             }
 
diff --git a/test/modules/overlays.js b/test/modules/overlays.js
index 223f99de..9fdfdb2e 100644
--- a/test/modules/overlays.js
+++ b/test/modules/overlays.js
@@ -1,4 +1,4 @@
-/* global QUnit, module, Util, $, console, test, asyncTest, start, ok, equal */
+/* global QUnit, module, Util, $, console, test, asyncTest, start, ok, equal, testLog */
 
 ( function() {
     var viewer;
@@ -532,4 +532,35 @@
 
     } );
 
+    // ----------
+    asyncTest('overlays appear immediately', function() {
+        equal($('#immediate-overlay0').length, 0, 'overlay 0 does not exist');
+        equal($('#immediate-overlay1').length, 0, 'overlay 1 does not exist');
+
+        viewer = OpenSeadragon( {
+            id: 'example-overlays',
+            prefixUrl: '/build/openseadragon/images/',
+            tileSources: '/test/data/testpattern.dzi',
+            springStiffness: 100, // Faster animation = faster tests
+            overlays: [ {
+                    x: 0,
+                    y: 0,
+                    id: "immediate-overlay0"
+                } ]
+        } );
+
+        viewer.addHandler('open', function() {
+            equal($('#immediate-overlay0').length, 1, 'overlay 0 exists');
+
+            viewer.addOverlay( {
+                x: 0,
+                y: 0,
+                id: "immediate-overlay1"
+            } );
+
+            equal($('#immediate-overlay1').length, 1, 'overlay 1 exists');
+            start();
+        });
+    });
+
 } )( );