@jscad/modeling 2.11.1 → 3.0.0-alpha.0

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

@@ -1,8 +1,8 @@
-const test = require('ava')
+import test from 'ava'
 
-const { path2 } = require('../../geometries')
+import { path2 } from '../../geometries/index.js'
 
-const hullPath2 = require('./hullPath2')
+import { hullPath2 } from './hullPath2.js'
 
 test('hullPath2', (t) => {
   const closed = true

package/src/operations/hulls/hullPoints2.js

@@ -1,4 +1,4 @@
-const vec2 = require('../../maths/vec2')
+import * as vec2 from '../../maths/vec2/index.js'
 
 /*
  * Create a convex hull of the given set of points, where each point is an array of [x,y].
@@ -6,7 +6,7 @@ const vec2 = require('../../maths/vec2')
  * @param {Array} uniquePoints - list of UNIQUE points from which to create a hull
  * @returns {Array} a list of points that form the hull
  */
-const hullPoints2 = (uniquePoints) => {
+export const hullPoints2 = (uniquePoints) => {
   // find min point
   let min = vec2.fromValues(Infinity, Infinity)
   uniquePoints.forEach((point) => {
@@ -25,8 +25,9 @@ const hullPoints2 = (uniquePoints) => {
   })
 
   // sort by polar coordinates
-  points.sort((pt1, pt2) => pt1.angle < pt2.angle ? -1 : pt1.angle > pt2.angle ? 1 :
-    pt1.distSq < pt2.distSq ? -1 : pt1.distSq > pt2.distSq ? 1 : 0)
+  points.sort((pt1, pt2) => pt1.angle !== pt2.angle
+    ? pt1.angle - pt2.angle
+    : pt1.distSq - pt2.distSq)
 
   const stack = [] // start with empty stack
   points.forEach((point) => {
@@ -55,5 +56,3 @@ const fakeAtan2 = (y, x) => {
     return -x / y
   }
 }
-
-module.exports = hullPoints2

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

@@ -1,6 +1,6 @@
-const test = require('ava')
+import test from 'ava'
 
-const hullPoints2 = require('./hullPoints2')
+import { hullPoints2 } from './hullPoints2.js'
 
 test('hullPoints2 bug #114 2 circles with 18 segments', (t) => {
   const points = [

package/src/operations/hulls/index.d.ts

@@ -1,4 +1,2 @@
-export { default as hull } from './hull'
-export { default as hullChain } from './hullChain'
-
-export as namespace hulls
+export { hull } from './hull.js'
+export { hullChain } from './hullChain.js'

package/src/operations/hulls/index.js

@@ -4,9 +4,7 @@
  * In all cases, the function returns the results, and never changes the original shapes.
  * @module modeling/hulls
  * @example
- * const { hull, hullChain } = require('@jscad/modeling').hulls
+ * import { hull, hullChain } from '@jscad/modeling'
  */
-module.exports = {
-  hull: require('./hull'),
-  hullChain: require('./hullChain')
-}
+export { hull } from './hull.js'
+export { hullChain } from './hullChain.js'

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

@@ -1,11 +1,4 @@
-const add = require('../../../maths/vec3/add')
-const copy = require('../../../maths/vec3/copy')
-const cross = require('../../../maths/vec3/cross')
-const dot = require('../../../maths/vec3/dot')
-const length = require('../../../maths/vec3/length')
-const normalize = require('../../../maths/vec3/normalize')
-const scale = require('../../../maths/vec3/scale')
-const subtract = require('../../../maths/vec3/subtract')
+import { add, copy, cross, dot, length, normalize, scale, subtract } from '../../../maths/vec3/index.js'
 
 /*
  * Original source from quickhull3d (https://github.com/mauriciopoppe/quickhull3d)
@@ -14,19 +7,19 @@ const subtract = require('../../../maths/vec3/subtract')
  * Adapted to JSCAD by Jeff Gay
  */
 
-const HalfEdge = require('./HalfEdge')
+import { HalfEdge } from './HalfEdge.js'
 
-const VISIBLE = 0
-const NON_CONVEX = 1
-const DELETED = 2
+export const VISIBLE = 0
+export const NON_CONVEX = 1
+export const DELETED = 2
 
-class Face {
+export class Face {
   constructor () {
     this.normal = []
     this.centroid = []
     // signed distance from face to the origin
     this.offset = 0
-    // pointer to the a vertex in a double linked list this face can see
+    // pointer to the vertex in a double linked list this face can see
     this.outside = null
     this.mark = VISIBLE
     this.edge = null
@@ -325,10 +318,3 @@ class Face {
     return face
   }
 }
-
-module.exports = {
-  VISIBLE,
-  NON_CONVEX,
-  DELETED,
-  Face
-}

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

@@ -1,5 +1,4 @@
-const distance = require('../../../maths/vec3/distance')
-const squaredDistance = require('../../../maths/vec3/squaredDistance')
+import { distance, squaredDistance } from '../../../maths/vec3/index.js'
 
 /*
  * Original source from quickhull3d (https://github.com/mauriciopoppe/quickhull3d)
@@ -8,7 +7,7 @@ const squaredDistance = require('../../../maths/vec3/squaredDistance')
  * Adapted to JSCAD by Jeff Gay
  */
 
-class HalfEdge {
+export class HalfEdge {
   constructor (vertex, face) {
     this.vertex = vertex
     this.face = face
@@ -52,5 +51,3 @@ class HalfEdge {
     edge.opposite = this
   }
 }
-
-module.exports = HalfEdge

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

@@ -1,11 +1,11 @@
-const dot = require('../../../maths/vec3/dot')
+import { dot } from '../../../maths/vec3/index.js'
+import * as plane from '../../../maths/plane/index.js'
 
-const pointLineDistance = require('./point-line-distance')
-const getPlaneNormal = require('./get-plane-normal')
+import { pointLineDistance } from './point-line-distance.js'
 
-const VertexList = require('./VertexList')
-const Vertex = require('./Vertex')
-const { Face, VISIBLE, NON_CONVEX, DELETED } = require('./Face')
+import { VertexList } from './VertexList.js'
+import { Vertex } from './Vertex.js'
+import { Face, VISIBLE, NON_CONVEX, DELETED } from './Face.js'
 
 /*
  * Original source from quickhull3d (https://github.com/mauriciopoppe/quickhull3d)
@@ -15,11 +15,11 @@ const { Face, VISIBLE, NON_CONVEX, DELETED } = require('./Face')
  */
 
 // merge types
-// non convex with respect to the large face
+// non-convex with respect to the large face
 const MERGE_NON_CONVEX_WRT_LARGER_FACE = 1
 const MERGE_NON_CONVEX = 2
 
-class QuickHull {
+export class QuickHull {
   constructor (points) {
     if (!Array.isArray(points)) {
       throw TypeError('input is not a valid array')
@@ -292,9 +292,9 @@ class QuickHull {
       }
     }
 
-    // the next vertes is the one farthest to the plane `v0`, `v1`, `v2`
+    // the next vertex is the one farthest to the plane `v0`, `v1`, `v2`
     // normalize((v2 - v1) x (v0 - v1))
-    const normal = getPlaneNormal([], v0.point, v1.point, v2.point)
+    const normal = plane.fromPoints([], v0.point, v1.point, v2.point)
     // distance from the origin to the plane
     const distPO = dot(v0.point, normal)
     maxDistance = -1
@@ -435,11 +435,11 @@ class QuickHull {
    * Finds the next vertex to make faces with the current hull
    *
    * - let `face` be the first face existing in the `claimed` vertex list
-   *  - if `face` doesn't exist then return since there're no vertices left
+   *  - if `face` doesn't exist then return since there are no vertices left
    *  - otherwise for each `vertex` that face sees find the one furthest away
    *  from `face`
    *
-   * @return {Vertex|undefined} Returns undefined when there're no more
+   * @return {Vertex|undefined} Returns undefined when there are no more
    * visible vertices
    */
   nextVertexToAdd () {
@@ -603,7 +603,7 @@ class QuickHull {
    *
    *    dot(centroid larger face, smaller face normal) - smaller face offset > -tolerance
    *
-   * If true then it means that two faces are non convex (concave), even if the
+   * If true then it means that two faces are non-convex (concave), even if the
    * dot(...) - offset value is > 0 (that's the point of doing the merge in the
    * first place)
    *
@@ -727,7 +727,7 @@ class QuickHull {
     }
 
     // second merge pass
-    // Do the merge on non convex faces (a face is marked as non convex in the
+    // Do the merge on non-convex faces (a face is marked as non-convex in the
     // first pass)
     for (let i = 0; i < this.newFaces.length; i += 1) {
       const face = this.newFaces[i]
@@ -750,5 +750,3 @@ class QuickHull {
     this.reindexFaceAndVertices()
   }
 }
-
-module.exports = QuickHull

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

@@ -5,7 +5,7 @@
  * Adapted to JSCAD by Jeff Gay
  */
 
-class Vertex {
+export class Vertex {
   constructor (point, index) {
     this.point = point
     // index in the input array
@@ -17,5 +17,3 @@ class Vertex {
     this.face = null
   }
 }
-
-module.exports = Vertex

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

@@ -4,8 +4,7 @@
  *
  * Adapted to JSCAD by Jeff Gay
  */
-
-class VertexList {
+export class VertexList {
   constructor () {
     this.head = null
     this.tail = null
@@ -142,5 +141,3 @@ class VertexList {
     return !this.head
   }
 }
-
-module.exports = VertexList

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

@@ -1,4 +1,4 @@
-const QuickHull = require('./QuickHull')
+import { QuickHull } from './QuickHull.js'
 
 /*
  * Original source from quickhull3d (https://github.com/mauriciopoppe/quickhull3d)
@@ -7,10 +7,8 @@ const QuickHull = require('./QuickHull')
  * Adapted to JSCAD by Jeff Gay
  */
 
-const runner = (points, options = {}) => {
+export const runner = (points, options = {}) => {
   const instance = new QuickHull(points)
   instance.build()
   return instance.collectFaces(options.skipTriangulation)
 }
-
-module.exports = runner

package/src/operations/hulls/quickhull/point-line-distance.js

@@ -1,6 +1,4 @@
-const cross = require('../../../maths/vec3/cross')
-const subtract = require('../../../maths/vec3/subtract')
-const squaredLength = require('../../../maths/vec3/squaredLength')
+import { cross, subtract, squaredLength } from '../../../maths/vec3/index.js'
 
 /*
  * Original source from quickhull3d (https://github.com/mauriciopoppe/quickhull3d)
@@ -37,6 +35,4 @@ const distanceSquared = (p, a, b) => {
   return area / s
 }
 
-const pointLineDistance = (point, a, b) => Math.sqrt(distanceSquared(point, a, b))
-
-module.exports = pointLineDistance
+export const pointLineDistance = (point, a, b) => Math.sqrt(distanceSquared(point, a, b))

package/src/operations/hulls/toUniquePoints.js

@@ -1,11 +1,11 @@
-const geom2 = require('../../geometries/geom2')
-const geom3 = require('../../geometries/geom3')
-const path2 = require('../../geometries/path2')
+import * as geom2 from '../../geometries/geom2/index.js'
+import * as geom3 from '../../geometries/geom3/index.js'
+import * as path2 from '../../geometries/path2/index.js'
 
 /*
  * Return the unique vertices of a geometry
  */
-const toUniquePoints = (geometries) => {
+export const toUniquePoints = (geometries) => {
   const found = new Set()
   const uniquePoints = []
 
@@ -30,5 +30,3 @@ const toUniquePoints = (geometries) => {
 
   return uniquePoints
 }
-
-module.exports = toUniquePoints

package/src/operations/modifiers/generalize.d.ts

@@ -1,5 +1,5 @@
-import { Geometry } from '../../geometries/types'
-import RecursiveArray from '../../utils/recursiveArray'
+import type { Geometry } from '../../geometries/types.d.ts'
+import type { RecursiveArray } from '../../utils/recursiveArray.d.ts'
 
 export interface GeneralizeOptions {
   snap?: boolean

package/src/operations/modifiers/generalize.js

@@ -1,15 +1,15 @@
-const flatten = require('../../utils/flatten')
+import { flatten } from '../../utils/flatten.js'
 
-const measureEpsilon = require('../../measurements/measureEpsilon')
+import { measureEpsilon } from '../../measurements/measureEpsilon.js'
 
-const geom2 = require('../../geometries/geom2')
-const geom3 = require('../../geometries/geom3')
-const path2 = require('../../geometries/path2')
+import * as geom2 from '../../geometries/geom2/index.js'
+import * as geom3 from '../../geometries/geom3/index.js'
+import * as path2 from '../../geometries/path2/index.js'
 
-const snapPolygons = require('./snapPolygons')
-const mergePolygons = require('./mergePolygons')
-const insertTjunctions = require('./insertTjunctions')
-const triangulatePolygons = require('./triangulatePolygons')
+import { snapPolygons } from './snapPolygons.js'
+import { mergePolygons } from './mergePolygons.js'
+import { insertTjunctions } from './insertTjunctions.js'
+import { triangulatePolygons } from './triangulatePolygons.js'
 
 /*
  */
@@ -58,15 +58,15 @@ const generalizeGeom3 = (options, geometry) => {
 
 /**
  * Apply various modifications in proper order to produce a generalized geometry.
- * @param {Object} options - options for modifications
- * @param {Boolean} [options.snap=false] the geometries should be snapped to epsilons
- * @param {Boolean} [options.simplify=false] the geometries should be simplified
- * @param {Boolean} [options.triangulate=false] the geometries should be triangulated
+ * @param {object} options - options for modifications
+ * @param {boolean} [options.snap=false] the geometries should be snapped to epsilons
+ * @param {boolean} [options.simplify=false] the geometries should be simplified
+ * @param {boolean} [options.triangulate=false] the geometries should be triangulated
  * @param {...Object} geometries - the geometries to generalize
  * @return {Object|Array} the modified geometry, or a list of modified geometries
  * @alias module:modeling/modifiers.generalize
  */
-const generalize = (options, ...geometries) => {
+export const generalize = (options, ...geometries) => {
   geometries = flatten(geometries)
   if (geometries.length === 0) throw new Error('wrong number of arguments')
 
@@ -78,5 +78,3 @@ const generalize = (options, ...geometries) => {
   })
   return results.length === 1 ? results[0] : results
 }
-
-module.exports = generalize

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

@@ -1,14 +1,14 @@
-const test = require('ava')
+import test from 'ava'
 
-const { comparePolygonsAsPoints } = require('../../../test/helpers')
+import { comparePolygonsAsPoints } from '../../../test/helpers/index.js'
 
-const { TAU } = require('../../maths/constants')
+import { TAU } from '../../maths/constants.js'
 
-const { geom3 } = require('../../geometries')
+import { geom3 } from '../../geometries/index.js'
 
-const { cuboid } = require('../../primitives')
+import { cuboid } from '../../primitives/index.js'
 
-const { generalize } = require('./index')
+import { generalize } from './index.js'
 
 test('generalize: generalize of a geom3 produces an expected geom3', (t) => {
   const geometry1 = cuboid({ size: [TAU / 2, TAU / 4, TAU] })

package/src/operations/modifiers/index.d.ts

@@ -1,3 +1,3 @@
-export { default as generalize } from './generalize'
-export { default as snap } from './snap'
-export { default as retessellate } from './retessellate'
+export { generalize } from './generalize.js'
+export { snap } from './snap.js'
+export { retessellate } from './retessellate.js'

package/src/operations/modifiers/index.js

@@ -3,10 +3,8 @@
  * In all cases, these functions returns the results, and never changes the original geometry.
  * @module modeling/modifiers
  * @example
- * const { snap } = require('@jscad/modeling').modifiers
+ * import { generalize, snap } from '@jscad/modeling'
  */
-module.exports = {
-  generalize: require('./generalize'),
-  snap: require('./snap'),
-  retessellate: require('./retessellate'),
-}
+export { generalize } from './generalize.js'
+export { snap } from './snap.js'
+export { retessellate } from './retessellate.js'