js-draw 0.3.2 → 0.4.0

package/src/tools/SelectionTool/SelectionHandle.ts

@@ -0,0 +1,99 @@
+import { assertUnreachable } from '../../language/assertions';
+import { Point2, Vec2 } from '../../math/Vec2';
+import { cssPrefix } from './SelectionTool';
+import Selection from './Selection';
+import Pointer from '../../Pointer';
+
+export enum HandleShape {
+	Circle,
+	Square,
+}
+
+export const handleSize = 30;
+
+// `startPoint` is in screen coordinates
+export type DragStartCallback = (startPoint: Point2)=>void;
+export type DragUpdateCallback = (canvasPoint: Point2)=> void;
+export type DragEndCallback = ()=> void;
+
+export default class SelectionHandle {
+	private element: HTMLElement;
+
+	// Bounding box in screen coordinates.
+
+	public constructor(
+		readonly shape: HandleShape,
+		private readonly parentSide: Vec2,
+		private readonly parent: Selection,
+
+		private readonly onDragStart: DragStartCallback,
+		private readonly onDragUpdate: DragUpdateCallback,
+		private readonly onDragEnd: DragEndCallback,
+	) {
+		this.element = document.createElement('div');
+		this.element.classList.add(`${cssPrefix}handle`);
+
+		switch (shape) {
+		case HandleShape.Circle:
+			this.element.classList.add(`${cssPrefix}circle`);
+			break;
+		case HandleShape.Square:
+			this.element.classList.add(`${cssPrefix}square`);
+			break;
+		default:
+			assertUnreachable(shape);
+		}
+
+		this.updatePosition();
+	}
+
+	/**
+     * Adds this to `container`, where `conatiner` should be the background/selection
+     * element visible on the screen.
+     */
+	public addTo(container: HTMLElement) {
+		container.appendChild(this.element);
+	}
+
+	public updatePosition() {
+		const parentRect = this.parent.screenRegion;
+		const size = Vec2.of(handleSize, handleSize);
+		const topLeft = parentRect.size.scale(this.parentSide)
+			// Center
+			.minus(size.times(1/2));
+
+		// Position within the selection box.
+		this.element.style.marginLeft = `${topLeft.x}px`;
+		this.element.style.marginTop = `${topLeft.y}px`;
+		this.element.style.width = `${size.x}px`;
+		this.element.style.height = `${size.y}px`;
+	}
+
+	/**
+     * @returns `true` if the given `EventTarget` matches this.
+     */
+	public isTarget(target: EventTarget): boolean {
+		return target === this.element;
+	}
+
+	private dragLastPos: Vec2|null = null;
+	public handleDragStart(pointer: Pointer) {
+		this.onDragStart(pointer.canvasPos);
+		this.dragLastPos = pointer.canvasPos;
+	}
+
+	public handleDragUpdate(pointer: Pointer) {
+		if (!this.dragLastPos) {
+			return;
+		}
+
+		this.onDragUpdate(pointer.canvasPos);
+	}
+
+	public handleDragEnd() {
+		if (!this.dragLastPos) {
+			return;
+		}
+		this.onDragEnd();
+	}
+}

package/src/tools/SelectionTool/SelectionTool.css

@@ -0,0 +1,22 @@
+
+.selection-tool-selection-background {
+    background-color: var(--secondary-background-color);
+    opacity: 0.8;
+    overflow: visible;
+}
+
+.selection-tool-handle {
+    border: 1px solid var(--primary-foreground-color);
+    background: var(--primary-background-color);
+    position: absolute;
+    cursor: grab;
+}
+
+.selection-tool-handle.selection-tool-circle {
+    border-radius: 100%;
+}
+
+.overlay.handleOverlay {
+    height: 0;
+    overflow: visible;
+}

package/src/tools/{SelectionTool.test.ts → SelectionTool/SelectionTool.test.ts}

@@ -1,21 +1,21 @@
-import Color4 from '../Color4';
-import Stroke from '../components/Stroke';
-import Editor from '../Editor';
-import EditorImage from '../EditorImage';
-import Path from '../math/Path';
-import { Vec2 } from '../math/Vec2';
-import { InputEvtType } from '../types';
+import Color4 from '../../Color4';
+import Stroke from '../../components/Stroke';
+import Editor from '../../Editor';
+import EditorImage from '../../EditorImage';
+import Path from '../../math/Path';
+import { Vec2 } from '../../math/Vec2';
+import { InputEvtType } from '../../types';
 import SelectionTool from './SelectionTool';
-import createEditor from '../testing/createEditor';
+import createEditor from '../../testing/createEditor';
 
 const getSelectionTool = (editor: Editor): SelectionTool => {
 	return editor.toolController.getMatchingTools(SelectionTool)[0];
 };
 
