js-draw 1.0.1 → 1.1.0

package/src/tools/ToolController.ts

@@ -1,224 +0,0 @@
-import { EditorEventType } from '../types';
-import { Color4 } from '@js-draw/math';
-import Editor from '../Editor';
-import BaseTool from './BaseTool';
-import PanZoom, { PanZoomMode } from './PanZoom';
-import Pen from './Pen';
-import ToolEnabledGroup from './ToolEnabledGroup';
-import Eraser from './Eraser';
-import SelectionTool from './SelectionTool/SelectionTool';
-import { ToolLocalization } from './localization';
-import UndoRedoShortcut from './UndoRedoShortcut';
-import TextTool from './TextTool';
-import PipetteTool from './PipetteTool';
-import ToolSwitcherShortcut from './ToolSwitcherShortcut';
-import PasteHandler from './PasteHandler';
-import ToolbarShortcutHandler from './ToolbarShortcutHandler';
-import { makePressureSensitiveFreehandLineBuilder } from '../components/builders/PressureSensitiveFreehandLineBuilder';
-import FindTool from './FindTool';
-import SelectAllShortcutHandler from './SelectionTool/SelectAllShortcutHandler';
-import SoundUITool from './SoundUITool';
-import InputMapper, { InputEventListener } from './InputFilter/InputMapper';
-import { InputEvt, InputEvtType } from '../inputEvents';
-import InputPipeline from './InputFilter/InputPipeline';
-import InputStabilizer from './InputFilter/InputStabilizer';
-
-export default class ToolController implements InputEventListener {
-	private tools: BaseTool[];
-	private activeTool: BaseTool|null = null;
-	private primaryToolGroup: ToolEnabledGroup;
-
-	// Form a pipeline that allows filtering/mapping input events.
-	private inputPipeline: InputPipeline;
-
-	/** @internal */
-	public constructor(editor: Editor, localization: ToolLocalization) {
-		this.inputPipeline = new InputPipeline();
-		this.inputPipeline.setEmitListener(event => this.onEventInternal(event));
-
-		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: 8 });
-		const secondaryPenTool = new Pen(editor, localization.penTool(2), { color: Color4.clay, thickness: 4 });
-
-		// Stabilize the secondary pen tool.
-		secondaryPenTool.setInputMapper(new InputStabilizer(editor.viewport));
-
-		const primaryTools = [
-			// Three pens
-			primaryPenTool,
-			secondaryPenTool,
-
-			// Highlighter-like pen with width=40
-			new Pen(
-				editor,
-				localization.penTool(3),
-				{
-					color: Color4.ofRGBA(1, 1, 0, 0.5),
-					thickness: 40,
-					factory: makePressureSensitiveFreehandLineBuilder
-				}
-			),
-
-			new Eraser(editor, localization.eraserTool),
-			new SelectionTool(editor, localization.selectionTool),
-			new TextTool(editor, localization.textTool, localization),
-			new PanZoom(editor, PanZoomMode.SinglePointerGestures, localization.anyDevicePanning),
-		];
-
-		// Accessibility tools
-		const soundExplorer = new SoundUITool(editor, localization.soundExplorer);
-		soundExplorer.setEnabled(false);
-
-		this.tools = [
-			new PipetteTool(editor, localization.pipetteTool),
-			soundExplorer,
-			panZoomTool,
-			...primaryTools,
-			keyboardPanZoomTool,
-			new UndoRedoShortcut(editor),
-			new ToolbarShortcutHandler(editor),
-			new ToolSwitcherShortcut(editor),
-			new FindTool(editor),
-			new PasteHandler(editor),
-			new SelectAllShortcutHandler(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));
-			}
-		});
-		editor.notifier.on(EditorEventType.ToolDisabled, event => {
-			if (event.kind === EditorEventType.ToolDisabled) {
-				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 `AbstractToolbar`).
-	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) {
-		tool.setToolGroup(this.primaryToolGroup);
-		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);
-	}
-
-	// @internal use `dispatchEvent` rather than calling `onEvent` directly.
-	private onEventInternal(event: InputEvt): boolean {
-		let handled = false;
-		if (event.kind === InputEvtType.PointerDownEvt) {
-			let canOnlySendToActiveTool = false;
-			if (this.activeTool && !this.activeTool.eventCanBeDeliveredToNonActiveTool(event)) {
-				canOnlySendToActiveTool = true;
-			}
-
-			for (const tool of this.tools) {
-				if (canOnlySendToActiveTool && tool !== this.activeTool) {
-					continue;
-				}
-
-				if (tool.isEnabled() && tool.onEvent(event)) {
-					if (this.activeTool !== tool) {
-						this.activeTool?.onEvent({ kind: InputEvtType.GestureCancelEvt });
-					}
-
-					this.activeTool = tool;
-					handled = true;
-					break;
-				}
-			}
-		} else if (event.kind === InputEvtType.PointerUpEvt) {
-			const upResult = this.activeTool?.onEvent(event);
-			const continueHandlingEvents = upResult && event.allPointers.length > 1;
-
-			// Should the active tool continue handling events (without an additional pointer down?)
-			if (!continueHandlingEvents) {
-				// No -- Remove the current tool
-				this.activeTool = null;
-			}
-			handled = true;
-		} else if (event.kind === InputEvtType.PointerMoveEvt) {
-			if (this.activeTool !== null) {
-				this.activeTool.onEvent(event);
-				handled = true;
-			}
-		} else if (event.kind === InputEvtType.GestureCancelEvt) {
-			if (this.activeTool !== null) {
-				this.activeTool.onEvent(event);
-				this.activeTool = null;
-			}
-		} else {
-			for (const tool of this.tools) {
-				if (!tool.isEnabled()) {
-					continue;
-				}
-
-				handled = tool.onEvent(event);
-				if (handled) {
-					break;
-				}
-			}
-		}
-
-		return handled;
-	}
-
-	/** Alias for {@link dispatchInputEvent}. */
-	public onEvent(event: InputEvt) {
-		return this.dispatchInputEvent(event);
-	}
-
-	// Returns true if the event was handled.
-	public dispatchInputEvent(event: InputEvt): boolean {
-		// Feed the event through the input pipeline
-		return this.inputPipeline.onEvent(event);
-	}
-
-	/**
-	 * Adds a new `InputMapper` to this' input pipeline.
-	 *
-	 * A `mapper` is really a relation that maps each event to no, one,
-	 * or many other events.
-	 *
-	 * @see {@link InputMapper}.
-	 */
-	public addInputMapper(mapper: InputMapper) {
-		this.inputPipeline.addToTail(mapper);
-	}
-
-	public getMatchingTools<Type extends BaseTool>(type: new (...args: any[])=>Type): Type[] {
-		return this.tools.filter(tool => tool instanceof type) as Type[];
-	}
-}
-

