Update overlays unit tests.

src/viewer.js

@@ -1331,6 +1331,15 @@ $.extend( $.Viewer.prototype, $.EventSource.prototype, $.ControlDock.prototype,
         return this;
     },
 
+    /**
+     * @function Force the viewer to redraw its content.
+     * @return {OpenSeadragon.Viewer} Chainable.
+     */
+    forceRedraw: function() {
+        THIS[ this.hash ].forceRedraw = true;
+        return this;
+    },
+
    /**
      * Adds an html element as an overlay to the current viewport.  Useful for
      * highlighting words or areas of interest on an image or other zoomable
@@ -1784,22 +1793,31 @@ function getOverlayObject( viewer, overlay ) {
 
     var location = overlay.location;
     if ( !location ) {
-        var rect = ( overlay.height && overlay.width ) ? new $.Rect(
+        if ( overlay.width && overlay.height ) {
-            overlay.x || overlay.px,
+            location = overlay.px !== undefined ?
-            overlay.y || overlay.py,
+                viewer.viewport.imageToViewportRectangle( new $.Rect(
+                    overlay.px,
+                    overlay.py,
+                    overlay.width,
+                    overlay.height
+                ) ) :
+                new $.Rect(
+                    overlay.x,
+                    overlay.y,
                     overlay.width,
                     overlay.height
-        ) : new $.Point(
-            overlay.x || overlay.px,
-            overlay.y || overlay.py
                 );
-        if( overlay.px !== undefined ) {
+        } else {
-            //if they specified 'px' so it's in pixel coordinates so
+            location = overlay.px !== undefined ?
-            //we need to translate to viewport coordinates
+                viewer.viewport.imageToViewportCoordinates( new $.Point(
-            rect = viewer.viewport.imageToViewportRectangle( rect );
+                    overlay.px,
+                    overlay.py
+                ) ) :
+                new $.Point(
+                    overlay.x,
+                    overlay.y
+                );
         }
-        location = overlay.placement ? viewer.viewport.pointFromPixel( rect ) :
-            rect;
     }
 
     var placement = overlay.placement;

test/overlays.js

@@ -221,7 +221,7 @@
         viewer = OpenSeadragon( {
             id: 'example-overlays',
             prefixUrl: '/build/openseadragon/images/',
-            tileSources: [ '/test/data/testpattern.dzi', '/test/data/testpattern.dzi' ],
+            tileSources: '/test/data/testpattern.dzi',
             springStiffness: 100, // Faster animation = faster tests
             overlays: [ {
                     px: 13,
@@ -232,7 +232,8 @@
                 }, {
                     px: 400,
                     py: 500,
-                    id: "fixed-overlay"
+                    id: "fixed-overlay",
+                    placement: "TOP_LEFT"
                 } ]
         } );
 
@@ -284,7 +285,7 @@
         viewer = OpenSeadragon( {
             id: 'example-overlays',
             prefixUrl: '/build/openseadragon/images/',
-            tileSources: [ '/test/data/testpattern.dzi', '/test/data/testpattern.dzi' ],
+            tileSources: '/test/data/testpattern.dzi',
             springStiffness: 100, // Faster animation = faster tests
             overlays: [ {
                     x: 0.2,
@@ -295,7 +296,8 @@
                 }, {
                     x: 0.5,
                     y: 0.6,
-                    id: "fixed-overlay"
+                    id: "fixed-overlay",
+                    placement: "TOP_LEFT"
                 } ]
         } );
 
@@ -341,4 +343,193 @@
         } );
     } );
 
+    asyncTest( 'Overlays placement', function() {
+
+        var scalableOverlayLocation = new OpenSeadragon.Rect( 0.2, 0.1, 0.5, 0.1 );
+        var fixedOverlayLocation = new OpenSeadragon.Point( 0.5, 0.6 );
+
+        viewer = OpenSeadragon( {
+            id: 'example-overlays',
+            prefixUrl: '/build/openseadragon/images/',
+            tileSources: '/test/data/testpattern.dzi',
+            springStiffness: 100, // Faster animation = faster tests
+            overlays: [ {
+                    x: scalableOverlayLocation.x,
+                    y: scalableOverlayLocation.y,
+                    width: scalableOverlayLocation.width,
+                    height: scalableOverlayLocation.height,
+                    id: "overlay",
+                    placement: "TOP_LEFT"
+                }, {
+                    x: fixedOverlayLocation.x,
+                    y: fixedOverlayLocation.y,
+                    id: "fixed-overlay",
+                    placement: "TOP_LEFT"
+                } ]
+        } );
+
+        // Scalable overlays are always TOP_LEFT
+        function checkScalableOverlayPosition( contextMessage ) {
+            var viewport = viewer.viewport;
+
+            var expPosition = viewport.viewportToViewerElementCoordinates(
+                new OpenSeadragon.Point( 0.2, 0.1 ) ).apply( Math.floor );
+            var actPosition = $( "#overlay" ).position();
+            equal( actPosition.left, expPosition.x, "X position mismatch " + contextMessage );
+            equal( actPosition.top, expPosition.y, "Y position mismatch " + contextMessage );
+        }
+
+        function checkFixedOverlayPosition( expectedOffset, contextMessage ) {
+            var viewport = viewer.viewport;
+
+            var expPosition = viewport.viewportToViewerElementCoordinates(
+                new OpenSeadragon.Point( 0.5, 0.6 ) )
+                .apply( Math.floor )
+                .plus( expectedOffset );
+            var actPosition = $( "#fixed-overlay" ).position();
+            equal( actPosition.left, expPosition.x, "Fixed overlay X position mismatch " + contextMessage );
+            equal( actPosition.top, expPosition.y, "Fixed overlay Y position mismatch " + contextMessage );
+        }
+
+        waitForViewer( function() {
+
+            checkScalableOverlayPosition( "with TOP_LEFT placement." );
+            checkFixedOverlayPosition( new OpenSeadragon.Point( 0, 0 ),
+                "with TOP_LEFT placement." );
+
+            viewer.updateOverlay( "overlay", scalableOverlayLocation,
+                OpenSeadragon.OverlayPlacement.CENTER );
+            viewer.updateOverlay( "fixed-overlay", fixedOverlayLocation,
+                OpenSeadragon.OverlayPlacement.CENTER );
+
+            setTimeout( function() {
+                checkScalableOverlayPosition( "with CENTER placement." );
+                checkFixedOverlayPosition( new OpenSeadragon.Point( -35, -30 ),
+                    "with CENTER placement." );
+
+                viewer.updateOverlay( "overlay", scalableOverlayLocation,
+                    OpenSeadragon.OverlayPlacement.BOTTOM_RIGHT );
+                viewer.updateOverlay( "fixed-overlay", fixedOverlayLocation,
+                    OpenSeadragon.OverlayPlacement.BOTTOM_RIGHT );
+                setTimeout( function() {
+                    checkScalableOverlayPosition( "with BOTTOM_RIGHT placement." );
+                    checkFixedOverlayPosition( new OpenSeadragon.Point( -70, -60 ),
+                        "with BOTTOM_RIGHT placement." );
+
+                    start();
+                }, 100 );
+
+            }, 100 );
+
+        } );
+    } );
+
+    asyncTest( 'Overlays placement and resizing check', function() {
+
+        var fixedOverlayLocation = new OpenSeadragon.Point( 0.5, 0.6 );
+
+        viewer = OpenSeadragon( {
+            id: 'example-overlays',
+            prefixUrl: '/build/openseadragon/images/',
+            tileSources: '/test/data/testpattern.dzi',
+            springStiffness: 100, // Faster animation = faster tests
+            overlays: [ {
+                    x: fixedOverlayLocation.x,
+                    y: fixedOverlayLocation.y,
+                    id: "fixed-overlay",
+                    placement: "CENTER",
+                    checkResize: true
+                } ]
+        } );
+
+        function checkFixedOverlayPosition( expectedOffset, contextMessage ) {
+            var viewport = viewer.viewport;
+
+            var expPosition = viewport.viewportToViewerElementCoordinates(
+                new OpenSeadragon.Point( 0.5, 0.6 ) )
+                .apply( Math.floor )
+                .plus( expectedOffset );
+            var actPosition = $( "#fixed-overlay" ).position();
+            equal( actPosition.left, expPosition.x, "Fixed overlay X position mismatch " + contextMessage );
+            equal( actPosition.top, expPosition.y, "Fixed overlay Y position mismatch " + contextMessage );
+        }
+
+        waitForViewer( function() {
+            checkFixedOverlayPosition( new OpenSeadragon.Point( -35, -30 ),
+                "with overlay of size 70,60." );
+
+            $( "#fixed-overlay" ).width( 50 );
+            $( "#fixed-overlay" ).height( 40 );
+
+            // The resizing of the overlays is not detected by the viewer's loop.
+            viewer.forceRedraw();
+
+            setTimeout( function() {
+                checkFixedOverlayPosition( new OpenSeadragon.Point( -25, -20 ),
+                    "with overlay of size 50,40." );
+
+                // Restore original size
+                $( "#fixed-overlay" ).width( 70 );
+                $( "#fixed-overlay" ).height( 60 );
+
+                start();
+            }, 100 );
+        } );
+
+    } );
+
+    asyncTest( 'Overlays placement and no resizing check', function() {
+
+        var fixedOverlayLocation = new OpenSeadragon.Point( 0.5, 0.6 );
+
+        viewer = OpenSeadragon( {
+            id: 'example-overlays',
+            prefixUrl: '/build/openseadragon/images/',
+            tileSources: '/test/data/testpattern.dzi',
+            springStiffness: 100, // Faster animation = faster tests
+            overlays: [ {
+                    x: fixedOverlayLocation.x,
+                    y: fixedOverlayLocation.y,
+                    id: "fixed-overlay",
+                    placement: "CENTER",
+                    checkResize: false
+                } ]
+        } );
+
+        function checkFixedOverlayPosition( expectedOffset, contextMessage ) {
+            var viewport = viewer.viewport;
+
+            var expPosition = viewport.viewportToViewerElementCoordinates(
+                new OpenSeadragon.Point( 0.5, 0.6 ) )
+                .apply( Math.floor )
+                .plus( expectedOffset );
+            var actPosition = $( "#fixed-overlay" ).position();
+            equal( actPosition.left, expPosition.x, "Fixed overlay X position mismatch " + contextMessage );
+            equal( actPosition.top, expPosition.y, "Fixed overlay Y position mismatch " + contextMessage );
+        }
+
+        waitForViewer( function() {
+            checkFixedOverlayPosition( new OpenSeadragon.Point( -35, -30 ),
+                "with overlay of size 70,60." );
+
+            $( "#fixed-overlay" ).width( 50 );
+            $( "#fixed-overlay" ).height( 40 );
+
+            // The resizing of the overlays is not detected by the viewer's loop.
+            viewer.forceRedraw();
+
+            setTimeout( function() {
+                checkFixedOverlayPosition( new OpenSeadragon.Point( -35, -30 ),
+                    "with overlay of size 50,40." );
+
+                // Restore original size
+                $( "#fixed-overlay" ).width( 70 );
+                $( "#fixed-overlay" ).height( 60 );
+
+                start();
+            }, 100 );
+        } );
+
+    } );
+
 } )( );