-const createSquareStroke = () => {
+const createSquareStroke = (size: number = 1) => {
 	const testStroke = new Stroke([
-		// A filled unit square
-		Path.fromString('M0,0 L1,0 L1,1 L0,1 Z').toRenderable({ fill: Color4.blue }),
+		// A filled square
+		Path.fromString(`M0,0 L${size},0 L${size},${size} L0,${size} Z`).toRenderable({ fill: Color4.blue }),
 	]);
 	const addTestStrokeCommand = EditorImage.addElement(testStroke);
 
@@ -46,8 +46,8 @@ describe('SelectionTool', () => {
 		});
 	});
 
-	it('dragging the selected region should move selected items', () => {
-		const { testStroke, addTestStrokeCommand } = createSquareStroke();
+	it('sending keyboard events to the selected region should move selected items', () => {
+		const { testStroke, addTestStrokeCommand } = createSquareStroke(50);
 		const editor = createEditor();
 		editor.dispatch(addTestStrokeCommand);
 
@@ -62,13 +62,12 @@ describe('SelectionTool', () => {
 		expect(selection).not.toBeNull();
 
 		// Drag the object
-		selection!.handleBackgroundDrag(Vec2.of(5, 5));
-		selection!.finalizeTransform();
+		// (d => move right (d is from WASD controls.))
+		editor.sendKeyboardEvent(InputEvtType.KeyPressEvent, 'd');
+		editor.sendKeyboardEvent(InputEvtType.KeyPressEvent, 'd');
+		editor.sendKeyboardEvent(InputEvtType.KeyUpEvent, 'd');
 
-		expect(testStroke.getBBox().topLeft).toMatchObject({
-			x: 5,
-			y: 5,
-		});
+		expect(testStroke.getBBox().topLeft.x).toBeGreaterThan(5);
 
 		editor.history.undo();
 
@@ -79,7 +78,7 @@ describe('SelectionTool', () => {
 	});
 
 	it('moving the selection with a keyboard should move the view to keep the selection in view', () => {
-		const { addTestStrokeCommand } = createSquareStroke();
+		const { addTestStrokeCommand } = createSquareStroke(100);
 		const editor = createEditor();
 		editor.dispatch(addTestStrokeCommand);
 
@@ -97,7 +96,8 @@ describe('SelectionTool', () => {
 			throw new Error('Selection should be non-null.');
 		}
 
-		selection.handleBackgroundDrag(Vec2.of(0, -1000));
+		editor.sendKeyboardEvent(InputEvtType.KeyPressEvent, 'a');
+		editor.sendKeyboardEvent(InputEvtType.KeyUpEvent, 'a');
 		expect(editor.viewport.visibleRect.containsPoint(selection.region.center)).toBe(true);
 	});
 });

package/src/tools/SelectionTool/SelectionTool.ts

@@ -0,0 +1,335 @@
+// Allows users to select/transform portions of the `EditorImage`.
+// With respect to `extend`ing, `SelectionTool` is not stable.
+// @packageDocumentation
+
+import AbstractComponent from '../../components/AbstractComponent';
+import Editor from '../../Editor';
+import Mat33 from '../../math/Mat33';
+import Rect2 from '../../math/Rect2';
+import { Point2, Vec2 } from '../../math/Vec2';
+import { CopyEvent, EditorEventType, KeyPressEvent, KeyUpEvent, PointerEvt } from '../../types';
+import Viewport from '../../Viewport';
+import BaseTool from '../BaseTool';
+import SVGRenderer from '../../rendering/renderers/SVGRenderer';
+import Selection from './Selection';
+
+export const cssPrefix = 'selection-tool-';
+
+// {@inheritDoc SelectionTool!}
+export default class SelectionTool extends BaseTool {
+	private handleOverlay: HTMLElement;
+	private prevSelectionBox: Selection|null;
+	private selectionBox: Selection|null;
+	private lastEvtTarget: EventTarget|null = null;
+
+	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 => {
+			this.selectionBox?.updateUI();
+		});
+
+		this.editor.handleKeyEventsFrom(this.handleOverlay);
+		this.editor.handlePointerEventsFrom(this.handleOverlay, (eventName, htmlEvent: PointerEvent) => {
+			if (eventName === 'pointerdown') {
+				this.lastEvtTarget = htmlEvent.target;
+			}
+			return true;
+		});
+	}
+
+	private makeSelectionBox(selectionStartPos: Point2) {
+		this.prevSelectionBox = this.selectionBox;
+		this.selectionBox = new Selection(
+			selectionStartPos, this.editor
+		);
+		// Remove any previous selection rects
+		this.handleOverlay.replaceChildren();
+		this.selectionBox.addTo(this.handleOverlay);
+	}
+
+	private selectionBoxHandlingEvt: boolean = false;
+	public onPointerDown(event: PointerEvt): boolean {
+		if (event.allPointers.length === 1 && event.current.isPrimary) {
+			if (this.lastEvtTarget && this.selectionBox?.onDragStart(event.current, this.lastEvtTarget)) {
+				this.selectionBoxHandlingEvt = true;
+			} else {
+				this.makeSelectionBox(event.current.canvasPos);
+			}
+
+			return true;
+		}
+		return false;
+	}
+
+	public onPointerMove(event: PointerEvt): void {
+		if (!this.selectionBox) return;
+
+		if (this.selectionBoxHandlingEvt) {
+			this.selectionBox.onDragUpdate(event.current);
+		} else {
+			this.selectionBox!.setToPoint(event.current.canvasPos);
+		}
+	}
+
+	private onSelectionUpdated() {
+		// Note that the selection has changed
+		this.editor.notifier.dispatch(EditorEventType.ToolUpdated, {
+			kind: EditorEventType.ToolUpdated,
+			tool: this,
+		});
+
+		const selectedItemCount = this.selectionBox?.getSelectedItemCount() ?? 0;
+		if (selectedItemCount > 0) {
+			this.editor.announceForAccessibility(
+				this.editor.localization.selectedElements(selectedItemCount)
+			);
+			this.zoomToSelection();
+		} else if (this.selectionBox) {
+			this.selectionBox.cancelSelection();
+			this.prevSelectionBox = this.selectionBox;
+			this.selectionBox = null;
+		}
+	}
+
+	private onGestureEnd() {
+		this.lastEvtTarget = null;
+
+		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;
+	}
+
+	private zoomToSelection() {
+		if (this.selectionBox) {
+			const selectionRect = this.selectionBox.region;
+			this.editor.dispatchNoAnnounce(this.editor.viewport.zoomTo(selectionRect, false), false);
+		}
+	}
+
+	public onPointerUp(event: PointerEvt): void {
+		if (!this.selectionBox) return;
+
+		this.selectionBox.setToPoint(event.current.canvasPos);
+		this.onGestureEnd();
+	}
+
+	public 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);
+		}
+	}
+
+	private static handleableKeys = [
+		'a', 'h', 'ArrowLeft',
+		'd', 'l', 'ArrowRight',
+		'q', 'k', 'ArrowUp',
+		'e', 'j', 'ArrowDown',
+		'r', 'R',
+		'i', 'I', 'o', 'O',
+	];
+	public onKeyPress(event: KeyPressEvent): boolean {
+		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 onKeyUp(evt: KeyUpEvent) {
+		if (this.selectionBox && SelectionTool.handleableKeys.some(key => key === evt.key)) {
+			this.selectionBox.finalizeTransform();
+			return true;
+		}
+		return false;
+	}
+
+	public 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(this.editor.notifier);
+		exportViewport.updateScreenSize(Vec2.of(bbox.w, bbox.h));
+		exportViewport.resetTransform(Mat33.translation(bbox.topLeft));
+
+		const svgNameSpace = 'http://www.w3.org/2000/svg';
+		const exportElem = document.createElementNS(svgNameSpace, 'svg');
+
+		const sanitize = true;
+		const renderer = new SVGRenderer(exportElem, exportViewport, sanitize);
+
+		for (const elem of selectedElems) {
+			elem.render(renderer);
+		}
+
+		event.setData('image/svg+xml', exportElem.outerHTML);
+		return true;
+	}
+
+	public setEnabled(enabled: boolean) {
+		super.setEnabled(enabled);
+
+		// Clear the selection
+		this.handleOverlay.replaceChildren();
+		this.selectionBox = null;
+
+		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.
+	public getSelection(): Selection|null {
+		return this.selectionBox;
+	}
+
+	public setSelection(objects: AbstractComponent[]) {
+		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,114 @@
+import Editor from '../../Editor';
+import Mat33 from '../../math/Mat33';
+import { Point2, Vec2 } from '../../math/Vec2';
+import Vec3 from '../../math/Vec3';
+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,
+}

package/src/tools/ToolController.ts

@@ -5,7 +5,7 @@ import PanZoom, { PanZoomMode } from './PanZoom';
 import Pen from './Pen';
 import ToolEnabledGroup from './ToolEnabledGroup';
 import Eraser from './Eraser';
-import SelectionTool from './SelectionTool';
+import SelectionTool from './SelectionTool/SelectionTool';
 import Color4 from '../Color4';
 import { ToolLocalization } from './localization';
 import UndoRedoShortcut from './UndoRedoShortcut';

package/src/tools/lib.ts

@@ -13,7 +13,7 @@ export { default as PanZoomTool, PanZoomMode } from './PanZoom';
 
 export { default as PenTool, PenStyle } from './Pen';
 export { default as TextTool } from './TextTool';
-export { default as SelectionTool } from './SelectionTool';
+export { default as SelectionTool } from './SelectionTool/SelectionTool';
 export { default as EraserTool } from './Eraser';
 export { default as PasteHandler } from './PasteHandler';
 

package/src/types.ts

@@ -10,7 +10,7 @@ import Rect2 from './math/Rect2';
 import Pointer from './Pointer';
 import Color4 from './Color4';
 import Command from './commands/Command';
-import { BaseWidget } from './lib';
+import BaseWidget from './toolbar/widgets/BaseWidget';
 
 
 export interface PointerEvtListener {