package/src/tools/ToolEnabledGroup.ts

@@ -1,14 +0,0 @@
-import BaseTool from './BaseTool';
-
-// Connects a group of tools -- at most one tool in the group can be enabled.
-export default class ToolEnabledGroup {
-	private activeTool: BaseTool|null;
-	public constructor() { }
-
-	public notifyEnabled(tool: BaseTool) {
-		if (tool !== this.activeTool) {
-			this.activeTool?.setEnabled(false);
-			this.activeTool = tool;
-		}
-	}
-}

package/src/tools/ToolSwitcherShortcut.ts

@@ -1,39 +0,0 @@
-import Editor from '../Editor';
-import { KeyPressEvent } from '../inputEvents';
-import BaseTool from './BaseTool';
-
-/**
- * Handles keyboard events used, by default, to select tools. By default,
- * 1 maps to the first primary tool, 2 to the second primary tool, ... .
- *
- * This is in the default set of {@link ToolController} tools.
- *
- * @deprecated This may be replaced in the future.
- */
-export default class ToolSwitcherShortcut extends BaseTool {
-	public constructor(private editor: Editor) {
-		super(editor.notifier, editor.localization.changeTool);
-	}
-
-	// @internal
-	public override onKeyPress({ key }: KeyPressEvent): boolean {
-		const toolController = this.editor.toolController;
-		const primaryTools = toolController.getPrimaryTools();
-
-		// Map keys 0-9 to primary tools.
-		const keyMatch = /^[0-9]$/.exec(key);
-
-		let targetTool: BaseTool|undefined;
-		if (keyMatch) {
-			const targetIdx = parseInt(keyMatch[0], 10) - 1;
-			targetTool = primaryTools[targetIdx];
-		}
-
-		if (targetTool) {
-			targetTool.setEnabled(true);
-			return true;
-		}
-
-		return false;
-	}
-}

package/src/tools/ToolbarShortcutHandler.ts

