js-draw 0.3.1 → 0.3.2

package/src/tools/PasteHandler.ts

@@ -0,0 +1,156 @@
+/**
+ * A tool that handles paste events.
+ * @packageDocumentation
+ */
+
+import Editor from '../Editor';
+import { AbstractComponent, TextComponent } from '../components/lib';
+import { Command, uniteCommands } from '../commands/lib';
+import SVGLoader from '../SVGLoader';
+import { PasteEvent } from '../types';
+import { Mat33, Rect2, Vec2 } from '../math/lib';
+import BaseTool from './BaseTool';
+import EditorImage from '../EditorImage';
+import SelectionTool from './SelectionTool';
+import TextTool from './TextTool';
+import Color4 from '../Color4';
+import { TextStyle } from '../components/Text';
+import ImageComponent from '../components/ImageComponent';
+
+// { @inheritDoc PasteHandler! }
+export default class PasteHandler extends BaseTool {
+	public constructor(private editor: Editor) {
+		super(editor.notifier, editor.localization.pasteHandler);
+	}
+
+	public onPaste(event: PasteEvent): boolean {
+		const mime = event.mime.toLowerCase();
+
+		if (mime === 'image/svg+xml') {
+			void this.doSVGPaste(event.data);
+			return true;
+		}
+		else if (mime === 'text/plain') {
+			void this.doTextPaste(event.data);
+			return true;
+		}
+		else if (mime === 'image/png' || mime === 'image/jpeg') {
+			void this.doImagePaste(event.data);
+			return true;
+		}
+
+		return false;
+	}
+
+	private async addComponentsFromPaste(components: AbstractComponent[]) {
+		let bbox: Rect2|null = null;
+		for (const component of components) {
+			if (bbox) {
+				bbox = bbox.union(component.getBBox());
+			} else {
+				bbox = component.getBBox();
+			}
+		}
+
+		if (!bbox) {
+			return;
+		}
+
+		// Find a transform that scales/moves bbox onto the screen.
+		const visibleRect = this.editor.viewport.visibleRect;
+		const scaleRatioX = visibleRect.width / bbox.width;
+		const scaleRatioY = visibleRect.height / bbox.height;
+
+		let scaleRatio = scaleRatioX;
+		if (bbox.width * scaleRatio > visibleRect.width || bbox.height * scaleRatio > visibleRect.height) {
+			scaleRatio = scaleRatioY;
+		}
+		scaleRatio *= 2 / 3;
+
+		const transfm = Mat33.translation(
+			visibleRect.center.minus(bbox.center)
+		).rightMul(
+			Mat33.scaling2D(scaleRatio, bbox.center)
+		);
+
+		const commands: Command[] = [];
+		for (const component of components) {
+			// To allow deserialization, we need to add first, then transform.
+			commands.push(EditorImage.addElement(component));
+			commands.push(component.transformBy(transfm));
+		}
+
+		const applyChunkSize = 100;
+		this.editor.dispatch(uniteCommands(commands, applyChunkSize), true);
+
+		for (const selectionTool of this.editor.toolController.getMatchingTools(SelectionTool)) {
+			selectionTool.setEnabled(true);
+			selectionTool.setSelection(components);
+		}
+	}
+
+	private async doSVGPaste(data: string) {
+		const sanitize = true;
+		const loader = SVGLoader.fromString(data, sanitize);
+
+		const components: AbstractComponent[] = [];
+
+		await loader.start((component) => {
+			components.push(component);
+		},
+		(_countProcessed: number, _totalToProcess: number) => null);
+
+		await this.addComponentsFromPaste(components);
+	}
+
+	private async doTextPaste(text: string) {
+		const textTools = this.editor.toolController.getMatchingTools(TextTool);
+
+		textTools.sort((a, b) => {
+			if (!a.isEnabled() && b.isEnabled()) {
+				return -1;
+			}
+
+			if (!b.isEnabled() && a.isEnabled()) {
+				return 1;
+			}
+
+			return 0;
+		});
+
+		const defaultTextStyle: TextStyle = { size: 12, fontFamily: 'sans', renderingStyle: { fill: Color4.red } };
+		const pastedTextStyle: TextStyle = textTools[0]?.getTextStyle() ?? defaultTextStyle;
+
+		const lines = text.split('\n');
+		let lastComponent: TextComponent|null = null;
+		const components: TextComponent[] = [];
+
+		for (const line of lines) {
+			let position = Vec2.zero;
+			if (lastComponent) {
+				const lineMargin = Math.floor(pastedTextStyle.size);
+				position = lastComponent.getBBox().bottomLeft.plus(Vec2.unitY.times(lineMargin));
+			}
+
+			const component = new TextComponent([ line ], Mat33.translation(position), pastedTextStyle);
+			components.push(component);
+			lastComponent = component;
+		}
+
+		if (components.length === 1) {
+			await this.addComponentsFromPaste([ components[0] ]);
+		} else {
+			// Wrap the existing `TextComponent`s --- dragging one component should drag all.
+			await this.addComponentsFromPaste([
+				new TextComponent(components, Mat33.identity, pastedTextStyle)
+			]);
+		}
+	}
+
+	private async doImagePaste(dataURL: string) {
+		const image = new Image();
+		image.src = dataURL;
+		const component = await ImageComponent.fromImage(image, Mat33.identity);
+		await this.addComponentsFromPaste([ component ]);
+	}
+}

