js-draw 1.0.0 → 1.0.1

package/src/tools/SelectionTool/SelectionTool.ts

@@ -0,0 +1,510 @@
+import AbstractComponent from '../../components/AbstractComponent';
+import Editor from '../../Editor';
+import { Mat33, Rect2, Point2, Vec2 } from '@js-draw/math';
+import { EditorEventType } from '../../types';
+import { CopyEvent, KeyPressEvent, KeyUpEvent, PointerEvt } from '../../inputEvents';
+import Viewport from '../../Viewport';
+import BaseTool from '../BaseTool';
+import SVGRenderer from '../../rendering/renderers/SVGRenderer';
+import Selection from './Selection';
+import TextComponent from '../../components/TextComponent';
+import { duplicateSelectionShortcut, selectAllKeyboardShortcut, snapToGridKeyboardShortcutId } from '../keybindings';
+
+export const cssPrefix = 'selection-tool-';
+
+// Allows users to select/transform portions of the `EditorImage`.
+// With respect to `extend`ing, `SelectionTool` is not stable.
+export default class SelectionTool extends BaseTool {
+	private handleOverlay: HTMLElement;
+	private prevSelectionBox: Selection | null;
+	private selectionBox: Selection | null;
+
+	private startPoint: Vec2 | null = null; // canvas position
+	private expandingSelectionBox: boolean = false;
+	private shiftKeyPressed: boolean = false;
+	private snapToGrid: boolean = false;
+
+	public constructor(private editor: Editor, description: string) {
+		super(editor.notifier, description);
+
+		this.handleOverlay = document.createElement('div');
+		editor.createHTMLOverlay(this.handleOverlay);
+
+		this.handleOverlay.style.display = 'none';
+		this.handleOverlay.classList.add('handleOverlay');
+
+		editor.notifier.on(EditorEventType.ViewportChanged, _data => {
+			// The selection box could be using the wet ink display if its transformation
+			// hasn't been finalized yet. Clear before updating the UI.
+			this.editor.clearWetInk();
+
+			this.selectionBox?.updateUI();
+		});
+
+		this.editor.handleKeyEventsFrom(this.handleOverlay);
+		this.editor.handlePointerEventsFrom(this.handleOverlay);
+	}
+
+	private makeSelectionBox(selectionStartPos: Point2) {
+		this.prevSelectionBox = this.selectionBox;
+		this.selectionBox = new Selection(
+			selectionStartPos, this.editor
+		);
+
+		if (!this.expandingSelectionBox) {
+			// Remove any previous selection rects
+			this.prevSelectionBox?.cancelSelection();
+		}
+		this.selectionBox.addTo(this.handleOverlay);
+	}
+
+	private snapSelectionToGrid() {
+		if (!this.selectionBox) throw new Error('No selection to snap!');
+
+		// Snap the top left corner of what we have selected.
+		const topLeftOfBBox = this.selectionBox.computeTightBoundingBox().topLeft;
+		const snappedTopLeft = this.editor.viewport.snapToGrid(topLeftOfBBox);
+		const snapDelta = snappedTopLeft.minus(topLeftOfBBox);
+
+		const oldTransform = this.selectionBox.getTransform();
+		this.selectionBox.setTransform(oldTransform.rightMul(Mat33.translation(snapDelta)));
+		this.selectionBox.finalizeTransform();
+	}
+
+	private selectionBoxHandlingEvt: boolean = false;
+	public override onPointerDown({ allPointers, current }: PointerEvt): boolean {
+		const snapToGrid = this.snapToGrid;
+		if (snapToGrid) {
+			current = current.snappedToGrid(this.editor.viewport);
+		}
+
+		if (allPointers.length === 1 && current.isPrimary) {
+			this.startPoint = current.canvasPos;
+
+			let transforming = false;
+
+			if (this.selectionBox) {
+				if (snapToGrid) {
+					this.snapSelectionToGrid();
+				}
+
+				const dragStartResult = this.selectionBox.onDragStart(current);
+
+				if (dragStartResult) {
+					transforming = true;
+
+					this.selectionBoxHandlingEvt = true;
+					this.expandingSelectionBox = false;
+				}
+			}
+
+			if (!transforming) {
+				// Shift key: Combine the new and old selection boxes at the end of the gesture.
+				this.expandingSelectionBox = this.shiftKeyPressed;
+				this.makeSelectionBox(current.canvasPos);
+			}
+
+			return true;
+		}
+		return false;
+	}
+
+	public override onPointerMove(event: PointerEvt): void {
+		if (!this.selectionBox) return;
+
+		let currentPointer = event.current;
+		if (!this.expandingSelectionBox && this.shiftKeyPressed && this.startPoint) {
+			const screenPos = this.editor.viewport.canvasToScreen(this.startPoint);
+			currentPointer = currentPointer.lockedToXYAxesScreen(screenPos, this.editor.viewport);
+		}
+
+		if (this.snapToGrid) {
+			currentPointer = currentPointer.snappedToGrid(this.editor.viewport);
+		}
+
+		if (this.selectionBoxHandlingEvt) {
+			this.selectionBox.onDragUpdate(currentPointer);
+		} else {
+			this.selectionBox!.setToPoint(currentPointer.canvasPos);
+		}
+	}
+
+	// Called after a gestureCancel and a pointerUp
+	private onGestureEnd() {
+		if (!this.selectionBox) return;
+
+		if (!this.selectionBoxHandlingEvt) {
+			// Expand/shrink the selection rectangle, if applicable
+			this.selectionBox.resolveToObjects();
+			this.onSelectionUpdated();
+		} else {
+			this.selectionBox.onDragEnd();
+		}
+
+
+		this.selectionBoxHandlingEvt = false;
+	}
+
+	public override onPointerUp(event: PointerEvt): void {
+		if (!this.selectionBox) return;
+
+		let currentPointer = event.current;
+		if (this.snapToGrid) {
+			currentPointer = currentPointer.snappedToGrid(this.editor.viewport);
+		}
+
+		this.selectionBox.setToPoint(currentPointer.canvasPos);
+
+		// Were we expanding the previous selection?
+		if (this.expandingSelectionBox && this.prevSelectionBox) {
+			// If so, finish expanding.
+			this.expandingSelectionBox = false;
+			this.selectionBox.resolveToObjects();
+			this.setSelection([
+				...this.selectionBox.getSelectedObjects(),
+				...this.prevSelectionBox.getSelectedObjects(),
+			]);
+		} else {
+			this.onGestureEnd();
+		}
+	}
+
+	public override onGestureCancel(): void {
+		if (this.selectionBoxHandlingEvt) {
+			this.selectionBox?.onDragCancel();
+		} else {
+			// Revert to the previous selection, if any.
+			this.selectionBox?.cancelSelection();
+			this.selectionBox = this.prevSelectionBox;
+			this.selectionBox?.addTo(this.handleOverlay);
+			this.selectionBox?.recomputeRegion();
+			this.prevSelectionBox = null;
+		}
+
+		this.expandingSelectionBox = false;
+	}
+
+	private lastSelectedObjects: AbstractComponent[] = [];
+
+	private onSelectionUpdated() {
+		const selectedItemCount = this.selectionBox?.getSelectedItemCount() ?? 0;
+		const selectedObjects = this.selectionBox?.getSelectedObjects() ?? [];
+		const hasDifferentSelection =
+			this.lastSelectedObjects.length !== selectedItemCount
+			|| selectedObjects.some((obj, i) => this.lastSelectedObjects[i] !== obj);
+
+		if (hasDifferentSelection) {
+			this.lastSelectedObjects = selectedObjects;
+
+			// Note that the selection has changed
+			this.editor.notifier.dispatch(EditorEventType.ToolUpdated, {
+				kind: EditorEventType.ToolUpdated,
+				tool: this,
+			});
+
+			// Only fire the SelectionUpdated event if the selection really updated.
+			this.editor.notifier.dispatch(EditorEventType.SelectionUpdated, {
+				kind: EditorEventType.SelectionUpdated,
+				selectedComponents: selectedObjects,
+				tool: this,
+			});
+
+			if (selectedItemCount > 0) {
+				this.editor.announceForAccessibility(
+					this.editor.localization.selectedElements(selectedItemCount)
+				);
+				this.zoomToSelection();
+			}
+		}
+
+		if (selectedItemCount === 0 && this.selectionBox) {
+			this.selectionBox.cancelSelection();
+			this.prevSelectionBox = this.selectionBox;
+			this.selectionBox = null;
+		}
+	}
+
+	private zoomToSelection() {
+		if (this.selectionBox) {
+			const selectionRect = this.selectionBox.region;
+			this.editor.dispatchNoAnnounce(this.editor.viewport.zoomTo(selectionRect, false), false);
+		}
+	}
+
+	private static handleableKeys = [
+		'a', 'h', 'ArrowLeft',
+		'd', 'l', 'ArrowRight',
+		'q', 'k', 'ArrowUp',
+		'e', 'j', 'ArrowDown',
+		'r', 'R',
+		'i', 'I', 'o', 'O',
+		'Control', 'Meta',
+	];
+	public override onKeyPress(event: KeyPressEvent): boolean {
+		const shortcucts = this.editor.shortcuts;
+
+		if (shortcucts.matchesShortcut(snapToGridKeyboardShortcutId, event)) {
+			this.snapToGrid = true;
+			return true;
+		}
+
+		if (this.selectionBox && shortcucts.matchesShortcut(duplicateSelectionShortcut, event)) {
+			// Handle duplication on key up — we don't want to accidentally duplicate
+			// many times.
+			return true;
+		}
+		else if (shortcucts.matchesShortcut(selectAllKeyboardShortcut, event)) {
+			this.setSelection(this.editor.image.getAllElements());
+			return true;
+		}
+		else if (event.ctrlKey) {
+			// Don't transform the selection with, for example, ctrl+i.
+			// Pass it to another tool, if apliccable.
+			return false;
+		}
+		else if (event.key === 'Shift') {
+			this.shiftKeyPressed = true;
+			return true;
+		}
+
+		let rotationSteps = 0;
+		let xTranslateSteps = 0;
+		let yTranslateSteps = 0;
+		let xScaleSteps = 0;
+		let yScaleSteps = 0;
+
+		switch (event.key) {
+		case 'a':
+		case 'h':
+		case 'ArrowLeft':
+			xTranslateSteps -= 1;
+			break;
+		case 'd':
+		case 'l':
+		case 'ArrowRight':
+			xTranslateSteps += 1;
+			break;
+		case 'q':
+		case 'k':
+		case 'ArrowUp':
+			yTranslateSteps -= 1;
+			break;
+		case 'e':
+		case 'j':
+		case 'ArrowDown':
+			yTranslateSteps += 1;
+			break;
+		case 'r':
+			rotationSteps += 1;
+			break;
+		case 'R':
+			rotationSteps -= 1;
+			break;
+		case 'i':
+			xScaleSteps -= 1;
+			break;
+		case 'I':
+			xScaleSteps += 1;
+			break;
+		case 'o':
+			yScaleSteps -= 1;
+			break;
+		case 'O':
+			yScaleSteps += 1;
+			break;
+		}
+
+		let handled = xTranslateSteps !== 0
+			|| yTranslateSteps !== 0
+			|| rotationSteps !== 0
+			|| xScaleSteps !== 0
+			|| yScaleSteps !== 0;
+
+		if (!this.selectionBox) {
+			handled = false;
+		} else if (handled) {
+			const translateStepSize = 10 * this.editor.viewport.getSizeOfPixelOnCanvas();
+			const rotateStepSize = Math.PI / 8;
+			const scaleStepSize = 5 / 4;
+
+			const region = this.selectionBox.region;
+			const scaleFactor = Vec2.of(scaleStepSize ** xScaleSteps, scaleStepSize ** yScaleSteps);
+
+			const rotationMat = Mat33.zRotation(
+				rotationSteps * rotateStepSize
+			);
+			const roundedRotationMatrix = rotationMat.mapEntries(component => Viewport.roundScaleRatio(component));
+			const regionCenter = this.editor.viewport.roundPoint(region.center);
+
+			const transform = Mat33.scaling2D(
+				scaleFactor,
+				this.editor.viewport.roundPoint(region.topLeft)
+			).rightMul(
+				Mat33.translation(regionCenter).rightMul(
+					roundedRotationMatrix
+				).rightMul(
+					Mat33.translation(regionCenter.times(-1))
+				)
+			).rightMul(Mat33.translation(
+				this.editor.viewport.roundPoint(Vec2.of(xTranslateSteps, yTranslateSteps).times(translateStepSize))
+			));
+			const oldTransform = this.selectionBox.getTransform();
+			this.selectionBox.setTransform(oldTransform.rightMul(transform));
+		}
+
+		if (this.selectionBox && !handled && (event.key === 'Delete' || event.key === 'Backspace')) {
+			this.editor.dispatch(this.selectionBox.deleteSelectedObjects());
+			this.clearSelection();
+			handled = true;
+		}
+
+		return handled;
+	}
+
+	public override onKeyUp(evt: KeyUpEvent) {
+		const shortcucts = this.editor.shortcuts;
+		if (shortcucts.matchesShortcut(snapToGridKeyboardShortcutId, evt)) {
+			this.snapToGrid = false;
+			return true;
+		}
+
+		if (shortcucts.matchesShortcut(selectAllKeyboardShortcut, evt)) {
+			// Selected all in onKeyDown. Don't finalizeTransform.
+			return true;
+		}
+
+		if (this.selectionBox && shortcucts.matchesShortcut(duplicateSelectionShortcut, evt)) {
+			// Finalize duplicating the selection
+			this.selectionBox.duplicateSelectedObjects().then(command => {
+				this.editor.dispatch(command);
+			});
+			return true;
+		}
+
+		if (evt.key === 'Shift') {
+			this.shiftKeyPressed = false;
+			return true;
+		}
+
+		if (this.selectionBox && SelectionTool.handleableKeys.some(key => key === evt.key)) {
+			this.selectionBox.finalizeTransform();
+			return true;
+		}
+		return false;
+	}
+
+	public override onCopy(event: CopyEvent): boolean {
+		if (!this.selectionBox) {
+			return false;
+		}
+
+		const selectedElems = this.selectionBox.getSelectedObjects();
+		const bbox = this.selectionBox.region;
+		if (selectedElems.length === 0) {
+			return false;
+		}
+
+		const exportViewport = new Viewport(() => { });
+		exportViewport.updateScreenSize(Vec2.of(bbox.w, bbox.h));
+		exportViewport.resetTransform(Mat33.translation(bbox.topLeft.times(-1)));
+
+		const sanitize = true;
+		const { element: svgExportElem, renderer: svgRenderer } = SVGRenderer.fromViewport(exportViewport, sanitize);
+
+		const text: string[] = [];
+		for (const elem of selectedElems) {
+			elem.render(svgRenderer);
+
+			if (elem instanceof TextComponent) {
+				text.push(elem.getText());
+			}
+		}
+
+		event.setData('image/svg+xml', svgExportElem.outerHTML);
+		event.setData('text/html', svgExportElem.outerHTML);
+		if (text.length > 0) {
+			event.setData('text/plain', text.join('\n'));
+		}
+		return true;
+	}
+
+	public override setEnabled(enabled: boolean) {
+		super.setEnabled(enabled);
+
+		// Clear the selection
+		this.selectionBox?.cancelSelection();
+		this.onSelectionUpdated();
+
+		this.handleOverlay.replaceChildren();
+		this.selectionBox = null;
+
+		this.shiftKeyPressed = false;
+		this.snapToGrid = false;
+
+		this.handleOverlay.style.display = enabled ? 'block' : 'none';
+
+		if (enabled) {
+			this.handleOverlay.tabIndex = 0;
+			this.handleOverlay.setAttribute('aria-label', this.editor.localization.selectionToolKeyboardShortcuts);
+		} else {
+			this.handleOverlay.tabIndex = -1;
+		}
+	}
+
+	// Get the object responsible for displaying this' selection.
+	// @internal
+	public getSelection(): Selection | null {
+		return this.selectionBox;
+	}
+
+	public getSelectedObjects(): AbstractComponent[] {
+		return this.selectionBox?.getSelectedObjects() ?? [];
+	}
+
+	// Select the given `objects`. Any non-selectable objects in `objects` are ignored.
+	public setSelection(objects: AbstractComponent[]) {
+		// Only select selectable objects.
+		objects = objects.filter(obj => obj.isSelectable());
+
+		// Sort by z-index
+		objects.sort((a, b) => a.getZIndex() - b.getZIndex());
+
+		// Remove duplicates
+		objects = objects.filter((current, idx) => {
+			if (idx > 0) {
+				return current !== objects[idx - 1];
+			}
+
+			return true;
+		});
+
+		let bbox: Rect2 | null = null;
+		for (const object of objects) {
+			if (bbox) {
+				bbox = bbox.union(object.getBBox());
+			} else {
+				bbox = object.getBBox();
+			}
+		}
+
+		if (!bbox) {
+			return;
+		}
+
+		this.clearSelection();
+		if (!this.selectionBox) {
+			this.makeSelectionBox(bbox.topLeft);
+		}
+
+		this.selectionBox!.setSelectedObjects(objects, bbox);
+		this.onSelectionUpdated();
+	}
+
+	public clearSelection() {
+		this.handleOverlay.replaceChildren();
+		this.prevSelectionBox = this.selectionBox;
+		this.selectionBox = null;
+
+		this.onSelectionUpdated();
+	}
+}