@@ -1,39 +0,0 @@
-// Allows the toolbar to register keyboard events.
-// @packageDocumentation
-
-import Editor from '../Editor';
-import { KeyPressEvent } from '../inputEvents';
-import BaseTool from './BaseTool';
-
-// Returns true if the event was handled, false otherwise.
-type KeyPressListener = (event: KeyPressEvent)=>boolean;
-
-export default class ToolbarShortcutHandler extends BaseTool {
-	private listeners: Set<KeyPressListener> = new Set([]);
-	public constructor(editor: Editor) {
-		super(editor.notifier, editor.localization.changeTool);
-	}
-
-	public registerListener(listener: KeyPressListener) {
-		this.listeners.add(listener);
-	}
-
-	public removeListener(listener: KeyPressListener) {
-		this.listeners.delete(listener);
-	}
-
-	public override onKeyPress(event: KeyPressEvent): boolean {
-		// TypeScript seems to automatically convert for of loops into for(init;check;update)
-		// loops (even with target set to es6). Thus, we cannot iterate directly through the
-		// set here.
-		// See https://stackoverflow.com/q/48886500
-		const listeners = Array.from(this.listeners.values());
-		for (const listener of listeners) {
-			if (listener(event)) {
-				return true;
-			}
-		}
-
-		return false;
-	}
-}

package/src/tools/UndoRedoShortcut.test.ts

@@ -1,62 +0,0 @@
-/* @jest-environment jsdom */
-
-import Stroke from '../components/Stroke';
-import EditorImage from '../EditorImage';
-import { Path, Color4 } from '@js-draw/math';
-import createEditor from '../testing/createEditor';
-import { InputEvtType } from '../inputEvents';
-import { pathToRenderable } from '../rendering/RenderablePathSpec';
-
-describe('UndoRedoShortcut', () => {
-	const testStroke = new Stroke([pathToRenderable(Path.fromString('M0,0L10,10'), { fill: Color4.red })]);
-	const addTestStrokeCommand = EditorImage.addElement(testStroke);
-
-	it('ctrl+z should undo', () => {
-		const editor = createEditor();
-		editor.dispatch(addTestStrokeCommand);
-		expect(editor.history.undoStackSize).toBe(1);
-
-		editor.toolController.dispatchInputEvent({
-			kind: InputEvtType.KeyPressEvent,
-			ctrlKey: true,
-			altKey: false,
-			shiftKey: false,
-			key: 'z',
-			code: 'KeyZ',
-		});
-
-		expect(editor.history.undoStackSize).toBe(0);
-		expect(editor.history.redoStackSize).toBe(1);
-	});
-
-	it('ctrl+shift+Z should re-do', () => {
-		const editor = createEditor();
-		editor.dispatch(addTestStrokeCommand);
-		editor.dispatch(addTestStrokeCommand);
-		expect(editor.history.undoStackSize).toBe(2);
-
-		editor.toolController.dispatchInputEvent({
-			kind: InputEvtType.KeyPressEvent,
-			ctrlKey: true,
-			altKey: false,
-			shiftKey: false,
-			key: 'z',
-			code: 'KeyZ',
-		});
-
-		expect(editor.history.undoStackSize).toBe(1);
-		expect(editor.history.redoStackSize).toBe(1);
-
-		editor.toolController.dispatchInputEvent({
-			kind: InputEvtType.KeyPressEvent,
-			ctrlKey: true,
-			altKey: false,
-			shiftKey: true,
-			key: 'Z',
-			code: 'KeyZ',
-		});
-
-		expect(editor.history.undoStackSize).toBe(2);
-		expect(editor.history.redoStackSize).toBe(0);
-	});
-});

package/src/tools/UndoRedoShortcut.ts

@@ -1,24 +0,0 @@
-import Editor from '../Editor';
-import { KeyPressEvent } from '../inputEvents';
-import BaseTool from './BaseTool';
-import { redoKeyboardShortcutId, undoKeyboardShortcutId } from './keybindings';
-
-// Handles ctrl+Z, ctrl+Shift+Z keyboard shortcuts.
-export default class UndoRedoShortcut extends BaseTool {
-	public constructor(private editor: Editor) {
-		super(editor.notifier, editor.localization.undoRedoTool);
-	}
-
-	// @internal
-	public override onKeyPress(event: KeyPressEvent): boolean {
-		if (this.editor.shortcuts.matchesShortcut(undoKeyboardShortcutId, event)) {
-			this.editor.history.undo();
-			return true;
-		} else if (this.editor.shortcuts.matchesShortcut(redoKeyboardShortcutId, event)) {
-			this.editor.history.redo();
-			return true;
-		}
-
-		return false;
-	}
-}

package/src/tools/keybindings.ts

