js-draw 1.0.1 → 1.1.0

package/src/components/TextComponent.ts

@@ -1,429 +0,0 @@
-import SerializableCommand from '../commands/SerializableCommand';
-import Editor from '../Editor';
-import { Vec2, LineSegment2, Rect2, Mat33, Mat33Array } from '@js-draw/math';
-import AbstractRenderer from '../rendering/renderers/AbstractRenderer';
-import { cloneTextStyle, TextRenderingStyle, textStyleFromJSON, textStyleToJSON } from '../rendering/TextRenderingStyle';
-import AbstractComponent from './AbstractComponent';
-import { ImageComponentLocalization } from './localization';
-import RestyleableComponent, { ComponentStyle, createRestyleComponentCommand } from './RestylableComponent';
-
-const componentTypeId = 'text';
-
-export enum TextTransformMode {
-	/** Absolutely positioned in both the X and Y dimensions. */
-	ABSOLUTE_XY,
-
-	/** Relatively positioned in both the X and Y dimensions. */
-	RELATIVE_XY,
-
-	/**Relatively positioned in the X direction, absolutely positioned in the Y direction. */
-	RELATIVE_X_ABSOLUTE_Y,
-
-	/**Relatively positioned in the Y direction, absolutely positioned in the X direction. */
-	RELATIVE_Y_ABSOLUTE_X,
-}
-
-type TextElement = TextComponent|string;
-
-/**
- * Displays text.
- */
-export default class TextComponent extends AbstractComponent implements RestyleableComponent {
-	protected contentBBox: Rect2;
-
-	// eslint-disable-next-line @typescript-eslint/prefer-as-const
-	readonly isRestylableComponent: true = true;
-
-	/**
-	 * Creates a new text object from a list of component text or child TextComponents.
-	 *
-	 * @see {@link fromLines}
-	 */
-	public constructor(
-		protected readonly textObjects: Array<TextElement>,
-
-		// Transformation relative to this component's parent element.
-		private transform: Mat33,
-		private style: TextRenderingStyle,
-
-		// @internal
-		private transformMode: TextTransformMode = TextTransformMode.ABSOLUTE_XY,
-	) {
-		super(componentTypeId);
-		this.recomputeBBox();
-
-		// If this has no direct children, choose a style representative of this' content
-		// (useful for estimating the style of the TextComponent).
-		const hasDirectContent = textObjects.some(obj => typeof obj === 'string');
-		if (!hasDirectContent && textObjects.length > 0) {
-			this.style = (textObjects[0] as TextComponent).getTextStyle();
-		}
-	}
-
-	public static applyTextStyles(ctx: CanvasRenderingContext2D, style: TextRenderingStyle) {
-		// Quote the font family if necessary.
-		const fontFamily = style.fontFamily.match(/\s/) ? style.fontFamily.replace(/["]/g, '\\"') : style.fontFamily;
-
-		ctx.font =	[
-			style.fontStyle ?? '',
-			style.fontWeight ?? '',
-			(style.size ?? 12) + 'px',
-			`${fontFamily}`
-		].join(' ');
-
-		// TODO: Support RTL
-		ctx.textAlign = 'left';
-	}
-
-	private static textMeasuringCtx: CanvasRenderingContext2D|null = null;
-
-	// Roughly estimate the bounding box of `text`. Use if no CanvasRenderingContext2D is available.
-	private static estimateTextDimens(text: string, style: TextRenderingStyle): Rect2 {
-		const widthEst = text.length * style.size;
-		const heightEst = style.size;
-
-		// Text is drawn with (0, 0) as its baseline. As such, the majority of the text's height should
-		// be above (0, 0).
-		return new Rect2(0, -heightEst * 2/3, widthEst, heightEst);
-	}
-
-	// Returns a set of TextMetrics for the given text, if a canvas is available.
-	private static getTextMetrics(text: string, style: TextRenderingStyle): TextMetrics|null {
-		TextComponent.textMeasuringCtx ??= document.createElement('canvas').getContext('2d') ?? null;
-		if (!TextComponent.textMeasuringCtx) {
-			return null;
-		}
-
-		const ctx = TextComponent.textMeasuringCtx;
-		TextComponent.applyTextStyles(ctx, style);
-
-		return ctx.measureText(text);
-	}
-
-	// Returns the bounding box of `text`. This is approximate if no Canvas is available.
-	private static getTextDimens(text: string, style: TextRenderingStyle): Rect2 {
-		const metrics = this.getTextMetrics(text, style);
-
-		if (!metrics) {
-			return this.estimateTextDimens(text, style);
-		}
-
-		// Text is drawn with (0,0) at the bottom left of the baseline.
-		const textY = -metrics.actualBoundingBoxAscent;
-		const textHeight = metrics.actualBoundingBoxAscent + metrics.actualBoundingBoxDescent;
-		return new Rect2(0, textY, metrics.width, textHeight);
-	}
-
-	private static getFontHeight(style: TextRenderingStyle): number {
-		return style.size;
-	}
-
-	private computeUntransformedBBoxOfPart(part: TextElement) {
-		if (typeof part === 'string') {
-			return TextComponent.getTextDimens(part, this.style);
-		} else {
-			return part.contentBBox;
-		}
-	}
-
-	private recomputeBBox() {
-		let bbox: Rect2|null = null;
-		const cursor = new TextComponent.TextCursor(this.transform, this.style);
-
-		for (const textObject of this.textObjects) {
-			const transform = cursor.update(textObject);
-			const currentBBox = this.computeUntransformedBBoxOfPart(textObject).transformedBoundingBox(transform);
-
-			bbox ??= currentBBox;
-			bbox = bbox.union(currentBBox);
-		}
-
-		this.contentBBox = bbox ?? Rect2.empty;
-	}
-
-	private renderInternal(canvas: AbstractRenderer) {
-		const cursor = new TextComponent.TextCursor(this.transform, this.style);
-
-		for (const textObject of this.textObjects) {
-			const transform = cursor.update(textObject);
-
-			if (typeof textObject === 'string') {
-				canvas.drawText(textObject, transform, this.style);
-			} else {
-				canvas.pushTransform(transform);
-				textObject.renderInternal(canvas);
-				canvas.popTransform();
-			}
-		}
-	}
-
-	public override render(canvas: AbstractRenderer, _visibleRect?: Rect2): void {
-		canvas.startObject(this.contentBBox);
-		this.renderInternal(canvas);
-		canvas.endObject(this.getLoadSaveData());
-	}
-
-	public override getProportionalRenderingTime(): number {
-		return this.textObjects.length;
-	}
-
-	public override intersects(lineSegment: LineSegment2): boolean {
-		const cursor = new TextComponent.TextCursor(this.transform, this.style);
-
-		for (const subObject of this.textObjects) {
-			// Convert canvas space to internal space relative to the current object.
-			const invTransform = cursor.update(subObject).inverse();
-			const transformedLine = lineSegment.transformedBy(invTransform);
-
-			if (typeof subObject === 'string') {
-				const textBBox = TextComponent.getTextDimens(subObject, this.style);
-
-				// TODO: Use a better intersection check. Perhaps draw the text onto a CanvasElement and
-				// use pixel-testing to check for intersection with its contour.
-				if (textBBox.getEdges().some(edge => transformedLine.intersection(edge) !== null)) {
-					return true;
-				}
-			} else {
-				if (subObject.intersects(transformedLine)) {
-					return true;
-				}
-			}
-		}
-
-		return false;
-	}
-
-	public getStyle(): ComponentStyle {
-		return {
-			color: this.style.renderingStyle.fill,
-
-			// Make a copy
-			textStyle: {
-				...this.style,
-				renderingStyle: {
-					...this.style.renderingStyle,
-				},
-			},
-		};
-	}
-
-	public updateStyle(style: ComponentStyle): SerializableCommand {
-		return createRestyleComponentCommand(this.getStyle(), style, this);
-	}
-
-	public forceStyle(style: ComponentStyle, editor: Editor|null): void {
-		if (style.textStyle) {
-			this.style = cloneTextStyle(style.textStyle);
-		} else if (style.color) {
-			this.style = {
-				...this.style,
-				renderingStyle: {
-					...this.style.renderingStyle,
-					fill: style.color,
-				},
-			};
-		} else {
-			return;
-		}
-
-		for (const child of this.textObjects) {
-			if (child instanceof TextComponent) {
-				child.forceStyle(style, editor);
-			}
-		}
-
-		if (editor) {
-			editor.image.queueRerenderOf(this);
-			editor.queueRerender();
-		}
-	}
-
-	// See {@link getStyle}
-	public getTextStyle(): TextRenderingStyle {
-		return cloneTextStyle(this.style);
-	}
-
-	public getBaselinePos() {
-		return this.transform.transformVec2(Vec2.zero);
-	}
-
-	public getTransform(): Mat33 {
-		return this.transform;
-	}
-
-	protected applyTransformation(affineTransfm: Mat33): void {
-		this.transform = affineTransfm.rightMul(this.transform);
-		this.recomputeBBox();
-	}
-
-	protected createClone(): AbstractComponent {
-		const clonedTextObjects = this.textObjects.map(obj => {
-			if (typeof obj === 'string') {
-				return obj;
-			} else {
-				return obj.createClone() as TextComponent;
-			}
-		});
-		return new TextComponent(clonedTextObjects, this.transform, this.style);
-	}
-
-	public getText() {
-		const result: string[] = [];
-
-		for (const textObject of this.textObjects) {
-			if (typeof textObject === 'string') {
-				result.push(textObject);
-			} else {
-				result.push(textObject.getText());
-			}
-		}
-
-		return result.join('\n');
-	}
-
-	public description(localizationTable: ImageComponentLocalization): string {
-		return localizationTable.text(this.getText());
-	}
-
-	// Do not rely on the output of `serializeToJSON` taking any particular format.
-	protected serializeToJSON(): Record<string, any> {
-		const serializableStyle = textStyleToJSON(this.style);
-
-		const serializedTextObjects = this.textObjects.map(text => {
-			if (typeof text === 'string') {
-				return {
-					text,
-				};
-			} else {
-				return {
-					json: text.serializeToJSON(),
-				};
-			}
-		});
-
-		return {
-			textObjects: serializedTextObjects,
-			transform: this.transform.toArray(),
-			style: serializableStyle,
-		};
-	}
-
-	// @internal
-	public static deserializeFromString(json: any): TextComponent {
-		if (typeof json === 'string') {
-			json = JSON.parse(json);
-		}
-
-		const style = textStyleFromJSON(json.style);
-
-		const textObjects: Array<TextElement> = json.textObjects.map((data: any) => {
-			if ((data.text ?? null) !== null) {
-				return data.text;
-			}
-
-			return TextComponent.deserializeFromString(data.json);
-		});
-
-		json.transform = json.transform.filter((elem: any) => typeof elem === 'number');
-		if (json.transform.length !== 9) {
-			throw new Error(`Unable to deserialize transform, ${json.transform}.`);
-		}
-
-		const transformData = json.transform as Mat33Array;
-		const transform = new Mat33(...transformData);
-
-		return new TextComponent(textObjects, transform, style);
-	}
-
-	/**
-	 * Creates a `TextComponent` from `lines`.
-	 *
-	 * @example
-	 * ```ts
-	 * const textStyle = {
-	 *   size: 12,
-	 *   fontFamily: 'serif',
-	 *   renderingStyle: { fill: Color4.black },
-	 * };
-	 *
-	 * const text = TextComponent.fromLines('foo\nbar'.split('\n'), Mat33.identity, textStyle);
-	 * ```
-	 */
-	public static fromLines(lines: string[], transform: Mat33, style: TextRenderingStyle): AbstractComponent {
-		let lastComponent: TextComponent|null = null;
-		const components: TextComponent[] = [];
-
-		const lineMargin = Math.round(this.getFontHeight(style));
-
-		let position = Vec2.zero;
-		for (const line of lines) {
-			if (lastComponent) {
-				position = position.plus(Vec2.unitY.times(lineMargin));
-			}
-
-			const component = new TextComponent([ line ], Mat33.translation(position), style);
-			components.push(component);
-			lastComponent = component;
-		}
-
-		return new TextComponent(components, transform, style);
-	}
-
-	private static TextCursor = class {
-		public transform: Mat33 = Mat33.identity;
-		public constructor(
-			private parentTransform: Mat33 = Mat33.identity, private parentStyle: TextRenderingStyle
-		) { }
-
-		/**
-		 * Based on previous calls to `update`, returns the transformation of
-		 * the given `element` (including the parentTransform given to this cursor's
-		 * constructor).
-		 *
-		 * The result does not take into account
-		 */
-		public update(elem: TextElement) {
-			let elementTransform = Mat33.identity;
-			let elemInternalTransform = Mat33.identity;
-			let textSize;
-			if (typeof(elem) === 'string') {
-				textSize = TextComponent.getTextDimens(elem, this.parentStyle);
-			} else {
-				// TODO: Double-check whether we need to take elem.transform into account here.
-				// elementTransform = elem.transform;
-				elemInternalTransform = elem.transform;
-				textSize = elem.getBBox();
-			}
-			const positioning = typeof(elem) === 'string' ? TextTransformMode.RELATIVE_XY : elem.transformMode;
-
-			if (positioning === TextTransformMode.RELATIVE_XY) {
-				// Position relative to the previous element's transform.
-				elementTransform = this.transform.rightMul(elementTransform);
-			} else if (positioning === TextTransformMode.RELATIVE_X_ABSOLUTE_Y || positioning === TextTransformMode.RELATIVE_Y_ABSOLUTE_X) {
-				// Zero the absolute component of this.transform's translation
-				const transform = this.transform.mapEntries((component, [row, col]) => {
-					if (positioning === TextTransformMode.RELATIVE_X_ABSOLUTE_Y) {
-						// Zero the y component of this.transform's translation
-						return row === 1 && col === 2 ? 0 : component;
-					} else if (positioning === TextTransformMode.RELATIVE_Y_ABSOLUTE_X) {
-						// Zero the x component of this.transform's translation
-						return row === 0 && col === 2 ? 0 : component;
-					}
-
-					throw new Error('Unreachable');
-					return 0;
-				});
-
-				elementTransform = transform.rightMul(elementTransform);
-			}
-
-			// Update this.transform so that future calls to update return correct values.
-			const endShiftTransform = Mat33.translation(Vec2.of(textSize.width, 0));
-			this.transform = elementTransform.rightMul(elemInternalTransform).rightMul(endShiftTransform);
-
-			return this.parentTransform.rightMul(elementTransform);
-		}
-	};
-}
-
-AbstractComponent.registerComponent(componentTypeId, (data: string) => TextComponent.deserializeFromString(data));

package/src/components/UnknownSVGObject.test.ts

@@ -1,10 +0,0 @@
-import AbstractComponent from './AbstractComponent';
-import UnknownSVGObject from './UnknownSVGObject';
-
-describe('UnknownSVGObject', () => {
-	it('should not be deserializable', () => {
-		const obj = new UnknownSVGObject(document.createElementNS('http://www.w3.org/2000/svg', 'circle'));
-		const serialized = obj.serialize();
-		expect(() => AbstractComponent.deserialize(serialized)).toThrow(/.*cannot be deserialized.*/);
-	});
-});

package/src/components/UnknownSVGObject.ts

@@ -1,60 +0,0 @@
-//
-// Stores objects loaded from an SVG that aren't recognised by the editor.
-// @internal
-// @packageDocumentation
-//
-
-import { LineSegment2, Mat33, Rect2 } from '@js-draw/math';
-import AbstractRenderer from '../rendering/renderers/AbstractRenderer';
-import SVGRenderer from '../rendering/renderers/SVGRenderer';
-import AbstractComponent from './AbstractComponent';
-import { ImageComponentLocalization } from './localization';
-
-const componentId = 'unknown-svg-object';
-export default class UnknownSVGObject extends AbstractComponent {
-	protected contentBBox: Rect2;
-
-	public constructor(private svgObject: SVGElement) {
-		super(componentId);
-		this.contentBBox = Rect2.of(svgObject.getBoundingClientRect());
-	}
-
-	public override render(canvas: AbstractRenderer, _visibleRect?: Rect2): void {
-		if (!(canvas instanceof SVGRenderer)) {
-			// Don't draw unrenderable objects if we can't
-			return;
-		}
-
-		canvas.startObject(this.contentBBox);
-		canvas.drawSVGElem(this.svgObject);
-		canvas.endObject(this.getLoadSaveData());
-	}
-
-	public override intersects(lineSegment: LineSegment2): boolean {
-		return this.contentBBox.getEdges().some(edge => edge.intersection(lineSegment) !== null);
-	}
-
-	protected applyTransformation(_affineTransfm: Mat33): void {
-	}
-
-	public override isSelectable() {
-		return false;
-	}
-
-	protected createClone(): AbstractComponent {
-		return new UnknownSVGObject(this.svgObject.cloneNode(true) as SVGElement);
-	}
-
-	public description(localization: ImageComponentLocalization): string {
-		return localization.svgObject;
-	}
-
-	protected serializeToJSON(): string | null {
-		return JSON.stringify({
-			html: this.svgObject.outerHTML,
-		});
-	}
-}
-
-// null: Do not deserialize UnknownSVGObjects.
-AbstractComponent.registerComponent(componentId, null);

package/src/components/builders/ArrowBuilder.ts

@@ -1,106 +0,0 @@
-import { Path, PathCommandType, Rect2 } from '@js-draw/math';
-import AbstractRenderer from '../../rendering/renderers/AbstractRenderer';
-import { StrokeDataPoint } from '../../types';
-import Viewport from '../../Viewport';
-import AbstractComponent from '../AbstractComponent';
-import Stroke from '../Stroke';
-import { ComponentBuilder, ComponentBuilderFactory } from './types';
-
-export const makeArrowBuilder: ComponentBuilderFactory = (initialPoint: StrokeDataPoint, viewport: Viewport) => {
-	return new ArrowBuilder(initialPoint, viewport);
-};
-
-export default class ArrowBuilder implements ComponentBuilder {
-	private endPoint: StrokeDataPoint;
-
-	public constructor(private readonly startPoint: StrokeDataPoint, private readonly viewport: Viewport) {
-		this.endPoint = startPoint;
-	}
-
-	private getLineWidth(): number {
-		return Math.max(this.endPoint.width, this.startPoint.width);
-	}
-
-	public getBBox(): Rect2 {
-		const preview = this.buildPreview();
-		return preview.getBBox();
-	}
-
-	private buildPreview(): Stroke {
-		const lineStartPoint = this.startPoint.pos;
-		const endPoint = this.endPoint.pos;
-		const toEnd = endPoint.minus(lineStartPoint).normalized();
-		const arrowLength = endPoint.minus(lineStartPoint).length();
-
-		// Ensure that the arrow tip is smaller than the arrow.
-		const arrowTipSize = Math.min(this.getLineWidth(), arrowLength / 2);
-		const startSize = this.startPoint.width / 2;
-		const endSize = this.endPoint.width / 2;
-
-		const arrowTipBase = endPoint.minus(toEnd.times(arrowTipSize));
-
-		// Scaled normal vectors.
-		const lineNormal = toEnd.orthog();
-		const scaledStartNormal = lineNormal.times(startSize);
-		const scaledBaseNormal = lineNormal.times(endSize);
-
-		const path = new Path(arrowTipBase.minus(scaledBaseNormal), [
-			// Stem
-			{
-				kind: PathCommandType.LineTo,
-				point: lineStartPoint.minus(scaledStartNormal),
-			},
-			{
-				kind: PathCommandType.LineTo,
-				point: lineStartPoint.plus(scaledStartNormal),
-			},
-			{
-				kind: PathCommandType.LineTo,
-				point: arrowTipBase.plus(scaledBaseNormal),
-			},
-
-			// Head
-			{
-				kind: PathCommandType.LineTo,
-				point: arrowTipBase.plus(lineNormal.times(arrowTipSize).plus(scaledBaseNormal)),
-			},
-			{
-				kind: PathCommandType.LineTo,
-				point: endPoint.plus(toEnd.times(endSize)),
-			},
-			{
-				kind: PathCommandType.LineTo,
-				point: arrowTipBase.plus(lineNormal.times(-arrowTipSize).minus(scaledBaseNormal)),
-			},
-			{
-				kind: PathCommandType.LineTo,
-				point: arrowTipBase.minus(scaledBaseNormal),
-			},
-		// Round all points in the arrow (to remove unnecessary decimal places)
-		]).mapPoints(point => this.viewport.roundPoint(point));
-
-		const preview = new Stroke([
-			{
-				startPoint: path.startPoint,
-				commands: path.parts,
-				style: {
-					fill: this.startPoint.color,
-				}
-			}
-		]);
-
-		return preview;
-	}
-
-	public build(): AbstractComponent {
-		return this.buildPreview();
-	}
-
-	public preview(renderer: AbstractRenderer): void {
-		this.buildPreview().render(renderer);
-	}
-
-	public addPoint(point: StrokeDataPoint): void {
-		this.endPoint = point;
-	}
-}

package/src/components/builders/CircleBuilder.ts

@@ -1,100 +0,0 @@
-import { Vec2, Path, PathCommand, PathCommandType, Rect2, Color4 } from '@js-draw/math';
-import AbstractRenderer from '../../rendering/renderers/AbstractRenderer';
-import { pathToRenderable } from '../../rendering/RenderablePathSpec';
-import { StrokeDataPoint } from '../../types';
-import Viewport from '../../Viewport';
-import AbstractComponent from '../AbstractComponent';
-import Stroke from '../Stroke';
-import { ComponentBuilder, ComponentBuilderFactory } from './types';
-
-export const makeOutlinedCircleBuilder: ComponentBuilderFactory = (initialPoint: StrokeDataPoint, viewport: Viewport) => {
-	return new CircleBuilder(initialPoint, viewport);
-};
-
-class CircleBuilder implements ComponentBuilder {
-	private endPoint: StrokeDataPoint;
-
-	public constructor(
-		private readonly startPoint: StrokeDataPoint,
-		private readonly viewport: Viewport,
-	) {
-		// Initially, the start and end points are the same.
-		this.endPoint = startPoint;
-	}
-
-	public getBBox(): Rect2 {
-		const preview = this.buildPreview();
-		return preview.getBBox();
-	}
-
-	private buildPreview(): Stroke {
-		const pathCommands: PathCommand[] = [];
-		const numDivisions = 6;
-		const stepSize = Math.PI * 2 / numDivisions;
-
-		// Round the stroke width so that when exported it doesn't have unnecessary trailing decimals.
-		const strokeWidth =
-			Viewport.roundPoint(this.endPoint.width, 5 / this.viewport.getScaleFactor());
-
-		const center = this.startPoint.pos.lerp(this.endPoint.pos, 0.5);
-		const startEndDelta = this.endPoint.pos.minus(center);
-		const radius = startEndDelta.length() - strokeWidth / 2;
-
-		const startPoint = center.plus(Vec2.of(radius, 0));
-
-		for (let t = stepSize; t <= Math.PI * 2; t += stepSize) {
-			const endPoint = Vec2.of(
-				radius * Math.cos(t),
-				-radius * Math.sin(t),
-			).plus(center);
-
-			// controlPointRadiusScale is selected to make the circles appear circular and
-			// **does** depend on stepSize.
-			const controlPointRadiusScale = 1.141;
-			const controlPoint = Vec2.of(
-				Math.cos(t - stepSize / 2),
-				-Math.sin(t - stepSize / 2),
-			).times(
-				radius * controlPointRadiusScale
-			).plus(center);
-
-			pathCommands.push({
-				kind: PathCommandType.QuadraticBezierTo,
-				controlPoint,
-				endPoint,
-			});
-		}
-
-		pathCommands.push({
-			kind: PathCommandType.LineTo,
-			point: startPoint,
-		});
-
-		const path = new Path(startPoint, pathCommands)
-			.mapPoints(point => this.viewport.roundPoint(point));
-
-		const preview = new Stroke([
-			pathToRenderable(path, {
-				fill: Color4.transparent,
-				stroke: {
-					width: strokeWidth,
-					color: this.endPoint.color,
-				},
-			}),
-		]);
-
-		return preview;
-	}
-
-	public build(): AbstractComponent {
-		return this.buildPreview();
-	}
-
-	public preview(renderer: AbstractRenderer): void {
-		this.buildPreview().render(renderer);
-	}
-
-	public addPoint(point: StrokeDataPoint): void {
-		this.endPoint = point;
-	}
-}