feature : zoom

- Created AbstractRenderer in rendering package
- Created CachedRenderer and CachedFrameRenderer to extract basic frame
  caching logic from DrawingController
- Created RendererManager to synchronize updates made to several Renderer
  settings
- Moved FrameRenderer from pskl.rendering to pskl.rendering.frame
- Fixed the resize of the drawing area when the window is resized

js/controller/AnimatedPreviewController.js

@@ -9,14 +9,15 @@
 
     this.setFPS(Constants.DEFAULT.FPS);
 
+    var zoom = this.calculateZoom_();
     var renderingOptions = {
-      "zoom": this.calculateZoom_(),
-      "height" : "auto",
-      "width" : "auto"
+      "zoom": zoom,
+      "height" : this.piskelController.getCurrentFrame().getHeight() * zoom,
+      "width" : this.piskelController.getCurrentFrame().getWidth() * zoom
     };
-    this.renderer = new pskl.rendering.FrameRenderer(this.container, renderingOptions);
+    this.renderer = new pskl.rendering.frame.FrameRenderer(this.container, renderingOptions);
 
-    $.subscribe(Events.FRAME_SIZE_CHANGED, this.updateDPI_.bind(this));
+    $.subscribe(Events.FRAME_SIZE_CHANGED, this.updateZoom_.bind(this));
   };
 
   ns.AnimatedPreviewController.prototype.init = function () {
@@ -58,16 +59,14 @@
    */
   ns.AnimatedPreviewController.prototype.calculateZoom_ = function () {
     var previewSize = 200,
-      framePixelHeight = this.piskelController.getCurrentFrame().getHeight(),
-      framePixelWidth = this.piskelController.getCurrentFrame().getWidth();
-    // TODO (julz) : should have a utility to get a Size from framesheet easily (what about empty framesheets though ?)
+      hZoom = previewSize / this.piskelController.getCurrentFrame().getHeight(),
+      wZoom = previewSize / this.piskelController.getCurrentFrame().getWidth();
 
-    //return pskl.PixelUtils.calculateDPIForContainer($(".preview-container"), framePixelHeight, framePixelWidth);
-    return pskl.PixelUtils.calculateDPI(previewSize, previewSize, framePixelHeight, framePixelWidth);
+    return Math.min(hZoom, wZoom);
   };
 
-  ns.AnimatedPreviewController.prototype.updateDPI_ = function () {
-    this.dpi = this.calculateDPI_();
-    this.renderer.setDPI(this.dpi);
+  ns.AnimatedPreviewController.prototype.updateZoom_ = function () {
+    var zoom = this.calculateZoom_();
+    this.renderer.setZoom(zoom);
   };
 })();

js/controller/DrawingController.js

@@ -16,25 +16,28 @@
      */
     this.container = container;
 
-    this.zoom = this.calculateZoom_();
-    this.xOffset = 0;
-    this.yOffset = 0;
-
     // TODO(vincz): Store user prefs in a localstorage string ?
     var renderingOptions = {
-      "zoom": this.zoom,
+      "zoom": this.calculateZoom_(),
       "supportGridRendering" : true,
       "height" : this.getContainerHeight_(),
       "width" : this.getContainerWidth_(),
-      "xOffset" : this.xOffset,
-      "yOffset" : this.yOffset
+      "xOffset" : 0,
+      "yOffset" : 0
     };
 
-    this.overlayRenderer = new pskl.rendering.FrameRenderer(this.container, renderingOptions, ["canvas-overlay"]);
-    this.renderer = new pskl.rendering.FrameRenderer(this.container, renderingOptions, ["drawing-canvas"]);
-    this.layersBelowRenderer = new pskl.rendering.FrameRenderer(this.container, renderingOptions, ["layers-canvas", "layers-below-canvas"]);
-    this.layersAboveRenderer = new pskl.rendering.FrameRenderer(this.container, renderingOptions, ["layers-canvas", "layers-above-canvas"]);
+    this.overlayRenderer = new pskl.rendering.frame.CachedFrameRenderer(this.container, renderingOptions, ["canvas-overlay"]);
+    this.renderer = new pskl.rendering.frame.CachedFrameRenderer(this.container, renderingOptions, ["drawing-canvas"]);
 