@@ -1,85 +0,0 @@
-import KeyboardShortcutManager from '../shortcuts/KeyboardShortcutManager';
-
-// This file contains user-overridable tool-realted keybindings.
-
-// Undo/redo
-export const undoKeyboardShortcutId = 'jsdraw.tools.undo';
-export const redoKeyboardShortcutId = 'jsdaw.tools.redo';
-
-KeyboardShortcutManager.registerDefaultKeyboardShortcut(
-	undoKeyboardShortcutId, [ 'CtrlOrMeta+KeyZ' ], 'Undo'
-);
-KeyboardShortcutManager.registerDefaultKeyboardShortcut(
-	redoKeyboardShortcutId, [ 'CtrlOrMeta+Shift+KeyZ', 'CtrlOrMeta+KeyY' ], 'Redo'
-);
-
-// Pen/eraser/selection keybindings
-export const increaseSizeKeyboardShortcutId = 'jsdraw.tools.increaseSize';
-KeyboardShortcutManager.registerDefaultKeyboardShortcut(
-	increaseSizeKeyboardShortcutId, [ 'Equal', 'Shift+Equal' ], 'Increase pen/eraser size'
-);
-export const decreaseSizeKeyboardShortcutId = 'jsdraw.tools.decreaseSize';
-KeyboardShortcutManager.registerDefaultKeyboardShortcut(
-	decreaseSizeKeyboardShortcutId, [ 'Minus', 'Shift+Minus' ], 'Decrease pen/eraser size'
-);
-export const snapToGridKeyboardShortcutId = 'jsdraw.tools.snapToGrid';
-KeyboardShortcutManager.registerDefaultKeyboardShortcut(
-	snapToGridKeyboardShortcutId, [ 'Control', 'Meta' ], 'Snap to grid (press and hold)'
-);
-export const lineLockKeyboardShortcutId = 'jsdraw.tools.lockToLine';
-KeyboardShortcutManager.registerDefaultKeyboardShortcut(
-	lineLockKeyboardShortcutId, [ 'Shift' ], 'Snap to XY axes (press and hold)'
-);
-
-// Find tool
-export const toggleFindVisibleShortcutId = 'js-draw.tools.FindTool.toggleVisible';
-KeyboardShortcutManager.registerDefaultKeyboardShortcut(
-	toggleFindVisibleShortcutId,
-	[ 'CtrlOrMeta+KeyF' ],
-	'Shows/hides the find tool'
-);
-
-// Pan/zoom
-export const moveLeftKeyboardShortcutId = 'jsdraw.tools.PanZoom.moveLeft';
-KeyboardShortcutManager.registerDefaultKeyboardShortcut(
-	moveLeftKeyboardShortcutId, [ 'ArrowLeft', 'KeyH', 'KeyA' ], 'Pan left'
-);
-export const moveRightKeyboardShortcutId = 'jsdraw.tools.PanZoom.moveRight';
-KeyboardShortcutManager.registerDefaultKeyboardShortcut(
-	moveRightKeyboardShortcutId, [ 'ArrowRight', 'KeyL', 'KeyD' ], 'Pan right'
-);
-export const moveUpKeyboardShortcutId = 'jsdraw.tools.PanZoom.moveUp';
-KeyboardShortcutManager.registerDefaultKeyboardShortcut(
-	moveUpKeyboardShortcutId, [ 'ArrowUp', 'KeyK', 'KeyQ' ], 'Pan up'
-);
-export const moveDownKeyboardShortcutId = 'jsdraw.tools.PanZoom.moveDown';
-KeyboardShortcutManager.registerDefaultKeyboardShortcut(
-	moveDownKeyboardShortcutId, [ 'ArrowDown', 'KeyJ', 'KeyE' ], 'Pan down'
-);
-export const rotateClockwiseKeyboardShortcutId = 'jsdraw.tools.PanZoom.rotateViewClockwise';
-KeyboardShortcutManager.registerDefaultKeyboardShortcut(
-	rotateClockwiseKeyboardShortcutId, [ 'Shift+KeyR' ], 'Rotate viewport clockwise'
-);
-export const rotateCounterClockwiseKeyboardShortcutId = 'jsdraw.tools.PanZoom.rotateViewCounterClockwise';
-KeyboardShortcutManager.registerDefaultKeyboardShortcut(
-	rotateCounterClockwiseKeyboardShortcutId, [ 'KeyR' ], 'Rotate viewport counter-clockwise'
-);
-export const zoomInKeyboardShortcutId = 'jsdraw.tools.PanZoom.zoomIn';
-KeyboardShortcutManager.registerDefaultKeyboardShortcut(
-	zoomInKeyboardShortcutId, [ 'KeyW' ], 'Zoom in'
-);
-export const zoomOutKeyboardShortcutId = 'jsdraw.tools.PanZoom.zoomOut';
-KeyboardShortcutManager.registerDefaultKeyboardShortcut(
-	zoomOutKeyboardShortcutId, [ 'KeyS' ], 'Zoom out'
-);
-
-// Selection
-export const selectAllKeyboardShortcut = 'jsdraw.tools.SelectionTool.selectAll';
-KeyboardShortcutManager.registerDefaultKeyboardShortcut(
-	selectAllKeyboardShortcut, [ 'CtrlOrMeta+KeyA' ], 'Select all'
-);
-export const duplicateSelectionShortcut = 'jsdraw.tools.SelectionTool.duplicateSelection';
-KeyboardShortcutManager.registerDefaultKeyboardShortcut(
-	duplicateSelectionShortcut, [ 'CtrlOrMeta+KeyD' ], 'Duplicate selection'
-);
-

