mirror of
https://github.com/google/blockly.git
synced 2026-01-07 17:10:11 +01:00
037eb59b89
* chore: add linting for tsdoc * chore: don't require types on return * chore: remove redundant fileoverview from ts * chore: change return to returns and add some newlines * chore: remove license tag * chore: don't require params/return docs * chore: remove spurious struct tags * Revert "chore: change return to returns and add some newlines" This reverts commitd6d8656a45. * chore: don't auto-add param names * chore: disable require-param bc it breaks on this * return to returns and add line breaks * chore: configure additional jsdoc rules * chore: run format * Revert "chore: remove license tag" This reverts commit173455588a. * chore: allow license tag format * chore: only require jsdoc on exported items * chore: add missing jsdoc or silence where needed * chore: run format * chore: lint fixes
107 lines
3.1 KiB
TypeScript
107 lines
3.1 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright 2017 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
/**
|
|
* Methods for dragging a workspace visually.
|
|
*
|
|
* @class
|
|
*/
|
|
import * as goog from '../closure/goog/goog.js';
|
|
goog.declareModuleId('Blockly.WorkspaceDragger');
|
|
|
|
import * as common from './common.js';
|
|
import {Coordinate} from './utils/coordinate.js';
|
|
import type {WorkspaceSvg} from './workspace_svg.js';
|
|
|
|
|
|
/**
|
|
* 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
|
|
*/
|
|
export class WorkspaceDragger {
|
|
private readonly horizontalScrollEnabled_: boolean;
|
|
private readonly verticalScrollEnabled_: boolean;
|
|
protected startScrollXY_: Coordinate;
|
|
|
|
/** @param workspace The workspace to drag. */
|
|
constructor(private workspace: WorkspaceSvg) {
|
|
/** Whether horizontal scroll is enabled. */
|
|
this.horizontalScrollEnabled_ = this.workspace.isMovableHorizontally();
|
|
|
|
/** Whether vertical scroll is enabled. */
|
|
this.verticalScrollEnabled_ = this.workspace.isMovableVertically();
|
|
|
|
/**
|
|
* The scroll position of the workspace at the beginning of the drag.
|
|
* Coordinate system: pixel coordinates.
|
|
*/
|
|
this.startScrollXY_ = new Coordinate(workspace.scrollX, workspace.scrollY);
|
|
}
|
|
|
|
/**
|
|
* Sever all links from this object.
|
|
*
|
|
* @suppress {checkTypes}
|
|
* @internal
|
|
*/
|
|
dispose() {
|
|
// AnyDuringMigration because: Type 'null' is not assignable to type
|
|
// 'WorkspaceSvg'.
|
|
this.workspace = null as AnyDuringMigration;
|
|
}
|
|
|
|
/**
|
|
* Start dragging the workspace.
|
|
*
|
|
* @internal
|
|
*/
|
|
startDrag() {
|
|
if (common.getSelected()) {
|
|
common.getSelected()!.unselect();
|
|
}
|
|
this.workspace.setupDragSurface();
|
|
}
|
|
|
|
/**
|
|
* Finish dragging the workspace and put everything back where it belongs.
|
|
*
|
|
* @param currentDragDeltaXY How far the pointer has moved from the position
|
|
* at the start of the drag, in pixel coordinates.
|
|
* @internal
|
|
*/
|
|
endDrag(currentDragDeltaXY: Coordinate) {
|
|
// Make sure everything is up to date.
|
|
this.drag(currentDragDeltaXY);
|
|
this.workspace.resetDragSurface();
|
|
}
|
|
|
|
/**
|
|
* Move the workspace based on the most recent mouse movements.
|
|
*
|
|
* @param currentDragDeltaXY How far the pointer has moved from the position
|
|
* at the start of the drag, in pixel coordinates.
|
|
* @internal
|
|
*/
|
|
drag(currentDragDeltaXY: Coordinate) {
|
|
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.');
|
|
}
|
|
}
|
|
}
|