+    this.layersBelowRenderer = new pskl.rendering.frame.FrameRenderer(this.container, renderingOptions, ["layers-canvas", "layers-below-canvas"]);
+    this.layersAboveRenderer = new pskl.rendering.frame.FrameRenderer(this.container, renderingOptions, ["layers-canvas", "layers-above-canvas"]);
+
+    this.rendererManager = new pskl.rendering.RendererManager();
+    this.rendererManager
+      .add(this.overlayRenderer)
+      .add(this.renderer)
+      .add(this.layersBelowRenderer)
+      .add(this.layersAboveRenderer);
 
     // State of drawing controller:
     this.isClicked = false;
@@ -69,12 +72,12 @@
       $.publish(Events.SECONDARY_COLOR_UPDATED, [color]);
     }, this));
 
-    $(window).resize($.proxy(this.startDPIUpdateTimer_, this));
+    $(window).resize($.proxy(this.startResizeTimer_, this));
 
     $.subscribe(Events.USER_SETTINGS_CHANGED, $.proxy(this.onUserSettingsChange_, this));
-    $.subscribe(Events.FRAME_SIZE_CHANGED, $.proxy(this.updateZoom_, this));
+    $.subscribe(Events.FRAME_SIZE_CHANGED, $.proxy(this.onFrameSizeChanged_, this));
 
-    this.updateZoom_();
+    this.centerColumnWrapperHorizontally_();
   };
 
   ns.DrawingController.prototype.initMouseBehavior = function() {
@@ -89,11 +92,15 @@
     body.contextmenu(this.onCanvasContextMenu_);
   };
 