package/src/tools/lib.ts

@@ -1,22 +0,0 @@
-
-/**
- * @packageDocumentation
- */
-
-export { default as BaseTool } from './BaseTool';
-export { default as ToolController } from './ToolController';
-export { default as ToolEnabledGroup } from './ToolEnabledGroup';
-
-export { default as UndoRedoShortcut } from './UndoRedoShortcut';
-export { default as ToolSwitcherShortcut } from './ToolSwitcherShortcut';
-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/SelectionTool';
-export { default as SelectAllShortcutHandler } from './SelectionTool/SelectAllShortcutHandler';
-export { default as EraserTool } from './Eraser';
-export { default as PasteHandler } from './PasteHandler';
-export { default as SoundUITool } from './SoundUITool';
-
-export { default as ToolbarShortcutHandler } from './ToolbarShortcutHandler';

package/src/tools/localization.ts

@@ -1,76 +0,0 @@
-
-export interface ToolLocalization {
-	keyboardPanZoom: string;
-	penTool: (penId: number)=>string;
-	selectionTool: string;
-	selectAllTool: string;
-	eraserTool: string;
-	touchPanTool: string;
-	twoFingerPanZoomTool: string;
-	undoRedoTool: string;
-	pipetteTool: string;
-	rightClickDragPanTool: string;
-
-	textTool: string;
-	enterTextToInsert: string;
-	changeTool: string;
-	pasteHandler: string;
-
-	soundExplorer: string;
-	disableAccessibilityExploreTool: string;
-	enableAccessibilityExploreTool: string;
-	soundExplorerUsageAnnouncement: string;
-
-	findLabel: string;
-	toNextMatch: string;
-	closeDialog: string;
-	findDialogShown: string;
-	findDialogHidden: string;
-	focusedFoundText: (currentMatchNumber: number, totalMatches: number)=> string;
-
-	anyDevicePanning: string;
-
-	copied: (count: number, description: string) => string;
-	pasted: (count: number, description: string) => string;
-
-	toolEnabledAnnouncement: (toolName: string) => string;
-	toolDisabledAnnouncement: (toolName: string) => string;
-}
-
-export const defaultToolLocalization: ToolLocalization = {
-	penTool: (penId) => `Pen ${penId}`,
-	selectionTool: 'Selection',
-	selectAllTool: 'Select all shortcut',
-	eraserTool: 'Eraser',
-	touchPanTool: 'Touch panning',
-	twoFingerPanZoomTool: 'Panning and zooming',
-	undoRedoTool: 'Undo/Redo',
-	rightClickDragPanTool: 'Right-click drag',
-	pipetteTool: 'Pick color from screen',
-	keyboardPanZoom: 'Keyboard pan/zoom shortcuts',
-
-	textTool: 'Text',
-	enterTextToInsert: 'Text to insert',
-	changeTool: 'Change tool',
-	pasteHandler: 'Copy paste handler',
-
-	soundExplorer: 'Sound-based image exploration',
-	disableAccessibilityExploreTool: 'Disable sound-based exploration',
-	enableAccessibilityExploreTool: 'Enable sound-based exploration',
-	soundExplorerUsageAnnouncement: 'Sound-based image exploration enabled: Click/drag the screen to play a sound representation of different parts of the image.',
-
-	findLabel: 'Find',
-	toNextMatch: 'Next',
-	closeDialog: 'Close',
-	findDialogShown: 'Find dialog shown',
-	findDialogHidden: 'Find dialog hidden',
-	focusedFoundText: (matchIdx: number, totalMatches: number) => `Viewing match ${matchIdx} of ${totalMatches}`,
-
-	anyDevicePanning: 'Any device panning',
-
-	copied: (count: number, description: string) => `Copied ${count} ${description}`,
-	pasted: (count: number, description: string) => `Pasted ${count} ${description}`,
-
-	toolEnabledAnnouncement: (toolName) => `${toolName} enabled`,
-	toolDisabledAnnouncement: (toolName) => `${toolName} disabled`,
-};