From bd0478fb35b764d894f49443732bb9d6945942ef Mon Sep 17 00:00:00 2001 From: juliandescottes Date: Wed, 19 Sep 2018 22:58:26 +0200 Subject: [PATCH] Extract PreviewActionsController from PreviewController --- .../preview/PreviewActionsController.js | 230 ++++++++++++++++++ .../controller/preview/PreviewController.js | 219 +---------------- src/piskel-script-list.js | 1 + 3 files changed, 238 insertions(+), 212 deletions(-) create mode 100644 src/js/controller/preview/PreviewActionsController.js diff --git a/src/js/controller/preview/PreviewActionsController.js b/src/js/controller/preview/PreviewActionsController.js new file mode 100644 index 00000000..cd15578e --- /dev/null +++ b/src/js/controller/preview/PreviewActionsController.js @@ -0,0 +1,230 @@ +(function () { + var ns = $.namespace('pskl.controller.preview'); + + ns.PreviewActionsController = function (previewController, container) { + this.previewController = previewController; + this.piskelController = previewController.piskelController; + this.container = container; + + this.onionSkinShortcut = pskl.service.keyboard.Shortcuts.MISC.ONION_SKIN; + + this.fpsRangeInput = document.querySelector('#preview-fps'); + this.fpsCounterDisplay = document.querySelector('#display-fps'); + this.openPopupPreview = document.querySelector('.open-popup-preview-button'); + this.toggleGridButton = document.querySelector('.toggle-grid-button'); + this.previewSizeDropdown = document.querySelector('.preview-drop-down'); + this.previewSizes = { + original: { + button: document.querySelector('.original-size-button'), + shortcut: pskl.service.keyboard.Shortcuts.MISC.X1_PREVIEW, + tooltip: 'Original size preview' + }, + best: { + button: document.querySelector('.best-size-button'), + shortcut: pskl.service.keyboard.Shortcuts.MISC.BEST_PREVIEW, + tooltip: 'Best size preview' + }, + full: { + button: document.querySelector('.full-size-button'), + shortcut: pskl.service.keyboard.Shortcuts.MISC.FULL_PREVIEW, + tooltip: 'Full size preview' + } + }; + this.toggleOnionSkinButton = document.querySelector('.preview-toggle-onion-skin'); + }; + + ns.PreviewActionsController.prototype.init = function () { + this.fpsRangeInput.addEventListener('change', this.onFpsRangeInputUpdate_.bind(this)); + this.fpsRangeInput.addEventListener('input', this.onFpsRangeInputUpdate_.bind(this)); + + var addEvent = pskl.utils.Event.addEventListener; + addEvent(this.toggleOnionSkinButton, 'click', this.toggleOnionSkin_, this); + addEvent(this.openPopupPreview, 'click', this.onOpenPopupPreviewClick_, this); + addEvent(this.toggleGridButton, 'click', this.toggleGrid_, this); + + var registerShortcut = pskl.app.shortcutService.registerShortcut.bind(pskl.app.shortcutService); + registerShortcut(this.onionSkinShortcut, this.toggleOnionSkin_.bind(this)); + + var onionSkinTooltip = pskl.utils.TooltipFormatter.format('Toggle onion skin', this.onionSkinShortcut); + this.toggleOnionSkinButton.setAttribute('title', onionSkinTooltip); + + for (var size in this.previewSizes) { + if (this.previewSizes.hasOwnProperty(size)) { + var previewSize = this.previewSizes[size]; + addEvent(previewSize.button, 'click', this.onChangePreviewSize_, this, size); + registerShortcut(previewSize.shortcut, this.onChangePreviewSize_.bind(this, size)); + var tooltip = pskl.utils.TooltipFormatter.format(previewSize.tooltip, previewSize.shortcut); + previewSize.button.setAttribute('title', tooltip); + } + } + + $.subscribe(Events.FRAME_SIZE_CHANGED, this.updatePreviewSizeButtons_.bind(this)); + $.subscribe(Events.USER_SETTINGS_CHANGED, this.onUserSettingsChange_.bind(this)); + $.subscribe(Events.FPS_CHANGED, this.updateFPS_.bind(this)); + $.subscribe(Events.PISKEL_RESET, this.updateFPS_.bind(this)); + + this.updatePreviewSizeButtons_(); + this.updateOnionSkinPreview_(); + this.selectPreviewSizeButton_(); + this.updateFPS_(); + this.updateMaxFPS_(); + this.updateToggleGridButton_(); + }; + + ns.PreviewActionsController.prototype.updateToggleGridButton_ = function () { + var gridEnabled = pskl.UserSettings.get(pskl.UserSettings.GRID_ENABLED); + this.toggleGridButton.classList.toggle('icon-minimap-grid-white', !gridEnabled); + this.toggleGridButton.classList.toggle('icon-minimap-grid-gold', gridEnabled); + this.toggleGridButton.classList.toggle('preview-contextual-action-enabled', gridEnabled); + }; + + ns.PreviewActionsController.prototype.toggleGrid_ = function () { + var gridEnabled = pskl.UserSettings.get(pskl.UserSettings.GRID_ENABLED); + pskl.UserSettings.set(pskl.UserSettings.GRID_ENABLED, !gridEnabled); + }; + + ns.PreviewActionsController.prototype.updatePreviewSizeButtons_ = function () { + var fullZoom = this.previewController.getZoom(); + var bestZoom = Math.floor(fullZoom); + var seamlessModeEnabled = pskl.UserSettings.get(pskl.UserSettings.SEAMLESS_MODE); + + var validSizes; + if (fullZoom < 1) { + this.disablePreviewSizeWidget_('No other option available'); + validSizes = ['full']; + } else if (fullZoom === 1) { + this.disablePreviewSizeWidget_('No other option available'); + validSizes = ['original']; + } else if (seamlessModeEnabled) { + this.disablePreviewSizeWidget_('Disabled in tile mode'); + validSizes = ['original']; + } else { + this.enablePreviewSizeWidget_(); + if (fullZoom === bestZoom) { + // If the full zoom is the same as the best zoom, display the best option only as + // it gives the exact factor information. + validSizes = ['original', 'best']; + } else if (bestZoom === 1) { + // If best zoom is 1x, remove it as it is redundant with the original option. + validSizes = ['full', 'original']; + } else { + validSizes = ['full', 'original', 'best']; + } + } + + // Update buttons content and status. + this.previewSizes.best.button.textContent = Math.floor(fullZoom) + 'x'; + for (var size in this.previewSizes) { + if (this.previewSizes.hasOwnProperty(size)) { + var previewSize = this.previewSizes[size]; + var isSizeEnabled = validSizes.indexOf(size) != -1; + + // classList.toggle is not available on IE11. + if (isSizeEnabled) { + previewSize.button.classList.remove('preview-contextual-action-hidden'); + } else { + previewSize.button.classList.add('preview-contextual-action-hidden'); + } + } + } + + // Update the selected preview size if the currently selected size is not valid. + var selectedSize = pskl.UserSettings.get(pskl.UserSettings.PREVIEW_SIZE); + if (validSizes.indexOf(selectedSize) === -1) { + this.onChangePreviewSize_(validSizes[0]); + } + }; + + ns.PreviewActionsController.prototype.enablePreviewSizeWidget_ = function () { + this.previewSizeDropdown.classList.remove('preview-drop-down-disabled'); + }; + + ns.PreviewActionsController.prototype.disablePreviewSizeWidget_ = function (reason) { + // The .preview-disable-overlay is displayed on top of the preview size widget + document.querySelector('.preview-disable-overlay').setAttribute('data-original-title', reason); + this.previewSizeDropdown.classList.add('preview-drop-down-disabled'); + }; + + ns.PreviewActionsController.prototype.onOpenPopupPreviewClick_ = function () { + this.previewController.openPopupPreview(); + }; + + ns.PreviewActionsController.prototype.onChangePreviewSize_ = function (size) { + var previewSize = this.previewSizes[size]; + var isEnabled = !previewSize.button.classList.contains('preview-contextual-action-hidden'); + if (isEnabled) { + pskl.UserSettings.set(pskl.UserSettings.PREVIEW_SIZE, size); + } + }; + + ns.PreviewActionsController.prototype.onUserSettingsChange_ = function (evt, name, value) { + if (name == pskl.UserSettings.ONION_SKIN) { + this.updateOnionSkinPreview_(); + } else if (name == pskl.UserSettings.MAX_FPS) { + this.updateMaxFPS_(); + } else if (name === pskl.UserSettings.SEAMLESS_MODE) { + this.updatePreviewSizeButtons_(); + } else if (name === pskl.UserSettings.GRID_ENABLED) { + this.updateToggleGridButton_(); + } else { + this.selectPreviewSizeButton_(); + } + }; + + ns.PreviewActionsController.prototype.updateOnionSkinPreview_ = function () { + var enabledClassname = 'preview-toggle-onion-skin-enabled'; + var isEnabled = pskl.UserSettings.get(pskl.UserSettings.ONION_SKIN); + + // classList.toggle is not available on IE11. + if (isEnabled) { + this.toggleOnionSkinButton.classList.add(enabledClassname); + } else { + this.toggleOnionSkinButton.classList.remove(enabledClassname); + } + }; + + ns.PreviewActionsController.prototype.selectPreviewSizeButton_ = function () { + var currentlySelected = document.querySelector('.size-button-selected'); + if (currentlySelected) { + currentlySelected.classList.remove('size-button-selected'); + } + + var selectedSize = pskl.UserSettings.get(pskl.UserSettings.PREVIEW_SIZE); + var previewSize = this.previewSizes[selectedSize]; + previewSize.button.classList.add('size-button-selected'); + }; + + ns.PreviewActionsController.prototype.updateMaxFPS_ = function () { + var maxFps = pskl.UserSettings.get(pskl.UserSettings.MAX_FPS); + this.fpsRangeInput.setAttribute('max', maxFps); + this.piskelController.setFPS(Math.min(maxFps, this.piskelController.getFPS())); + }; + + /** + * Event handler triggered on 'input' or 'change' events. + */ + ns.PreviewActionsController.prototype.onFpsRangeInputUpdate_ = function (evt) { + var fps = parseInt(this.fpsRangeInput.value, 10); + this.piskelController.setFPS(fps); + // blur only on 'change' events, as blurring on 'input' breaks on Firefox + if (evt.type === 'change') { + this.fpsRangeInput.blur(); + } + }; + + ns.PreviewActionsController.prototype.updateFPS_ = function () { + var fps = this.piskelController.getFPS(); + if (fps !== this.fpsRangeInput.value) { + // reset + this.fpsRangeInput.value = 0; + // set proper value + this.fpsRangeInput.value = fps; + this.fpsCounterDisplay.innerHTML = fps + ' FPS'; + } + }; + + ns.PreviewActionsController.prototype.toggleOnionSkin_ = function () { + var currentValue = pskl.UserSettings.get(pskl.UserSettings.ONION_SKIN); + pskl.UserSettings.set(pskl.UserSettings.ONION_SKIN, !currentValue); + }; +})(); diff --git a/src/js/controller/preview/PreviewController.js b/src/js/controller/preview/PreviewController.js index 1dafea90..8481fccd 100644 --- a/src/js/controller/preview/PreviewController.js +++ b/src/js/controller/preview/PreviewController.js @@ -11,219 +11,43 @@ this.elapsedTime = 0; this.currentIndex = 0; - - this.onionSkinShortcut = pskl.service.keyboard.Shortcuts.MISC.ONION_SKIN; - this.lastRenderTime = 0; this.renderFlag = true; - this.fpsRangeInput = document.querySelector('#preview-fps'); - this.fpsCounterDisplay = document.querySelector('#display-fps'); - this.openPopupPreview = document.querySelector('.open-popup-preview-button'); - this.toggleGridButton = document.querySelector('.toggle-grid-button'); - this.previewSizeDropdown = document.querySelector('.preview-drop-down'); - this.previewSizes = { - original: { - button: document.querySelector('.original-size-button'), - shortcut: pskl.service.keyboard.Shortcuts.MISC.X1_PREVIEW, - tooltip: 'Original size preview' - }, - best: { - button: document.querySelector('.best-size-button'), - shortcut: pskl.service.keyboard.Shortcuts.MISC.BEST_PREVIEW, - tooltip: 'Best size preview' - }, - full: { - button: document.querySelector('.full-size-button'), - shortcut: pskl.service.keyboard.Shortcuts.MISC.FULL_PREVIEW, - tooltip: 'Full size preview' - } - }; - this.toggleOnionSkinButton = document.querySelector('.preview-toggle-onion-skin'); - this.renderer = new pskl.rendering.frame.BackgroundImageFrameRenderer(this.container); this.popupPreviewController = new ns.PopupPreviewController(piskelController); + this.previewActionsController = new ns.PreviewActionsController(this, container); }; ns.PreviewController.prototype.init = function () { - this.fpsRangeInput.addEventListener('change', this.onFpsRangeInputUpdate_.bind(this)); - this.fpsRangeInput.addEventListener('input', this.onFpsRangeInputUpdate_.bind(this)); - var width = Constants.ANIMATED_PREVIEW_WIDTH + Constants.RIGHT_COLUMN_PADDING_LEFT; document.querySelector('.right-column').style.width = width + 'px'; - var addEvent = pskl.utils.Event.addEventListener; - addEvent(this.toggleOnionSkinButton, 'click', this.toggleOnionSkin_, this); - addEvent(this.openPopupPreview, 'click', this.onOpenPopupPreviewClick_, this); - addEvent(this.toggleGridButton, 'click', this.toggleGrid_, this); - - var registerShortcut = pskl.app.shortcutService.registerShortcut.bind(pskl.app.shortcutService); - registerShortcut(this.onionSkinShortcut, this.toggleOnionSkin_.bind(this)); - - var onionSkinTooltip = pskl.utils.TooltipFormatter.format('Toggle onion skin', this.onionSkinShortcut); - this.toggleOnionSkinButton.setAttribute('title', onionSkinTooltip); - - for (var size in this.previewSizes) { - if (this.previewSizes.hasOwnProperty(size)) { - var previewSize = this.previewSizes[size]; - addEvent(previewSize.button, 'click', this.onChangePreviewSize_, this, size); - registerShortcut(previewSize.shortcut, this.onChangePreviewSize_.bind(this, size)); - var tooltip = pskl.utils.TooltipFormatter.format(previewSize.tooltip, previewSize.shortcut); - previewSize.button.setAttribute('title', tooltip); - } - } - $.subscribe(Events.FRAME_SIZE_CHANGED, this.onFrameSizeChange_.bind(this)); $.subscribe(Events.USER_SETTINGS_CHANGED, this.onUserSettingsChange_.bind(this)); $.subscribe(Events.PISKEL_SAVE_STATE, this.setRenderFlag_.bind(this, true)); - $.subscribe(Events.FPS_CHANGED, this.updateFPS_.bind(this)); - // On PISKEL_RESET, set the render flag and update the FPS input $.subscribe(Events.PISKEL_RESET, this.setRenderFlag_.bind(this, true)); - $.subscribe(Events.PISKEL_RESET, this.updateFPS_.bind(this)); - this.updatePreviewSizeButtons_(); this.popupPreviewController.init(); + this.previewActionsController.init(); this.updateZoom_(); - this.updateOnionSkinPreview_(); - this.selectPreviewSizeButton_(); - this.updateFPS_(); - this.updateMaxFPS_(); this.updateContainerDimensions_(); - this.updateToggleGridButton_(); }; - ns.PreviewController.prototype.updateToggleGridButton_ = function () { - var gridEnabled = pskl.UserSettings.get(pskl.UserSettings.GRID_ENABLED); - this.toggleGridButton.classList.toggle('icon-minimap-grid-white', !gridEnabled); - this.toggleGridButton.classList.toggle('icon-minimap-grid-gold', gridEnabled); - this.toggleGridButton.classList.toggle('preview-contextual-action-enabled', gridEnabled); - }; - - ns.PreviewController.prototype.toggleGrid_ = function () { - var gridEnabled = pskl.UserSettings.get(pskl.UserSettings.GRID_ENABLED); - pskl.UserSettings.set(pskl.UserSettings.GRID_ENABLED, !gridEnabled); - }; - - ns.PreviewController.prototype.updatePreviewSizeButtons_ = function () { - var fullZoom = this.calculateZoom_(); - var bestZoom = Math.floor(fullZoom); - var seamlessModeEnabled = pskl.UserSettings.get(pskl.UserSettings.SEAMLESS_MODE); - - var validSizes; - if (fullZoom < 1) { - this.disablePreviewSizeWidget_('No other option available'); - validSizes = ['full']; - } else if (fullZoom === 1) { - this.disablePreviewSizeWidget_('No other option available'); - validSizes = ['original']; - } else if (seamlessModeEnabled) { - this.disablePreviewSizeWidget_('Disabled in tile mode'); - validSizes = ['original']; - } else { - this.enablePreviewSizeWidget_(); - if (fullZoom === bestZoom) { - // If the full zoom is the same as the best zoom, display the best option only as - // it gives the exact factor information. - validSizes = ['original', 'best']; - } else if (bestZoom === 1) { - // If best zoom is 1x, remove it as it is redundant with the original option. - validSizes = ['full', 'original']; - } else { - validSizes = ['full', 'original', 'best']; - } - } - - // Update buttons content and status. - this.previewSizes.best.button.textContent = Math.floor(fullZoom) + 'x'; - for (var size in this.previewSizes) { - if (this.previewSizes.hasOwnProperty(size)) { - var previewSize = this.previewSizes[size]; - var isSizeEnabled = validSizes.indexOf(size) != -1; - - // classList.toggle is not available on IE11. - if (isSizeEnabled) { - previewSize.button.classList.remove('preview-contextual-action-hidden'); - } else { - previewSize.button.classList.add('preview-contextual-action-hidden'); - } - } - } - - // Update the selected preview size if the currently selected size is not valid. - var selectedSize = pskl.UserSettings.get(pskl.UserSettings.PREVIEW_SIZE); - if (validSizes.indexOf(selectedSize) === -1) { - this.onChangePreviewSize_(validSizes[0]); - } - }; - - ns.PreviewController.prototype.enablePreviewSizeWidget_ = function () { - this.previewSizeDropdown.classList.remove('preview-drop-down-disabled'); - }; - - ns.PreviewController.prototype.disablePreviewSizeWidget_ = function (reason) { - // The .preview-disable-overlay is displayed on top of the preview size widget - document.querySelector('.preview-disable-overlay').setAttribute('data-original-title', reason); - this.previewSizeDropdown.classList.add('preview-drop-down-disabled'); - }; - - ns.PreviewController.prototype.onOpenPopupPreviewClick_ = function () { + ns.PreviewController.prototype.openPopupPreview = function () { this.popupPreviewController.open(); }; - ns.PreviewController.prototype.onChangePreviewSize_ = function (size) { - var previewSize = this.previewSizes[size]; - var isEnabled = !previewSize.button.classList.contains('preview-contextual-action-hidden'); - if (isEnabled) { - pskl.UserSettings.set(pskl.UserSettings.PREVIEW_SIZE, size); - } - }; - ns.PreviewController.prototype.onUserSettingsChange_ = function (evt, name, value) { - if (name == pskl.UserSettings.ONION_SKIN) { - this.updateOnionSkinPreview_(); - } else if (name == pskl.UserSettings.MAX_FPS) { - this.updateMaxFPS_(); - } else if (name === pskl.UserSettings.SEAMLESS_MODE) { + if (name === pskl.UserSettings.SEAMLESS_MODE) { this.onFrameSizeChange_(); - } else if (name === pskl.UserSettings.GRID_ENABLED) { - this.updateToggleGridButton_(); } else { this.updateZoom_(); - this.selectPreviewSizeButton_(); this.updateContainerDimensions_(); } }; - ns.PreviewController.prototype.updateOnionSkinPreview_ = function () { - var enabledClassname = 'preview-toggle-onion-skin-enabled'; - var isEnabled = pskl.UserSettings.get(pskl.UserSettings.ONION_SKIN); - - // classList.toggle is not available on IE11. - if (isEnabled) { - this.toggleOnionSkinButton.classList.add(enabledClassname); - } else { - this.toggleOnionSkinButton.classList.remove(enabledClassname); - } - }; - - ns.PreviewController.prototype.selectPreviewSizeButton_ = function () { - var currentlySelected = document.querySelector('.size-button-selected'); - if (currentlySelected) { - currentlySelected.classList.remove('size-button-selected'); - } - - var selectedSize = pskl.UserSettings.get(pskl.UserSettings.PREVIEW_SIZE); - var previewSize = this.previewSizes[selectedSize]; - previewSize.button.classList.add('size-button-selected'); - }; - - ns.PreviewController.prototype.updateMaxFPS_ = function () { - var maxFps = pskl.UserSettings.get(pskl.UserSettings.MAX_FPS); - this.fpsRangeInput.setAttribute('max', maxFps); - this.piskelController.setFPS(Math.min(maxFps, this.piskelController.getFPS())); - }; - ns.PreviewController.prototype.updateZoom_ = function () { var previewSize = pskl.UserSettings.get(pskl.UserSettings.PREVIEW_SIZE); @@ -255,30 +79,6 @@ }; }; - /** - * Event handler triggered on 'input' or 'change' events. - */ - ns.PreviewController.prototype.onFpsRangeInputUpdate_ = function (evt) { - var fps = parseInt(this.fpsRangeInput.value, 10); - this.piskelController.setFPS(fps); - // blur only on 'change' events, as blurring on 'input' breaks on Firefox - if (evt.type === 'change') { - this.fpsRangeInput.blur(); - } - }; - - ns.PreviewController.prototype.updateFPS_ = function () { - var fps = this.piskelController.getFPS(); - if (fps !== this.fps) { - this.fps = fps; - // reset - this.fpsRangeInput.value = 0; - // set proper value - this.fpsRangeInput.value = this.fps; - this.fpsCounterDisplay.innerHTML = this.fps + ' FPS'; - } - }; - ns.PreviewController.prototype.render = function (delta) { this.elapsedTime += delta; var index = this.getNextIndex_(delta); @@ -294,10 +94,11 @@ }; ns.PreviewController.prototype.getNextIndex_ = function (delta) { - if (this.fps === 0) { + var fps = this.piskelController.getFPS(); + if (fps === 0) { return this.piskelController.getCurrentFrameIndex(); } else { - var index = Math.floor(this.elapsedTime / (1000 / this.fps)); + var index = Math.floor(this.elapsedTime / (1000 / fps)); var frameIndexes = this.piskelController.getVisibleFrameIndexes(); if (frameIndexes.length <= index) { this.elapsedTime = 0; @@ -322,7 +123,6 @@ ns.PreviewController.prototype.onFrameSizeChange_ = function () { this.updateZoom_(); this.updateContainerDimensions_(); - this.updatePreviewSizeButtons_(); }; ns.PreviewController.prototype.updateContainerDimensions_ = function () { @@ -363,9 +163,4 @@ return (this.renderFlag || this.popupPreviewController.renderFlag) && (Date.now() - this.lastRenderTime > RENDER_MINIMUM_DELAY); }; - - ns.PreviewController.prototype.toggleOnionSkin_ = function () { - var currentValue = pskl.UserSettings.get(pskl.UserSettings.ONION_SKIN); - pskl.UserSettings.set(pskl.UserSettings.ONION_SKIN, !currentValue); - }; })(); diff --git a/src/piskel-script-list.js b/src/piskel-script-list.js index 8c286b35..11352a03 100644 --- a/src/piskel-script-list.js +++ b/src/piskel-script-list.js @@ -113,6 +113,7 @@ "js/controller/HeaderController.js", "js/controller/LayersListController.js", "js/controller/preview/PopupPreviewController.js", + "js/controller/preview/PreviewActionsController.js", "js/controller/preview/PreviewController.js", "js/controller/MinimapController.js", "js/controller/ToolController.js",