Compare commits

...

9 Commits

Author SHA1 Message Date
Ryan Di
3c34b3f48a add clippings bounds tolerance, improve group related checks 2023-11-17 17:23:30 +08:00
Ryan Di
683b80ad2b alternative clipping improvement 2023-11-14 18:31:21 +08:00
Ryan Di
d636abff79 Merge branch 'master' into frame-group-perf 2023-11-13 18:21:21 +08:00
Ryan Di
47d8fa542c remove redundant code 2023-11-13 18:18:36 +08:00
Ryan Di
34cf71b0f4 keep dynamic clipping with batch clipping 2023-11-13 18:17:39 +08:00
Ryan Di
a30e46b756 batch clipping 2023-11-10 19:24:32 +08:00
Ryan Di
71ba0a3f26 Merge branch 'master' into frame-group-perf 2023-11-10 15:29:46 +08:00
Ryan Di
9bcd0b69dc remove redundant code 2023-11-10 15:16:11 +08:00
Ryan Di
afed893419 keep only unique frames when ungrouping 2023-11-08 22:50:54 +08:00
4 changed files with 187 additions and 175 deletions

View File

@ -6868,10 +6868,13 @@ class App extends React.Component<AppProps, AppState> {
topLayerFrame && topLayerFrame &&
!this.state.selectedElementIds[topLayerFrame.id] !this.state.selectedElementIds[topLayerFrame.id]
) { ) {
const processedGroupIds = new Map<string, boolean>();
const elementsToAdd = selectedElements.filter( const elementsToAdd = selectedElements.filter(
(element) => (element) =>
element.frameId !== topLayerFrame.id && element.frameId !== topLayerFrame.id &&
isElementInFrame(element, nextElements, this.state), isElementInFrame(element, nextElements, this.state, {
processedGroupIds,
}),
); );
if (this.state.editingGroupId) { if (this.state.editingGroupId) {

View File

@ -1,8 +1,4 @@
import { import { getCommonBounds, getElementBounds, isTextElement } from "./element";
getCommonBounds,
getElementAbsoluteCoords,
isTextElement,
} from "./element";
import { import {
ExcalidrawElement, ExcalidrawElement,
ExcalidrawFrameElement, ExcalidrawFrameElement,
@ -56,6 +52,7 @@ export const bindElementsToFramesAfterDuplication = (
} }
}; };
// --------------------------- Frame Geometry ---------------------------------
export function isElementIntersectingFrame( export function isElementIntersectingFrame(
element: ExcalidrawElement, element: ExcalidrawElement,
frame: ExcalidrawFrameElement, frame: ExcalidrawFrameElement,
@ -85,36 +82,27 @@ export const getElementsCompletelyInFrame = (
element.frameId === frame.id, element.frameId === frame.id,
); );
export const isElementContainingFrame = (
elements: readonly ExcalidrawElement[],
element: ExcalidrawElement,
frame: ExcalidrawFrameElement,
) => {
return getElementsWithinSelection(elements, element).some(
(e) => e.id === frame.id,
);
};
export const getElementsIntersectingFrame = ( export const getElementsIntersectingFrame = (
elements: readonly ExcalidrawElement[], elements: readonly ExcalidrawElement[],
frame: ExcalidrawFrameElement, frame: ExcalidrawFrameElement,
) => elements.filter((element) => isElementIntersectingFrame(element, frame)); ) => elements.filter((element) => isElementIntersectingFrame(element, frame));
export const elementsAreInFrameBounds = ( export const elementsAreInBounds = (
elements: readonly ExcalidrawElement[], elements: readonly ExcalidrawElement[],
frame: ExcalidrawFrameElement, element: ExcalidrawElement,
tolerance = 0,
) => { ) => {
const [selectionX1, selectionY1, selectionX2, selectionY2] =
getElementAbsoluteCoords(frame);
const [elementX1, elementY1, elementX2, elementY2] = const [elementX1, elementY1, elementX2, elementY2] =
getElementBounds(element);
const [elementsX1, elementsY1, elementsX2, elementsY2] =
getCommonBounds(elements); getCommonBounds(elements);
return ( return (
selectionX1 <= elementX1 && elementX1 <= elementsX1 - tolerance &&
selectionY1 <= elementY1 && elementY1 <= elementsY1 - tolerance &&
selectionX2 >= elementX2 && elementX2 >= elementsX2 + tolerance &&
selectionY2 >= elementY2 elementY2 >= elementsY2 + tolerance
); );
}; };
@ -123,9 +111,12 @@ export const elementOverlapsWithFrame = (
frame: ExcalidrawFrameElement, frame: ExcalidrawFrameElement,
) => { ) => {
return ( return (
elementsAreInFrameBounds([element], frame) || // frame contains element
isElementIntersectingFrame(element, frame) || elementsAreInBounds([element], frame) ||
isElementContainingFrame([frame], element, frame) // element contains frame
(elementsAreInBounds([frame], element) && element.frameId === frame.id) ||
// element intersects with frame
isElementIntersectingFrame(element, frame)
); );
}; };
@ -136,7 +127,7 @@ export const isCursorInFrame = (
}, },
frame: NonDeleted<ExcalidrawFrameElement>, frame: NonDeleted<ExcalidrawFrameElement>,
) => { ) => {
const [fx1, fy1, fx2, fy2] = getElementAbsoluteCoords(frame); const [fx1, fy1, fx2, fy2] = getElementBounds(frame);
return isPointWithinBounds( return isPointWithinBounds(
[fx1, fy1], [fx1, fy1],
@ -160,7 +151,7 @@ export const groupsAreAtLeastIntersectingTheFrame = (
return !!elementsInGroup.find( return !!elementsInGroup.find(
(element) => (element) =>
elementsAreInFrameBounds([element], frame) || elementsAreInBounds([element], frame) ||
isElementIntersectingFrame(element, frame), isElementIntersectingFrame(element, frame),
); );
}; };
@ -181,7 +172,7 @@ export const groupsAreCompletelyOutOfFrame = (
return ( return (
elementsInGroup.find( elementsInGroup.find(
(element) => (element) =>
elementsAreInFrameBounds([element], frame) || elementsAreInBounds([element], frame) ||
isElementIntersectingFrame(element, frame), isElementIntersectingFrame(element, frame),
) === undefined ) === undefined
); );
@ -249,12 +240,18 @@ export const getElementsInResizingFrame = (
const prevElementsInFrame = getFrameChildren(allElements, frame.id); const prevElementsInFrame = getFrameChildren(allElements, frame.id);
const nextElementsInFrame = new Set<ExcalidrawElement>(prevElementsInFrame); const nextElementsInFrame = new Set<ExcalidrawElement>(prevElementsInFrame);
const elementsCompletelyInFrame = new Set([ const elementsCompletelyInFrame = new Set<ExcalidrawElement>(
...getElementsCompletelyInFrame(allElements, frame), getElementsCompletelyInFrame(allElements, frame),
...prevElementsInFrame.filter((element) => );
isElementContainingFrame(allElements, element, frame),
), for (const element of prevElementsInFrame) {
]); if (!elementsCompletelyInFrame.has(element)) {
// element contains the frame
if (elementsAreInBounds([frame], element)) {
elementsCompletelyInFrame.add(element);
}
}
}
const elementsNotCompletelyInFrame = prevElementsInFrame.filter( const elementsNotCompletelyInFrame = prevElementsInFrame.filter(
(element) => !elementsCompletelyInFrame.has(element), (element) => !elementsCompletelyInFrame.has(element),
@ -321,7 +318,7 @@ export const getElementsInResizingFrame = (
if (isSelected) { if (isSelected) {
const elementsInGroup = getElementsInGroup(allElements, id); const elementsInGroup = getElementsInGroup(allElements, id);
if (elementsAreInFrameBounds(elementsInGroup, frame)) { if (elementsAreInBounds(elementsInGroup, frame)) {
for (const element of elementsInGroup) { for (const element of elementsInGroup) {
nextElementsInFrame.add(element); nextElementsInFrame.add(element);
} }
@ -370,7 +367,7 @@ export const getContainingFrame = (
// --------------------------- Frame Operations ------------------------------- // --------------------------- Frame Operations -------------------------------
/** /**
* Retains (or repairs for target frame) the ordering invriant where children * Retains (or repairs for target frame) the ordering invariant where children
* elements come right before the parent frame: * elements come right before the parent frame:
* [el, el, child, child, frame, el] * [el, el, child, child, frame, el]
*/ */
@ -437,25 +434,14 @@ export const removeElementsFromFrame = (
ExcalidrawElement ExcalidrawElement
>(); >();
const toRemoveElementsByFrame = new Map<
ExcalidrawFrameElement["id"],
ExcalidrawElement[]
>();
for (const element of elementsToRemove) { for (const element of elementsToRemove) {
if (element.frameId) { if (element.frameId) {
_elementsToRemove.set(element.id, element); _elementsToRemove.set(element.id, element);
const arr = toRemoveElementsByFrame.get(element.frameId) || [];
arr.push(element);
const boundTextElement = getBoundTextElement(element); const boundTextElement = getBoundTextElement(element);
if (boundTextElement) { if (boundTextElement) {
_elementsToRemove.set(boundTextElement.id, boundTextElement); _elementsToRemove.set(boundTextElement.id, boundTextElement);
arr.push(boundTextElement);
} }
toRemoveElementsByFrame.set(element.frameId, arr);
} }
} }
@ -520,12 +506,15 @@ export const updateFrameMembershipOfSelectedElements = (
} }
const elementsToRemove = new Set<ExcalidrawElement>(); const elementsToRemove = new Set<ExcalidrawElement>();
const processedGroupIds = new Map<string, boolean>();
elementsToFilter.forEach((element) => { elementsToFilter.forEach((element) => {
if ( if (
element.frameId && element.frameId &&
!isFrameElement(element) && !isFrameElement(element) &&
!isElementInFrame(element, allElements, appState) !isElementInFrame(element, allElements, appState, {
processedGroupIds,
})
) { ) {
elementsToRemove.add(element); elementsToRemove.add(element);
} }
@ -587,26 +576,36 @@ export const getTargetFrame = (
: getContainingFrame(_element); : getContainingFrame(_element);
}; };
// TODO: this a huge bottleneck for large scenes, optimise
// given an element, return if the element is in some frame // given an element, return if the element is in some frame
export const isElementInFrame = ( export const isElementInFrame = (
element: ExcalidrawElement, element: ExcalidrawElement,
allElements: ExcalidrawElementsIncludingDeleted, allElements: ExcalidrawElementsIncludingDeleted,
appState: StaticCanvasAppState, appState: StaticCanvasAppState,
opts?: {
targetFrame?: ExcalidrawFrameElement;
processedGroupIds?: Map<string, boolean>;
},
) => { ) => {
const frame = getTargetFrame(element, appState); const frame = opts?.targetFrame ?? getTargetFrame(element, appState);
const _element = isTextElement(element) const _element = isTextElement(element)
? getContainerElement(element) || element ? getContainerElement(element) || element
: element; : element;
const groupsInFrame = (yes: boolean) => {
if (opts?.processedGroupIds) {
_element.groupIds.forEach((gid) => {
opts.processedGroupIds?.set(gid, yes);
});
}
};
if (frame) { if (frame) {
// Perf improvement: // Perf improvement:
// For an element that's already in a frame, if it's not being dragged // For an element that's already in a frame, if it's not being selected
// then there is no need to refer to geometry (which, yes, is slow) to check if it's in a frame. // and its frame is not being selected, it has to be in its containing frame.
// It has to be in its containing frame.
if ( if (
!appState.selectedElementIds[element.id] || !appState.selectedElementIds[element.id] &&
!appState.selectedElementsAreBeingDragged !appState.selectedElementIds[frame.id]
) { ) {
return true; return true;
} }
@ -615,8 +614,21 @@ export const isElementInFrame = (
return elementOverlapsWithFrame(_element, frame); return elementOverlapsWithFrame(_element, frame);
} }
for (const gid of _element.groupIds) {
if (opts?.processedGroupIds?.has(gid)) {
return opts.processedGroupIds.get(gid);
}
}
const allElementsInGroup = new Set( const allElementsInGroup = new Set(
_element.groupIds.flatMap((gid) => getElementsInGroup(allElements, gid)), _element.groupIds
.filter((gid) => {
if (opts?.processedGroupIds) {
return !opts.processedGroupIds.has(gid);
}
return true;
})
.flatMap((gid) => getElementsInGroup(allElements, gid)),
); );
if (appState.editingGroupId && appState.selectedElementsAreBeingDragged) { if (appState.editingGroupId && appState.selectedElementsAreBeingDragged) {
@ -637,16 +649,22 @@ export const isElementInFrame = (
for (const elementInGroup of allElementsInGroup) { for (const elementInGroup of allElementsInGroup) {
if (isFrameElement(elementInGroup)) { if (isFrameElement(elementInGroup)) {
groupsInFrame(false);
return false; return false;
} }
} }
for (const elementInGroup of allElementsInGroup) { for (const elementInGroup of allElementsInGroup) {
if (elementOverlapsWithFrame(elementInGroup, frame)) { if (elementOverlapsWithFrame(elementInGroup, frame)) {
groupsInFrame(true);
return true; return true;
} }
} }
} }
if (_element.groupIds.length > 0) {
groupsInFrame(false);
}
return false; return false;
}; };

View File

@ -232,6 +232,8 @@ export const selectGroupsFromGivenElements = (
selectedGroupIds: {}, selectedGroupIds: {},
}; };
const processedGroupIds = new Set<string>();
for (const element of elements) { for (const element of elements) {
let groupIds = element.groupIds; let groupIds = element.groupIds;
if (appState.editingGroupId) { if (appState.editingGroupId) {
@ -242,10 +244,13 @@ export const selectGroupsFromGivenElements = (
} }
if (groupIds.length > 0) { if (groupIds.length > 0) {
const groupId = groupIds[groupIds.length - 1]; const groupId = groupIds[groupIds.length - 1];
nextAppState = { if (!processedGroupIds.has(groupId)) {
...nextAppState, nextAppState = {
...selectGroup(groupId, nextAppState, elements), ...nextAppState,
}; ...selectGroup(groupId, nextAppState, elements),
};
processedGroupIds.add(groupId);
}
} }
} }

View File

@ -71,6 +71,7 @@ import { renderSnaps } from "./renderSnaps";
import { import {
isEmbeddableElement, isEmbeddableElement,
isFrameElement, isFrameElement,
isFreeDrawElement,
isLinearElement, isLinearElement,
} from "../element/typeChecks"; } from "../element/typeChecks";
import { import {
@ -78,7 +79,7 @@ import {
createPlaceholderEmbeddableLabel, createPlaceholderEmbeddableLabel,
} from "../element/embeddable"; } from "../element/embeddable";
import { import {
elementOverlapsWithFrame, elementsAreInBounds,
getTargetFrame, getTargetFrame,
isElementInFrame, isElementInFrame,
} from "../frame"; } from "../frame";
@ -945,102 +946,79 @@ const _renderStaticScene = ({
); );
} }
const groupsToBeAddedToFrame = new Set<string>(); // Paint visible elements with embeddables on top
const visibleNonEmbeddableOrLabelElements = visibleElements.filter(
(el) => !isEmbeddableOrLabel(el),
);
visibleElements.forEach((element) => { const visibleEmbeddableOrLabelElements = visibleElements.filter((el) =>
if ( isEmbeddableOrLabel(el),
element.groupIds.length > 0 && );
appState.frameToHighlight &&
appState.selectedElementIds[element.id] && const visibleElementsToRender = [
(elementOverlapsWithFrame(element, appState.frameToHighlight) || ...visibleNonEmbeddableOrLabelElements,
element.groupIds.find((groupId) => groupsToBeAddedToFrame.has(groupId))) ...visibleEmbeddableOrLabelElements,
) { ];
element.groupIds.forEach((groupId) =>
groupsToBeAddedToFrame.add(groupId), const _renderElement = (element: ExcalidrawElement) => {
); try {
renderElement(element, rc, context, renderConfig, appState);
if (
isEmbeddableElement(element) &&
(isExporting || !element.validated) &&
element.width &&
element.height
) {
const label = createPlaceholderEmbeddableLabel(element);
renderElement(label, rc, context, renderConfig, appState);
}
if (!isExporting) {
renderLinkIcon(element, context, appState);
}
} catch (error: any) {
console.error(error);
} }
}); };
// Paint visible elements const processedGroupIds = new Map<string, boolean>();
visibleElements for (const element of visibleElementsToRender) {
.filter((el) => !isEmbeddableOrLabel(el)) const frameId = element.frameId || appState.frameToHighlight?.id;
.forEach((element) => {
try {
const frameId = element.frameId || appState.frameToHighlight?.id;
if ( if (
frameId && frameId &&
appState.frameRendering.enabled && appState.frameRendering.enabled &&
appState.frameRendering.clip appState.frameRendering.clip
) { ) {
context.save(); const targetFrame = getTargetFrame(element, appState);
// for perf:
const frame = getTargetFrame(element, appState); // only clip elements that are not completely in the target frame
if (
// TODO do we need to check isElementInFrame here? targetFrame &&
if (frame && isElementInFrame(element, elements, appState)) { !elementsAreInBounds(
frameClip(frame, context, renderConfig, appState); [element],
} targetFrame,
renderElement(element, rc, context, renderConfig, appState); isFreeDrawElement(element)
context.restore(); ? element.strokeWidth * 8
} else { : element.roughness * (isLinearElement(element) ? 8 : 4),
renderElement(element, rc, context, renderConfig, appState); ) &&
} isElementInFrame(element, elements, appState, {
if (!isExporting) { targetFrame,
renderLinkIcon(element, context, appState); processedGroupIds,
} })
} catch (error: any) { ) {
console.error(error); context.save();
frameClip(targetFrame, context, renderConfig, appState);
_renderElement(element);
context.restore();
} else {
_renderElement(element);
} }
}); } else {
_renderElement(element);
// render embeddables on top }
visibleElements }
.filter((el) => isEmbeddableOrLabel(el))
.forEach((element) => {
try {
const render = () => {
renderElement(element, rc, context, renderConfig, appState);
if (
isEmbeddableElement(element) &&
(isExporting || !element.validated) &&
element.width &&
element.height
) {
const label = createPlaceholderEmbeddableLabel(element);
renderElement(label, rc, context, renderConfig, appState);
}
if (!isExporting) {
renderLinkIcon(element, context, appState);
}
};
// - when exporting the whole canvas, we DO NOT apply clipping
// - when we are exporting a particular frame, apply clipping
// if the containing frame is not selected, apply clipping
const frameId = element.frameId || appState.frameToHighlight?.id;
if (
frameId &&
appState.frameRendering.enabled &&
appState.frameRendering.clip
) {
context.save();
const frame = getTargetFrame(element, appState);
if (frame && isElementInFrame(element, elements, appState)) {
frameClip(frame, context, renderConfig, appState);
}
render();
context.restore();
} else {
render();
}
} catch (error: any) {
console.error(error);
}
});
}; };
/** throttled to animation framerate */ /** throttled to animation framerate */
@ -1145,7 +1123,7 @@ const renderTransformHandles = (
const renderSelectionBorder = ( const renderSelectionBorder = (
context: CanvasRenderingContext2D, context: CanvasRenderingContext2D,
appState: InteractiveCanvasAppState, appState: InteractiveCanvasAppState | StaticCanvasAppState,
elementProperties: { elementProperties: {
angle: number; angle: number;
elementX1: number; elementX1: number;
@ -1310,6 +1288,23 @@ const renderFrameHighlight = (
context.restore(); context.restore();
}; };
const getSelectionFromElements = (elements: ExcalidrawElement[]) => {
const [elementX1, elementY1, elementX2, elementY2] =
getCommonBounds(elements);
return {
angle: 0,
elementX1,
elementX2,
elementY1,
elementY2,
selectionColors: ["rgb(0,118,255)"],
dashed: false,
cx: elementX1 + (elementX2 - elementX1) / 2,
cy: elementY1 + (elementY2 - elementY1) / 2,
activeEmbeddable: false,
};
};
const renderElementsBoxHighlight = ( const renderElementsBoxHighlight = (
context: CanvasRenderingContext2D, context: CanvasRenderingContext2D,
appState: InteractiveCanvasAppState, appState: InteractiveCanvasAppState,
@ -1323,37 +1318,28 @@ const renderElementsBoxHighlight = (
(element) => element.groupIds.length > 0, (element) => element.groupIds.length > 0,
); );
const getSelectionFromElements = (elements: ExcalidrawElement[]) => { const processedGroupIds = new Set<string>();
const [elementX1, elementY1, elementX2, elementY2] =
getCommonBounds(elements);
return {
angle: 0,
elementX1,
elementX2,
elementY1,
elementY2,
selectionColors: ["rgb(0,118,255)"],
dashed: false,
cx: elementX1 + (elementX2 - elementX1) / 2,
cy: elementY1 + (elementY2 - elementY1) / 2,
activeEmbeddable: false,
};
};
const getSelectionForGroupId = (groupId: GroupId) => { const getSelectionForGroupId = (groupId: GroupId) => {
const groupElements = getElementsInGroup(elements, groupId); if (!processedGroupIds.has(groupId)) {
return getSelectionFromElements(groupElements); const groupElements = getElementsInGroup(elements, groupId);
processedGroupIds.add(groupId);
return getSelectionFromElements(groupElements);
}
return null;
}; };
Object.entries(selectGroupsFromGivenElements(elementsInGroups, appState)) Object.entries(selectGroupsFromGivenElements(elementsInGroups, appState))
.filter(([id, isSelected]) => isSelected) .filter(([id, isSelected]) => isSelected)
.map(([id, isSelected]) => id) .map(([id, isSelected]) => id)
.map((groupId) => getSelectionForGroupId(groupId)) .map((groupId) => getSelectionForGroupId(groupId))
.filter((selection) => selection)
.concat( .concat(
individualElements.map((element) => getSelectionFromElements([element])), individualElements.map((element) => getSelectionFromElements([element])),
) )
.forEach((selection) => .forEach((selection) =>
renderSelectionBorder(context, appState, selection), renderSelectionBorder(context, appState, selection!),
); );
}; };