Files
blockly/core/workspace_dragger.js
Rachel Fenichel df2eafb8dd refactor: move properties into constructors and convert to classes (#5822)
* refactor: move properties to constructor in block_drag_surface.js

* refactor: move properties to constructor in block_svg.js

* refactor: move properties to constructor in block.js

* refactor: move properties to constructor in bubble.js

* refactor: move properties to constructor in connection.js

* refactor: move properties to constructor in flyout_base.js

* refactor: move properties to constructor in flyout_button.js

* refactor: move properties to constructor in generator.js

* refactor: move properties to constructor in grid.js

* refactor: move properties to constructor in input.js

* refactor: move properties to constructor in mutator.js

* refactor: move properties to constructor in scrollbar.js

* refactor: move properties to constructor in trashcan.js

* refactor: move properties to constructor in warning.js

* refactor: move properties to constructor in workspace_audio.js

* refactor: move properties to constructor in workspace_drag_surface_svg.js

* refactor: move properties to constructor in workspace_svg.js

* refactor: move properties to constructor in workspace.js

* refactor: move properties to constructor in zoom_controls.js

* chore: rebuild

* refactor: convert zoom_controls.js to es6 class and format

* refactor: convert workspace_audio.js to es6 class and format

* refactor: convert workspace_dragger.js to es6 class and format

* refactor: convert workspace_drag_surface_svg.js to es6 class and format

* refactor: convert variable_model.js to es6 class and format

* refactor: convert variable_map.js to es6 class and format

* refactor: convert theme.js to es6 class and format

* chore: remove bad comment
2022-01-06 13:13:40 -08:00

116 lines
3.1 KiB
JavaScript

/**
* @license
* Copyright 2017 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
/**
* @fileoverview Methods for dragging a workspace visually.
*/
'use strict';
/**
* Methods for dragging a workspace visually.
* @class
*/
goog.module('Blockly.WorkspaceDragger');
const common = goog.require('Blockly.common');
const {Coordinate} = goog.require('Blockly.utils.Coordinate');
/* eslint-disable-next-line no-unused-vars */
const {WorkspaceSvg} = goog.requireType('Blockly.WorkspaceSvg');
/**
* Class for a workspace dragger. It moves the workspace around when it is
* being dragged by a mouse or touch.
* Note that the workspace itself manages whether or not it has a drag surface
* and how to do translations based on that. This simply passes the right
* commands based on events.
* @alias Blockly.WorkspaceDragger
*/
class WorkspaceDragger {
/**
* @param {!WorkspaceSvg} workspace The workspace to drag.
*/
constructor(workspace) {
/**
* @type {!WorkspaceSvg}
* @private
*/
this.workspace_ = workspace;
/**
* Whether horizontal scroll is enabled.
* @type {boolean}
* @private
*/
this.horizontalScrollEnabled_ = this.workspace_.isMovableHorizontally();
/**
* Whether vertical scroll is enabled.
* @type {boolean}
* @private
*/
this.verticalScrollEnabled_ = this.workspace_.isMovableVertically();
/**
* The scroll position of the workspace at the beginning of the drag.
* Coordinate system: pixel coordinates.
* @type {!Coordinate}
* @protected
*/
this.startScrollXY_ = new Coordinate(workspace.scrollX, workspace.scrollY);
}
/**
* Sever all links from this object.
* @package
* @suppress {checkTypes}
*/
dispose() {
this.workspace_ = null;
}
/**
* Start dragging the workspace.
* @package
*/
startDrag() {
if (common.getSelected()) {
common.getSelected().unselect();
}
this.workspace_.setupDragSurface();
}
/**
* Finish dragging the workspace and put everything back where it belongs.
* @param {!Coordinate} currentDragDeltaXY How far the pointer has
* moved from the position at the start of the drag, in pixel coordinates.
* @package
*/
endDrag(currentDragDeltaXY) {
// Make sure everything is up to date.
this.drag(currentDragDeltaXY);
this.workspace_.resetDragSurface();
}
/**
* Move the workspace based on the most recent mouse movements.
* @param {!Coordinate} currentDragDeltaXY How far the pointer has
* moved from the position at the start of the drag, in pixel coordinates.
* @package
*/
drag(currentDragDeltaXY) {
const newXY = Coordinate.sum(this.startScrollXY_, currentDragDeltaXY);
if (this.horizontalScrollEnabled_ && this.verticalScrollEnabled_) {
this.workspace_.scroll(newXY.x, newXY.y);
} else if (this.horizontalScrollEnabled_) {
this.workspace_.scroll(newXY.x, this.workspace_.scrollY);
} else if (this.verticalScrollEnabled_) {
this.workspace_.scroll(this.workspace_.scrollX, newXY.y);
} else {
throw new TypeError('Invalid state.');
}
}
}
exports.WorkspaceDragger = WorkspaceDragger;