@jscad/modeling 2.7.1 → 2.9.0

package/src/maths/vec3/fromScalar.js

@@ -4,7 +4,7 @@
  *
  * @param {vec3} out - receiving vector
  * @param {Number} scalar
- * @returns {Vec3} out
+ * @returns {vec3} out
  * @alias module:modeling/maths/vec3.fromScalar
  */
 const fromScalar = (out, scalar) => {

package/src/maths/vec3/fromVec2.d.ts

@@ -3,4 +3,4 @@ import Vec2 from '../vec2/type'
 
 export default fromVector2
 
-declare function fromVector2(out: Vec3, vec2: Vec2, z?: number): Vec3
+declare function fromVector2(out: Vec3, vector: Vec2, z?: number): Vec3

package/src/maths/vec3/fromVec2.js

@@ -7,9 +7,9 @@
  * @returns {vec3} out
  * @alias module:modeling/maths/vec3.fromVec2
  */
-const fromVector2 = (out, vec2, z = 0) => {
-  out[0] = vec2[0]
-  out[1] = vec2[1]
+const fromVector2 = (out, vector, z = 0) => {
+  out[0] = vector[0]
+  out[1] = vector[1]
   out[2] = z
   return out
 }

package/src/maths/vec3/length.d.ts

@@ -2,4 +2,4 @@ import Vec3 from './type'
 
 export default length
 
-declare function length(a: Vec3): number
+declare function length(vector: Vec3): number

package/src/maths/vec3/length.js

@@ -5,10 +5,10 @@
  * @returns {Number} length
  * @alias module:modeling/maths/vec3.length
  */
-const length = (a) => {
-  const x = a[0]
-  const y = a[1]
-  const z = a[2]
+const length = (vector) => {
+  const x = vector[0]
+  const y = vector[1]
+  const z = vector[2]
   return Math.hypot(x, y, z)
 }
 

package/src/maths/vec3/length.test.js

@@ -41,5 +41,15 @@ test('vec3: length() should return correct values', (t) => {
   const length9 = length(vec9)
   nearlyEqual(t, length9, 3.74165, EPS)
 
+  // huge vector
+  const vec10 = fromValues(1e200, 0, 1e200)
+  const length10 = length(vec10)
+  nearlyEqual(t, length10, Math.SQRT2 * 1e200, EPS)
+
+  // tiny vector
+  const vec11 = fromValues(1e-200, 0, 1e-200)
+  const length11 = length(vec11)
+  nearlyEqual(t, length11, Math.SQRT2 * 1e-200, EPS)
+
   t.true(true)
 })

package/src/maths/vec3/lerp.test.js

@@ -3,7 +3,7 @@ const { lerp, fromValues } = require('./index')
 
 const { compareVectors } = require('../../../test/helpers/index')
 
-test('vec3: lerp() called with three paramerters should update a vec3 with correct values', (t) => {
+test('vec3: lerp() called with three parameters should update a vec3 with correct values', (t) => {
   const obs1 = fromValues(0, 0, 0)
   const ret1 = lerp(obs1, [0, 0, 0], [0, 0, 0], 0)
   t.true(compareVectors(obs1, [0, 0, 0]))

package/src/maths/vec3/multiply.test.js

@@ -3,7 +3,7 @@ const { multiply, fromValues } = require('./index')
 
 const { compareVectors } = require('../../../test/helpers/index')
 
-test('vec3: multiply() called with three paramerters should update a vec3 with correct values', (t) => {
+test('vec3: multiply() called with three parameters should update a vec3 with correct values', (t) => {
   const obs1 = fromValues(0, 0, 0)
   const ret1 = multiply(obs1, [0, 0, 0], [0, 0, 0])
   t.true(compareVectors(obs1, [0, 0, 0]))

package/src/maths/vec3/negate.d.ts

@@ -2,4 +2,4 @@ import Vec3 from './type'
 
 export default negate
 
-declare function negate(out: Vec3, vec: Vec3): Vec3
+declare function negate(out: Vec3, vector: Vec3): Vec3

package/src/maths/vec3/negate.test.js

@@ -3,7 +3,7 @@ const { negate, fromValues } = require('./index')
 
 const { compareVectors } = require('../../../test/helpers/index')
 
-test('vec3: negate() called with two paramerters should update a vec3 with correct values', (t) => {
+test('vec3: negate() called with two parameters should update a vec3 with correct values', (t) => {
   const obs1 = fromValues(0, 0, 0)
   const ret1 = negate(obs1, [0, 0, 0])
   t.true(compareVectors(obs1, [-0, -0, -0]))

package/src/maths/vec3/normalize.d.ts

@@ -2,4 +2,4 @@ import Vec3 from './type'
 
 export default normalize
 
-declare function normalize(out: Vec3, vec:  Vec3): Vec3
+declare function normalize(out: Vec3, vector: Vec3): Vec3

package/src/maths/vec3/normalize.test.js

@@ -3,7 +3,7 @@ const { normalize, fromValues } = require('./index')
 
 const { compareVectors } = require('../../../test/helpers/index')
 
-test('vec3: normalize() called with two paramerters should update a vec3 with correct values', (t) => {
+test('vec3: normalize() called with two parameters should update a vec3 with correct values', (t) => {
   const obs1 = fromValues(0, 0, 0)
   const ret1 = normalize(obs1, [0, 0, 0])
   t.true(compareVectors(obs1, [0, 0, 0]))

package/src/maths/vec3/rotateX.test.js

@@ -3,7 +3,7 @@ const { rotateX, fromValues } = require('./index')
 
 const { compareVectors } = require('../../../test/helpers/index')
 
-test('vec3: rotateX() called with four paramerters should update a vec3 with correct values', (t) => {
+test('vec3: rotateX() called with four parameters should update a vec3 with correct values', (t) => {
   const radians = 90 * Math.PI / 180
 
   const obs1 = fromValues(0, 0, 0)

package/src/maths/vec3/rotateY.test.js

@@ -3,7 +3,7 @@ const { rotateY, fromValues } = require('./index')
 
 const { compareVectors } = require('../../../test/helpers/index')
 
-test('vec3: rotateY() called with three paramerters should update a vec3 with correct values', (t) => {
+test('vec3: rotateY() called with three parameters should update a vec3 with correct values', (t) => {
   const radians = 90 * Math.PI / 180
 
   const obs1 = fromValues(0, 0, 0)

package/src/maths/vec3/rotateZ.test.js

@@ -3,7 +3,7 @@ const { rotateZ, fromValues } = require('./index')
 
 const { compareVectors } = require('../../../test/helpers/index')
 
-test('vec3: rotateZ() called with four paramerters should update a vec3 with correct values', (t) => {
+test('vec3: rotateZ() called with four parameters should update a vec3 with correct values', (t) => {
   const radians = 90 * Math.PI / 180
 
   const obs1 = fromValues(0, 0, 0)

package/src/maths/vec3/scale.test.js

@@ -3,7 +3,7 @@ const { scale, fromValues } = require('./index')
 
 const { compareVectors } = require('../../../test/helpers/index')
 
-test('vec3: scale() called with three paramerters should update a vec3 with correct values', (t) => {
+test('vec3: scale() called with three parameters should update a vec3 with correct values', (t) => {
   const obs1 = fromValues(0, 0, 0)
   const ret1 = scale(obs1, [0, 0, 0], 0)
   t.true(compareVectors(obs1, [0, 0, 0]))

package/src/maths/vec3/squaredLength.d.ts

@@ -2,4 +2,4 @@ import Vec3 from './type'
 
 export default squaredLength
 
-declare function squaredLength(vec: Vec3): number
+declare function squaredLength(vector: Vec3): number

package/src/maths/vec3/squaredLength.js

@@ -5,10 +5,10 @@
  * @returns {Number} squared length
  * @alias module:modeling/maths/vec3.squaredLength
  */
-const squaredLength = (a) => {
-  const x = a[0]
-  const y = a[1]
-  const z = a[2]
+const squaredLength = (vector) => {
+  const x = vector[0]
+  const y = vector[1]
+  const z = vector[2]
   return x * x + y * y + z * z
 }
 

package/src/maths/vec3/subtract.test.js

@@ -3,7 +3,7 @@ const { subtract, fromValues } = require('./index')
 
 const { compareVectors } = require('../../../test/helpers/index')
 
-test('vec3: subtract() called with three paramerters should update a vec3 with correct values', (t) => {
+test('vec3: subtract() called with three parameters should update a vec3 with correct values', (t) => {
   const obs1 = fromValues(0, 0, 0)
   const ret1 = subtract(obs1, [0, 0, 0], [0, 0, 0])
   t.true(compareVectors(obs1, [0, 0, 0]))

package/src/maths/vec3/toString.js

@@ -1,6 +1,6 @@
 /**
  * Convert the given vector to a representative string.
- * @param {vec3} vector - vector of reference
+ * @param {vec3} vec - vector of reference
  * @returns {String} string representation
  * @alias module:modeling/maths/vec3.toString
  */

package/src/maths/vec3/transform.test.js

@@ -3,7 +3,7 @@ const { transform, fromValues } = require('./index')
 
 const { compareVectors } = require('../../../test/helpers/index')
 
-test('vec3: transform() called with three paramerters should update a vec3 with correct values', (t) => {
+test('vec3: transform() called with three parameters should update a vec3 with correct values', (t) => {
   const identityMatrix = [
     1, 0, 0, 0,
     0, 1, 0, 0,

package/src/maths/vec4/toString.js

@@ -1,7 +1,7 @@
 /**
  * Convert the given vector to a representative string.
  *
- * @param {vec4} vector - vector to convert
+ * @param {vec4} vec - vector to convert
  * @returns {String} representative string
  * @alias module:modeling/maths/vec4.toString
  */

package/src/maths/vec4/transform.test.js

@@ -3,7 +3,7 @@ const { transform, fromValues } = require('./index')
 
 const { compareVectors } = require('../../../test/helpers/index')
 
-test('vec4: transform() called with three paramerters should update a vec4 with correct values', (t) => {
+test('vec4: transform() called with three parameters should update a vec4 with correct values', (t) => {
   const identityMatrix = [
     1, 0, 0, 0,
     0, 1, 0, 0,

package/src/measurements/measureBoundingSphere.js

@@ -24,7 +24,7 @@ const measureBoundingSphereOfPath2 = (geometry) => {
   const points = path2.toPoints(geometry)
 
   if (points.length > 0) {
-    // calculate the centriod of the geometry
+    // calculate the centroid of the geometry
     let numPoints = 0
     const temp = vec3.create()
     points.forEach((point) => {
@@ -60,7 +60,7 @@ const measureBoundingSphereOfGeom2 = (geometry) => {
   const sides = geom2.toSides(geometry)
 
   if (sides.length > 0) {
-    // calculate the centriod of the geometry
+    // calculate the centroid of the geometry
     let numPoints = 0
     const temp = vec3.create()
     sides.forEach((side) => {
@@ -96,7 +96,7 @@ const measureBoundingSphereOfGeom3 = (geometry) => {
   const polygons = geom3.toPolygons(geometry)
 
   if (polygons.length > 0) {
-    // calculate the centriod of the geometry
+    // calculate the centroid of the geometry
     let numPoints = 0
     polygons.forEach((polygon) => {
       poly3.toPoints(polygon).forEach((point) => {
@@ -122,7 +122,7 @@ const measureBoundingSphereOfGeom3 = (geometry) => {
 }
 
 /**
- * Measure the (aproximate) bounding sphere of the given geometries.
+ * Measure the (approximate) bounding sphere of the given geometries.
  * @see https://en.wikipedia.org/wiki/Bounding_sphere
  * @param {...Object} geometries - the geometries to measure
  * @return {Array} the bounding sphere for each geometry, i.e. [centroid, radius]

package/src/measurements/measureCenterOfMass.js

@@ -61,7 +61,7 @@ const measureCenterOfMassGeom3 = (geometry) => {
   let totalVolume = 0
   const vector = vec3.create() // for speed
   polygons.forEach((polygon) => {
-    // calculate volume and center of each tetrahedon
+    // calculate volume and center of each tetrahedron
     const vertices = polygon.vertices
     for (let i = 0; i < vertices.length - 2; i++) {
       vec3.cross(vector, vertices[i + 1], vertices[i + 2])

package/src/operations/booleans/mayOverlap.js

@@ -4,9 +4,9 @@ const measureBoundingBox = require('../../measurements/measureBoundingBox')
 
 /*
  * Determine if the given geometries overlap by comparing min and max bounds.
- * NOTE: This is used in union for performace gains.
- * @param {geom3} geometry1 - geometry for comparision
- * @param {geom3} geometry2 - geometry for comparision
+ * NOTE: This is used in union for performance gains.
+ * @param {geom3} geometry1 - geometry for comparison
+ * @param {geom3} geometry2 - geometry for comparison
  * @returns {boolean} true if the geometries overlap
  */
 const mayOverlap = (geometry1, geometry2) => {

package/src/operations/booleans/retessellate.js

@@ -3,16 +3,14 @@ const poly3 = require('../../geometries/poly3')
 
 const reTesselateCoplanarPolygons = require('./reTesselateCoplanarPolygons')
 
-// Normals are directional vectors with component values from 0 to 1.0, requiring specialized comparision
-// This EPS is derived from a serieas of tests to determine the optimal precision for comparing coplanar polygons,
+// Normals are directional vectors with component values from 0 to 1.0, requiring specialized comparison
+// This EPS is derived from a series of tests to determine the optimal precision for comparing coplanar polygons,
 // as provided by the sphere primitive at high segmentation
 // This EPS is for 64 bit Number values
 const NEPS = 1e-13
 
 // Compare two normals (unit vectors) for equality.
-const aboutEqualNormals = (a, b) => {
-  return (Math.abs(a[0] - b[0]) <= NEPS && Math.abs(a[1] - b[1]) <= NEPS && Math.abs(a[2] - b[2]) <= NEPS)
-}
+const aboutEqualNormals = (a, b) => (Math.abs(a[0] - b[0]) <= NEPS && Math.abs(a[1] - b[1]) <= NEPS && Math.abs(a[2] - b[2]) <= NEPS)
 
 const coplanar = (plane1, plane2) => {
   // expect the same distance from the origin, within tolerance

package/src/operations/booleans/scission.js

@@ -9,7 +9,7 @@ const scissionGeom3 = require('./scissionGeom3')
 /**
  * Scission (divide) the given geometry into the component pieces.
  *
- * @param {...Object} geometries - list of geometries
+ * @param {...Object} objects - list of geometries
  * @returns {Array} list of pieces from each geometry
  * @alias module:modeling/booleans.scission
  *

package/src/operations/booleans/subtract.js

@@ -17,7 +17,7 @@ const subtractGeom3 = require('./subtractGeom3')
  * @alias module:modeling/booleans.subtract
  *
  * @example
- * let myshape = subtract(cubiod({size: [5,5,5]}), cubiod({size: [5,5,5], center: [5,5,5]}))
+ * let myshape = subtract(cuboid({size: [5,5,5]}), cuboid({size: [5,5,5], center: [5,5,5]}))
  *
  * @example
  * +-------+            +-------+

package/src/operations/booleans/union.test.js

@@ -198,7 +198,7 @@ test('union of one or more geom3 objects produces expected geometry', (t) => {
 
 test('union of geom3 with rounding issues #137', (t) => {
   const geometry1 = center({ relativeTo: [0, 0, -1] }, cuboid({ size: [44, 26, 5] }))
-  const geometry2 = center({ relativeTo: [0, 0, -4.400001] }, cuboid({ size: [44, 26, 1.8] })) // introduce percision error
+  const geometry2 = center({ relativeTo: [0, 0, -4.400001] }, cuboid({ size: [44, 26, 1.8] })) // introduce precision error
 
   const obs = union(geometry1, geometry2)
   const pts = geom3.toPoints(obs)

package/src/operations/booleans/unionGeom3Sub.js

@@ -7,7 +7,7 @@ const { Tree } = require('./trees')
  * Return a new 3D geometry representing the space in the given geometries.
  * @param {geom3} geometry1 - geometry to union
  * @param {geom3} geometry2 - geometry to union
- * @returns {goem3} new 3D geometry
+ * @returns {geom3} new 3D geometry
  */
 const unionSub = (geometry1, geometry2) => {
   if (!mayOverlap(geometry1, geometry2)) {

package/src/operations/expansions/expand.js

@@ -10,14 +10,14 @@ const expandPath2 = require('./expandPath2')
 
 /**
  * Expand the given geometry using the given options.
- * Both interal and external space is expanded for 2D and 3D shapes.
+ * Both internal and external space is expanded for 2D and 3D shapes.
  *
  * Note: Contract is expand using a negative delta.
  * @param {Object} options - options for expand
  * @param {Number} [options.delta=1] - delta (+/-) of expansion
  * @param {String} [options.corners='edge'] - type of corner to create after expanding; edge, chamfer, round
  * @param {Integer} [options.segments=16] - number of segments when creating round corners
- * @param {...Objects} geometry - the list of geometry to expand
+ * @param {...Objects} objects - the geometries to expand
  * @return {Object|Array} new geometry, or list of new geometries
  * @alias module:modeling/expansions.expand
  *

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, 2065)
+  t.is(pts2.length, 1588)
 })
 
 test('expand (options): offsetting of a complex geom2 produces expected offset geom2', (t) => {
@@ -151,59 +151,27 @@ test('expand (options): offsetting of a complex geom2 produces expected offset g
   const obs = expand({ delta: 2, corners: 'edge' }, geometry)
   const pts = geom2.toPoints(obs)
   const exp = [
-    [-77, -77],
-    [-75, -77],
-    [75, -77],
     [77, -77],
-    [77, -75],
-    [77, 75],
     [77, 77],
-    [75, 77],
-    [40, 77],
     [38, 77],
-    [38, 75],
     [38, 2],
     [-38, 2],
-    [-38, 75],
     [-37.99999999999999, 77],
-    [-40, 77],
-    [-75, 77],
     [-77, 77],
-    [-77, 75],
-    [17, -40],
     [16.999999999999996, -42],
-    [15, -42],
-    [8, -42],
     [6, -42],
-    [6, -40],
     [6, -27],
     [-6, -27],
-    [-6, -40],
     [-6.000000000000001, -42],
-    [-8, -42],
-    [-15, -42],
     [-17, -42],
-    [-17, -40],
-    [-17, -10],
     [-16.999999999999996, -8],
-    [-15, -8],
-    [15, -8],
     [17, -8.000000000000004],
-    [17, -10],
-    [-4, -19],
     [-4, -21],
-    [-2, -21],
-    [1.9999999999999998, -21],
     [3.9999999999999996, -21],
-    [4, -19],
-    [4, -15],
     [4, -13],
-    [2, -13],
-    [-1.9999999999999998, -13],
     [-4, -13],
-    [-4, -15],
-    [-77, -75]
+    [-77, -77]
   ]
-  t.is(pts.length, 52)
+  t.is(pts.length, 20)
   t.true(comparePoints(pts, exp))
 })

package/src/operations/expansions/expandShell.js

@@ -15,37 +15,43 @@ const unionGeom3Sub = require('../booleans/unionGeom3Sub')
 
 const extrudePolygon = require('./extrudePolygon')
 
+/*
+ * Collect all planes adjacent to each vertex
+ */
 const mapPlaneToVertex = (map, vertex, plane) => {
-  const i = map.findIndex((item) => vec3.equals(item[0], vertex))
-  if (i < 0) {
+  const key = vertex.toString()
+  if (!map.has(key)) {
     const entry = [vertex, [plane]]
-    map.push(entry)
-    return map.length
+    map.set(key, entry)
+  } else {
+    const planes = map.get(key)[1]
+    planes.push(plane)
   }
-  const planes = map[i][1]
-  planes.push(plane)
-  return i
 }
 
+/*
+ * Collect all planes adjacent to each edge.
+ * Combine undirected edges, no need for duplicate cylinders.
+ */
 const mapPlaneToEdge = (map, edge, plane) => {
-  const i = map.findIndex((item) => (vec3.equals(item[0], edge[0]) && vec3.equals(item[1], edge[1])) || (vec3.equals(item[0], edge[1]) && vec3.equals(item[1], edge[0])))
-  if (i < 0) {
+  const key0 = edge[0].toString()
+  const key1 = edge[1].toString()
+  // Sort keys to make edges undirected
+  const key = key0 < key1 ? `${key0},${key1}` : `${key1},${key0}`
+  if (!map.has(key)) {
     const entry = [edge, [plane]]
-    map.push(entry)
-    return map.length
+    map.set(key, entry)
+  } else {
+    const planes = map.get(key)[1]
+    planes.push(plane)
   }
-  const planes = map[i][1]
-  planes.push(plane)
-  return i
 }
 
 const addUniqueAngle = (map, angle) => {
   const i = map.findIndex((item) => item === angle)
   if (i < 0) {
     map.push(angle)
-    return map.length
   }
-  return i
 }
 
 /*
@@ -65,8 +71,8 @@ const expandShell = (options, geometry) => {
   const { delta, segments } = Object.assign({ }, defaults, options)
 
   let result = geom3.create()
-  const vertices2planes = [] // contents: [vertex, [plane, ...]]
-  const edges2planes = [] // contents: [[vertex, vertex], [plane, ...]]
+  const vertices2planes = new Map() // {vertex: [vertex, [plane, ...]]}
+  const edges2planes = new Map() // {edge: [[vertex, vertex], [plane, ...]]}
 
   const v1 = vec3.create()
   const v2 = vec3.create()

package/src/operations/expansions/offset.js

@@ -13,7 +13,7 @@ const offsetPath2 = require('./offsetPath2')
  * @param {Float} [options.delta=1] - delta of offset (+ to exterior, - from interior)
  * @param {String} [options.corners='edge'] - type of corner to create after offseting; edge, chamfer, round
  * @param {Integer} [options.segments=16] - number of segments when creating round corners
- * @param {...Object} geometry - the list of geometry to offset
+ * @param {...Object} objects - the geometries to offset
  * @return {Object|Array} new geometry, or list of new geometries
  * @alias module:modeling/expansions.offset
  *