@jscad/modeling 2.7.1 → 2.9.0

package/src/operations/extrusions/slice/toPolygons.js

@@ -1,21 +1,6 @@
-const vec3 = require('../../../maths/vec3')
-
-const geom3 = require('../../../geometries/geom3')
 const poly3 = require('../../../geometries/poly3')
-
-const intersectGeom3Sub = require('../../booleans/intersectGeom3Sub')
-
-const calculatePlane = require('./calculatePlane')
-
-const toPolygon3D = (vector, edge) => {
-  const points = [
-    vec3.subtract(vec3.create(), edge[0], vector),
-    vec3.subtract(vec3.create(), edge[1], vector),
-    vec3.add(vec3.create(), edge[1], vector),
-    vec3.add(vec3.create(), edge[0], vector)
-  ]
-  return poly3.fromPoints(points)
-}
+const earcut = require('../earcut')
+const PolygonHierarchy = require('../earcut/polygonHierarchy')
 
 /**
  * Return a list of polygons which are enclosed by the slice.
@@ -24,52 +9,31 @@ const toPolygon3D = (vector, edge) => {
  * @alias module:modeling/extrusions/slice.toPolygons
  */
 const toPolygons = (slice) => {
-  const splane = calculatePlane(slice)
-
-  // find the midpoint of the slice, which will lie on the plane by definition
-  const edges = slice.edges
-  const midpoint = edges.reduce((point, edge) => vec3.add(vec3.create(), point, edge[0]), vec3.create())
-  vec3.scale(midpoint, midpoint, 1 / edges.length)
-
-  // find the farthest edge from the midpoint, which will be on an outside edge
-  let farthestEdge = [[NaN, NaN, NaN], [NaN, NaN, NaN]]
-  let distance = 0
-  edges.forEach((edge) => {
-    const d = vec3.squaredDistance(midpoint, edge[0])
-    if (d > distance) {
-      farthestEdge = edge
-      distance = d
+  const hierarchy = new PolygonHierarchy(slice)
+
+  const polygons = []
+  hierarchy.roots.forEach(({ solid, holes }) => {
+    // hole indices
+    let index = solid.length
+    const holesIndex = []
+    holes.forEach((hole, i) => {
+      holesIndex.push(index)
+      index += hole.length
+    })
+
+    // compute earcut triangulation for each solid
+    const vertices = [solid, ...holes].flat()
+    const data = vertices.flat()
+    // Get original 3D vertex by index
+    const getVertex = (i) => hierarchy.to3D(vertices[i])
+    const indices = earcut(data, holesIndex)
+    for (let i = 0; i < indices.length; i += 3) {
+      // Map back to original vertices
+      const tri = indices.slice(i, i + 3).map(getVertex)
+      polygons.push(poly3.fromPointsAndPlane(tri, hierarchy.plane))
     }
   })
 
-  // create one LARGE polygon to encompass the side, i.e. base
-  const direction = vec3.subtract(vec3.create(), farthestEdge[0], midpoint)
-  const perpendicular = vec3.cross(vec3.create(), splane, direction)
-
-  const p1 = vec3.add(vec3.create(), midpoint, direction)
-  vec3.add(p1, p1, direction)
-  const p2 = vec3.add(vec3.create(), midpoint, perpendicular)
-  vec3.add(p2, p2, perpendicular)
-  const p3 = vec3.subtract(vec3.create(), midpoint, direction)
-  vec3.subtract(p3, p3, direction)
-  const p4 = vec3.subtract(vec3.create(), midpoint, perpendicular)
-  vec3.subtract(p4, p4, perpendicular)
-  const poly1 = poly3.fromPoints([p1, p2, p3, p4])
-  const base = geom3.create([poly1])
-
-  const wallPolygons = edges.map((edge) => toPolygon3D(splane, edge))
-  const walls = geom3.create(wallPolygons)
-
-  // make an insection of the base and the walls, creating... a set of polygons!
-  const geometry3 = intersectGeom3Sub(base, walls)
-
-  // return only those polygons from the base
-  let polygons = geom3.toPolygons(geometry3)
-  polygons = polygons.filter((polygon) => {
-    const a = vec3.angle(splane, poly3.plane(polygon))
-    // walls should be PI / 2 radians rotated from the base
-    return Math.abs(a) < (Math.PI / 90)
-  })
   return polygons
 }
 

package/src/operations/hulls/hull.test.js

@@ -43,7 +43,7 @@ test('hull (single, geom2)', (t) => {
   t.is(pts.length, 7)
 })
 
-test('hull (multiple, overlaping, geom2)', (t) => {
+test('hull (multiple, overlapping, geom2)', (t) => {
   const geometry1 = geom2.fromPoints([[5, 5], [-5, 5], [-5, -5], [5, -5]])
   const geometry2 = geom2.fromPoints([[3, 3], [-3, 3], [-3, -3], [3, -3]])
   const geometry3 = geom2.fromPoints([[6, 3], [-6, 3], [-6, -3], [6, -3]])

package/src/operations/hulls/hullChain.js

@@ -5,7 +5,7 @@ const union = require('../booleans/union')
 const hull = require('./hull')
 
 /**
- * Create a chain of hulled geometries from the given gemetries.
+ * Create a chain of hulled geometries from the given geometries.
  * Essentially hull A+B, B+C, C+D, etc., then union the results.
  * The given geometries should be of the same type, either geom2 or geom3 or path2.
  *

package/src/operations/hulls/hullGeom2.js

@@ -30,7 +30,7 @@ const hullGeom2 = (...geometries) => {
 
   const hullpoints = hullPoints2(uniquepoints)
 
-  // NOTE: more then three points are required to create a new geometry
+  // NOTE: more than three points are required to create a new geometry
   if (hullpoints.length < 3) return geom2.create()
 
   // assemble a new geometry from the list of points

package/src/operations/hulls/hullPath2.js

@@ -1,7 +1,5 @@
 const flatten = require('../../utils/flatten')
 
-const vec2 = require('../../maths/vec2')
-
 const path2 = require('../../geometries/path2')
 
 const hullPoints2 = require('./hullPoints2')
@@ -16,11 +14,15 @@ const hullPath2 = (...geometries) => {
 
   // extract the unique points from the geometries
   const uniquepoints = []
+  const found = new Set()
   geometries.forEach((geometry) => {
     const points = path2.toPoints(geometry)
     points.forEach((point) => {
-      const index = uniquepoints.findIndex((unique) => vec2.equals(unique, point))
-      if (index < 0) uniquepoints.push(point)
+      const key = point.toString()
+      if (!found.has(key)) {
+        uniquepoints.push(point)
+        found.add(key)
+      }
     })
   })
 

package/src/operations/hulls/hullPath2.test.js

@@ -0,0 +1,16 @@
+const test = require('ava')
+
+const { path2 } = require('../../geometries')
+
+const hullPath2 = require('./hullPath2')
+
+test('hullPath2', (t) => {
+  const closed = true
+  const geometry1 = path2.fromPoints({ closed }, [[0, 0], [-4, 4], [-4, -4]])
+  const geometry2 = path2.fromPoints({ closed }, [[0, 0], [4, -4], [4, 4]])
+
+  const obs = hullPath2(geometry1, geometry2)
+  t.true(path2.isA(obs))
+  const pts = path2.toPoints(obs)
+  t.is(pts.length, 4)
+})

package/src/operations/hulls/hullPoints2.test.js

@@ -42,7 +42,7 @@ test('hullPoints2 bug #114 2 circles with 18 segments', (t) => {
     [7.298133329356933, -1.9283628290596186]
   ]
 
-  // we just want to bwe sure no err happens for this case
+  // we just want to be sure no err happens for this case
   const out = hullPoints2(points)
   t.is(out.length, 19)
 })

package/src/operations/hulls/quickhull/QuickHull.js

@@ -722,7 +722,7 @@ class QuickHull {
     for (let i = 0; i < this.newFaces.length; i += 1) {
       const face = this.newFaces[i]
       if (face.mark === VISIBLE) {
-        while (this.doAdjacentMerge(face, MERGE_NON_CONVEX_WRT_LARGER_FACE)) {}
+        while (this.doAdjacentMerge(face, MERGE_NON_CONVEX_WRT_LARGER_FACE)) {} // eslint-disable-line no-empty
       }
     }
 
@@ -733,7 +733,7 @@ class QuickHull {
       const face = this.newFaces[i]
       if (face.mark === NON_CONVEX) {
         face.mark = VISIBLE
-        while (this.doAdjacentMerge(face, MERGE_NON_CONVEX)) {}
+        while (this.doAdjacentMerge(face, MERGE_NON_CONVEX)) {} // eslint-disable-line no-empty
       }
     }
 

package/src/operations/modifiers/edges.js

@@ -99,9 +99,7 @@ const splitPolygon = (openedge, polygon, eps) => {
 /*
  * TBD This should be part of vec3.
  */
-const almostEquals = (eps, v1, v2) => {
-  return (Math.abs(v1[0] - v2[0]) <= eps && Math.abs(v1[1] - v2[1]) <= eps && Math.abs(v1[2] - v2[2]) <= eps)
-}
+const almostEquals = (eps, v1, v2) => (Math.abs(v1[0] - v2[0]) <= eps && Math.abs(v1[1] - v2[1]) <= eps && Math.abs(v1[2] - v2[2]) <= eps)
 
 const enclosedEdge = (openedge, edge, eps) => {
   if (openedge.distance < edge.distance) {
@@ -151,7 +149,7 @@ const splitEdge = (openedges, edge, eps) => {
  */
 const cullOpenEdges = (edges) => {
   const openedges = []
-  edges.forEach((edge, i) => {
+  edges.forEach((edge) => {
     const polygons = edge.polygons
     if (polygons.length === 1) {
       // console.log('open edge: ',edge[0],'<-->',edge[1])

package/src/operations/modifiers/generalize.js

@@ -15,15 +15,11 @@ const repairTjunctions = require('./repairTjunctions')
 
 /*
  */
-const generalizePath2 = (options, geometry) => {
-  return geometry
-}
+const generalizePath2 = (options, geometry) => geometry
 
 /*
  */
-const generalizeGeom2 = (options, geometry) => {
-  return geometry
-}
+const generalizeGeom2 = (options, geometry) => geometry
 
 /*
  */
@@ -77,6 +73,7 @@ const generalizeGeom3 = (options, geometry) => {
  * @param {Boolean} [options.simplify=false] the geometries should be simplified
  * @param {Boolean} [options.triangulate=false] the geometries should be triangulated
  * @param {Boolean} [options.repair=false] the geometries should be repaired
+ * @param {...Object} geometries - the geometries to generalize
  * @return {Object|Array} the modified geometry, or a list of modified geometries
  * @alias module:modeling/modifiers.generalize
  */
@@ -84,7 +81,7 @@ const generalize = (options, ...geometries) => {
   geometries = flatten(geometries)
   if (geometries.length === 0) throw new Error('wrong number of arguments')
 
-  const results = geometries.map((geometry, i) => {
+  const results = geometries.map((geometry) => {
     if (path2.isA(geometry)) return generalizePath2(options, geometry)
     if (geom2.isA(geometry)) return generalizeGeom2(options, geometry)
     if (geom3.isA(geometry)) return generalizeGeom3(options, geometry)

package/src/operations/modifiers/snap.test.js

@@ -11,7 +11,7 @@ const { snap } = require('./index')
 test('snap: snap of a path2 produces an expected path2', (t) => {
   const geometry1 = path2.create()
   const geometry2 = arc({ radius: 1 / 2, segments: 8 })
-  const geometry3 = arc({ radius: 1.3333333333333333333 / 2, segments: 8 })
+  const geometry3 = arc({ radius: 1.3333333333333333 / 2, segments: 8 })
   const geometry4 = arc({ radius: Math.PI * 1000 / 2, segments: 8 })
 
   const results = snap(geometry1, geometry2, geometry3, geometry4)
@@ -55,7 +55,7 @@ test('snap: snap of a path2 produces an expected path2', (t) => {
 test('snap: snap of a geom2 produces an expected geom2', (t) => {
   const geometry1 = geom2.create()
   const geometry2 = rectangle({ size: [1, 1, 1] })
-  const geometry3 = rectangle({ size: [1.3333333333333333333, 1.3333333333333333333, 1.3333333333333333333] })
+  const geometry3 = rectangle({ size: [1.3333333333333333, 1.3333333333333333, 1.3333333333333333] })
   const geometry4 = rectangle({ size: [Math.PI * 1000, Math.PI * 1000, Math.PI * 1000] })
 
   const results = snap(geometry1, geometry2, geometry3, geometry4)
@@ -87,7 +87,7 @@ test('snap: snap of a geom2 produces an expected geom2', (t) => {
 test('snap: snap of a geom3 produces an expected geom3', (t) => {
   const geometry1 = geom3.create()
   const geometry2 = cuboid({ size: [1, 1, 1] })
-  const geometry3 = cuboid({ size: [1.3333333333333333333, 1.3333333333333333333, 1.3333333333333333333] })
+  const geometry3 = cuboid({ size: [1.3333333333333333, 1.3333333333333333, 1.3333333333333333] })
   const geometry4 = cuboid({ size: [Math.PI * 1000, Math.PI * 1000, Math.PI * 1000] })
 
   const results = snap(geometry1, geometry2, geometry3, geometry4)

package/src/operations/transforms/align.d.ts

@@ -7,7 +7,7 @@ type NullableNumber = null | number
 
 export interface AlignOptions {
   modes?: Array<'center' | 'max' | 'min' | 'none'>
-  relativeTo?: [NullableNumber] | [NullableNumber | NullableNumber] | [NullableNumber | NullableNumber | NullableNumber]
+  relativeTo?: [NullableNumber] | [NullableNumber, NullableNumber] | [NullableNumber, NullableNumber, NullableNumber]
   grouped?: boolean
 }
 

package/src/operations/transforms/center.js

@@ -24,18 +24,18 @@ const centerGeometry = (options, object) => {
 }
 
 /**
- * Center the given geometries using the given options.
+ * Center the given objects using the given options.
  * @param {Object} options - options for centering
  * @param {Array} [options.axes=[true,true,true]] - axis of which to center, true or false
- * @param {Array} [options.relativeTo=[0,0,0]] - relative point of which to center the geometries
- * @param {...Object} geometries - the geometries to center
- * @return {Object|Array} the centered geometry, or a list of centered geometries
+ * @param {Array} [options.relativeTo=[0,0,0]] - relative point of which to center the objects
+ * @param {...Object} objects - the objects to center
+ * @return {Object|Array} the centered object, or a list of centered objects
  * @alias module:modeling/transforms.center
  *
  * @example
  * let myshape = center({axes: [true,false,false]}, sphere()) // center about the X axis
  */
-const center = (options, ...geometries) => {
+const center = (options, ...objects) => {
   const defaults = {
     axes: [true, true, true],
     relativeTo: [0, 0, 0]
@@ -43,13 +43,13 @@ const center = (options, ...geometries) => {
   }
   const { axes, relativeTo } = Object.assign({}, defaults, options)
 
-  geometries = flatten(geometries)
-  if (geometries.length === 0) throw new Error('wrong number of arguments')
+  objects = flatten(objects)
+  if (objects.length === 0) throw new Error('wrong number of arguments')
   if (relativeTo.length !== 3) throw new Error('relativeTo must be an array of length 3')
 
   options = { axes, relativeTo }
 
-  const results = geometries.map((object) => {
+  const results = objects.map((object) => {
     if (path2.isA(object)) return centerGeometry(options, object)
     if (geom2.isA(object)) return centerGeometry(options, object)
     if (geom3.isA(object)) return centerGeometry(options, object)
@@ -59,25 +59,25 @@ const center = (options, ...geometries) => {
 }
 
 /**
- * Center the given geometries about the X axis.
- * @param {...Object} geometries - the geometries to center
- * @return {Object|Array} the centered geometry, or a list of centered geometry
+ * Center the given objects about the X axis.
+ * @param {...Object} objects - the objects to center
+ * @return {Object|Array} the centered object, or a list of centered objects
  * @alias module:modeling/transforms.centerX
  */
 const centerX = (...objects) => center({ axes: [true, false, false] }, objects)
 
 /**
- * Center the given geometries about the Y axis.
- * @param {...Object} geometries - the geometries to center
- * @return {Object|Array} the centered geometry, or a list of centered geometry
+ * Center the given objects about the Y axis.
+ * @param {...Object} objects - the objects to center
+ * @return {Object|Array} the centered object, or a list of centered objects
  * @alias module:modeling/transforms.centerY
  */
 const centerY = (...objects) => center({ axes: [false, true, false] }, objects)
 
 /**
- * Center the given geometries about the Z axis.
- * @param {...Object} geometries - the geometries to center
- * @return {Object|Array} the centered geometry, or a list of centered geometry
+ * Center the given objects about the Z axis.
+ * @param {...Object} objects - the objects to center
+ * @return {Object|Array} the centered object, or a list of centered objects
  * @alias module:modeling/transforms.centerZ
  */
 const centerZ = (...objects) => center({ axes: [false, false, true] }, objects)

package/src/operations/transforms/mirror.js

@@ -8,12 +8,12 @@ const geom3 = require('../../geometries/geom3')
 const path2 = require('../../geometries/path2')
 
 /**
- * Mirror the given geometries using the given options.
+ * Mirror the given objects using the given options.
  * @param {Object} options - options for mirror
  * @param {Array} [options.origin=[0,0,0]] - the origin of the plane
  * @param {Array} [options.normal=[0,0,1]] - the normal vector of the plane
- * @param {...Object} geometries - the geometries to mirror
- * @return {Object|Array} the mirrored geometry, or a list of mirrored geometry
+ * @param {...Object} objects - the objects to mirror
+ * @return {Object|Array} the mirrored object, or a list of mirrored objects
  * @alias module:modeling/transforms.mirror
  *
  * @example
@@ -47,25 +47,25 @@ const mirror = (options, ...objects) => {
 }
 
 /**
- * Mirror the given geometries about the X axis.
- * @param {...Object} geometries - the geometries to mirror
- * @return {Object|Array} the mirrored geometry, or a list of mirrored geometry
+ * Mirror the given objects about the X axis.
+ * @param {...Object} objects - the objects to mirror
+ * @return {Object|Array} the mirrored object, or a list of mirrored objects
  * @alias module:modeling/transforms.mirrorX
  */
 const mirrorX = (...objects) => mirror({ normal: [1, 0, 0] }, objects)
 
 /**
- * Mirror the given geometries about the Y axis.
- * @param {...Object} geometries - the geometries to mirror
- * @return {Object|Array} the mirrored geometry, or a list of mirrored geometry
+ * Mirror the given objects about the Y axis.
+ * @param {...Object} objects - the geometries to mirror
+ * @return {Object|Array} the mirrored object, or a list of mirrored objects
  * @alias module:modeling/transforms.mirrorY
  */
 const mirrorY = (...objects) => mirror({ normal: [0, 1, 0] }, objects)
 
 /**
- * Mirror the given object(s) about the Z axis.
+ * Mirror the given objects about the Z axis.
  * @param {...Object} objects - the geometries to mirror
- * @return {Object|Array} the mirrored geometry, or a list of mirrored geometry
+ * @return {Object|Array} the mirrored object, or a list of mirrored objects
  * @alias module:modeling/transforms.mirrorZ
  */
 const mirrorZ = (...objects) => mirror({ normal: [0, 0, 1] }, objects)

package/src/operations/transforms/rotate.js

@@ -7,10 +7,10 @@ const geom3 = require('../../geometries/geom3')
 const path2 = require('../../geometries/path2')
 
 /**
- * Rotate the given geometries using the given options.
+ * Rotate the given objects using the given options.
  * @param {Array} angles - angle (RADIANS) of rotations about X, Y, and Z axis
- * @param {...Object} geometries - the geometries to rotate
- * @return {Object|Array} the rotated geometry, or a list of rotated geometries
+ * @param {...Object} objects - the objects to rotate
+ * @return {Object|Array} the rotated object, or a list of rotated objects
  * @alias module:modeling/transforms.rotate
  *
  * @example
@@ -42,28 +42,28 @@ const rotate = (angles, ...objects) => {
 }
 
 /**
- * Rotate the given object(s) about the X axis, using the given options.
+ * Rotate the given objects about the X axis, using the given options.
  * @param {Number} angle - angle (RADIANS) of rotations about X
- * @param {...Object} geometries - the geometries to rotate
- * @return {Object|Array} the rotated geometry, or a list of rotated geometries
+ * @param {...Object} objects - the objects to rotate
+ * @return {Object|Array} the rotated object, or a list of rotated objects
  * @alias module:modeling/transforms.rotateX
  */
 const rotateX = (angle, ...objects) => rotate([angle, 0, 0], objects)
 
 /**
- * Rotate the given object(s) about the Y axis, using the given options.
+ * Rotate the given objects about the Y axis, using the given options.
  * @param {Number} angle - angle (RADIANS) of rotations about Y
- * @param {...Object} geometries - the geometries to rotate
- * @return {Object|Array} the rotated geometry, or a list of rotated geometries
+ * @param {...Object} objects - the objects to rotate
+ * @return {Object|Array} the rotated object, or a list of rotated objects
  * @alias module:modeling/transforms.rotateY
  */
 const rotateY = (angle, ...objects) => rotate([0, angle, 0], objects)
 
 /**
- * Rotate the given object(s) about the Z axis, using the given options.
+ * Rotate the given objects about the Z axis, using the given options.
  * @param {Number} angle - angle (RADIANS) of rotations about Z
- * @param {...Object} geometries - the geometries to rotate
- * @return {Object|Array} the rotated geometry, or a list of rotated geometries
+ * @param {...Object} objects - the objects to rotate
+ * @return {Object|Array} the rotated object, or a list of rotated objects
  * @alias module:modeling/transforms.rotateZ
  */
 const rotateZ = (angle, ...objects) => rotate([0, 0, angle], objects)

package/src/operations/transforms/scale.js

@@ -7,10 +7,10 @@ const geom3 = require('../../geometries/geom3')
 const path2 = require('../../geometries/path2')
 
 /**
- * Scale the given geometries using the given options.
- * @param {Array} factors - X, Y, Z factors by which to scale the geometries
- * @param {...Object} geometries - the geometries to scale
- * @return {Object|Array} the scaled geometry, or a list of scaled geometries
+ * Scale the given objects using the given options.
+ * @param {Array} factors - X, Y, Z factors by which to scale the objects
+ * @param {...Object} objects - the objects to scale
+ * @return {Object|Array} the scaled object, or a list of scaled objects
  * @alias module:modeling/transforms.scale
  *
  * @example
@@ -40,31 +40,31 @@ const scale = (factors, ...objects) => {
 }
 
 /**
- * Scale the given geometries about the X axis using the given options.
- * @param {Number} factor - X factor by which to scale the geometries
- * @param {...Object} geometries - the geometries to scale
- * @return {Object|Array} the scaled geometry, or a list of scaled geometries
+ * Scale the given objects about the X axis using the given options.
+ * @param {Number} factor - X factor by which to scale the objects
+ * @param {...Object} objects - the objects to scale
+ * @return {Object|Array} the scaled object, or a list of scaled objects
  * @alias module:modeling/transforms.scaleX
  */
-const scaleX = (offset, ...objects) => scale([offset, 1, 1], objects)
+const scaleX = (factor, ...objects) => scale([factor, 1, 1], objects)
 
 /**
- * Scale the given geometries about the Y axis using the given options.
- * @param {Number} factor - Y factor by which to scale the geometries
- * @param {...Object} geometries - the geometries to scale
- * @return {Object|Array} the scaled geometry, or a list of scaled geometries
+ * Scale the given objects about the Y axis using the given options.
+ * @param {Number} factor - Y factor by which to scale the objects
+ * @param {...Object} objects - the objects to scale
+ * @return {Object|Array} the scaled object, or a list of scaled objects
  * @alias module:modeling/transforms.scaleY
  */
-const scaleY = (offset, ...objects) => scale([1, offset, 1], objects)
+const scaleY = (factor, ...objects) => scale([1, factor, 1], objects)
 
 /**
- * Scale the given geometries about the Z axis using the given options.
- * @param {Number} factor - Z factor by which to scale the geometries
- * @param {...Object} geometries - the geometries to scale
- * @return {Object|Array} the scaled geometry, or a list of scaled geometries
+ * Scale the given objects about the Z axis using the given options.
+ * @param {Number} factor - Z factor by which to scale the objects
+ * @param {...Object} objects - the objects to scale
+ * @return {Object|Array} the scaled object, or a list of scaled objects
  * @alias module:modeling/transforms.scaleZ
  */
-const scaleZ = (offset, ...objects) => scale([1, 1, offset], objects)
+const scaleZ = (factor, ...objects) => scale([1, 1, factor], objects)
 
 module.exports = {
   scale,

package/src/operations/transforms/transform.js

@@ -5,10 +5,10 @@ const geom3 = require('../../geometries/geom3')
 const path2 = require('../../geometries/path2')
 
 /**
- * Transform the given geometries using the given matrix.
+ * Transform the given objects using the given matrix.
  * @param {mat4} matrix - a transformation matrix
- * @param {...Object} geometries - the geometries to transform
- * @return {Object|Array} the transformed geometry, or a list of transformed geometries
+ * @param {...Object} objects - the objects to transform
+ * @return {Object|Array} the transformed object, or a list of transformed objects
  * @alias module:modeling/transforms.transform
  *
  * @example

package/src/operations/transforms/translate.js

@@ -7,10 +7,10 @@ const geom3 = require('../../geometries/geom3')
 const path2 = require('../../geometries/path2')
 
 /**
- * Translate the given geometries using the given options.
- * @param {Array} offset - offset (vector) of which to translate the geometries
- * @param {...Object} geometries - the geometries to translate
- * @return {Object|Array} the translated geometry, or a list of translated geometries
+ * Translate the given objects using the given options.
+ * @param {Array} offset - offset (vector) of which to translate the objects
+ * @param {...Object} objects - the objects to translate
+ * @return {Object|Array} the translated object, or a list of translated objects
  * @alias module:modeling/transforms.translate
  *
  * @example
@@ -38,28 +38,28 @@ const translate = (offset, ...objects) => {
 }
 
 /**
- * Translate the given geometries along the X axis using the given options.
- * @param {Number} offset - X offset of which to translate the geometries
- * @param {...Object} geometries - the geometries to translate
- * @return {Object|Array} the translated geometry, or a list of translated geometries
+ * Translate the given objects along the X axis using the given options.
+ * @param {Number} offset - X offset of which to translate the objects
+ * @param {...Object} objects - the objects to translate
+ * @return {Object|Array} the translated object, or a list of translated objects
  * @alias module:modeling/transforms.translateX
  */
 const translateX = (offset, ...objects) => translate([offset, 0, 0], objects)
 
 /**
- * Translate the given geometries along the Y axis using the given options.
+ * Translate the given objects along the Y axis using the given options.
  * @param {Number} offset - Y offset of which to translate the geometries
- * @param {...Object} geometries - the geometries to translate
- * @return {Object|Array} the translated geometry, or a list of translated geometries
+ * @param {...Object} objects - the objects to translate
+ * @return {Object|Array} the translated object, or a list of translated objects
  * @alias module:modeling/transforms.translateY
  */
 const translateY = (offset, ...objects) => translate([0, offset, 0], objects)
 
 /**
- * Translate the given geometries along the Z axis using the given options.
+ * Translate the given objects along the Z axis using the given options.
  * @param {Number} offset - Z offset of which to translate the geometries
- * @param {...Object} geometries - the geometries to translate
- * @return {Object|Array} the translated geometry, or a list of translated geometries
+ * @param {...Object} objects - the objects to translate
+ * @return {Object|Array} the translated object, or a list of translated objects
  * @alias module:modeling/transforms.translateZ
  */
 const translateZ = (offset, ...objects) => translate([0, 0, offset], objects)

package/src/primitives/arc.js

@@ -78,7 +78,7 @@ const arc = (options) => {
       pointArray.push(point)
     }
   }
-  return path2.fromPoints({ close: false }, pointArray)
+  return path2.fromPoints({ closed: false }, pointArray)
 }
 
 module.exports = arc

package/src/primitives/cylinderElliptic.test.js

@@ -131,8 +131,6 @@ test('cylinderElliptic (options)', (t) => {
   // test startAngle and endAngle
   obs = cylinderElliptic({ startRadius: [1, 2], endRadius: [2, 1], startAngle: Math.PI / 2, endAngle: Math.PI * 2 * 0.75, segments: 12 })
   pts = geom3.toPoints(obs)
-  exp = [
-  ]
 
   t.is(pts.length, 28)
   // t.true(comparePolygonsAsPoints(pts, exp))

package/src/primitives/ellipsoid.js

@@ -10,7 +10,7 @@ const { isGTE, isNumberArray } = require('./commonChecks')
  * @param {Object} [options] - options for construction
  * @param {Array} [options.center=[0,0,0]] - center of ellipsoid
  * @param {Array} [options.radius=[1,1,1]] - radius of ellipsoid, along X, Y and Z
- * @param {Number} [options.segments=32] - number of segements to create per full rotation
+ * @param {Number} [options.segments=32] - number of segments to create per full rotation
  * @param {Array} [options.axes] -  an array with three vectors for the x, y and z base vectors
  * @returns {geom3} new 3D geometry
  * @alias module:modeling/primitives.ellipsoid