@jscad/modeling 2.8.0 → 2.9.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jscad/modeling",
-  "version": "2.8.0",
+  "version": "2.9.0",
   "description": "Constructive Solid Geometry (CSG) Library for JSCAD",
   "repository": "https://github.com/jscad/OpenJSCAD.org",
   "main": "src/index.js",
@@ -60,5 +60,5 @@
     "nyc": "15.1.0",
     "uglifyify": "5.0.2"
   },
-  "gitHead": "92fb9c75eb070fca5f5ee8c2bab6614b1f54514e"
+  "gitHead": "45fbcb7298fcacf3e45d67fdca32d0744ab7f2de"
 }

package/src/geometries/poly3/invert.js

@@ -1,3 +1,4 @@
+const plane = require('../../maths/plane')
 const create = require('./create')
 
 /**
@@ -9,7 +10,12 @@ const create = require('./create')
  */
 const invert = (polygon) => {
   const vertices = polygon.vertices.slice().reverse()
-  return create(vertices)
+  const inverted = create(vertices)
+  if (polygon.plane) {
+    // Flip existing plane to save recompute
+    inverted.plane = plane.flip(plane.create(), polygon.plane)
+  }
+  return inverted
 }
 
 module.exports = invert

package/src/operations/expansions/expand.test.js