package/src/tools/SelectionTool.ts

@@ -11,10 +11,11 @@ import Mat33 from '../math/Mat33';
 import Rect2 from '../math/Rect2';
 import { Point2, Vec2 } from '../math/Vec2';
 import { EditorLocalization } from '../localization';
-import { EditorEventType, KeyPressEvent, KeyUpEvent, PointerEvt } from '../types';
+import { CopyEvent, EditorEventType, KeyPressEvent, KeyUpEvent, PointerEvt } from '../types';
 import Viewport from '../Viewport';
 import BaseTool from './BaseTool';
 import SerializableCommand from '../commands/SerializableCommand';
+import SVGRenderer from '../rendering/renderers/SVGRenderer';
 
 const handleScreenSize = 30;
 const styles = `
@@ -381,6 +382,16 @@ class Selection {
 		this.region = Rect2.empty;
 	}
 
+	public setSelectedObjects(objects: AbstractComponent[], bbox: Rect2) {
+		this.region = bbox;
+		this.selectedElems = objects;
+		this.updateUI();
+	}
+
+	public getSelectedObjects(): AbstractComponent[] {
+		return this.selectedElems;
+	}
+
 	// Find the objects corresponding to this in the document,
 	// select them.
 	// Returns false iff nothing was selected.
@@ -528,15 +539,19 @@ export default class SelectionTool extends BaseTool {
 		this.editor.handleKeyEventsFrom(this.handleOverlay);
 	}
 
+	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.appendBackgroundBoxTo(this.handleOverlay);
+	}
+
 	public onPointerDown(event: PointerEvt): boolean {
 		if (event.allPointers.length === 1 && event.current.isPrimary) {
-			this.prevSelectionBox = this.selectionBox;
-			this.selectionBox = new Selection(
-				event.current.canvasPos, this.editor
-			);
-			// Remove any previous selection rects
-			this.handleOverlay.replaceChildren();
-			this.selectionBox.appendBackgroundBoxTo(this.handleOverlay);
+			this.makeSelectionBox(event.current.canvasPos);
 
 			return true;
 		}
@@ -679,6 +694,12 @@ export default class SelectionTool extends BaseTool {
 			this.selectionBox.transformPreview(transform);
 		}
 
+		if (this.selectionBox && !handled && (event.key === 'Delete' || event.key === 'Backspace')) {
+			this.editor.dispatch(this.selectionBox.deleteSelectedObjects());
+			this.clearSelection();
+			handled = true;
+		}
+
 		return handled;
 	}
 
@@ -690,6 +711,35 @@ export default class SelectionTool extends BaseTool {
 		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);
 
@@ -712,6 +762,28 @@ export default class SelectionTool extends BaseTool {
 		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);
+	}
+
 	public clearSelection() {
 		this.handleOverlay.replaceChildren();
 		this.prevSelectionBox = this.selectionBox;

package/src/tools/ToolController.ts

@@ -12,17 +12,18 @@ import UndoRedoShortcut from './UndoRedoShortcut';
 import TextTool from './TextTool';
 import PipetteTool from './PipetteTool';
 import ToolSwitcherShortcut from './ToolSwitcherShortcut';
+import PasteHandler from './PasteHandler';
 
 export default class ToolController {
 	private tools: BaseTool[];
 	private activeTool: BaseTool|null = null;
 	private primaryToolGroup: ToolEnabledGroup;
-
+	
 	/** @internal */
 	public constructor(editor: Editor, localization: ToolLocalization) {
 		const primaryToolGroup = new ToolEnabledGroup();
 		this.primaryToolGroup = primaryToolGroup;
-
+		
 		const panZoomTool = new PanZoom(editor, PanZoomMode.TwoFingerTouchGestures | PanZoomMode.RightClickDrags, localization.touchPanTool);
 		const keyboardPanZoomTool = new PanZoom(editor, PanZoomMode.Keyboard, localization.keyboardPanZoom);
 		const primaryPenTool = new Pen(editor, localization.penTool(1), { color: Color4.purple, thickness: 16 });
@@ -30,10 +31,10 @@ export default class ToolController {
 			// Three pens
 			primaryPenTool,
 			new Pen(editor, localization.penTool(2), { color: Color4.clay, thickness: 4 }),
-
+			
 			// Highlighter-like pen with width=64
 			new Pen(editor, localization.penTool(3), { color: Color4.ofRGBA(1, 1, 0, 0.5), thickness: 64 }),
-
+			
 			new Eraser(editor, localization.eraserTool),
 			new SelectionTool(editor, localization.selectionTool),
 			new TextTool(editor, localization.textTool, localization),
@@ -45,11 +46,12 @@ export default class ToolController {
 			keyboardPanZoomTool,
 			new UndoRedoShortcut(editor),
 			new ToolSwitcherShortcut(editor),
+			new PasteHandler(editor),
 		];
 		primaryTools.forEach(tool => tool.setToolGroup(primaryToolGroup));
 		panZoomTool.setEnabled(true);
 		primaryPenTool.setEnabled(true);
-
+		
 		editor.notifier.on(EditorEventType.ToolEnabled, event => {
 			if (event.kind === EditorEventType.ToolEnabled) {
 				editor.announceForAccessibility(localization.toolEnabledAnnouncement(event.tool.description));
@@ -60,17 +62,17 @@ export default class ToolController {
 				editor.announceForAccessibility(localization.toolDisabledAnnouncement(event.tool.description));
 			}
 		});
-
+		
 		this.activeTool = null;
 	}
-
+	
 	// Replaces the current set of tools with `tools`. This should only be done before
 	// the creation of the app's toolbar (if using `HTMLToolbar`).
 	public setTools(tools: BaseTool[], primaryToolGroup?: ToolEnabledGroup) {
 		this.tools = tools;
 		this.primaryToolGroup = primaryToolGroup ?? new ToolEnabledGroup();
 	}
-
+	
 	// Add a tool that acts like one of the primary tools (only one primary tool can be enabled at a time).
 	// This should be called before creating the app's toolbar.
 	public addPrimaryTool(tool: BaseTool) {
@@ -78,22 +80,22 @@ export default class ToolController {
 		if (tool.isEnabled()) {
 			this.primaryToolGroup.notifyEnabled(tool);
 		}
-
+		
 		this.addTool(tool);
 	}
-
+	
 	public getPrimaryTools(): BaseTool[] {
 		return this.tools.filter(tool => {
 			return tool.getToolGroup() === this.primaryToolGroup;
 		});
 	}
-
+	
 	// Add a tool to the end of this' tool list (the added tool receives events after tools already added to this).
 	// This should be called before creating the app's toolbar.
 	public addTool(tool: BaseTool) {
 		this.tools.push(tool);
 	}
-
+	
 	// Returns true if the event was handled
 	public dispatchInputEvent(event: InputEvt): boolean {
 		let handled = false;
@@ -103,7 +105,7 @@ export default class ToolController {
 					if (this.activeTool !== tool) {
 						this.activeTool?.onGestureCancel();
 					}
-
+					
 					this.activeTool = tool;
 					handled = true;
 					break;
@@ -113,49 +115,54 @@ export default class ToolController {
 			this.activeTool?.onPointerUp(event);
 			this.activeTool = null;
 			handled = true;
-		} else if (
-			event.kind === InputEvtType.WheelEvt || event.kind === InputEvtType.KeyPressEvent || event.kind === InputEvtType.KeyUpEvent
-		) {
-			const isKeyPressEvt = event.kind === InputEvtType.KeyPressEvent;
-			const isKeyReleaseEvt = event.kind === InputEvtType.KeyUpEvent;
-			const isWheelEvt = event.kind === InputEvtType.WheelEvt;
+		} else if (event.kind === InputEvtType.PointerMoveEvt) {
+			if (this.activeTool !== null) {
+				this.activeTool.onPointerMove(event);
+				handled = true;
+			}
+		} else if (event.kind === InputEvtType.GestureCancelEvt) {
+			if (this.activeTool !== null) {
+				this.activeTool.onGestureCancel();
+				this.activeTool = null;	
+			}
+		} else {
+			let allCasesHandledGuard: never;
+
 			for (const tool of this.tools) {
 				if (!tool.isEnabled()) {
 					continue;
 				}
-
-				const wheelResult = isWheelEvt && tool.onWheel(event);
-				const keyPressResult = isKeyPressEvt && tool.onKeyPress(event);
-				const keyReleaseResult = isKeyReleaseEvt && tool.onKeyUp(event);
-				handled = keyPressResult || wheelResult || keyReleaseResult;
+				
+				switch (event.kind) {
+				case InputEvtType.KeyPressEvent:
+					handled = tool.onKeyPress(event);
+					break;
+				case InputEvtType.KeyUpEvent:
+					handled = tool.onKeyUp(event);
+					break;
+				case InputEvtType.WheelEvt:
+					handled = tool.onWheel(event);
+					break;
+				case InputEvtType.CopyEvent:
+					handled = tool.onCopy(event);
+					break;
+				case InputEvtType.PasteEvent:
+					handled = tool.onPaste(event);
+					break;
+				default:
+					allCasesHandledGuard = event;
+					return allCasesHandledGuard;
+				}
 
 				if (handled) {
 					break;
 				}
 			}
-		} else if (this.activeTool !== null) {
-			let allCasesHandledGuard: never;
-
-			switch (event.kind) {
-			case InputEvtType.PointerMoveEvt:
-				this.activeTool.onPointerMove(event);
-				break;
-			case InputEvtType.GestureCancelEvt:
-				this.activeTool.onGestureCancel();
-				this.activeTool = null;
-				break;
-			default:
-				allCasesHandledGuard = event;
-				return allCasesHandledGuard;
-			}
-			handled = true;
-		} else {
-			handled = false;
 		}
-
+		
 		return handled;
 	}
-
+	
 	public getMatchingTools<Type extends BaseTool>(type: new (...args: any[])=>Type): Type[] {
 		return this.tools.filter(tool => tool instanceof type) as Type[];
 	}

package/src/tools/lib.ts

@@ -15,4 +15,5 @@ export { default as PenTool, PenStyle } from './Pen';
 export { default as TextTool } from './TextTool';
 export { default as SelectionTool } from './SelectionTool';
 export { default as EraserTool } from './Eraser';
+export { default as PasteHandler } from './PasteHandler';
 

package/src/tools/localization.ts

@@ -13,6 +13,10 @@ export interface ToolLocalization {
 	textTool: string;
 	enterTextToInsert: string;
 	changeTool: string;
+	pasteHandler: string;
+
+	copied: (count: number, description: string) => string;
+	pasted: (count: number, description: string) => string;
 
     toolEnabledAnnouncement: (toolName: string) => string;
     toolDisabledAnnouncement: (toolName: string) => string;
@@ -32,6 +36,10 @@ export const defaultToolLocalization: ToolLocalization = {
 	textTool: 'Text',
 	enterTextToInsert: 'Text to insert',
 	changeTool: 'Change tool',
+	pasteHandler: 'Copy paste handler',
+
+	copied: (count: number, description: string) => `Copied ${count} ${description}`,
+	pasted: (count: number, description: string) => `Pasted ${count} ${description}`,
 
 	toolEnabledAnnouncement: (toolName) => `${toolName} enabled`,
 	toolDisabledAnnouncement: (toolName) => `${toolName} disabled`,

package/src/types.ts

@@ -35,7 +35,10 @@ export enum InputEvtType {
 
 	WheelEvt,
 	KeyPressEvent,
-	KeyUpEvent
+	KeyUpEvent,
+
+	CopyEvent,
+	PasteEvent,
 }
 
 // [delta.x] is horizontal scroll,
@@ -59,6 +62,17 @@ export interface KeyUpEvent {
 	readonly ctrlKey: boolean;
 }
 
+export interface CopyEvent {
+	readonly kind: InputEvtType.CopyEvent;
+	setData(mime: string, data: string): void;
+}
+
+export interface PasteEvent {
+	readonly kind: InputEvtType.PasteEvent;
+	readonly data: string;
+	readonly mime: string;
+}
+
 // Event triggered when pointer capture is taken by a different [PointerEvtListener].
 export interface GestureCancelEvt {
 	readonly kind: InputEvtType.GestureCancelEvt;
@@ -82,7 +96,7 @@ export interface PointerUpEvt extends PointerEvtBase {
 }
 
 export type PointerEvt = PointerDownEvt | PointerMoveEvt | PointerUpEvt;
-export type InputEvt = KeyPressEvent | KeyUpEvent | WheelEvt | GestureCancelEvt | PointerEvt;
+export type InputEvt = KeyPressEvent | KeyUpEvent | WheelEvt | GestureCancelEvt | PointerEvt | CopyEvent | PasteEvent;
 
 export type EditorNotifier = EventDispatcher<EditorEventType, EditorEventDataType>;