OpenZoom catalog viewer sample

OpenZoomCatalogViewerSample.as

////////////////////////////////////////////////////////////////////////////////
//
//  OpenZoom SDK
//
//  Version: MPL 1.1/GPL 3/LGPL 3
//
//  The contents of this file are subject to the Mozilla Public License Version
//  1.1 (the "License"); you may not use this file except in compliance with
//  the License. You may obtain a copy of the License at
//  http://www.mozilla.org/MPL/
//
//  Software distributed under the License is distributed on an "AS IS" basis,
//  WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
//  for the specific language governing rights and limitations under the
//  License.
//
//  The Original Code is the OpenZoom SDK.
//
//  The Initial Developer of the Original Code is Daniel Gasienica.
//  Portions created by the Initial Developer are Copyright (c) 2007-2009
//  the Initial Developer. All Rights Reserved.
//
//  Contributor(s):
//    Daniel Gasienica <daniel@gasienica.ch>
//
//  Alternatively, the contents of this file may be used under the terms of
//  either the GNU General Public License Version 3 or later (the "GPL"), or
//  the GNU Lesser General Public License Version 3 or later (the "LGPL"),
//  in which case the provisions of the GPL or the LGPL are applicable instead
//  of those above. If you wish to allow use of your version of this file only
//  under the terms of either the GPL or the LGPL, and not to allow others to
//  use your version of this file under the terms of the MPL, indicate your
//  decision by deleting the provisions above and replace them with the notice
//  and other provisions required by the GPL or the LGPL. If you do not delete
//  the provisions above, a recipient may use your version of this file under
//  the terms of any one of the MPL, the GPL or the LGPL.
//
////////////////////////////////////////////////////////////////////////////////
package
{

import flash.display.Sprite;
import flash.display.StageAlign;
import flash.display.StageScaleMode;
import flash.events.Event;
import flash.events.KeyboardEvent;
import flash.events.MouseEvent;
import flash.geom.Rectangle;
import flash.net.URLLoader;
import flash.net.URLRequest;
import flash.ui.Keyboard;

import org.openzoom.flash.components.MemoryMonitor;
import org.openzoom.flash.components.MultiScaleContainer;
import org.openzoom.flash.descriptors.IImagePyramidDescriptor;
import org.openzoom.flash.descriptors.deepzoom.DeepZoomCollectionDescriptor;
import org.openzoom.flash.descriptors.deepzoom.DeepZoomImageDescriptor;
import org.openzoom.flash.renderers.images.ImagePyramidRenderManager;
import org.openzoom.flash.renderers.images.ImagePyramidRenderer;
import org.openzoom.flash.utils.ExternalMouseWheel;
import org.openzoom.flash.viewport.ISceneViewport;
import org.openzoom.flash.viewport.SceneViewport;
import org.openzoom.flash.viewport.constraints.CenterConstraint;
import org.openzoom.flash.viewport.constraints.CompositeConstraint;
import org.openzoom.flash.viewport.constraints.ScaleConstraint;
import org.openzoom.flash.viewport.constraints.VisibilityConstraint;
import org.openzoom.flash.viewport.constraints.ZoomConstraint;
import org.openzoom.flash.viewport.controllers.ContextMenuController;
import org.openzoom.flash.viewport.controllers.KeyboardController;
import org.openzoom.flash.viewport.controllers.MouseController;
import org.openzoom.flash.viewport.transformers.TweenerTransformer;

[SWF(width="960", height="540", frameRate="60", backgroundColor="#000000")]
public class CatalogViewer extends Sprite
{
    private static var PATH:String = ""
    private static var IMAGE_PATH:String = ""

    private static const DEFAULT_SCALE_FACTOR:Number = 1


    public function CatalogViewer()
    {
        stage.align = StageAlign.TOP_LEFT
        stage.scaleMode = StageScaleMode.NO_SCALE
        stage.addEventListener(Event.RESIZE,
                               stage_resizeHandler,
                               false, 0, true)

        stage.stageFocusRect = false

        ExternalMouseWheel.initialize(stage)
        
        include "config.as"

        loader = new URLLoader()
        loader.addEventListener(Event.COMPLETE,
                                loader_completeHandler,
                                false, 0, true)
        var collectionURL:String = PATH + "collection/collection.dzc"
        loader.load(new URLRequest(collectionURL))
    }

    private var container:MultiScaleContainer
    private var memoryMonitor:MemoryMonitor
    private var renderManager:ImagePyramidRenderManager

    private var loader:URLLoader

    private var sections:Array = [
                                    [0,     0], // Front
                                    [1,    10], // 1
                                    [11,   14], // 2
                                    [15,   50], // 3
                                    [51,   86], // 4
                                    [87,  112], // 5
                                    [113, 113]  // Back
                                 ]

    private var pageSection:Array = []

    private function loader_completeHandler(event:Event):void
    {
        for (var section:int = 0; section < sections.length; section++)
        {
            var firstPage:int = sections[section][0]
            var lastPage:int = sections[section][1]

            for (var page:int = firstPage; page <= lastPage; page++)
                pageSection[page] = section
        }

        container = new MultiScaleContainer()
        var transformer:TweenerTransformer = new TweenerTransformer()
        transformer.duration = 1.4
        container.transformer = transformer

        var mouseController:MouseController = new MouseController()

        var keyboardController:KeyboardController = new KeyboardController()
        var contextMenuController:ContextMenuController = new ContextMenuController()
        container.controllers = [mouseController,
                                 keyboardController,
                                 contextMenuController]

        renderManager = new ImagePyramidRenderManager(container,
                                                      container.scene,
                                                      container.viewport,
                                                      container.loader)

        var source:IImagePyramidDescriptor
        var numRenderers:int
        var numColumns:int
        var width:Number
        var height:Number
        var path:String
        var aspectRatio:Number

        var collection:DeepZoomCollectionDescriptor
        var collectionXML:XML = new XML(loader.data)

        collection = new DeepZoomCollectionDescriptor(PATH + "collection/collection.dzc",
                                                      collectionXML)

        path = IMAGE_PATH + "1/image.dzi"
        source = new DeepZoomImageDescriptor(path, 707, 1000, 254, 1, "png")
        numRenderers = sections[sections.length - 1][1]
        numColumns = 22
        aspectRatio = source.width / source.height
        width = 256
        height = width / aspectRatio

        var hPadding:Number = width * 0.1
        var vPadding:Number = height * 0.15

        var maxRight:Number = 0
        var maxBottom:Number = 0

        var column:int = 0
        var row:int = 0

        for (var i:int = 0; i < numRenderers; i++)
        {
            var renderer:ImagePyramidRenderer = new ImagePyramidRenderer()
            
            if (i % 2 == 0 && i != 0)
            {
                renderer.x = column * (width + hPadding) - hPadding * 0.66
                renderer.y = row * (height + vPadding)
            }
            else
            {
                renderer.x = column * (width + hPadding)
                renderer.y = row * (height + vPadding)
            }

            renderer.width = width
            renderer.height = height

            var s:String = IMAGE_PATH + (i + 1) + "/image.dzi"
            renderer.source = new DeepZoomImageDescriptor(s, 707, 1000, 254, 1, "png", null, i, collection)

            container.addChild(renderer)
            renderManager.addRenderer(renderer)

            renderer.buttonMode = true
            renderer.addEventListener(MouseEvent.CLICK,
                                      renderer_clickHandler,
                                      false, 0, true)

            maxRight = Math.max(maxRight, renderer.x + renderer.width)
            maxBottom = Math.max(maxBottom, renderer.y + renderer.height)

            column++
            if (column == numColumns || pageSection[i] != pageSection[i+1])
            {
                column = 0
                row++
            }
        }

        container.sceneWidth = maxRight
        container.sceneHeight = maxBottom

        var scaleConstraint:ScaleConstraint = new ScaleConstraint()
        scaleConstraint.maxScale = source.width / container.sceneWidth * numColumns * DEFAULT_SCALE_FACTOR

        var visibilityContraint:VisibilityConstraint = new VisibilityConstraint()
        var centerConstraint:CenterConstraint = new CenterConstraint()
        var zoomConstraint:ZoomConstraint = new ZoomConstraint()
        zoomConstraint.minZoom = 1

        var compositeContraint:CompositeConstraint = new CompositeConstraint()
        compositeContraint.constraints = [scaleConstraint,
                                          visibilityContraint]
        container.constraint = compositeContraint

        addChild(container)

        memoryMonitor = new MemoryMonitor()
        addChild(memoryMonitor)

        stage.addEventListener(KeyboardEvent.KEY_DOWN,
                               stage_keyDownHandler,
                               false, 0, true)
        layout()
    }

    private var focusIndex:int = -1
    private var focusedRenderer:ImagePyramidRenderer = null

    private function stage_keyDownHandler(event:KeyboardEvent):void
    {
        var renderer:ImagePyramidRenderer

        switch (event.keyCode)
        {
            case Keyboard.TAB:
            {
                var step:int = 1

                if (event.shiftKey)
                    step = -1

                focusIndex = (focusIndex + step) % container.numChildren

                if (focusIndex < 0)
                    focusIndex = container.numChildren - 1

                renderer = container.getChildAt(focusIndex) as ImagePyramidRenderer
                break
            }
        }

        if (renderer)
            focusRenderer(renderer)
    }

    private function renderer_clickHandler(event:MouseEvent):void
    {
        var renderer:ImagePyramidRenderer = event.target as ImagePyramidRenderer
        if (renderer)
        {
            focusIndex = container.getChildIndex(renderer)
            focusRenderer(renderer)
            focusedRenderer = renderer
        }
    }

    private function focusRenderer(renderer:ImagePyramidRenderer,
                                   scale:Number=0.8,
                                   immediately:Boolean=false):void
    {
        if (renderer == focusedRenderer && renderer.zoom > 0.5)
            return

        var sceneViewport:ISceneViewport = SceneViewport.getInstance(container.viewport)
        var bounds:Rectangle = renderer.getBounds(container.scene.targetCoordinateSpace)
        sceneViewport.fitToBounds(bounds, scale, immediately)
    }

    private function stage_resizeHandler(event:Event):void
    {
        layout()
    }

    private function layout():void
    {
        if (container)
        {
            container.width = stage.stageWidth
            container.height = stage.stageHeight
        }

        if (memoryMonitor)
        {
            memoryMonitor.x = stage.stageWidth - memoryMonitor.width - 10
            memoryMonitor.y = stage.stageHeight - memoryMonitor.height - 10
        }
    }
}

}