Files
blockly/core/workspace_dragger.ts
Maribeth Bottorff 88ff901a72 chore: use prettier instead of clang-format (#7014)
* chore: add and configure prettier

* chore: remove clang-format

* chore: remove clang-format config

* chore: lint additional ts files

* chore: fix lint errors in blocks

* chore: add prettier-ignore where needed

* chore: ignore js blocks when formatting

* chore: fix playground html syntax

* chore: fix yaml spacing from merge

* chore: convert text blocks to use arrow functions

* chore: format everything with prettier

* chore: fix lint unused imports in blocks
2023-05-10 16:01:39 -07:00

104 lines
3.0 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.
*/
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.');
}
}
}