Merge pull request #1341 from GColoy/boolean-Operations

Boolean operations

ea-scripts/Boolean Operations.md

@@ -0,0 +1,361 @@
+/*
+With This Script it is possible to make boolean Operations on Shapes. 
+The style of the resulting shape will be the style of the highest ranking Element that was used. 
+The ranking of the elemtns is based on their background. The "denser" the background, the higher the ranking (the order of backgroundstyles is shown below). If they have the same background the opacity will decide. If thats also the same its decided by the order they were created.
+The ranking is also important for the diffrence operation, so a tranparent object for example will cut a hole into a solid object.
+![](https://raw.githubusercontent.com/zsviczian/obsidian-excalidraw-plugin/master/images/scripts-boolean-operations-showcase.png)
+![](https://raw.githubusercontent.com/zsviczian/obsidian-excalidraw-plugin/master/images/scripts-boolean-operations-element-ranking.png)
+
+
+See documentation for more details:
+https://zsviczian.github.io/obsidian-excalidraw-plugin/ExcalidrawScriptsEngine.html
+
+```javascript
+*/
+if(!ea.verifyMinimumPluginVersion || !ea.verifyMinimumPluginVersion("1.9.20")) {
+  new Notice("This script requires a newer version of Excalidraw. Please install the latest version.");
+  return;
+}
+const ShadowGroupMarker = "ShadowCloneOf-";
+
+
+const PolyBool = ea.getPolybool();
+const polyboolAction = await utils.suggester(["union (a + b)", "intersect (a && b)", "diffrence (a - b)", "reversed diffrence (b - a)", "xor"], [
+  PolyBool.union, PolyBool.intersect, PolyBool.difference, PolyBool.differenceRev, PolyBool.xor
+], "What would you like todo with the object");
+
+const elements = ea.getViewSelectedElements();
+const shadowClones = elements.filter(element => element.groupIds.some(id => id.startsWith(ShadowGroupMarker)));
+shadowClones.forEach(shadowClone => {
+  let parentId = shadowClone.groupIds
+    .filter(id => id.startsWith(ShadowGroupMarker))[0]
+    .slice(ShadowGroupMarker.length);
+  const shadowCloneIndex = elements.findIndex(element => element.id == parentId);
+  if (shadowCloneIndex == -1) return;
+  elements[shadowCloneIndex].backgroundColor = shadowClone.backgroundColor;
+  elements[shadowCloneIndex].fillStyle = shadowClone.fillStyle;
+})
+const borderElements = elements.filter(element => !element.groupIds.some(id => id.startsWith(ShadowGroupMarker)));
+groups = ea.getMaximumGroups(borderElements);
+groups = groups.map((group) => group.sort((a, b) => RankElement(b) - RankElement(a)));
+groups.sort((a, b) => RankElement(b[0]) - RankElement(a[0]));
+
+ea.style.strokeColor = groups[0][0].strokeColor;
+ea.style.backgroundColor = groups[0][0].backgroundColor;
+ea.style.fillStyle = groups[0][0].fillStyle;
+ea.style.strokeWidth = groups[0][0].strokeWidth;
+ea.style.strokeStyle = groups[0][0].strokeStyle;
+ea.style.roughness = groups[0][0].roughness;
+ea.style.opacity = groups[0][0].opacity;
+
+const basePolygons = groups.shift().map(element => traceElement(element));
+const toolPolygons = groups.flatMap(group => group.map(element => traceElement(element)));
+
+const result = polyboolAction({
+  regions: basePolygons,
+  inverted: false
+}, {
+  regions: toolPolygons,
+  inverted: false
+});
+const polygonHierachy = subordinateInnerPolygons(result.regions);
+drawPolygonHierachy(polygonHierachy);
+ea.deleteViewElements(elements);
+ea.addElementsToView(false,false,true);
+return;
+
+
+
+function traceElement(element) {
+  const diamondPath = (diamond) => [
+      SxVEC(1/2, [0, diamond.height]),
+      SxVEC(1/2, [diamond.width, 0]),
+      addVec([SxVEC(1/2, [0, diamond.height]), ([diamond.width, 0])]),
+      addVec([SxVEC(1/2, [diamond.width, 0]), ([0, diamond.height])]),
+      SxVEC(1/2, [0, diamond.height])
+    ];
+  const rectanglePath = (rectangle) => [
+    [0,0],
+    [0, rectangle.height],
+    [rectangle.width, rectangle.height],
+    [rectangle.width, 0],
+    [0, 0]
+  ]
+  const ellipsePath = (ellipse) => {
+    const angle = ellipse.angle;
+    const width = ellipse.width;
+    const height = ellipse.height;
+    const ellipseAtPoint = (t) => {
+      const spanningVector = [width/2*Math.cos(t), height/2*Math.sin(t)];
+      const baseVector = [width/2, height/2];
+      return addVec([spanningVector, baseVector]);
+    }
+    let points = [];
+    step = (2*Math.PI)/64
+    for (let t = 0; t < 2*Math.PI; t = t + step) {
+      points.push(ellipseAtPoint(t));
+    }
+    return points;
+  }
+  let polygon;
+  let correctForPolygon = [0, 0];
+  switch (element.type) {
+    case "diamond":
+      polygon = diamondPath(element);
+      break;
+    case "rectangle":
+      polygon = rectanglePath(element);
+      break;
+    case "ellipse":
+      polygon = ellipsePath(element);
+      break;
+    case "line":
+    case "arrow":
+      if (element.angle != 0) {
+        let smallestX = 0;
+        let smallestY = 0;
+        element.points.forEach(point => {
+          if (point[0] < smallestX) smallestX = point[0];
+          if (point[1] < smallestY) smallestY = point[1];
+        });
+        polygon = element.points.map(point => {
+          return [
+            point[0] -= smallestX,
+            point[1] -= smallestY
+          ];
+        });
+        correctForPolygon = [smallestX, smallestY];
+        break;
+      }
+      if (element.roundness) {
+        new Notice("This script does not work with curved lines or arrows yet!");
+        return [];
+      }
+      polygon = element.points; 
+      default:
+          break;
+    }
+  if (element.angle == 0) return polygon.map(v => addVec([v, [element.x, element.y]]));
+  
+  polygon = polygon.map(v => addVec([v, SxVEC(-1/2, [element.width, element.height])]));
+  polygon = rotateVectorsByAngle(polygon, element.angle);
+  return polygon.map(v => addVec([v, [element.x, element.y], SxVEC(1/2, [element.width, element.height]), correctForPolygon]));
+}
+
+function RankElement(element) {
+  let score = 0;
+  const backgroundRank = [
+    "dashed",
+    "none",
+    "hachure",
+    "zigzag",
+    "zigzag-line",
+    "cross-hatch",
+    "solid"
+  ]
+  score += (backgroundRank.findIndex((fillStyle) => fillStyle == element.fillStyle) + 1) * 10;
+  if (element.backgroundColor == "transparent") score -= 100;
+  if (element.points && getVectorLength(element.points[element.points.length - 1]) > 8) score -= 100; 
+  if (score < 0) score = 0;
+  score += element.opacity / 100;
+  return score;
+}
+
+function drawPolygonHierachy(polygonHierachy) {
+  const backgroundColor = ea.style.backgroundColor;
+  const strokeColor = ea.style.strokeColor;
+  const setInnerStyle = () => {
+    ea.style.backgroundColor = backgroundColor;
+    ea.style.strokeColor = "transparent";
+  }
+  const setBorderStyle = () => {
+    ea.style.backgroundColor = "transparent";
+    ea.style.strokeColor = strokeColor;
+  }
+  const setFilledStyle = () => {
+    ea.style.backgroundColor = backgroundColor;
+    ea.style.strokeColor = strokeColor;
+  }
+  
+  polygonHierachy.forEach(polygon => {
+    setFilledStyle();
+    let path = polygon.path;
+    path.push(polygon.path[0]);
+    if (polygon.innerPolygons.length === 0) {
+      ea.addLine(path);
+      return;
+    }
+    const outerBorder = path;
+    const innerPolygons = addInnerPolygons(polygon.innerPolygons);
+    path = path.concat(innerPolygons.backgroundPath);
+    path.push(polygon.path[0]);
+    setInnerStyle();
+    const backgroundId = ea.addLine(path);
+    setBorderStyle();
+    const outerBorderId = ea.addLine(outerBorder)
+    const innerBorderIds = innerPolygons.borderPaths.map(path => ea.addLine(path));
+    const allIds = [innerBorderIds, outerBorderId, backgroundId].flat();
+    ea.addToGroup(allIds);
+    const background = ea.getElement(backgroundId);
+    background.groupIds.push(ShadowGroupMarker + outerBorderId);
+  });
+}
+
+function addInnerPolygons(polygonHierachy) {
+  let firstPath = [];
+  let secondPath = [];
+  let borderPaths = [];
+  polygonHierachy.forEach(polygon => {
+    let path = polygon.path;
+    path.push(polygon.path[0]);
+    borderPaths.push(path);
+    firstPath = firstPath.concat(path);
+    secondPath.push(polygon.path[0]);
+    drawPolygonHierachy(polygon.innerPolygons);
+  });
+  return {
+    backgroundPath: firstPath.concat(secondPath.reverse()), 
+    borderPaths: borderPaths
+  };
+}
+
+function subordinateInnerPolygons(polygons) {
+  const polygonObjectPrototype = (polygon) => {
+    return {
+      path: polygon,
+      innerPolygons: []
+    };
+  }
+
+  const insertPolygonIntoHierachy = (polygon, hierarchy) => {
+    for (let i = 0; i < hierarchy.length; i++) {
+      const polygonObject = hierarchy[i];
+      let inside = null;
+      let pointIndex = 0;
+      do {
+        inside = pointInPolygon(polygon[pointIndex], polygonObject.path);
+        pointIndex++
+      } while (inside === null);
+      if (inside) {
+        hierarchy[i].innerPolygons = insertPolygonIntoHierachy(polygon, hierarchy[i].innerPolygons);
+        return hierarchy;
+      }
+    }
+    polygon = polygonObjectPrototype(polygon);
+    for (let i = 0; i < hierarchy.length; i++) {
+      const polygonObject = hierarchy[i];
+      let inside = null;
+      let pointIndex = 0;
+      do {
+        inside = pointInPolygon(polygonObject.path[pointIndex], polygon.path);
+        pointIndex++
+      } while (inside === null);
+      if (inside) {
+        polygon.innerPolygons.push(hierarchy.splice(i, 1)[0]);
+        i--;
+      }
+    }
+    hierarchy.push(polygon);
+    return hierarchy;
+  }
+
+  let polygonHierachy = [];
+  polygons.forEach(polygon => {
+    polygonHierachy = insertPolygonIntoHierachy(polygon, polygonHierachy);
+  })
+
+  return polygonHierachy;
+}
+
+/**
+ * Checks if the given point lays in the polygon
+ * @param point array [x, y]
+ * @param polygon array [[x, y], ...]
+ * @returns true if inside, false if not, null if the point is on one of the polygons vertecies
+ */
+function pointInPolygon(point, polygon) {
+  const x = point[0];
+  const y = point[1];
+  let inside = false;
+
+  // odd even test if point is in polygon
+  for (let i = 0, j = polygon.length - 1; i < polygon.length; j = i++) {
+    const xi = polygon[i][0];
+    const yi = polygon[i][1];
+    const xj = polygon[j][0];
+    const yj = polygon[j][1];
+
+    const intersect =
+      yi > y !== yj > y &&
+      x < ((xj - xi) * (y - yi)) / (yj - yi) + xi;
+
+    if (intersect) {
+      inside = !inside;
+    }
+
+    if ((x === xi && y === yi) || (x === xj && y === yj)) {
+      return null;
+    }
+  }
+
+  return inside;
+}
+
+
+function getVectorLength(vector) {
+  return Math.sqrt(vector[0]**2+vector[1]**2);
+}
+
+/**
+ * Adds two Vectors together
+ */
+function addVec(vectors) {
+  return vectors.reduce((acc, vec) => [acc[0] + vec[0], acc[1] + vec[1]], [0, 0]);
+}
+
+/**
+ * Returns the negative of the vector
+ */
+function negVec(vector) {
+  return [-vector[0], -vector[1]];
+}
+ 
+/**
+ * Multiplies Vector with a scalar
+ */
+function SxVEC(scalar, vector) {
+  return [vector[0] * scalar, vector[1] * scalar];
+}
+
+function rotateVector (vec, ang)  {
+  var cos = Math.cos(ang);
+  var sin = Math.sin(ang);
+  return [vec[0] * cos - vec[1] * sin, vec[0] * sin + vec[1] * cos];
+}
+
+function rotateVectorsByAngle(vectors, angle) {
+  const cosAngle = Math.cos(angle);
+  const sinAngle = Math.sin(angle);
+
+  const rotationMatrix = [
+    [cosAngle, -sinAngle],
+    [sinAngle, cosAngle]
+  ];
+
+  return applyTranformationMatrix(vectors, rotationMatrix);
+}
+
+function applyTranformationMatrix(vectors, transformationMatrix) {
+  const result = [];
+  for (const vector of vectors) {
+    const x = vector[0];
+    const y = vector[1];
+
+    const newX = transformationMatrix[0][0] * x + transformationMatrix[0][1] * y;
+    const newY = transformationMatrix[1][0] * x + transformationMatrix[1][1] * y;
+
+    result.push([newX, newY]);
+  }
+
+  return result;
+}