package/src/tools/SelectionTool/TransformMode.ts

@@ -0,0 +1,112 @@
+import Editor from '../../Editor';
+import { Vec3, Mat33, Vec2, Point2 } from '@js-draw/math';
+import Viewport from '../../Viewport';
+import Selection from './Selection';
+import { ResizeMode } from './types';
+
+export class DragTransformer {
+	private dragStartPoint: Point2;
+	public constructor(private readonly editor: Editor, private selection: Selection) { }
+
+	public onDragStart(startPoint: Vec3) {
+		this.selection.setTransform(Mat33.identity);
+		this.dragStartPoint = startPoint;
+	}
+	public onDragUpdate(canvasPos: Vec3) {
+		const delta = this.editor.viewport.roundPoint(canvasPos.minus(this.dragStartPoint));
+		this.selection.setTransform(Mat33.translation(
+			delta
+		));
+	}
+	public onDragEnd() {
+		this.selection.finalizeTransform();
+	}
+}
+
+export class ResizeTransformer {
+	private mode: ResizeMode = ResizeMode.Both;
+	private dragStartPoint: Point2;
+	public constructor(private readonly editor: Editor, private selection: Selection) { }
+
+	public onDragStart(startPoint: Vec3, mode: ResizeMode) {
+		this.selection.setTransform(Mat33.identity);
+		this.mode = mode;
+		this.dragStartPoint = startPoint;
+	}
+	public onDragUpdate(canvasPos: Vec3) {
+		const canvasDelta = canvasPos.minus(this.dragStartPoint);
+
+		const origWidth = this.selection.preTransformRegion.width;
+		const origHeight = this.selection.preTransformRegion.height;
+
+		let scale = Vec2.of(1, 1);
+		if (this.mode === ResizeMode.HorizontalOnly) {
+			const newWidth = origWidth + canvasDelta.x;
+			scale = Vec2.of(newWidth / origWidth, scale.y);
+		}
+
+		if (this.mode === ResizeMode.VerticalOnly) {
+			const newHeight = origHeight + canvasDelta.y;
+			scale = Vec2.of(scale.x, newHeight / origHeight);
+		}
+
+		if (this.mode === ResizeMode.Both) {
+			const delta = Math.abs(canvasDelta.x) > Math.abs(canvasDelta.y) ? canvasDelta.x : canvasDelta.y;
+			const newWidth = origWidth + delta;
+			scale = Vec2.of(newWidth / origWidth, newWidth / origWidth);
+		}
+
+		// Round: If this isn't done, scaling can create numbers with long decimal representations.
+		//    long decimal representations => large file sizes.
+		scale = scale.map(component => Viewport.roundScaleRatio(component, 2));
+
+		if (scale.x !== 0 && scale.y !== 0) {
+			const origin = this.editor.viewport.roundPoint(this.selection.preTransformRegion.topLeft);
+			this.selection.setTransform(Mat33.scaling2D(scale, origin));
+		}
+	}
+	public onDragEnd() {
+		this.selection.finalizeTransform();
+	}
+}
+
+export class RotateTransformer {
+	private startAngle: number = 0;
+	public constructor(private readonly editor: Editor, private selection: Selection) { }
+
+	private getAngle(canvasPoint: Point2) {
+		const selectionCenter = this.selection.preTransformRegion.center;
+		const offset = canvasPoint.minus(selectionCenter);
+		return offset.angle();
+	}
+
+	private roundAngle(angle: number) {
+		// Round angles to the nearest 16th of a turn
+		const roundingFactor = 16 / 2 / Math.PI;
+		return Math.round(angle * roundingFactor) / roundingFactor;
+	}
+
+	public onDragStart(startPoint: Vec3) {
+		this.selection.setTransform(Mat33.identity);
+		this.startAngle = this.getAngle(startPoint);
+	}
+
+	public onDragUpdate(canvasPos: Vec3) {
+		const targetRotation = this.roundAngle(this.getAngle(canvasPos) - this.startAngle);
+
+		// Transform in canvas space
+		const canvasSelCenter = this.editor.viewport.roundPoint(this.selection.preTransformRegion.center);
+		const unrounded = Mat33.zRotation(targetRotation);
+		const roundedRotationTransform = unrounded.mapEntries(entry => Viewport.roundScaleRatio(entry));
+
+		const fullRoundedTransform = Mat33
+			.translation(canvasSelCenter)
+			.rightMul(roundedRotationTransform)
+			.rightMul(Mat33.translation(canvasSelCenter.times(-1)));
+
+		this.selection.setTransform(fullRoundedTransform);
+	}
+	public onDragEnd() {
+		this.selection.finalizeTransform();
+	}
+}

package/src/tools/SelectionTool/types.ts

@@ -0,0 +1,11 @@
+
+export enum ResizeMode {
+	Both,
+	HorizontalOnly,
+	VerticalOnly,
+}
+
+export enum TransformMode {
+	Snap,
+	NoSnap,
+}