-  ns.DrawingController.prototype.startDPIUpdateTimer_ = function () {
-    if (this.zoomUpdateTimer) {
-      window.clearInterval(this.zoomUpdateTimer);
+  ns.DrawingController.prototype.startResizeTimer_ = function () {
+    if (this.resizeTimer) {
+      window.clearInterval(this.resizeTimer);
     }
-    this.zoomUpdateTimer = window.setTimeout($.proxy(this.updateZoom_, this), 200);
+    this.resizeTimer = window.setTimeout($.proxy(this.afterWindowResize_, this), 200);
+  },
+
+  ns.DrawingController.prototype.afterWindowResize_ = function () {
+    this.rendererManager.setDisplaySize(this.getContainerWidth_(), this.getContainerHeight_());
   },
 
   /**
@@ -101,7 +108,7 @@
    */
   ns.DrawingController.prototype.onUserSettingsChange_ = function (evt, settingsName, settingsValue) {
     if(settingsName == pskl.UserSettings.SHOW_GRID) {
-      this.updateZoom_();
+      console.warn('DrawingController:onUserSettingsChange_ not implemented !');
     }
   },
 
@@ -116,10 +123,11 @@
       $.publish(Events.CANVAS_RIGHT_CLICKED);
     }
 
-    var coords = this.getSpriteCoordinates(event);
+    var coords = this.renderer.getCoordinates(event.clientX, event.clientY);
 
     this.currentToolBehavior.applyToolAt(
-      coords.col, coords.row,
+      coords.x,
+      coords.y,
       this.getCurrentColor_(),
       this.piskelController.getCurrentFrame(),
       this.overlayFrame,
@@ -136,11 +144,13 @@
     var currentTime = new Date().getTime();
     // Throttling of the mousemove event:
     if ((currentTime - this.previousMousemoveTime) > 40 ) {
-      var coords = this.getSpriteCoordinates(event);
+      var coords = this.renderer.getCoordinates(event.clientX, event.clientY);
+
       if (this.isClicked) {
 
         this.currentToolBehavior.moveToolAt(
-          coords.col, coords.row,
+          coords.x,
+          coords.y,
           this.getCurrentColor_(),
           this.piskelController.getCurrentFrame(),
           this.overlayFrame,
@@ -154,7 +164,8 @@
       } else {
 
         this.currentToolBehavior.moveUnactiveToolAt(
-          coords.col, coords.row,
+          coords.x,
+          coords.y,
           this.getCurrentColor_(),
           this.piskelController.getCurrentFrame(),
           this.overlayFrame,
@@ -168,10 +179,11 @@
   ns.DrawingController.prototype.onMousewheel_ = function (jQueryEvent) {
     var event = jQueryEvent.originalEvent;
     var delta = event.wheelDeltaY;
+    var currentZoom = this.renderer.getZoom();
     if (delta > 0) {
-      this.setZoom(this.zoom + 1);
+      this.rendererManager.setZoom(currentZoom + 1);
     } else if (delta < 0) {
-      this.setZoom(this.zoom - 1);
+      this.rendererManager.setZoom(currentZoom - 1);
     }
   };
 
@@ -188,10 +200,11 @@
       this.isClicked = false;
       this.isRightClicked = false;
 
-      var coords = this.getSpriteCoordinates(event);
+      var coords = this.renderer.getCoordinates(event.clientX, event.clientY);
       //console.log("mousemove: col: " + spriteCoordinate.col + " - row: " + spriteCoordinate.row);
       this.currentToolBehavior.releaseToolAt(
-        coords.col, coords.row,
+        coords.x,
+        coords.y,
         this.getCurrentColor_(),
         this.piskelController.getCurrentFrame(),
         this.overlayFrame,
@@ -215,23 +228,12 @@
     return evtInfo;
   };
 
-  /**
-   * @private
-   */
-  ns.DrawingController.prototype.getRelativeCoordinates = function (clientX, clientY) {
-    var canvasPageOffset = this.container.offset();
-    return {
-      x : clientX - canvasPageOffset.left,
-      y : clientY - canvasPageOffset.top
-    };
-  };
 
   /**
    * @private
    */
   ns.DrawingController.prototype.getSpriteCoordinates = function(event) {
-    var coords = this.getRelativeCoordinates(event.clientX, event.clientY);
-    return this.renderer.convertPixelCoordinatesIntoSpriteCoordinate(coords);
+    return this.renderer.getCoordinates(event.clientX, event.clientY);
   };
 
   /**
@@ -265,23 +267,15 @@
   };
 
   ns.DrawingController.prototype.renderFrame = function () {
-    var frame = this.piskelController.getCurrentFrame();
-    var serializedFrame = [this.zoom, this.xOffset, this.yOffset, frame.serialize()].join('-');
-    if (this.serializedFrame != serializedFrame) {
-      if (!frame.isSameSize(this.overlayFrame)) {
-        this.overlayFrame = pskl.model.Frame.createEmptyFromFrame(frame);
-      }
-      this.serializedFrame = serializedFrame;
-      this.renderer.render(frame);
-    }
+    this.renderer.render(this.piskelController.getCurrentFrame());
   };
 
   ns.DrawingController.prototype.renderOverlay = function () {
-    var serializedOverlay = [this.zoom, this.xOffset, this.yOffset, this.overlayFrame.serialize()].join('-');
-    if (this.serializedOverlay != serializedOverlay) {
-      this.serializedOverlay = serializedOverlay;
-      this.overlayRenderer.render(this.overlayFrame);
+    var currentFrame = this.piskelController.getCurrentFrame();
+    if (!currentFrame.isSameSize(this.overlayFrame)) {
+      this.overlayFrame = pskl.model.Frame.createEmptyFromFrame(currentFrame);
     }
+    this.overlayRenderer.render(this.overlayFrame);
   };
 
   ns.DrawingController.prototype.renderLayers = function () {
@@ -349,39 +343,19 @@
   ns.DrawingController.prototype.getContainerWidth_ = function () {
     return this.calculateZoom_() * this.piskelController.getCurrentFrame().getWidth();
   };
+
   /**
    * @private
    */
-  ns.DrawingController.prototype.updateZoom_ = function() {
-    this.setZoom(this.calculateZoom_());
-
-    var currentFrameHeight =  this.piskelController.getCurrentFrame().getHeight();
-    var canvasHeight = currentFrameHeight * this.zoom;
-    if (pskl.UserSettings.get(pskl.UserSettings.SHOW_GRID)) {
-      canvasHeight += Constants.GRID_STROKE_WIDTH * currentFrameHeight;
-    }
-
-    var verticalGapInPixel = Math.floor(($('#main-wrapper').height() - canvasHeight) / 2);
+  ns.DrawingController.prototype.centerColumnWrapperHorizontally_ = function() {
+    var containerHeight = this.getContainerHeight_();
+    var verticalGapInPixel = Math.floor(($('#main-wrapper').height() - containerHeight) / 2);
     $('#column-wrapper').css({
-      'top': verticalGapInPixel + 'px',
-      'height': canvasHeight + 'px'
+      'top': verticalGapInPixel + 'px'
     });
   };
 
-  ns.DrawingController.prototype.setZoom = function (zoom) {
-    this.zoom = zoom;
-    this.overlayRenderer.setZoom(this.zoom);
-    this.renderer.setZoom(this.zoom);
-    this.layersAboveRenderer.setZoom(this.zoom);
-    this.layersBelowRenderer.setZoom(this.zoom);
-  };
-
   ns.DrawingController.prototype.moveOffset = function (xOffset, yOffset) {
-    this.xOffset = xOffset;
-    this.yOffset = yOffset;
-    this.overlayRenderer.setDisplayOffset(xOffset, yOffset);
-    this.renderer.setDisplayOffset(xOffset, yOffset);
-    this.layersAboveRenderer.setDisplayOffset(xOffset, yOffset);
-    this.layersBelowRenderer.setDisplayOffset(xOffset, yOffset);
+    this.rendererManager.moveOffset(xOffset, yOffset);
   };
 })();

js/controller/PreviewFilmController.js

@@ -155,10 +155,10 @@
     // is to make this update function (#createPreviewTile) less aggressive.
     var renderingOptions = {
       "zoom" : this.zoom,
-      "height" : "auto",
-      "width" : "auto"
+      "height" : this.piskelController.getCurrentFrame().getHeight() * this.zoom,
+      "width" : this.piskelController.getCurrentFrame().getWidth() * this.zoom
     };
-    var currentFrameRenderer = new pskl.rendering.FrameRenderer($(canvasContainer), renderingOptions, ["tile-view"]);
+    var currentFrameRenderer = new pskl.rendering.frame.FrameRenderer($(canvasContainer), renderingOptions, ["tile-view"]);
     currentFrameRenderer.render(currentFrame);
 
     previewTileRoot.appendChild(canvasContainer);

js/controller/settings/ApplicationSettingsController.js

@@ -1,6 +1,6 @@
 (function () {
   var ns = $.namespace("pskl.controller.settings");
-  
+
   ns.ApplicationSettingsController = function () {};
 
   /**
@@ -18,21 +18,26 @@
     $('#show-grid').prop('checked', show_grid);
 
     // Handle grid display changes:
-    $('#show-grid').change($.proxy(function(evt) {
-      var checked = $('#show-grid').prop('checked');
-      pskl.UserSettings.set(pskl.UserSettings.SHOW_GRID, checked);
-    }, this));
+    $('#show-grid').change(this.onShowGridClick.bind(this));
 
     // Handle canvas background changes:
-    $('#background-picker-wrapper').click(function(evt) {
-      var target = $(evt.target).closest('.background-picker');
-      if (target.length) {
-        var backgroundClass = target.data('background-class');
-        pskl.UserSettings.set(pskl.UserSettings.CANVAS_BACKGROUND, backgroundClass);
-
-        $('.background-picker').removeClass('selected');
-        target.addClass('selected');
-      }
-    });
+    $('#background-picker-wrapper').click(this.onBackgroundClick.bind(this));
   };
+
+  ns.ApplicationSettingsController.prototype.onShowGridClick = function (evt) {
+    var checked = $('#show-grid').prop('checked');
+    pskl.UserSettings.set(pskl.UserSettings.SHOW_GRID, checked);
+  };
+
+  ns.ApplicationSettingsController.prototype.onBackgroundClick = function (evt) {
+    var target = $(evt.target).closest('.background-picker');
+    if (target.length) {
+      var backgroundClass = target.data('background-class');
+      pskl.UserSettings.set(pskl.UserSettings.CANVAS_BACKGROUND, backgroundClass);
+
+      $('.background-picker').removeClass('selected');
+      target.addClass('selected');
+    }
+  };
+
 })();