ea-scripts/README.md

@@ -33,6 +33,7 @@ Open the script you are interested in and save it to your Obsidian Vault includi
 |[Add Link to Existing File and Open](Add%20Link%20to%20Existing%20File%20and%20Open.md)|Prompts for a file from the vault. Adds a link to the selected element pointing to the selected file. You can control in settings to open the file in the current active pane or an adjacent pane.|![](https://raw.githubusercontent.com/zsviczian/obsidian-excalidraw-plugin/master/images/scripts-add-link-and-open.jpg)|[@zsviczian](https://github.com/zsviczian)|
 |[Add Link to New Page and Open](Add%20Link%20and%20Open%20Page.md)|Prompts for filename. Offers option to create and open a new Markdown or Excalidraw document. Adds link pointing to the new file, to the selected objects in the drawing. You can control in settings to open the file in the current active pane or an adjacent pane.|![](https://raw.githubusercontent.com/zsviczian/obsidian-excalidraw-plugin/master/images/scripts-add-link-to-new-page-and-pen.jpg)|[@zsviczian](https://github.com/zsviczian)|
 |[Add Next Step in Process](Add%20Link%20to%20New%20Page%20and%20Open.md)|This script will prompt you for the title of the process step, then will create a stick note with the text. If an element is selected then the script will connect this new step with an arrow to the previous step (the selected element). If no element is selected, then the script assumes this is the first step in the process and will only output the sticky note with the text that was entered.|![](https://raw.githubusercontent.com/zsviczian/obsidian-excalidraw-plugin/master/images/scripts-add-process-step.jpg)|[@zsviczian](https://github.com/zsviczian)|
+|[Split Ellipse](Boolean%20Operations.md)|With This Script it is possible to make boolean Operations on Shapes.|![](https://raw.githubusercontent.com/zsviczian/obsidian-excalidraw-plugin/master/images/scripts-boolean-operations-showcase.png)|[@GColoy](https://github.com/GColoy)|
 |[Box Each Selected Groups](Box%20Each%20Selected%20Groups.md)|This script will add encapsulating boxes around each of the currently selected groups in Excalidraw.|![](https://raw.githubusercontent.com/zsviczian/obsidian-excalidraw-plugin/master/images/scripts-box-each-selected-groups.png)|[@1-2-3](https://github.com/1-2-3)|
 |[Box Selected Elements](Box%20Selected%20Elements.md)|This script will add an encapsulating box around the currently selected elements in Excalidraw.|![](https://raw.githubusercontent.com/zsviczian/obsidian-excalidraw-plugin/master/images/scripts-box-elements.jpg)|[@zsviczian](https://github.com/zsviczian)|
 |[Change shape of selected elements](Change%20shape%20of%20selected%20elements.md)|The script allows you to change the shape of selected Rectangles, Diamonds and Ellipses|![](https://raw.githubusercontent.com/zsviczian/obsidian-excalidraw-plugin/master/images/scripts-change-shape.jpg)|[@zsviczian](https://github.com/zsviczian)|

ea-scripts/index-new.md

@@ -112,6 +112,7 @@ I would love to include your contribution in the script library. If you have a s
 |    |     |
 |----|-----|
 |<div><img src="https://raw.githubusercontent.com/zsviczian/obsidian-excalidraw-plugin/master/ea-scripts/Auto%20Draw%20for%20Pen.svg"/></div>|[[#Auto Draw for Pen]]|
+|<div><img src="https://raw.githubusercontent.com/zsviczian/obsidian-excalidraw-plugin/master/ea-scripts/Boolean%20Operations.svg"/></div>|[[#Boolean Operations]]|
 |<div><img src="https://raw.githubusercontent.com/zsviczian/obsidian-excalidraw-plugin/master/ea-scripts/Copy%20Selected%20Element%20Styles%20to%20Global.svg"/></div>|[[#Copy Selected Element Styles to Global]]|
 |<div><img src="https://raw.githubusercontent.com/zsviczian/obsidian-excalidraw-plugin/master/ea-scripts/Hardware%20Eraser%20Support.svg"/></div>|[[#Hardware Eraser Support]]|
 |<div><img src="https://raw.githubusercontent.com/zsviczian/obsidian-excalidraw-plugin/master/ea-scripts/Palette%20loader.svg"/></div>|[[#Palette Loader]]|
@@ -179,6 +180,13 @@ https://raw.githubusercontent.com/zsviczian/obsidian-excalidraw-plugin/master/ea
 ```
 <table><tr  valign='top'><td class="label">Author</td><td class="data"><a href='https://github.com/1-2-3'>@1-2-3</a></td></tr><tr valign='top'><td class="label">Source</td><td class="data"><a href='https://github.com/zsviczian/obsidian-excalidraw-plugin/blob/master/ea-scripts/Auto%20Layout.md'>File on GitHub</a></td></tr><tr valign='top'><td class="label">Description</td><td class="data">This script performs automatic layout for the selected top-level grouping objects. It is powered by <a href='https://github.com/kieler/elkjs'>elkjs</a> and needs to be connected to the Internet.<br><img src='https://raw.githubusercontent.com/zsviczian/obsidian-excalidraw-plugin/master/images/scripts-auto-layout.png'></td></tr></table>
 
+## Boolean Operations
+```excalidraw-script-install
+https://raw.githubusercontent.com/zsviczian/obsidian-excalidraw-plugin/master/ea-scripts/Boolean%20Operations.md
+```
+<table><tr  valign='top'><td class="label">Author</td><td class="data"><a href='https://github.com/GColoy'>@GColoy</a></td></tr><tr valign='top'><td class="label">Source</td><td class="data"><a href='https://github.com/zsviczian/obsidian-excalidraw-plugin/blob/master/ea-scripts/Boolean%20Operations.md'>File on GitHub</a></td></tr><tr valign='top'><td class="label">Description</td><td class="data">With This Script it is possible to make boolean Operations on Shapes.<br>The style of the resulting shape will be the style of the highest ranking Element that was used.<br>The ranking of the elemtns is based on their background. The "denser" the background, the higher the ranking (the order of backgroundstyles is shown below). If they have the same background the opacity will decide. If thats also the same its decided by the order they were created.<br>The ranking is also important for the diffrence operation, so a tranparent object for example will cut a hole into a solid object.<br><img src='https://raw.githubusercontent.com/zsviczian/obsidian-excalidraw-plugin/master/images/scripts-boolean-operations-showcase.png'><br><img src='https://raw.githubusercontent.com/zsviczian/obsidian-excalidraw-plugin/master/images/scripts-boolean-operations-element-ranking.png'></td></tr></table>
+
+
 ## Box Each Selected Groups
 ```excalidraw-script-install
 https://raw.githubusercontent.com/zsviczian/obsidian-excalidraw-plugin/master/ea-scripts/Box%20Each%20Selected%20Groups.md

package.json

@@ -25,6 +25,7 @@
     "gl-matrix": "^3.4.3",
     "lz-string": "^1.5.0",
     "monkey-around": "^2.3.0",
+    "polybooljs": "^1.2.0",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
     "roughjs": "^4.5.2",

src/ExcalidrawAutomate.ts

@@ -78,6 +78,7 @@ import { ROUNDNESS } from "src/constants";
 import { ClipboardData } from "@zsviczian/excalidraw/types/clipboard";
 import { emulateKeysForLinkClick, KeyEvent, PaneTarget } from "src/utils/ModifierkeyHelper";
 import { Mutable } from "@zsviczian/excalidraw/types/utility-types";
+import PolyBool from "polybooljs";
 
 extendPlugins([
   HarmonyPlugin,
@@ -2307,6 +2308,16 @@ export class ExcalidrawAutomate {
     return CM(color);
   }
 
+  /**
+   * Gets the class PolyBool from https://github.com/velipso/polybooljs
+   * @returns 
+   */
+  getPolyool() {
+    const defaultEpsilon = 0.0000000001;
+    PolyBool.epsilon(defaultEpsilon);
+    return PolyBool;
+  }
+
   importSVG(svgString:string):boolean {
     const res:ConversionResult =  svgToExcalidraw(svgString);
     if(res.hasErrors) {

src/polybooljs.d.ts

@@ -0,0 +1 @@
+declare module "polybooljs";