Compare commits

...

5 Commits

Author SHA1 Message Date
dwelle 0256559b68 improve balls 2026-04-03 19:51:41 +02:00
dwelle c9d29ea600 improve miter 2026-04-03 19:36:06 +02:00
dwelle 90c4770a5b improve smoothing 2026-04-03 19:23:26 +02:00
dwelle e48043aef5 remove raf & batching 2026-04-03 19:18:45 +02:00
dwelle 3e53dcd956 wip 2026-04-03 16:34:26 +02:00
29 changed files with 1152 additions and 69 deletions
+5 -2
View File
@@ -405,8 +405,9 @@ export const ROUGHNESS = {
export const STROKE_WIDTH = { export const STROKE_WIDTH = {
thin: 1, thin: 1,
bold: 2, medium: 2,
extraBold: 4, bold: 4,
extraBold: 8,
} as const; } as const;
export const DEFAULT_ELEMENT_PROPS: { export const DEFAULT_ELEMENT_PROPS: {
@@ -429,6 +430,8 @@ export const DEFAULT_ELEMENT_PROPS: {
locked: false, locked: false,
}; };
export const DEFAULT_FREE_DRAW_STROKE_SHAPE = "variable" as const;
export const LIBRARY_SIDEBAR_TAB = "library"; export const LIBRARY_SIDEBAR_TAB = "library";
export const CANVAS_SEARCH_TAB = "search"; export const CANVAS_SEARCH_TAB = "search";
+11 -8
View File
@@ -168,12 +168,14 @@ export class ElementBounds {
), ),
), ),
); );
const padding =
element.strokeShape === "fixed" ? element.strokeWidth / 2 : 0;
return [ return [
minX + element.x, minX + element.x - padding,
minY + element.y, minY + element.y - padding,
maxX + element.x, maxX + element.x + padding,
maxY + element.y, maxY + element.y + padding,
]; ];
} else if (isLinearElement(element)) { } else if (isLinearElement(element)) {
bounds = getLinearElementRotatedBounds(element, cx, cy, elementsMap); bounds = getLinearElementRotatedBounds(element, cx, cy, elementsMap);
@@ -703,10 +705,11 @@ const getFreeDrawElementAbsoluteCoords = (
element: ExcalidrawFreeDrawElement, element: ExcalidrawFreeDrawElement,
): [number, number, number, number, number, number] => { ): [number, number, number, number, number, number] => {
const [minX, minY, maxX, maxY] = getBoundsFromPoints(element.points); const [minX, minY, maxX, maxY] = getBoundsFromPoints(element.points);
const x1 = minX + element.x; const padding = element.strokeShape === "fixed" ? element.strokeWidth / 2 : 0;
const y1 = minY + element.y; const x1 = minX + element.x - padding;
const x2 = maxX + element.x; const y1 = minY + element.y - padding;
const y2 = maxY + element.y; const x2 = maxX + element.x + padding;
const y2 = maxY + element.y + padding;
return [x1, y1, x2, y2, (x1 + x2) / 2, (y1 + y2) / 2]; return [x1, y1, x2, y2, (x1 + x2) / 2, (y1 + y2) / 2];
}; };
+4 -3
View File
@@ -27,6 +27,7 @@ import type {
import type { FrameNameBounds } from "@excalidraw/excalidraw/types"; import type { FrameNameBounds } from "@excalidraw/excalidraw/types";
import { isLoopFreeDrawElement } from "./freedraw";
import { isPathALoop } from "./utils"; import { isPathALoop } from "./utils";
import { import {
doBoundsIntersect, doBoundsIntersect,
@@ -93,7 +94,7 @@ export const shouldTestInside = (element: ExcalidrawElement) => {
} }
if (element.type === "freedraw") { if (element.type === "freedraw") {
return isDraggableFromInside && isPathALoop(element.points); return isDraggableFromInside && isLoopFreeDrawElement(element);
} }
return isDraggableFromInside || isImageElement(element); return isDraggableFromInside || isImageElement(element);
@@ -754,8 +755,8 @@ export const isPointInElement = (
elementsMap: ElementsMap, elementsMap: ElementsMap,
) => { ) => {
if ( if (
(isLinearElement(element) || isFreeDrawElement(element)) && (isLinearElement(element) && !isPathALoop(element.points)) ||
!isPathALoop(element.points) (isFreeDrawElement(element) && !isLoopFreeDrawElement(element))
) { ) {
// There isn't any "inside" for a non-looping path // There isn't any "inside" for a non-looping path
return false; return false;
+181
View File
@@ -0,0 +1,181 @@
import {
pointDistance,
vectorCross,
vectorDot,
vectorFromPoint,
} from "@excalidraw/math";
import type { LocalPoint } from "@excalidraw/math";
import { isPathALoop } from "./utils";
import type { ExcalidrawFreeDrawElement } from "./types";
type ZoomValue = NonNullable<Parameters<typeof isPathALoop>[1]>;
type FixedFreeDrawSimplificationProfile = {
minPointDistancePx: number;
maxPointDistance: number;
strokeDistanceFactor: number;
collinearityFactor: number;
minAlignment: number;
zoomScaling: "sqrt" | "none";
};
const FIXED_FREEDRAW_CAPTURE_PROFILE: FixedFreeDrawSimplificationProfile = {
minPointDistancePx: 0.35,
maxPointDistance: 0.85,
strokeDistanceFactor: 0.08,
collinearityFactor: 0.3,
minAlignment: 0.985,
zoomScaling: "sqrt",
};
const hasSyntheticLoopClosure = (
points: readonly LocalPoint[],
): points is readonly [LocalPoint, LocalPoint, ...LocalPoint[]] => {
if (points.length < 3) {
return false;
}
const firstPoint = points[0];
const lastPoint = points[points.length - 1];
return firstPoint[0] === lastPoint[0] && firstPoint[1] === lastPoint[1];
};
const stripSyntheticLoopClosure = (points: readonly LocalPoint[]) =>
hasSyntheticLoopClosure(points) ? points.slice(0, -1) : points;
export const isLoopFreeDrawElement = (
element: ExcalidrawFreeDrawElement,
zoomValue: ZoomValue = 1 as ZoomValue,
) => element.strokeShape !== "fixed" && isPathALoop(element.points, zoomValue);
export const getFixedFreeDrawPoints = (
element: ExcalidrawFreeDrawElement,
): readonly LocalPoint[] => stripSyntheticLoopClosure(element.points);
export const getFixedFreeDrawPointSamplingDistance = (
strokeWidth: number,
zoomValue: ZoomValue = 1 as ZoomValue,
profile: FixedFreeDrawSimplificationProfile = FIXED_FREEDRAW_CAPTURE_PROFILE,
) =>
Math.min(
Math.max(
profile.minPointDistancePx /
(profile.zoomScaling === "sqrt"
? Math.max(1, Math.sqrt(zoomValue))
: 1),
strokeWidth * profile.strokeDistanceFactor,
),
profile.maxPointDistance,
);
const isRedundantFixedFreeDrawPoint = (
previousPoint: LocalPoint,
currentPoint: LocalPoint,
nextPoint: LocalPoint,
strokeWidth: number,
zoomValue: ZoomValue,
profile: FixedFreeDrawSimplificationProfile,
) => {
const previousSegmentLength = pointDistance(previousPoint, currentPoint);
const nextSegmentLength = pointDistance(currentPoint, nextPoint);
if (!previousSegmentLength || !nextSegmentLength) {
return true;
}
const previousVector = vectorFromPoint(currentPoint, previousPoint);
const nextVector = vectorFromPoint(nextPoint, currentPoint);
const alignment =
vectorDot(previousVector, nextVector) /
(previousSegmentLength * nextSegmentLength);
if (alignment < profile.minAlignment) {
return false;
}
const chord = vectorFromPoint(nextPoint, previousPoint);
const chordLength = pointDistance(previousPoint, nextPoint);
if (!chordLength) {
return true;
}
const distanceToChord =
Math.abs(vectorCross(vectorFromPoint(currentPoint, previousPoint), chord)) /
chordLength;
return (
distanceToChord <=
getFixedFreeDrawPointSamplingDistance(strokeWidth, zoomValue, profile) *
profile.collinearityFactor
);
};
export const getFixedFreeDrawPointAction = ({
points,
nextPoint,
strokeWidth,
zoomValue,
isFinalPoint = false,
profile,
}: {
points: readonly LocalPoint[];
nextPoint: LocalPoint;
strokeWidth: number;
zoomValue: ZoomValue;
isFinalPoint?: boolean;
profile?: FixedFreeDrawSimplificationProfile;
}) => {
const simplificationProfile = profile ?? FIXED_FREEDRAW_CAPTURE_PROFILE;
const lastPoint = points[points.length - 1];
if (!lastPoint) {
return "append" as const;
}
if (lastPoint[0] === nextPoint[0] && lastPoint[1] === nextPoint[1]) {
return "discard" as const;
}
const samplingDistance = getFixedFreeDrawPointSamplingDistance(
strokeWidth,
zoomValue,
simplificationProfile,
);
if (points.length === 1) {
return !isFinalPoint &&
pointDistance(lastPoint, nextPoint) < samplingDistance
? ("discard" as const)
: ("append" as const);
}
const previousPoint = points[points.length - 2];
if (
isRedundantFixedFreeDrawPoint(
previousPoint,
lastPoint,
nextPoint,
strokeWidth,
zoomValue,
simplificationProfile,
)
) {
return "replace" as const;
}
if (!isFinalPoint && pointDistance(lastPoint, nextPoint) < samplingDistance) {
return "discard" as const;
}
return "append" as const;
};
export const getRenderableFixedFreeDrawPoints = (
element: ExcalidrawFreeDrawElement,
): readonly LocalPoint[] => getFixedFreeDrawPoints(element);
+1
View File
@@ -69,6 +69,7 @@ export * from "./duplicate";
export * from "./elbowArrow"; export * from "./elbowArrow";
export * from "./elementLink"; export * from "./elementLink";
export * from "./embeddable"; export * from "./embeddable";
export * from "./freedraw";
export * from "./flowchart"; export * from "./flowchart";
export * from "./arrows/focus"; export * from "./arrows/focus";
export * from "./fractionalIndex"; export * from "./fractionalIndex";
+27
View File
@@ -1,4 +1,5 @@
import { import {
DEFAULT_FREE_DRAW_STROKE_SHAPE,
getSizeFromPoints, getSizeFromPoints,
randomInteger, randomInteger,
getUpdatedTimestamp, getUpdatedTimestamp,
@@ -18,6 +19,8 @@ import type {
ElementsMap, ElementsMap,
ExcalidrawElbowArrowElement, ExcalidrawElbowArrowElement,
ExcalidrawElement, ExcalidrawElement,
ExcalidrawFreeDrawElement,
FreeDrawStrokeShape,
NonDeletedSceneElementsMap, NonDeletedSceneElementsMap,
} from "./types"; } from "./types";
@@ -177,6 +180,30 @@ export const newElementWith = <TElement extends ExcalidrawElement>(
}; };
}; };
export const newFreeDrawElementWithStrokeShape = <
TElement extends ExcalidrawFreeDrawElement,
>(
element: TElement,
strokeShape: FreeDrawStrokeShape,
): TElement => {
if (strokeShape === DEFAULT_FREE_DRAW_STROKE_SHAPE) {
if (!("strokeShape" in element)) {
return element;
}
const nextElement = newElementWith(
element,
{} as ElementUpdate<TElement>,
true,
);
delete (nextElement as Mutable<Partial<TElement>>).strokeShape;
return nextElement;
}
return newElementWith(element, {
strokeShape,
} as ElementUpdate<TElement>);
};
/** /**
* Mutates element, bumping `version`, `versionNonce`, and `updated`. * Mutates element, bumping `version`, `versionNonce`, and `updated`.
* *
+2
View File
@@ -445,6 +445,7 @@ export const newFreeDrawElement = (
points?: ExcalidrawFreeDrawElement["points"]; points?: ExcalidrawFreeDrawElement["points"];
simulatePressure: boolean; simulatePressure: boolean;
pressures?: ExcalidrawFreeDrawElement["pressures"]; pressures?: ExcalidrawFreeDrawElement["pressures"];
strokeShape?: ExcalidrawFreeDrawElement["strokeShape"];
} & ElementConstructorOpts, } & ElementConstructorOpts,
): NonDeleted<ExcalidrawFreeDrawElement> => { ): NonDeleted<ExcalidrawFreeDrawElement> => {
return { return {
@@ -452,6 +453,7 @@ export const newFreeDrawElement = (
points: opts.points || [], points: opts.points || [],
pressures: opts.pressures || [], pressures: opts.pressures || [],
simulatePressure: opts.simulatePressure, simulatePressure: opts.simulatePressure,
...(opts.strokeShape === "fixed" ? { strokeShape: opts.strokeShape } : {}),
}; };
}; };
+13 -2
View File
@@ -417,16 +417,27 @@ const drawElementOnCanvas = (
case "freedraw": { case "freedraw": {
// Draw directly to canvas // Draw directly to canvas
context.save(); context.save();
context.lineJoin = "round";
context.lineCap = "round";
const shapes = ShapeCache.generateElementShape(element, renderConfig); const shapes = ShapeCache.generateElementShape(element, renderConfig);
const isFixedStroke = element.strokeShape === "fixed";
for (const shape of shapes) { for (const shape of shapes) {
if (typeof shape === "string") { if (typeof shape === "string") {
context.fillStyle = const strokeColor =
renderConfig.theme === THEME.DARK renderConfig.theme === THEME.DARK
? applyDarkModeFilter(element.strokeColor) ? applyDarkModeFilter(element.strokeColor)
: element.strokeColor; : element.strokeColor;
context.fill(new Path2D(shape));
if (isFixedStroke) {
context.strokeStyle = strokeColor;
context.lineWidth = element.strokeWidth;
context.stroke(new Path2D(shape));
} else {
context.fillStyle = strokeColor;
context.fill(new Path2D(shape));
}
} else { } else {
rc.draw(shape); rc.draw(shape);
} }
+236 -9
View File
@@ -1,4 +1,5 @@
import { simplify } from "points-on-curve"; import { simplify } from "points-on-curve";
import { DEFAULT_FREE_DRAW_STROKE_SHAPE } from "@excalidraw/common";
import { getStroke } from "perfect-freehand"; import { getStroke } from "perfect-freehand";
import { import {
@@ -13,6 +14,7 @@ import {
import { import {
pointFrom, pointFrom,
pointDistance, pointDistance,
round,
type LocalPoint, type LocalPoint,
pointRotateRads, pointRotateRads,
} from "@excalidraw/math"; } from "@excalidraw/math";
@@ -52,6 +54,10 @@ import {
isIframeLikeElement, isIframeLikeElement,
isLinearElement, isLinearElement,
} from "./typeChecks"; } from "./typeChecks";
import {
getRenderableFixedFreeDrawPoints,
isLoopFreeDrawElement,
} from "./freedraw";
import { getCornerRadius, isPathALoop } from "./utils"; import { getCornerRadius, isPathALoop } from "./utils";
import { headingForPointIsHorizontal } from "./heading"; import { headingForPointIsHorizontal } from "./heading";
@@ -244,7 +250,12 @@ export const generateRoughOptions = (
} }
case "line": case "line":
case "freedraw": { case "freedraw": {
if (isPathALoop(element.points)) { const isLoop =
element.type === "freedraw"
? isLoopFreeDrawElement(element)
: isPathALoop(element.points);
if (isLoop) {
options.fillStyle = element.fillStyle; options.fillStyle = element.fillStyle;
options.fill = options.fill =
element.backgroundColor === "transparent" element.backgroundColor === "transparent"
@@ -966,7 +977,7 @@ const _generateElementShape = (
const shapes: ElementShapes[typeof element.type] = []; const shapes: ElementShapes[typeof element.type] = [];
// (1) background fill (rc shape), optional // (1) background fill (rc shape), optional
if (isPathALoop(element.points)) { if (isLoopFreeDrawElement(element)) {
// generate rough polygon to fill freedraw shape // generate rough polygon to fill freedraw shape
const simplifiedPoints = simplify( const simplifiedPoints = simplify(
element.points as Mutable<LocalPoint[]>, element.points as Mutable<LocalPoint[]>,
@@ -1173,6 +1184,13 @@ export const toggleLinePolygonState = (
// NOTE not cached (-> for SVG export) // NOTE not cached (-> for SVG export)
const getFreeDrawSvgPath = (element: ExcalidrawFreeDrawElement) => { const getFreeDrawSvgPath = (element: ExcalidrawFreeDrawElement) => {
if (element.strokeShape === "fixed") {
return getSvgPathFromFixedFreeDrawPoints(
getRenderableFixedFreeDrawPoints(element),
element.strokeWidth,
) as SVGPathString;
}
return getSvgPathFromStroke( return getSvgPathFromStroke(
getFreedrawOutlinePoints(element), getFreedrawOutlinePoints(element),
) as SVGPathString; ) as SVGPathString;
@@ -1181,34 +1199,243 @@ const getFreeDrawSvgPath = (element: ExcalidrawFreeDrawElement) => {
export const getFreedrawOutlinePoints = ( export const getFreedrawOutlinePoints = (
element: ExcalidrawFreeDrawElement, element: ExcalidrawFreeDrawElement,
) => { ) => {
const strokeShape = element.strokeShape ?? DEFAULT_FREE_DRAW_STROKE_SHAPE;
const isFixedStroke = strokeShape === "fixed";
// If input points are empty (should they ever be?) return a dot // If input points are empty (should they ever be?) return a dot
const inputPoints = element.simulatePressure const inputPoints = isFixedStroke
? element.points.length
? element.points
: [[0, 0]]
: element.simulatePressure
? element.points ? element.points
: element.points.length : element.points.length
? element.points.map(([x, y], i) => [x, y, element.pressures[i]]) ? element.points.map(([x, y], i) => [x, y, element.pressures[i]])
: [[0, 0, 0.5]]; : [[0, 0, 0.5]];
return getStroke(inputPoints as number[][], { return getStroke(inputPoints as number[][], {
simulatePressure: element.simulatePressure, simulatePressure: isFixedStroke ? false : element.simulatePressure,
size: element.strokeWidth * 4.25, size: isFixedStroke ? element.strokeWidth : element.strokeWidth * 4.25,
thinning: 0.6, thinning: isFixedStroke ? 0 : 0.6,
smoothing: 0.5, smoothing: 0.5,
streamline: 0.5, streamline: 0.5,
easing: (t) => Math.sin((t * Math.PI) / 2), // https://easings.net/#easeOutSine easing: isFixedStroke ? (t) => t : (t) => Math.sin((t * Math.PI) / 2), // https://easings.net/#easeOutSine
last: true, last: true,
}) as [number, number][]; }) as [number, number][];
}; };
const med = (A: number[], B: number[]) => { const med = (A: readonly number[], B: readonly number[]) => {
return [(A[0] + B[0]) / 2, (A[1] + B[1]) / 2]; return [(A[0] + B[0]) / 2, (A[1] + B[1]) / 2];
}; };
const roundPoint = (point: readonly number[]) =>
`${round(point[0], 2)},${round(point[1], 2)} `;
const averagePoint = (A: readonly number[], B: readonly number[]) =>
`${round((A[0] + B[0]) / 2, 2)},${round((A[1] + B[1]) / 2, 2)} `;
const getReadonlyPointDistance = (
pointA: readonly number[],
pointB: readonly number[],
) => Math.hypot(pointA[0] - pointB[0], pointA[1] - pointB[1]);
// Trim SVG path data so number are each two decimal points. This // Trim SVG path data so number are each two decimal points. This
// improves SVG exports, and prevents rendering errors on points // improves SVG exports, and prevents rendering errors on points
// with long decimals. // with long decimals.
const TO_FIXED_PRECISION = /(\s?[A-Z]?,?-?[0-9]*\.[0-9]{0,2})(([0-9]|e|-)*)/g; const TO_FIXED_PRECISION = /(\s?[A-Z]?,?-?[0-9]*\.[0-9]{0,2})(([0-9]|e|-)*)/g;
const getSvgPathFromStroke = (points: number[][]): string => { const getSvgPathFromPoints = (
points: ReadonlyArray<readonly number[]>,
closed = false,
): string => {
const len = points.length;
if (len < 2) {
return "";
}
const path = points
.slice(1)
.map((point) => `L${roundPoint(point)}`)
.join("");
return `M${roundPoint(points[0])}${path}${closed ? "Z" : ""}`;
};
const FIXED_FREEDRAW_MIN_SMOOTH_ALIGNMENT = 0.6;
const FIXED_FREEDRAW_MIN_SMOOTH_SEGMENT_LENGTH = 0.2;
const FIXED_FREEDRAW_MIN_CORNER_ALIGNMENT = -0.25;
const FIXED_FREEDRAW_MIN_CORNER_ROUNDING = 0.75;
const FIXED_FREEDRAW_MAX_CORNER_ROUNDING = 6;
const FIXED_FREEDRAW_CORNER_ROUNDING_FACTOR = 0.35;
const FIXED_FREEDRAW_CORNER_ROUNDING_WIDTH_FACTOR = 1.5;
const FIXED_FREEDRAW_MIN_TERMINAL_STUB = 0.75;
const FIXED_FREEDRAW_MAX_TERMINAL_STUB = 2.5;
const FIXED_FREEDRAW_TERMINAL_STUB_WIDTH_FACTOR = 1.5;
const shouldSmoothFixedFreeDrawPoint = (
previousPoint: readonly number[],
currentPoint: readonly number[],
nextPoint: readonly number[],
) => {
const previousDeltaX = currentPoint[0] - previousPoint[0];
const previousDeltaY = currentPoint[1] - previousPoint[1];
const nextDeltaX = nextPoint[0] - currentPoint[0];
const nextDeltaY = nextPoint[1] - currentPoint[1];
const previousSegmentLength = Math.hypot(previousDeltaX, previousDeltaY);
const nextSegmentLength = Math.hypot(nextDeltaX, nextDeltaY);
if (
previousSegmentLength < FIXED_FREEDRAW_MIN_SMOOTH_SEGMENT_LENGTH ||
nextSegmentLength < FIXED_FREEDRAW_MIN_SMOOTH_SEGMENT_LENGTH
) {
return false;
}
const alignment =
(previousDeltaX * nextDeltaX + previousDeltaY * nextDeltaY) /
(previousSegmentLength * nextSegmentLength);
return alignment >= FIXED_FREEDRAW_MIN_SMOOTH_ALIGNMENT;
};
const getFixedFreeDrawRoundedCorner = (
previousPoint: readonly number[],
currentPoint: readonly number[],
nextPoint: readonly number[],
strokeWidth: number,
) => {
const previousDeltaX = currentPoint[0] - previousPoint[0];
const previousDeltaY = currentPoint[1] - previousPoint[1];
const nextDeltaX = nextPoint[0] - currentPoint[0];
const nextDeltaY = nextPoint[1] - currentPoint[1];
const previousSegmentLength = Math.hypot(previousDeltaX, previousDeltaY);
const nextSegmentLength = Math.hypot(nextDeltaX, nextDeltaY);
if (!previousSegmentLength || !nextSegmentLength) {
return null;
}
const alignment =
(previousDeltaX * nextDeltaX + previousDeltaY * nextDeltaY) /
(previousSegmentLength * nextSegmentLength);
if (
alignment >= FIXED_FREEDRAW_MIN_SMOOTH_ALIGNMENT ||
alignment <= FIXED_FREEDRAW_MIN_CORNER_ALIGNMENT
) {
return null;
}
const cornerRounding = Math.min(
Math.max(
strokeWidth * FIXED_FREEDRAW_CORNER_ROUNDING_WIDTH_FACTOR,
FIXED_FREEDRAW_MIN_CORNER_ROUNDING,
),
previousSegmentLength * FIXED_FREEDRAW_CORNER_ROUNDING_FACTOR,
nextSegmentLength * FIXED_FREEDRAW_CORNER_ROUNDING_FACTOR,
FIXED_FREEDRAW_MAX_CORNER_ROUNDING,
);
if (!cornerRounding) {
return null;
}
return {
entryPoint: [
currentPoint[0] - (previousDeltaX / previousSegmentLength) * cornerRounding,
currentPoint[1] - (previousDeltaY / previousSegmentLength) * cornerRounding,
] as const,
exitPoint: [
currentPoint[0] + (nextDeltaX / nextSegmentLength) * cornerRounding,
currentPoint[1] + (nextDeltaY / nextSegmentLength) * cornerRounding,
] as const,
};
};
const getFixedFreeDrawTerminalStubThreshold = (strokeWidth: number) =>
Math.min(
Math.max(
strokeWidth * FIXED_FREEDRAW_TERMINAL_STUB_WIDTH_FACTOR,
FIXED_FREEDRAW_MIN_TERMINAL_STUB,
),
FIXED_FREEDRAW_MAX_TERMINAL_STUB,
);
const getSvgPathFromFixedFreeDrawPoints = (
points: ReadonlyArray<readonly number[]>,
strokeWidth: number,
): string => {
const len = points.length;
if (len < 2) {
return "";
}
if (len === 2) {
return `M${roundPoint(points[0])}L${roundPoint(points[1])}`;
}
let path = `M${roundPoint(points[0])}`;
const lastPoint = points[len - 1];
let endsAtLastPoint = false;
for (let index = 1; index < len - 1; index++) {
const previousPoint = points[index - 1];
const currentPoint = points[index];
const nextPoint = points[index + 1];
const isLastCurveSegment = index === len - 2;
const terminalStubThreshold = getFixedFreeDrawTerminalStubThreshold(
strokeWidth,
);
const shouldSmooth = shouldSmoothFixedFreeDrawPoint(
previousPoint,
currentPoint,
nextPoint,
);
const roundedCorner = shouldSmooth
? null
: getFixedFreeDrawRoundedCorner(
previousPoint,
currentPoint,
nextPoint,
strokeWidth,
);
const shouldCollapseSmoothTerminalStub =
isLastCurveSegment &&
shouldSmooth &&
getReadonlyPointDistance(currentPoint, nextPoint) / 2 <=
terminalStubThreshold;
const shouldCollapseRoundedTerminalStub =
isLastCurveSegment &&
!!roundedCorner &&
getReadonlyPointDistance(roundedCorner.exitPoint, lastPoint) <=
terminalStubThreshold;
path += shouldSmooth
? `Q${roundPoint(currentPoint)}${
shouldCollapseSmoothTerminalStub
? roundPoint(lastPoint)
: averagePoint(currentPoint, nextPoint)
}`
: roundedCorner
? `L${roundPoint(roundedCorner.entryPoint)}Q${roundPoint(
currentPoint,
)}${
shouldCollapseRoundedTerminalStub
? roundPoint(lastPoint)
: roundPoint(roundedCorner.exitPoint)
}`
: `L${roundPoint(currentPoint)}`;
endsAtLastPoint =
shouldCollapseSmoothTerminalStub || shouldCollapseRoundedTerminalStub;
}
return endsAtLastPoint ? path : `${path}L${roundPoint(lastPoint)}`;
};
const getSvgPathFromStroke = (
points: ReadonlyArray<readonly number[]>,
): string => {
if (!points.length) { if (!points.length) {
return ""; return "";
} }
+2
View File
@@ -26,6 +26,7 @@ export type PointerType = "mouse" | "pen" | "touch";
export type StrokeRoundness = "round" | "sharp"; export type StrokeRoundness = "round" | "sharp";
export type RoundnessType = ValueOf<typeof ROUNDNESS>; export type RoundnessType = ValueOf<typeof ROUNDNESS>;
export type StrokeStyle = "solid" | "dashed" | "dotted"; export type StrokeStyle = "solid" | "dashed" | "dotted";
export type FreeDrawStrokeShape = "variable" | "fixed";
export type TextAlign = typeof TEXT_ALIGN[keyof typeof TEXT_ALIGN]; export type TextAlign = typeof TEXT_ALIGN[keyof typeof TEXT_ALIGN];
type VerticalAlignKeys = keyof typeof VERTICAL_ALIGN; type VerticalAlignKeys = keyof typeof VERTICAL_ALIGN;
@@ -390,6 +391,7 @@ export type ExcalidrawFreeDrawElement = _ExcalidrawElementBase &
points: readonly LocalPoint[]; points: readonly LocalPoint[];
pressures: readonly number[]; pressures: readonly number[];
simulatePressure: boolean; simulatePressure: boolean;
strokeShape?: FreeDrawStrokeShape;
}>; }>;
export type FileId = string & { _brand: "FileId" }; export type FileId = string & { _brand: "FileId" };
+30 -1
View File
@@ -6,7 +6,11 @@ import type { LocalPoint } from "@excalidraw/math";
import { getElementAbsoluteCoords, getElementBounds } from "../src/bounds"; import { getElementAbsoluteCoords, getElementBounds } from "../src/bounds";
import type { ExcalidrawElement, ExcalidrawLinearElement } from "../src/types"; import type {
ExcalidrawElement,
ExcalidrawFreeDrawElement,
ExcalidrawLinearElement,
} from "../src/types";
const _ce = ({ const _ce = ({
x, x,
@@ -117,6 +121,31 @@ describe("getElementBounds", () => {
expect(y2).toEqual(42.90569415042095); expect(y2).toEqual(42.90569415042095);
}); });
it("fixed freedraw", () => {
const element = {
..._ce({
x: 40,
y: 30,
w: 10,
h: 0,
a: 0,
t: "freedraw",
}),
strokeWidth: 8,
points: [pointFrom<LocalPoint>(0, 0), pointFrom<LocalPoint>(10, 0)],
pressures: [],
simulatePressure: true,
strokeShape: "fixed",
} as unknown as ExcalidrawFreeDrawElement;
const [x1, y1, x2, y2] = getElementBounds(element, arrayToMap([element]));
expect(x1).toEqual(36);
expect(y1).toEqual(26);
expect(x2).toEqual(54);
expect(y2).toEqual(34);
});
it("curved line", () => { it("curved line", () => {
const element = { const element = {
..._ce({ ..._ce({
+160
View File
@@ -0,0 +1,160 @@
import { pointFrom } from "@excalidraw/math";
import { API } from "@excalidraw/excalidraw/tests/helpers/api";
import { vi } from "vitest";
vi.mock("perfect-freehand", () => ({
getStroke: vi.fn(() => []),
}));
import { getStroke } from "perfect-freehand";
import { getFreedrawOutlinePoints, ShapeCache } from "../src/shape";
describe("freedraw stroke shape", () => {
beforeEach(() => {
vi.mocked(getStroke).mockClear();
ShapeCache.destroy();
});
it("renders fixed strokes from the centerline path", () => {
const element = API.createElement({
type: "freedraw",
strokeShape: "fixed",
points: [pointFrom(0, 0), pointFrom(10, 10), pointFrom(20, 15)],
});
const shapes = ShapeCache.generateElementShape(element, null);
expect(shapes).toEqual([expect.any(String)]);
expect(shapes[0]).not.toContain("Z");
expect(vi.mocked(getStroke)).not.toHaveBeenCalled();
});
it("rounds fixed stroke corners without flattening them", () => {
const element = API.createElement({
type: "freedraw",
strokeShape: "fixed",
strokeWidth: 1,
points: [pointFrom(0, 0), pointFrom(10, 0), pointFrom(10, 10)],
});
const [path] = ShapeCache.generateElementShape(element, null);
expect(path).toBe("M0,0 L8.5,0 Q10,0 10,1.5 L10,10 ");
});
it("does not round fixed stroke hairpin turns", () => {
const element = API.createElement({
type: "freedraw",
strokeShape: "fixed",
strokeWidth: 1,
points: [pointFrom(0, 0), pointFrom(10, 0), pointFrom(9, 1)],
});
const [path] = ShapeCache.generateElementShape(element, null);
expect(path).toBe("M0,0 L10,0 L9,1 ");
});
it("curves directly to the endpoint for tiny final smooth segments", () => {
const element = API.createElement({
type: "freedraw",
strokeShape: "fixed",
strokeWidth: 1,
points: [pointFrom(0, 0), pointFrom(0.5, 0.1), pointFrom(0.8, 0.3)],
});
const [path] = ShapeCache.generateElementShape(element, null);
expect(path).toBe("M0,0 Q0.5,0.1 0.8,0.3 ");
});
it("curves directly to the endpoint for tiny final rounded corners", () => {
const element = API.createElement({
type: "freedraw",
strokeShape: "fixed",
strokeWidth: 1,
points: [pointFrom(0, 0), pointFrom(10, 0), pointFrom(10, 1)],
});
const [path] = ShapeCache.generateElementShape(element, null);
expect(path).toBe("M0,0 L9.65,0 Q10,0 10,1 ");
});
it("smooths dense fixed stroke points without dropping them", () => {
const element = API.createElement({
type: "freedraw",
strokeShape: "fixed",
points: [
pointFrom(0, 0),
pointFrom(0.3, 0.1),
pointFrom(0.6, 0.35),
pointFrom(1, 0.9),
],
});
const [path] = ShapeCache.generateElementShape(element, null);
expect(path).toContain("Q0.3,0.1 ");
expect(path).toContain("Q0.6,0.35 ");
});
it("drops synthetic loop closure for fixed strokes", () => {
const element = API.createElement({
type: "freedraw",
strokeShape: "fixed",
points: [pointFrom(0, 0), pointFrom(10, 0), pointFrom(0, 0)],
});
const [path] = ShapeCache.generateElementShape(element, null);
expect(path).toBe("M0,0 L10,0 ");
});
it("uses fixed perfect-freehand settings for fixed strokes", () => {
const element = API.createElement({
type: "freedraw",
strokeShape: "fixed",
strokeWidth: 8,
points: [pointFrom(0, 0), pointFrom(10, 10), pointFrom(20, 15)],
});
getFreedrawOutlinePoints(element);
expect(vi.mocked(getStroke)).toHaveBeenCalledWith(
element.points,
expect.objectContaining({
simulatePressure: false,
size: element.strokeWidth,
thinning: 0,
}),
);
});
it("keeps pressure-aware perfect-freehand settings for variable strokes", () => {
const element = API.createElement({
type: "freedraw",
points: [pointFrom(0, 0), pointFrom(10, 10), pointFrom(20, 15)],
});
getFreedrawOutlinePoints({
...element,
simulatePressure: false,
pressures: [0.2, 0.8, 0.4],
});
expect(vi.mocked(getStroke)).toHaveBeenCalledWith(
[
[0, 0, 0.2],
[10, 10, 0.8],
[20, 15, 0.4],
],
expect.objectContaining({
simulatePressure: false,
size: element.strokeWidth * 4.25,
thinning: 0.6,
}),
);
});
});
@@ -2,6 +2,7 @@ import { pointFrom } from "@excalidraw/math";
import { bindOrUnbindBindingElement } from "@excalidraw/element/binding"; import { bindOrUnbindBindingElement } from "@excalidraw/element/binding";
import { import {
isLoopFreeDrawElement,
isValidPolygon, isValidPolygon,
LinearElementEditor, LinearElementEditor,
newElementWith, newElementWith,
@@ -242,7 +243,11 @@ export const actionFinalize = register<FormData>({
// If the multi point line closes the loop, // If the multi point line closes the loop,
// set the last point to first point. // set the last point to first point.
// This ensures that loop remains closed at different scales. // This ensures that loop remains closed at different scales.
const isLoop = isPathALoop(element.points, appState.zoom.value); const isLoop = isLineElement(element)
? isPathALoop(element.points, appState.zoom.value)
: isFreeDrawElement(element)
? isLoopFreeDrawElement(element, appState.zoom.value)
: false;
if (isLoop && (isLineElement(element) || isFreeDrawElement(element))) { if (isLoop && (isLineElement(element) || isFreeDrawElement(element))) {
const linePoints = element.points; const linePoints = element.points;
@@ -1,4 +1,5 @@
import { queryByTestId } from "@testing-library/react"; import { queryByTestId } from "@testing-library/react";
import { pointFrom } from "@excalidraw/math";
import { import {
COLOR_PALETTE, COLOR_PALETTE,
@@ -10,7 +11,7 @@ import {
import { Excalidraw } from "../index"; import { Excalidraw } from "../index";
import { API } from "../tests/helpers/api"; import { API } from "../tests/helpers/api";
import { UI } from "../tests/helpers/ui"; import { UI } from "../tests/helpers/ui";
import { render } from "../tests/test-utils"; import { act, render } from "../tests/test-utils";
describe("element locking", () => { describe("element locking", () => {
beforeEach(async () => { beforeEach(async () => {
@@ -80,6 +81,20 @@ describe("element locking", () => {
const centerTextAlign = queryByTestId(document.body, `align-right`); const centerTextAlign = queryByTestId(document.body, `align-right`);
expect(centerTextAlign).toBeChecked(); expect(centerTextAlign).toBeChecked();
}); });
it("should show the active freedraw stroke type", () => {
UI.clickTool("freedraw");
API.setAppState({
currentItemStrokeShape: "fixed",
});
const fixedStrokeShape = queryByTestId(
document.body,
"strokeShape-fixed",
);
expect(fixedStrokeShape).toBeChecked();
});
}); });
describe("properties when elements selected", () => { describe("properties when elements selected", () => {
@@ -144,6 +159,9 @@ describe("element locking", () => {
expect( expect(
queryByTestId(document.body, `strokeWidth-thin`), queryByTestId(document.body, `strokeWidth-thin`),
).not.toBeChecked(); ).not.toBeChecked();
expect(
queryByTestId(document.body, `strokeWidth-medium`),
).not.toBeChecked();
expect( expect(
queryByTestId(document.body, `strokeWidth-bold`), queryByTestId(document.body, `strokeWidth-bold`),
).not.toBeChecked(); ).not.toBeChecked();
@@ -159,6 +177,7 @@ describe("element locking", () => {
}); });
const text = API.createElement({ const text = API.createElement({
type: "text", type: "text",
strokeWidth: STROKE_WIDTH.bold,
fontFamily: FONT_FAMILY["Comic Shanns"], fontFamily: FONT_FAMILY["Comic Shanns"],
}); });
API.setElements([rect, text]); API.setElements([rect, text]);
@@ -169,5 +188,35 @@ describe("element locking", () => {
"active", "active",
); );
}); });
it("should highlight the fixed freedraw stroke type for selected elements", () => {
const freedraw = API.createElement({
type: "freedraw",
strokeShape: "fixed",
points: [pointFrom(0, 0), pointFrom(10, 10), pointFrom(20, 15)],
});
API.setElements([freedraw]);
API.setSelectedElements([freedraw]);
const fixedStrokeShape = queryByTestId(
document.body,
"strokeShape-fixed",
);
expect(fixedStrokeShape).toBeChecked();
});
it("should apply fixed freedraw stroke type to newly drawn strokes", () => {
UI.clickTool("freedraw");
act(() => {
queryByTestId(document.body, "strokeShape-fixed")?.click();
});
const freedraw = UI.createElement("freedraw", {
points: [pointFrom(0, 0), pointFrom(10, 10), pointFrom(20, 15)],
});
expect(freedraw.strokeShape).toBe("fixed");
});
}); });
}); });
@@ -3,6 +3,7 @@ import { pointFrom } from "@excalidraw/math";
import { useEffect, useMemo, useRef, useState } from "react"; import { useEffect, useMemo, useRef, useState } from "react";
import { import {
DEFAULT_FREE_DRAW_STROKE_SHAPE,
DEFAULT_ELEMENT_BACKGROUND_COLOR_PALETTE, DEFAULT_ELEMENT_BACKGROUND_COLOR_PALETTE,
DEFAULT_ELEMENT_BACKGROUND_PICKS, DEFAULT_ELEMENT_BACKGROUND_PICKS,
DEFAULT_ELEMENT_STROKE_COLOR_PALETTE, DEFAULT_ELEMENT_STROKE_COLOR_PALETTE,
@@ -36,6 +37,7 @@ import {
import { LinearElementEditor } from "@excalidraw/element"; import { LinearElementEditor } from "@excalidraw/element";
import { newElementWith } from "@excalidraw/element"; import { newElementWith } from "@excalidraw/element";
import { newFreeDrawElementWithStrokeShape } from "@excalidraw/element";
import { getArrowheadForPicker } from "@excalidraw/element"; import { getArrowheadForPicker } from "@excalidraw/element";
import { import {
@@ -47,6 +49,7 @@ import {
isArrowElement, isArrowElement,
isBoundToContainer, isBoundToContainer,
isElbowArrow, isElbowArrow,
isFreeDrawElement,
isLinearElement, isLinearElement,
isLineElement, isLineElement,
isTextElement, isTextElement,
@@ -70,6 +73,7 @@ import type {
ElementsMap, ElementsMap,
ExcalidrawBindableElement, ExcalidrawBindableElement,
ExcalidrawElement, ExcalidrawElement,
ExcalidrawFreeDrawElement,
ExcalidrawLinearElement, ExcalidrawLinearElement,
ExcalidrawTextElement, ExcalidrawTextElement,
FontFamilyValues, FontFamilyValues,
@@ -105,8 +109,11 @@ import {
SloppinessArtistIcon, SloppinessArtistIcon,
SloppinessCartoonistIcon, SloppinessCartoonistIcon,
StrokeWidthBaseIcon, StrokeWidthBaseIcon,
StrokeWidthMediumIcon,
StrokeWidthBoldIcon, StrokeWidthBoldIcon,
StrokeWidthExtraBoldIcon, StrokeWidthExtraBoldIcon,
StrokeShapeFixedIcon,
StrokeShapeVariableIcon,
FontSizeSmallIcon, FontSizeSmallIcon,
FontSizeMediumIcon, FontSizeMediumIcon,
FontSizeLargeIcon, FontSizeLargeIcon,
@@ -187,6 +194,29 @@ export const changeProperty = (
}); });
}; };
const getFreeDrawStrokeShape = (item: {
strokeShape?: ExcalidrawFreeDrawElement["strokeShape"];
currentItemStrokeShape?: AppState["currentItemStrokeShape"];
}) =>
item.strokeShape ??
item.currentItemStrokeShape ??
DEFAULT_FREE_DRAW_STROKE_SHAPE;
const getAppStateWithCurrentItemStrokeShape = (
appState: AppState,
strokeShape: NonNullable<ExcalidrawFreeDrawElement["strokeShape"]>,
) => {
// if (strokeShape === DEFAULT_FREE_DRAW_STROKE_SHAPE) {
// const { currentItemStrokeShape, ...nextAppState } = appState;
// return nextAppState;
// }
return {
...appState,
currentItemStrokeShape: strokeShape,
};
};
export const getFormValue = function <T extends Primitive>( export const getFormValue = function <T extends Primitive>(
elements: readonly ExcalidrawElement[], elements: readonly ExcalidrawElement[],
app: AppClassProperties, app: AppClassProperties,
@@ -574,6 +604,12 @@ export const actionChangeStrokeWidth = register<
icon: StrokeWidthBaseIcon, icon: StrokeWidthBaseIcon,
testId: "strokeWidth-thin", testId: "strokeWidth-thin",
}, },
{
value: STROKE_WIDTH.medium,
text: t("labels.medium"),
icon: StrokeWidthMediumIcon,
testId: "strokeWidth-medium",
},
{ {
value: STROKE_WIDTH.bold, value: STROKE_WIDTH.bold,
text: t("labels.bold"), text: t("labels.bold"),
@@ -602,6 +638,60 @@ export const actionChangeStrokeWidth = register<
), ),
}); });
export const actionChangeStrokeShape = register<
NonNullable<ExcalidrawFreeDrawElement["strokeShape"]>
>({
name: "changeStrokeShape",
label: "labels.strokeShape",
trackEvent: false,
perform: (elements, appState, value) => {
invariant(value, "actionChangeStrokeShape: value must be defined");
return {
elements: changeProperty(elements, appState, (el) =>
isFreeDrawElement(el)
? newFreeDrawElementWithStrokeShape(el, value)
: el,
),
appState: getAppStateWithCurrentItemStrokeShape(appState, value),
captureUpdate: CaptureUpdateAction.IMMEDIATELY,
};
},
PanelComponent: ({ elements, appState, updateData, app }) => (
<fieldset>
<legend>{t("labels.strokeShape")}</legend>
<div className="buttonList">
<RadioSelection
group="stroke-shape"
options={[
{
value: "variable",
text: t("labels.strokeShape_variable"),
icon: StrokeShapeVariableIcon,
testId: "strokeShape-variable",
},
{
value: "fixed",
text: t("labels.strokeShape_fixed"),
icon: StrokeShapeFixedIcon,
testId: "strokeShape-fixed",
},
]}
value={getFormValue(
elements,
app,
(element) =>
getFreeDrawStrokeShape(element as ExcalidrawFreeDrawElement),
isFreeDrawElement,
(hasSelection) =>
hasSelection ? null : getFreeDrawStrokeShape(appState),
)}
onChange={(value) => updateData(value)}
/>
</div>
</fieldset>
),
});
export const actionChangeSloppiness = register<ExcalidrawElement["roughness"]>({ export const actionChangeSloppiness = register<ExcalidrawElement["roughness"]>({
name: "changeSloppiness", name: "changeSloppiness",
label: "labels.sloppiness", label: "labels.sloppiness",
@@ -1,4 +1,5 @@
import { import {
DEFAULT_FREE_DRAW_STROKE_SHAPE,
DEFAULT_FONT_SIZE, DEFAULT_FONT_SIZE,
DEFAULT_FONT_FAMILY, DEFAULT_FONT_FAMILY,
DEFAULT_TEXT_ALIGN, DEFAULT_TEXT_ALIGN,
@@ -10,6 +11,7 @@ import {
import { newElementWith } from "@excalidraw/element"; import { newElementWith } from "@excalidraw/element";
import { import {
isFreeDrawElement,
hasBoundTextElement, hasBoundTextElement,
canApplyRoundnessTypeToElement, canApplyRoundnessTypeToElement,
getDefaultRoundnessTypeForElement, getDefaultRoundnessTypeForElement,
@@ -18,6 +20,7 @@ import {
isExcalidrawElement, isExcalidrawElement,
isTextElement, isTextElement,
} from "@excalidraw/element"; } from "@excalidraw/element";
import { newFreeDrawElementWithStrokeShape } from "@excalidraw/element";
import { import {
getBoundTextElement, getBoundTextElement,
@@ -154,6 +157,17 @@ export const actionPasteStyles = register({
}); });
} }
if (
isFreeDrawElement(newElement) &&
isFreeDrawElement(elementStylesToCopyFrom)
) {
newElement = newFreeDrawElementWithStrokeShape(
newElement,
elementStylesToCopyFrom.strokeShape ??
DEFAULT_FREE_DRAW_STROKE_SHAPE,
);
}
if (isFrameLikeElement(element)) { if (isFrameLikeElement(element)) {
newElement = newElementWith(newElement, { newElement = newElementWith(newElement, {
roundness: null, roundness: null,
+1
View File
@@ -172,6 +172,7 @@ const APP_STATE_STORAGE_CONF = (<
currentItemStrokeColor: { browser: true, export: false, server: false }, currentItemStrokeColor: { browser: true, export: false, server: false },
currentItemStrokeStyle: { browser: true, export: false, server: false }, currentItemStrokeStyle: { browser: true, export: false, server: false },
currentItemStrokeWidth: { browser: true, export: false, server: false }, currentItemStrokeWidth: { browser: true, export: false, server: false },
currentItemStrokeShape: { browser: true, export: false, server: false },
currentItemTextAlign: { browser: true, export: false, server: false }, currentItemTextAlign: { browser: true, export: false, server: false },
currentHoveredFontFamily: { browser: false, export: false, server: false }, currentHoveredFontFamily: { browser: false, export: false, server: false },
cursorButton: { browser: true, export: false, server: false }, cursorButton: { browser: true, export: false, server: false },
@@ -394,6 +394,11 @@ const CombinedShapeProperties = ({
hasStrokeWidth(element.type), hasStrokeWidth(element.type),
)) && )) &&
renderAction("changeStrokeWidth")} renderAction("changeStrokeWidth")}
{(appState.activeTool.type === "freedraw" ||
targetElements.some(
(element) => element.type === "freedraw",
)) &&
renderAction("changeStrokeShape")}
{(hasStrokeStyle(appState.activeTool.type) || {(hasStrokeStyle(appState.activeTool.type) ||
targetElements.some((element) => targetElements.some((element) =>
hasStrokeStyle(element.type), hasStrokeStyle(element.type),
+87 -28
View File
@@ -9,6 +9,7 @@ import {
clamp, clamp,
pointFrom, pointFrom,
pointDistance, pointDistance,
round,
vector, vector,
pointRotateRads, pointRotateRads,
vectorFromPoint, vectorFromPoint,
@@ -119,6 +120,7 @@ import {
getElementAbsoluteCoords, getElementAbsoluteCoords,
bindOrUnbindBindingElements, bindOrUnbindBindingElements,
fixBindingsAfterDeletion, fixBindingsAfterDeletion,
getFixedFreeDrawPointAction,
getHoveredElementForBinding, getHoveredElementForBinding,
isBindingEnabled, isBindingEnabled,
updateBoundElements, updateBoundElements,
@@ -615,6 +617,19 @@ const gesture: Gesture = {
initialScale: null, initialScale: null,
}; };
const FREEDRAW_POINT_DECIMALS = 2;
const FREEDRAW_PRESSURE_DECIMALS = 3;
const FREEDRAW_DOT_EPSILON = 1 / 10 ** FREEDRAW_POINT_DECIMALS;
const roundFreeDrawCoordinate = (value: number) =>
round(value, FREEDRAW_POINT_DECIMALS);
const roundFreeDrawPressure = (value: number) =>
round(value, FREEDRAW_PRESSURE_DECIMALS);
const getRoundedFreeDrawPoint = (x: number, y: number) =>
pointFrom<LocalPoint>(roundFreeDrawCoordinate(x), roundFreeDrawCoordinate(y));
class App extends React.Component<AppProps, AppState> { class App extends React.Component<AppProps, AppState> {
canvas: AppClassProperties["canvas"]; canvas: AppClassProperties["canvas"];
interactiveCanvas: AppClassProperties["interactiveCanvas"] = null; interactiveCanvas: AppClassProperties["interactiveCanvas"] = null;
@@ -8080,7 +8095,7 @@ class App extends React.Component<AppProps, AppState> {
setCursor(this.interactiveCanvas, CURSOR_TYPE.GRABBING); setCursor(this.interactiveCanvas, CURSOR_TYPE.GRABBING);
let { clientX: lastX, clientY: lastY } = event; let { clientX: lastX, clientY: lastY } = event;
const onPointerMove = withBatchedUpdatesThrottled((event: PointerEvent) => { const onPointerMove = ((event: PointerEvent) => {
const deltaX = lastX - event.clientX; const deltaX = lastX - event.clientX;
const deltaY = lastY - event.clientY; const deltaY = lastY - event.clientY;
lastX = event.clientX; lastX = event.clientX;
@@ -8146,7 +8161,7 @@ class App extends React.Component<AppProps, AppState> {
window.removeEventListener(EVENT.POINTER_MOVE, onPointerMove); window.removeEventListener(EVENT.POINTER_MOVE, onPointerMove);
window.removeEventListener(EVENT.POINTER_UP, teardown); window.removeEventListener(EVENT.POINTER_UP, teardown);
window.removeEventListener(EVENT.BLUR, teardown); window.removeEventListener(EVENT.BLUR, teardown);
onPointerMove.flush(); // onPointerMove.flush();
}), }),
); );
window.addEventListener(EVENT.BLUR, teardown); window.addEventListener(EVENT.BLUR, teardown);
@@ -8256,14 +8271,14 @@ class App extends React.Component<AppProps, AppState> {
isDraggingScrollBar = true; isDraggingScrollBar = true;
pointerDownState.lastCoords.x = event.clientX; pointerDownState.lastCoords.x = event.clientX;
pointerDownState.lastCoords.y = event.clientY; pointerDownState.lastCoords.y = event.clientY;
const onPointerMove = withBatchedUpdatesThrottled((event: PointerEvent) => { const onPointerMove = (event: PointerEvent) => {
const target = event.target; const target = event.target;
if (!(target instanceof HTMLElement)) { if (!(target instanceof HTMLElement)) {
return; return;
} }
this.handlePointerMoveOverScrollbars(event, pointerDownState); this.handlePointerMoveOverScrollbars(event, pointerDownState);
}); };
const onPointerUp = withBatchedUpdates(() => { const onPointerUp = withBatchedUpdates(() => {
lastPointerUp = null; lastPointerUp = null;
isDraggingScrollBar = false; isDraggingScrollBar = false;
@@ -8274,7 +8289,7 @@ class App extends React.Component<AppProps, AppState> {
this.savePointer(event.clientX, event.clientY, "up"); this.savePointer(event.clientX, event.clientY, "up");
window.removeEventListener(EVENT.POINTER_MOVE, onPointerMove); window.removeEventListener(EVENT.POINTER_MOVE, onPointerMove);
window.removeEventListener(EVENT.POINTER_UP, onPointerUp); window.removeEventListener(EVENT.POINTER_UP, onPointerUp);
onPointerMove.flush(); // onPointerMove.flush();
}); });
lastPointerUp = onPointerUp; lastPointerUp = onPointerUp;
@@ -8833,10 +8848,13 @@ class App extends React.Component<AppProps, AppState> {
opacity: this.state.currentItemOpacity, opacity: this.state.currentItemOpacity,
roundness: null, roundness: null,
simulatePressure, simulatePressure,
strokeShape: this.state.currentItemStrokeShape,
locked: false, locked: false,
frameId: topLayerFrame ? topLayerFrame.id : null, frameId: topLayerFrame ? topLayerFrame.id : null,
points: [pointFrom<LocalPoint>(0, 0)], points: [pointFrom<LocalPoint>(0, 0)],
pressures: simulatePressure ? [] : [event.pressure], pressures: simulatePressure
? []
: [roundFreeDrawPressure(event.pressure)],
}); });
this.scene.insertElement(element); this.scene.insertElement(element);
@@ -9478,7 +9496,7 @@ class App extends React.Component<AppProps, AppState> {
private onPointerMoveFromPointerDownHandler( private onPointerMoveFromPointerDownHandler(
pointerDownState: PointerDownState, pointerDownState: PointerDownState,
) { ) {
return withBatchedUpdatesThrottled((event: PointerEvent) => { return (event: PointerEvent) => {
if (this.state.openDialog?.name === "elementLinkSelector") { if (this.state.openDialog?.name === "elementLinkSelector") {
return; return;
} }
@@ -10174,20 +10192,36 @@ class App extends React.Component<AppProps, AppState> {
const points = newElement.points; const points = newElement.points;
const dx = pointerCoords.x - newElement.x; const dx = pointerCoords.x - newElement.x;
const dy = pointerCoords.y - newElement.y; const dy = pointerCoords.y - newElement.y;
const nextPoint = getRoundedFreeDrawPoint(dx, dy);
const pressure = roundFreeDrawPressure(event.pressure);
const pointAction =
newElement.strokeShape === "fixed"
? getFixedFreeDrawPointAction({
points,
nextPoint,
strokeWidth: newElement.strokeWidth,
zoomValue: this.state.zoom.value,
})
: points.length > 0 &&
points[points.length - 1][0] === nextPoint[0] &&
points[points.length - 1][1] === nextPoint[1]
? "discard"
: "append";
const lastPoint = points.length > 0 && points[points.length - 1]; if (pointAction !== "discard") {
const discardPoint =
lastPoint && lastPoint[0] === dx && lastPoint[1] === dy;
if (!discardPoint) {
const pressures = newElement.simulatePressure const pressures = newElement.simulatePressure
? newElement.pressures ? newElement.pressures
: [...newElement.pressures, event.pressure]; : pointAction === "replace"
? [...newElement.pressures.slice(0, -1), pressure]
: [...newElement.pressures, pressure];
this.scene.mutateElement( this.scene.mutateElement(
newElement, newElement,
{ {
points: [...points, pointFrom<LocalPoint>(dx, dy)], points:
pointAction === "replace"
? [...points.slice(0, -1), nextPoint]
: [...points, nextPoint],
pressures, pressures,
}, },
{ {
@@ -10345,7 +10379,7 @@ class App extends React.Component<AppProps, AppState> {
}); });
} }
} }
}); };
} }
// Returns whether the pointer move happened over either scrollbar // Returns whether the pointer move happened over either scrollbar
@@ -10390,7 +10424,7 @@ class App extends React.Component<AppProps, AppState> {
this.removePointer(childEvent); this.removePointer(childEvent);
pointerDownState.drag.blockDragging = false; pointerDownState.drag.blockDragging = false;
if (pointerDownState.eventListeners.onMove) { if (pointerDownState.eventListeners.onMove) {
pointerDownState.eventListeners.onMove.flush(); // pointerDownState.eventListeners.onMove.flush();
} }
const { const {
newElement, newElement,
@@ -10627,23 +10661,48 @@ class App extends React.Component<AppProps, AppState> {
); );
const points = newElement.points; const points = newElement.points;
let dx = pointerCoords.x - newElement.x; const dx = pointerCoords.x - newElement.x;
let dy = pointerCoords.y - newElement.y; const dy = pointerCoords.y - newElement.y;
let nextPoint = getRoundedFreeDrawPoint(dx, dy);
// Allows dots to avoid being flagged as infinitely small // Allows dots to avoid being flagged as infinitely small
if (dx === points[0][0] && dy === points[0][1]) { if (nextPoint[0] === points[0][0] && nextPoint[1] === points[0][1]) {
dy += 0.0001; nextPoint = getRoundedFreeDrawPoint(
dx += 0.0001; dx + FREEDRAW_DOT_EPSILON,
dy + FREEDRAW_DOT_EPSILON,
);
} }
const pressures = newElement.simulatePressure const lastPoint = points[points.length - 1];
? [] const pressure = roundFreeDrawPressure(childEvent.pressure);
: [...newElement.pressures, childEvent.pressure]; const pointAction =
newElement.strokeShape === "fixed"
? getFixedFreeDrawPointAction({
points,
nextPoint,
strokeWidth: newElement.strokeWidth,
zoomValue: this.state.zoom.value,
isFinalPoint: true,
})
: !lastPoint ||
lastPoint[0] !== nextPoint[0] ||
lastPoint[1] !== nextPoint[1]
? "append"
: "discard";
this.scene.mutateElement(newElement, { if (pointAction !== "discard") {
points: [...points, pointFrom<LocalPoint>(dx, dy)], this.scene.mutateElement(newElement, {
pressures, points:
}); pointAction === "replace"
? [...points.slice(0, -1), nextPoint]
: [...points, nextPoint],
pressures: newElement.simulatePressure
? []
: pointAction === "replace"
? [...newElement.pressures.slice(0, -1), pressure]
: [...newElement.pressures, pressure],
});
}
this.actionManager.executeAction(actionFinalize); this.actionManager.executeAction(actionFinalize);
+44 -2
View File
@@ -1164,7 +1164,7 @@ export const StrokeWidthBaseIcon = createIcon(
modifiedTablerIconProps, modifiedTablerIconProps,
); );
export const StrokeWidthBoldIcon = createIcon( export const StrokeWidthMediumIcon = createIcon(
<path <path
d="M5 10h10" d="M5 10h10"
stroke="currentColor" stroke="currentColor"
@@ -1175,7 +1175,7 @@ export const StrokeWidthBoldIcon = createIcon(
modifiedTablerIconProps, modifiedTablerIconProps,
); );
export const StrokeWidthExtraBoldIcon = createIcon( export const StrokeWidthBoldIcon = createIcon(
<path <path
d="M5 10h10" d="M5 10h10"
stroke="currentColor" stroke="currentColor"
@@ -1186,6 +1186,48 @@ export const StrokeWidthExtraBoldIcon = createIcon(
modifiedTablerIconProps, modifiedTablerIconProps,
); );
export const StrokeWidthExtraBoldIcon = createIcon(
<path
d="M5 10h10"
stroke="currentColor"
strokeWidth="5"
strokeLinecap="round"
strokeLinejoin="round"
/>,
modifiedTablerIconProps,
);
export const StrokeShapeVariableIcon = createIcon(
<>
<path
d="M3.5 12.5c1.8-3.5 4.1-5.2 6.8-5.2 2.4 0 4.4 1.3 6.2 3.9"
stroke="currentColor"
strokeWidth="1.25"
strokeLinecap="round"
strokeLinejoin="round"
/>
<path
d="M7.75 10.8c1-.9 2-1.35 3.05-1.35 1.2 0 2.4.57 3.7 1.72"
stroke="currentColor"
strokeWidth="2.5"
strokeLinecap="round"
strokeLinejoin="round"
/>
</>,
modifiedTablerIconProps,
);
export const StrokeShapeFixedIcon = createIcon(
<path
d="M3.5 12h13"
stroke="currentColor"
strokeWidth="2.5"
strokeLinecap="round"
strokeLinejoin="round"
/>,
modifiedTablerIconProps,
);
export const StrokeStyleSolidIcon = React.memo(({ theme }: { theme: Theme }) => export const StrokeStyleSolidIcon = React.memo(({ theme }: { theme: Theme }) =>
createIcon( createIcon(
<path <path
+19
View File
@@ -96,6 +96,13 @@ type RestoredAppState = Omit<
"offsetTop" | "offsetLeft" | "width" | "height" "offsetTop" | "offsetLeft" | "width" | "height"
>; >;
const normalizeFreeDrawStrokeShape = (
strokeShape: unknown,
): AppState["currentItemStrokeShape"] =>
strokeShape === "fixed" || strokeShape === "stable"
? "fixed"
: undefined;
export const AllowedExcalidrawActiveTools: Record< export const AllowedExcalidrawActiveTools: Record<
AppState["activeTool"]["type"], AppState["activeTool"]["type"],
boolean boolean
@@ -412,10 +419,12 @@ export const restoreElement = (
return element; return element;
case "freedraw": { case "freedraw": {
const strokeShape = normalizeFreeDrawStrokeShape(element.strokeShape);
return restoreElementWithProperties(element, { return restoreElementWithProperties(element, {
points: element.points, points: element.points,
simulatePressure: element.simulatePressure, simulatePressure: element.simulatePressure,
pressures: element.pressures, pressures: element.pressures,
...(strokeShape ? { strokeShape } : {}),
}); });
} }
case "image": case "image":
@@ -944,6 +953,16 @@ export const restoreAppState = (
return { return {
...nextAppState, ...nextAppState,
...(normalizeFreeDrawStrokeShape(
appState.currentItemStrokeShape ?? localAppState?.currentItemStrokeShape,
)
? {
currentItemStrokeShape: normalizeFreeDrawStrokeShape(
appState.currentItemStrokeShape ??
localAppState?.currentItemStrokeShape,
),
}
: {}),
cursorButton: localAppState?.cursorButton || "up", cursorButton: localAppState?.cursorButton || "up",
// reset on fresh restore so as to hide the UI button if penMode not active // reset on fresh restore so as to hide the UI button if penMode not active
penDetected: penDetected:
+3
View File
@@ -30,6 +30,9 @@
"changeBackground": "Change background color", "changeBackground": "Change background color",
"fill": "Fill", "fill": "Fill",
"strokeWidth": "Stroke width", "strokeWidth": "Stroke width",
"strokeShape": "Stroke type",
"strokeShape_variable": "Variable",
"strokeShape_fixed": "Fixed",
"strokeStyle": "Stroke style", "strokeStyle": "Stroke style",
"strokeStyle_solid": "Solid", "strokeStyle_solid": "Solid",
"strokeStyle_dashed": "Dashed", "strokeStyle_dashed": "Dashed",
+4 -4
View File
@@ -11,10 +11,10 @@ export const withBatchedUpdates = <
TFunction extends ((event: any) => void) | (() => void), TFunction extends ((event: any) => void) | (() => void),
>( >(
func: Parameters<TFunction>["length"] extends 0 | 1 ? TFunction : never, func: Parameters<TFunction>["length"] extends 0 | 1 ? TFunction : never,
) => ) => func;
((event) => { // ((event) => {
unstable_batchedUpdates(func as TFunction, event); // unstable_batchedUpdates(func as TFunction, event);
}) as TFunction; // }) as TFunction;
/** /**
* barches React state updates and throttles the calls to a single call per * barches React state updates and throttles the calls to a single call per
+14 -6
View File
@@ -376,6 +376,11 @@ const renderElementToSvg = (
} }
case "freedraw": { case "freedraw": {
const wrapper = svgRoot.ownerDocument.createElementNS(SVG_NS, "g"); const wrapper = svgRoot.ownerDocument.createElementNS(SVG_NS, "g");
const isFixedStroke = element.strokeShape === "fixed";
const strokeColor =
renderConfig.theme === THEME.DARK
? applyDarkModeFilter(element.strokeColor)
: element.strokeColor;
const shapes = ShapeCache.generateElementShape(element, renderConfig); const shapes = ShapeCache.generateElementShape(element, renderConfig);
// always ordered as [background, stroke] // always ordered as [background, stroke]
@@ -384,12 +389,15 @@ const renderElementToSvg = (
// stroke (SVGPathString) // stroke (SVGPathString)
const path = svgRoot.ownerDocument.createElementNS(SVG_NS, "path"); const path = svgRoot.ownerDocument.createElementNS(SVG_NS, "path");
path.setAttribute( if (isFixedStroke) {
"fill", path.setAttribute("fill", "none");
renderConfig.theme === THEME.DARK path.setAttribute("stroke", strokeColor);
? applyDarkModeFilter(element.strokeColor) path.setAttribute("stroke-width", `${element.strokeWidth}`);
: element.strokeColor, path.setAttribute("stroke-linecap", "round");
); path.setAttribute("stroke-linejoin", "round");
} else {
path.setAttribute("fill", strokeColor);
}
path.setAttribute("d", shape); path.setAttribute("d", shape);
wrapper.appendChild(path); wrapper.appendChild(path);
} else { } else {
@@ -160,6 +160,40 @@ describe("restoreElements", () => {
}); });
}); });
it("should restore fixed freedraw element correctly", () => {
const freedrawElement = API.createElement({
type: "freedraw",
id: "id-freedraw02",
strokeShape: "fixed",
points: [pointFrom(0, 0), pointFrom(10, 10)],
});
const restoredFreedraw = restore.restoreElements(
[freedrawElement],
null,
)[0] as ExcalidrawFreeDrawElement;
expect(restoredFreedraw.strokeShape).toBe("fixed");
});
it("should restore legacy stable freedraw element as fixed", () => {
const restoredFreedraw = restore.restoreElements(
[
{
...API.createElement({
type: "freedraw",
id: "id-freedraw03",
points: [pointFrom(0, 0), pointFrom(10, 10)],
}),
strokeShape: "stable",
} as any,
],
null,
)[0] as ExcalidrawFreeDrawElement;
expect(restoredFreedraw.strokeShape).toBe("fixed");
});
it("should restore line and draw elements correctly", () => { it("should restore line and draw elements correctly", () => {
const lineElement = API.createElement({ type: "line", id: "id-line01" }); const lineElement = API.createElement({ type: "line", id: "id-line01" });
@@ -641,6 +675,26 @@ describe("restoreAppState", () => {
expect(restoredAppState.name).toBe(stubImportedAppState.name); expect(restoredAppState.name).toBe(stubImportedAppState.name);
}); });
it("should restore fixed freedraw stroke type from app state", () => {
const restoredAppState = restore.restoreAppState(
{ currentItemStrokeShape: "fixed" } as ImportedDataState["appState"],
null,
);
expect(restoredAppState.currentItemStrokeShape).toBe("fixed");
});
it("should restore legacy stable freedraw stroke type from app state as fixed", () => {
const restoredAppState = restore.restoreAppState(
{
currentItemStrokeShape: "stable",
} as unknown as ImportedDataState["appState"],
null,
);
expect(restoredAppState.currentItemStrokeShape).toBe("fixed");
});
it("should return local app state when imported data state is null", () => { it("should return local app state when imported data state is null", () => {
const stubLocalAppState = getDefaultAppState(); const stubLocalAppState = getDefaultAppState();
stubLocalAppState.cursorButton = "down"; stubLocalAppState.cursorButton = "down";
@@ -0,0 +1,78 @@
import React from "react";
import { Excalidraw } from "../index";
import { API } from "./helpers/api";
import { Pointer, UI } from "./helpers/ui";
import { render } from "./test-utils";
describe("freedraw", () => {
beforeEach(async () => {
await render(<Excalidraw />);
});
it("rounds stored points and drops duplicates after rounding", () => {
const mouse = new Pointer("mouse");
UI.clickTool("freedraw");
mouse.downAt(10, 20);
mouse.moveTo(10.1234, 20.5678);
mouse.moveTo(10.1249, 20.5681);
mouse.upAt(20.9999, 30.0001);
const freedraw = window.h.elements.at(-1);
expect(freedraw).toEqual(expect.objectContaining({ type: "freedraw" }));
expect((freedraw as any).points).toEqual([
[0, 0],
[0.12, 0.57],
[11, 10],
]);
});
it("does not snap fixed strokes closed when ending near the start point", () => {
const mouse = new Pointer("mouse");
API.setAppState({ currentItemStrokeShape: "fixed" });
UI.clickTool("freedraw");
mouse.downAt(10, 10);
mouse.moveTo(40, 10);
mouse.moveTo(30, 30);
mouse.upAt(12, 12);
const freedraw = window.h.elements.at(-1) as any;
expect(freedraw.points[0]).toEqual([0, 0]);
expect(freedraw.points.at(-1)).not.toEqual([0, 0]);
});
it("coalesces nearly straight fixed freedraw points at the tip", () => {
const mouse = new Pointer("mouse");
API.setAppState({ currentItemStrokeShape: "fixed" });
UI.clickTool("freedraw");
mouse.downAt(10, 10);
[
[10.2, 10.01],
[10.4, 10.03],
[10.6, 10.02],
[10.8, 10.04],
[11, 10.03],
[11.2, 10.05],
[11.4, 10.04],
[11.6, 10.06],
[11.8, 10.05],
].forEach(([x, y]) => {
mouse.moveTo(x, y);
});
mouse.upAt(12, 10.05);
const freedraw = window.h.elements.at(-1) as any;
expect(freedraw.points.length).toBeLessThan(5);
expect(freedraw.points).toEqual([
[0, 0],
[2, 0.05],
]);
});
});
+4
View File
@@ -201,6 +201,9 @@ export class API {
? ExcalidrawTextElement["containerId"] ? ExcalidrawTextElement["containerId"]
: never; : never;
points?: T extends "arrow" | "line" | "freedraw" ? readonly LocalPoint[] : never; points?: T extends "arrow" | "line" | "freedraw" ? readonly LocalPoint[] : never;
strokeShape?: T extends "freedraw"
? ExcalidrawFreeDrawElement["strokeShape"]
: never;
locked?: boolean; locked?: boolean;
fileId?: T extends "image" ? string : never; fileId?: T extends "image" ? string : never;
scale?: T extends "image" ? ExcalidrawImageElement["scale"] : never; scale?: T extends "image" ? ExcalidrawImageElement["scale"] : never;
@@ -318,6 +321,7 @@ export class API {
type: type as "freedraw", type: type as "freedraw",
simulatePressure: true, simulatePressure: true,
points: rest.points, points: rest.points,
strokeShape: rest.strokeShape ?? appState.currentItemStrokeShape,
...base, ...base,
}); });
break; break;
+4 -1
View File
@@ -28,6 +28,7 @@ import type { GlobalPoint, LocalPoint, Radians } from "@excalidraw/math";
import type { TransformHandleType } from "@excalidraw/element"; import type { TransformHandleType } from "@excalidraw/element";
import type { import type {
ExcalidrawElement, ExcalidrawElement,
ExcalidrawFreeDrawElement,
ExcalidrawLinearElement, ExcalidrawLinearElement,
ExcalidrawTextElement, ExcalidrawTextElement,
ExcalidrawArrowElement, ExcalidrawArrowElement,
@@ -432,8 +433,10 @@ type DrawingToolName = Exclude<
"lock" | "selection" | "eraser" | "lasso" "lock" | "selection" | "eraser" | "lasso"
>; >;
type Element<T extends DrawingToolName> = T extends "line" | "freedraw" type Element<T extends DrawingToolName> = T extends "line"
? ExcalidrawLinearElement ? ExcalidrawLinearElement
: T extends "freedraw"
? ExcalidrawFreeDrawElement
: T extends "arrow" : T extends "arrow"
? ExcalidrawArrowElement ? ExcalidrawArrowElement
: T extends "text" : T extends "text"
+3 -1
View File
@@ -33,6 +33,7 @@ import type {
ExcalidrawNonSelectionElement, ExcalidrawNonSelectionElement,
BindMode, BindMode,
ExcalidrawTextElement, ExcalidrawTextElement,
FreeDrawStrokeShape,
} from "@excalidraw/element/types"; } from "@excalidraw/element/types";
import type { import type {
@@ -358,6 +359,7 @@ export interface AppState {
currentItemFillStyle: ExcalidrawElement["fillStyle"]; currentItemFillStyle: ExcalidrawElement["fillStyle"];
currentItemStrokeWidth: number; currentItemStrokeWidth: number;
currentItemStrokeStyle: ExcalidrawElement["strokeStyle"]; currentItemStrokeStyle: ExcalidrawElement["strokeStyle"];
currentItemStrokeShape?: FreeDrawStrokeShape;
currentItemRoughness: number; currentItemRoughness: number;
currentItemOpacity: number; currentItemOpacity: number;
currentItemFontFamily: FontFamilyValues; currentItemFontFamily: FontFamilyValues;
@@ -888,7 +890,7 @@ export type PointerDownState = Readonly<{
// We need to have these in the state so that we can unsubscribe them // We need to have these in the state so that we can unsubscribe them
eventListeners: { eventListeners: {
// It's defined on the initial pointer down event // It's defined on the initial pointer down event
onMove: null | ReturnType<typeof throttleRAF>; onMove: null | ((event: PointerEvent) => void);
// It's defined on the initial pointer down event // It's defined on the initial pointer down event
onUp: null | ((event: PointerEvent) => void); onUp: null | ((event: PointerEvent) => void);
// It's defined on the initial pointer down event // It's defined on the initial pointer down event