@@ -120,7 +120,7 @@ test('expand: expanding of a geom3 produces expected changes to polygons', (t) =
   const geometry2 = sphere({ radius: 5, segments: 8 })
   const obs2 = expand({ delta: 5 }, geometry2)
   const pts2 = geom3.toPoints(obs2)
-  t.is(pts2.length, 1612)
+  t.is(pts2.length, 1588)
 })
 
 test('expand (options): offsetting of a complex geom2 produces expected offset geom2', (t) => {

package/src/operations/expansions/expandShell.js

@@ -15,7 +15,7 @@ const unionGeom3Sub = require('../booleans/unionGeom3Sub')
 
 const extrudePolygon = require('./extrudePolygon')
 
-/**
+/*
  * Collect all planes adjacent to each vertex
  */
 const mapPlaneToVertex = (map, vertex, plane) => {
@@ -29,7 +29,7 @@ const mapPlaneToVertex = (map, vertex, plane) => {
   }
 }
 
-/**
+/*
  * Collect all planes adjacent to each edge.
  * Combine undirected edges, no need for duplicate cylinders.
  */

package/src/operations/extrusions/earcut/assignHoles.js

@@ -0,0 +1,87 @@
+const { area } = require('../../../maths/utils')
+const { toOutlines } = require('../../../geometries/geom2')
+const { arePointsInside } = require('../../../geometries/poly2')
+
+/*
+ * Constructs a polygon hierarchy of solids and holes.
+ * The hierarchy is represented as a forest of trees. All trees shall be depth at most 2.
+ * If a solid exists inside the hole of another solid, it will be split out as its own root.
+ *
+ * @param {geom2} geometry
+ * @returns {Array} an array of polygons with associated holes
+ * @alias module:modeling/geometries/geom2.toTree
+ *
+ * @example
+ * const geometry = subtract(rectangle({size: [5, 5]}), rectangle({size: [3, 3]}))
+ * console.log(assignHoles(geometry))
+ * [{
+ *   "solid": [[-2.5,-2.5],[2.5,-2.5],[2.5,2.5],[-2.5,2.5]],
+ *   "holes": [[[-1.5,1.5],[1.5,1.5],[1.5,-1.5],[-1.5,-1.5]]]
+ * }]
+ */
+const assignHoles = (geometry) => {
+  const outlines = toOutlines(geometry)
+  const solids = [] // solid indices
+  const holes = [] // hole indices
+  outlines.forEach((outline, i) => {
+    const a = area(outline)
+    if (a < 0) {
+      holes.push(i)
+    } else if (a > 0) {
+      solids.push(i)
+    }
+  })
+  // for each hole, determine what solids it is inside of
+  const children = [] // child holes of solid[i]
+  const parents = [] // parent solids of hole[i]
+  solids.forEach((s, i) => {
+    const solid = outlines[s]
+    children[i] = []
+    holes.forEach((h, j) => {
+      const hole = outlines[h]
+      // check if a point of hole j is inside solid i
+      if (arePointsInside([hole[0]], { vertices: solid })) {
+        children[i].push(h)
+        if (!parents[j]) parents[j] = []
+        parents[j].push(i)
+      }
+    })
+  })
+  // check if holes have multiple parents and choose one with fewest children
+  holes.forEach((h, j) => {
+    // ensure at least one parent exists
+    if (parents[j] && parents[j].length > 1) {
+      const parent = minIndex(parents[j], (p) => p.length)
+      parents[j].forEach((p, i) => {
+        if (i !== parent) {
+          // Remove hole from skip level parents
+          children[p] = children[p].filter((c) => c !== j)
+        }
+      })
+    }
+  })
+  // map indices back to points
+  return children.map((holes, i) => ({
+    solid: outlines[solids[i]],
+    holes: holes.map((h) => outlines[h])
+  }))
+}
+
+/*
+ * Find the item in the list with smallest score(item).
+ * If the list is empty, return undefined.
+ */
+const minIndex = (list, score) => {
+  let bestIndex
+  let best
+  list.forEach((item, index) => {
+    const value = score(item)
+    if (best === undefined || value < best) {
+      bestIndex = index
+      best = value
+    }
+  })
+  return bestIndex
+}
+
+module.exports = assignHoles

package/src/operations/extrusions/earcut/assignHoles.test.js

@@ -0,0 +1,28 @@
+const test = require('ava')
+
+const { subtract } = require('../../../operations/booleans')
+const rectangle = require('../../../primitives/rectangle')
+const assignHoles = require('./assignHoles')
+
+test('slice: assignHoles() should return a polygon hierarchy', (t) => {
+  const exp1 = [{
+    solid: [
+      [-3.000013333333334, -3.000013333333334],
+      [3.000013333333334, -3.000013333333334],
+      [3.000013333333334, 3.000013333333334],
+      [-3.000013333333334, 3.000013333333334]
+    ],
+    holes: [[
+      [-1.9999933333333335, 1.9999933333333335],
+      [1.9999933333333335, 1.9999933333333335],
+      [1.9999933333333335, -1.9999933333333335],
+      [-1.9999933333333335, -1.9999933333333335]
+    ]]
+  }]
+  const geometry = subtract(
+    rectangle({ size: [6, 6] }),
+    rectangle({ size: [4, 4] })
+  )
+  const obs1 = assignHoles(geometry)
+  t.deepEqual(obs1, exp1)
+})

package/src/operations/extrusions/earcut/eliminateHoles.js

@@ -0,0 +1,131 @@
+const { filterPoints, linkedPolygon, locallyInside, splitPolygon } = require('./linkedPolygon')
+const { area, pointInTriangle } = require('./triangle')
+
+/*
+ * link every hole into the outer loop, producing a single-ring polygon without holes
+ *
+ * Original source from https://github.com/mapbox/earcut
+ * Copyright (c) 2016 Mapbox
+ */
+const eliminateHoles = (data, holeIndices, outerNode, dim) => {
+  const queue = []
+
+  for (let i = 0, len = holeIndices.length; i < len; i++) {
+    const start = holeIndices[i] * dim
+    const end = i < len - 1 ? holeIndices[i + 1] * dim : data.length
+    const list = linkedPolygon(data, start, end, dim, false)
+    if (list === list.next) list.steiner = true
+    queue.push(getLeftmost(list))
+  }
+
+  queue.sort((a, b) => a.x - b.x) // compare X
+
+  // process holes from left to right
+  for (let i = 0; i < queue.length; i++) {
+    outerNode = eliminateHole(queue[i], outerNode)
+    outerNode = filterPoints(outerNode, outerNode.next)
+  }
+
+  return outerNode
+}
+
+/*
+ * find a bridge between vertices that connects hole with an outer ring and link it
+ */
+const eliminateHole = (hole, outerNode) => {
+  const bridge = findHoleBridge(hole, outerNode)
+  if (!bridge) {
+    return outerNode
+  }
+
+  const bridgeReverse = splitPolygon(bridge, hole)
+
+  // filter colinear points around the cuts
+  const filteredBridge = filterPoints(bridge, bridge.next)
+  filterPoints(bridgeReverse, bridgeReverse.next)
+
+  // Check if input node was removed by the filtering
+  return outerNode === bridge ? filteredBridge : outerNode
+}
+
+/*
+ * David Eberly's algorithm for finding a bridge between hole and outer polygon
+ */
+const findHoleBridge = (hole, outerNode) => {
+  let p = outerNode
+  const hx = hole.x
+  const hy = hole.y
+  let qx = -Infinity
+  let m
+
+  // find a segment intersected by a ray from the hole's leftmost point to the left
+  // segment's endpoint with lesser x will be potential connection point
+  do {
+    if (hy <= p.y && hy >= p.next.y && p.next.y !== p.y) {
+      const x = p.x + (hy - p.y) * (p.next.x - p.x) / (p.next.y - p.y)
+      if (x <= hx && x > qx) {
+        qx = x
+        if (x === hx) {
+          if (hy === p.y) return p
+          if (hy === p.next.y) return p.next
+        }
+
+        m = p.x < p.next.x ? p : p.next
+      }
+    }
+
+    p = p.next
+  } while (p !== outerNode)
+
+  if (!m) return null
+
+  if (hx === qx) return m // hole touches outer segment; pick leftmost endpoint
+
+  // look for points inside the triangle of hole point, segment intersection and endpoint
+  // if there are no points found, we have a valid connection
+  // otherwise choose the point of the minimum angle with the ray as connection point
+
+  const stop = m
+  const mx = m.x
+  const my = m.y
+  let tanMin = Infinity
+
+  p = m
+
+  do {
+    if (hx >= p.x && p.x >= mx && hx !== p.x &&
+        pointInTriangle(hy < my ? hx : qx, hy, mx, my, hy < my ? qx : hx, hy, p.x, p.y)) {
+      const tan = Math.abs(hy - p.y) / (hx - p.x) // tangential
+
+      if (locallyInside(p, hole) && (tan < tanMin || (tan === tanMin && (p.x > m.x || (p.x === m.x && sectorContainsSector(m, p)))))) {
+        m = p
+        tanMin = tan
+      }
+    }
+
+    p = p.next
+  } while (p !== stop)
+
+  return m
+}
+
+/*
+ * whether sector in vertex m contains sector in vertex p in the same coordinates
+ */
+const sectorContainsSector = (m, p) => area(m.prev, m, p.prev) < 0 && area(p.next, m, m.next) < 0
+
+/*
+ * find the leftmost node of a polygon ring
+ */
+const getLeftmost = (start) => {
+  let p = start
+  let leftmost = start
+  do {
+    if (p.x < leftmost.x || (p.x === leftmost.x && p.y < leftmost.y)) leftmost = p
+    p = p.next
+  } while (p !== start)
+
+  return leftmost
+}
+
+module.exports = eliminateHoles

package/src/operations/extrusions/earcut/index.js

@@ -0,0 +1,252 @@
+const eliminateHoles = require('./eliminateHoles')
+const { removeNode, sortLinked } = require('./linkedList')
+const { cureLocalIntersections, filterPoints, isValidDiagonal, linkedPolygon, splitPolygon } = require('./linkedPolygon')
+const { area, pointInTriangle } = require('./triangle')
+
+/*
+ * An implementation of the earcut polygon triangulation algorithm.
+ *
+ * Original source from https://github.com/mapbox/earcut
+ * Copyright (c) 2016 Mapbox
+ *
+ * @param {data} A flat array of vertex coordinates.
+ * @param {holeIndices} An array of hole indices if any.
+ * @param {dim} The number of coordinates per vertex in the input array.
+ */
+const triangulate = (data, holeIndices, dim = 2) => {
+  const hasHoles = holeIndices && holeIndices.length
+  const outerLen = hasHoles ? holeIndices[0] * dim : data.length
+  let outerNode = linkedPolygon(data, 0, outerLen, dim, true)
+  const triangles = []
+
+  if (!outerNode || outerNode.next === outerNode.prev) return triangles
+
+  let minX, minY, maxX, maxY, invSize
+
+  if (hasHoles) outerNode = eliminateHoles(data, holeIndices, outerNode, dim)
+
+  // if the shape is not too simple, we'll use z-order curve hash later; calculate polygon bbox
+  if (data.length > 80 * dim) {
+    minX = maxX = data[0]
+    minY = maxY = data[1]
+
+    for (let i = dim; i < outerLen; i += dim) {
+      const x = data[i]
+      const y = data[i + 1]
+      if (x < minX) minX = x
+      if (y < minY) minY = y
+      if (x > maxX) maxX = x
+      if (y > maxY) maxY = y
+    }
+
+    // minX, minY and invSize are later used to transform coords into integers for z-order calculation
+    invSize = Math.max(maxX - minX, maxY - minY)
+    invSize = invSize !== 0 ? 1 / invSize : 0
+  }
+
+  earcutLinked(outerNode, triangles, dim, minX, minY, invSize)
+
+  return triangles
+}
+
+/*
+ * main ear slicing loop which triangulates a polygon (given as a linked list)
+ */
+const earcutLinked = (ear, triangles, dim, minX, minY, invSize, pass) => {
+  if (!ear) return
+
+  // interlink polygon nodes in z-order
+  if (!pass && invSize) indexCurve(ear, minX, minY, invSize)
+
+  let stop = ear
+  let prev
+  let next
+
+  // iterate through ears, slicing them one by one
+  while (ear.prev !== ear.next) {
+    prev = ear.prev
+    next = ear.next
+
+    if (invSize ? isEarHashed(ear, minX, minY, invSize) : isEar(ear)) {
+      // cut off the triangle
+      triangles.push(prev.i / dim)
+      triangles.push(ear.i / dim)
+      triangles.push(next.i / dim)
+
+      removeNode(ear)
+
+      // skipping the next vertex leads to less sliver triangles
+      ear = next.next
+      stop = next.next
+
+      continue
+    }
+
+    ear = next
+
+    // if we looped through the whole remaining polygon and can't find any more ears
+    if (ear === stop) {
+      // try filtering points and slicing again
+      if (!pass) {
+        earcutLinked(filterPoints(ear), triangles, dim, minX, minY, invSize, 1)
+
+        // if this didn't work, try curing all small self-intersections locally
+      } else if (pass === 1) {
+        ear = cureLocalIntersections(filterPoints(ear), triangles, dim)
+        earcutLinked(ear, triangles, dim, minX, minY, invSize, 2)
+
+        // as a last resort, try splitting the remaining polygon into two
+      } else if (pass === 2) {
+        splitEarcut(ear, triangles, dim, minX, minY, invSize)
+      }
+
+      break
+    }
+  }
+}
+
+/*
+ * check whether a polygon node forms a valid ear with adjacent nodes
+ */
+const isEar = (ear) => {
+  const a = ear.prev
+  const b = ear
+  const c = ear.next
+
+  if (area(a, b, c) >= 0) return false // reflex, can't be an ear
+
+  // now make sure we don't have other points inside the potential ear
+  let p = ear.next.next
+
+  while (p !== ear.prev) {
+    if (pointInTriangle(a.x, a.y, b.x, b.y, c.x, c.y, p.x, p.y) && area(p.prev, p, p.next) >= 0) {
+      return false
+    }
+    p = p.next
+  }
+
+  return true
+}
+
+const isEarHashed = (ear, minX, minY, invSize) => {
+  const a = ear.prev
+  const b = ear
+  const c = ear.next
+
+  if (area(a, b, c) >= 0) return false // reflex, can't be an ear
+
+  // triangle bbox; min & max are calculated like this for speed
+  const minTX = a.x < b.x ? (a.x < c.x ? a.x : c.x) : (b.x < c.x ? b.x : c.x)
+  const minTY = a.y < b.y ? (a.y < c.y ? a.y : c.y) : (b.y < c.y ? b.y : c.y)
+  const maxTX = a.x > b.x ? (a.x > c.x ? a.x : c.x) : (b.x > c.x ? b.x : c.x)
+  const maxTY = a.y > b.y ? (a.y > c.y ? a.y : c.y) : (b.y > c.y ? b.y : c.y)
+
+  // z-order range for the current triangle bbox
+  const minZ = zOrder(minTX, minTY, minX, minY, invSize)
+  const maxZ = zOrder(maxTX, maxTY, minX, minY, invSize)
+
+  let p = ear.prevZ
+  let n = ear.nextZ
+
+  // look for points inside the triangle in both directions
+  while (p && p.z >= minZ && n && n.z <= maxZ) {
+    if (p !== ear.prev && p !== ear.next &&
+      pointInTriangle(a.x, a.y, b.x, b.y, c.x, c.y, p.x, p.y) &&
+      area(p.prev, p, p.next) >= 0) return false
+    p = p.prevZ
+
+    if (n !== ear.prev && n !== ear.next &&
+      pointInTriangle(a.x, a.y, b.x, b.y, c.x, c.y, n.x, n.y) &&
+      area(n.prev, n, n.next) >= 0) return false
+    n = n.nextZ
+  }
+
+  // look for remaining points in decreasing z-order
+  while (p && p.z >= minZ) {
+    if (p !== ear.prev && p !== ear.next &&
+      pointInTriangle(a.x, a.y, b.x, b.y, c.x, c.y, p.x, p.y) &&
+      area(p.prev, p, p.next) >= 0) return false
+    p = p.prevZ
+  }
+
+  // look for remaining points in increasing z-order
+  while (n && n.z <= maxZ) {
+    if (n !== ear.prev && n !== ear.next &&
+      pointInTriangle(a.x, a.y, b.x, b.y, c.x, c.y, n.x, n.y) &&
+      area(n.prev, n, n.next) >= 0) return false
+    n = n.nextZ
+  }
+
+  return true
+}
+
+/*
+ * try splitting polygon into two and triangulate them independently
+ */
+const splitEarcut = (start, triangles, dim, minX, minY, invSize) => {
+  // look for a valid diagonal that divides the polygon into two
+  let a = start
+  do {
+    let b = a.next.next
+    while (b !== a.prev) {
+      if (a.i !== b.i && isValidDiagonal(a, b)) {
+        // split the polygon in two by the diagonal
+        let c = splitPolygon(a, b)
+
+        // filter colinear points around the cuts
+        a = filterPoints(a, a.next)
+        c = filterPoints(c, c.next)
+
+        // run earcut on each half
+        earcutLinked(a, triangles, dim, minX, minY, invSize)
+        earcutLinked(c, triangles, dim, minX, minY, invSize)
+        return
+      }
+
+      b = b.next
+    }
+
+    a = a.next
+  } while (a !== start)
+}
+
+/*
+ * interlink polygon nodes in z-order
+ */
+const indexCurve = (start, minX, minY, invSize) => {
+  let p = start
+  do {
+    if (p.z === null) p.z = zOrder(p.x, p.y, minX, minY, invSize)
+    p.prevZ = p.prev
+    p.nextZ = p.next
+    p = p.next
+  } while (p !== start)
+
+  p.prevZ.nextZ = null
+  p.prevZ = null
+
+  sortLinked(p, (p) => p.z)
+}
+
+/*
+ * z-order of a point given coords and inverse of the longer side of data bbox
+ */
+const zOrder = (x, y, minX, minY, invSize) => {
+  // coords are transformed into non-negative 15-bit integer range
+  x = 32767 * (x - minX) * invSize
+  y = 32767 * (y - minY) * invSize
+
+  x = (x | (x << 8)) & 0x00FF00FF
+  x = (x | (x << 4)) & 0x0F0F0F0F
+  x = (x | (x << 2)) & 0x33333333
+  x = (x | (x << 1)) & 0x55555555
+
+  y = (y | (y << 8)) & 0x00FF00FF
+  y = (y | (y << 4)) & 0x0F0F0F0F
+  y = (y | (y << 2)) & 0x33333333
+  y = (y | (y << 1)) & 0x55555555
+
+  return x | (y << 1)
+}
+
+module.exports = triangulate

package/src/operations/extrusions/earcut/linkedList.js

@@ -0,0 +1,58 @@
+const sortLinked = require('./linkedListSort')
+
+class Node {
+  constructor(i, x, y) {
+    // vertex index in coordinates array
+    this.i = i
+
+    // vertex coordinates
+    this.x = x
+    this.y = y
+
+    // previous and next vertex nodes in a polygon ring
+    this.prev = null
+    this.next = null
+
+    // z-order curve value
+    this.z = null
+
+    // previous and next nodes in z-order
+    this.prevZ = null
+    this.nextZ = null
+
+    // indicates whether this is a steiner point
+    this.steiner = false
+  }
+}
+
+/*
+ * create a node and optionally link it with previous one (in a circular doubly linked list)
+ */
+const insertNode = (i, x, y, last) => {
+  const p = new Node(i, x, y)
+
+  if (!last) {
+    p.prev = p
+    p.next = p
+  } else {
+    p.next = last.next
+    p.prev = last
+    last.next.prev = p
+    last.next = p
+  }
+
+  return p
+}
+
+/*
+ * remove a node and join prev with next nodes
+ */
+const removeNode = (p) => {
+  p.next.prev = p.prev
+  p.prev.next = p.next
+
+  if (p.prevZ) p.prevZ.nextZ = p.nextZ
+  if (p.nextZ) p.nextZ.prevZ = p.prevZ
+}
+
+module.exports = { Node, insertNode, removeNode, sortLinked }

package/src/operations/extrusions/earcut/linkedListSort.js

@@ -0,0 +1,54 @@
+
+// Simon Tatham's linked list merge sort algorithm
+// https://www.chiark.greenend.org.uk/~sgtatham/algorithms/listsort.html
+const sortLinked = (list, fn) => {
+  let i, p, q, e, numMerges
+  let inSize = 1
+
+  do {
+    p = list
+    list = null
+    let tail = null
+    numMerges = 0
+
+    while (p) {
+      numMerges++
+      q = p
+      let pSize = 0
+      for (i = 0; i < inSize; i++) {
+        pSize++
+        q = q.nextZ
+        if (!q) break
+      }
+
+      let qSize = inSize
+
+      while (pSize > 0 || (qSize > 0 && q)) {
+        if (pSize !== 0 && (qSize === 0 || !q || fn(p) <= fn(q))) {
+          e = p
+          p = p.nextZ
+          pSize--
+        } else {
+          e = q
+          q = q.nextZ
+          qSize--
+        }
+
+        if (tail) tail.nextZ = e
+        else list = e
+
+        e.prevZ = tail
+        tail = e
+      }
+
+      p = q
+    }
+
+    tail.nextZ = null
+    inSize *= 2
+  } while (numMerges > 1)
+
+  return list
+}
+
+module.exports = sortLinked