@jscad/modeling 2.12.0 → 3.0.0-alpha.0

package/src/curves/bezier/length.js

@@ -1,4 +1,4 @@
-const lengths = require('./lengths')
+import { lengths } from './lengths.js'
 
 /**
  * Approximates the length of the bezier curve by sampling it at a sequence of points, then adding up all the distances.
@@ -8,11 +8,9 @@ const lengths = require('./lengths')
  * const b = bezier.create([[0, 0], [0, 10]]);
  * console.log(length(100, b)) // output 10
  *
- * @param {Number} segments the number of segments to use when approximating the curve length.
- * @param {Object} bezier a bezier curve.
+ * @param {number} segments the number of segments to use when approximating the curve length.
+ * @param {object} bezier a bezier curve.
  * @returns an approximation of the curve's length.
  * @alias module:modeling/curves/bezier.length
  */
-const length = (segments, bezier) => lengths(segments, bezier)[segments]
-
-module.exports = length
+export const length = (segments, bezier) => lengths(segments, bezier)[segments]

package/src/curves/bezier/length.test.js

@@ -1,54 +1,54 @@
-const test = require('ava')
+import test from 'ava'
 
-const { bezier } = require('../index')
-const length = require('./length')
+import { create } from './create.js'
+import { length } from './length.js'
 
-const { nearlyEqual } = require('../../../test/helpers/index')
+import { nearlyEqual } from '../../../test/helpers/nearlyEqual.js'
 
 test('calculate the length of an 1D linear bezier with numeric control points', (t) => {
-  const bezierCurve = bezier.create([0, 10])
+  const bezierCurve = create([0, 10])
   nearlyEqual(t, length(100, bezierCurve), 10, 0.0001)
   t.true(true)
 })
 
 test('calculate the length of an 1D linear bezier with array control points', (t) => {
-  const bezierCurve = bezier.create([[0], [10]])
+  const bezierCurve = create([[0], [10]])
   nearlyEqual(t, length(100, bezierCurve), 10, 0.0001)
   t.true(true)
 })
 
 test('calculate the length of a 2D linear bezier', (t) => {
-  const bezierCurve = bezier.create([[0, 0], [10, 10]])
+  const bezierCurve = create([[0, 0], [10, 10]])
   nearlyEqual(t, length(100, bezierCurve), 14.1421, 0.0001)
   t.true(true)
 })
 
 test('calculate the length of a 2D quadratic (3 control points) bezier', (t) => {
-  const bezierCurve = bezier.create([[0, 0], [0, 10], [10, 10]])
+  const bezierCurve = create([[0, 0], [0, 10], [10, 10]])
   nearlyEqual(t, length(100, bezierCurve), 16.2320, 0.0001)
   t.true(true)
 })
 
 test('calculate the length of a 2D cubic (4 control points) bezier', (t) => {
-  const bezierCurve = bezier.create([[0, 0], [0, 10], [10, 10], [10, 0]])
+  const bezierCurve = create([[0, 0], [0, 10], [10, 10], [10, 0]])
   nearlyEqual(t, length(100, bezierCurve), 19.9992, 0.0001)
   t.true(true)
 })
 
 test('calculate the length of a 3D linear bezier', (t) => {
-  const bezierCurve = bezier.create([[0, 0, 0], [10, 10, 10]])
+  const bezierCurve = create([[0, 0, 0], [10, 10, 10]])
   nearlyEqual(t, length(100, bezierCurve), 17.3205, 0.0001)
   t.true(true)
 })
 
 test('calculate the length of a 3D quadratic (3 control points) bezier', (t) => {
-  const bezierCurve = bezier.create([[0, 0, 0], [5, 5, 5], [0, 0, 10]])
+  const bezierCurve = create([[0, 0, 0], [5, 5, 5], [0, 0, 10]])
   nearlyEqual(t, length(100, bezierCurve), 12.7125, 0.0001)
   t.true(true)
 })
 
 test('calculate the length of a 3D cubic (4 control points) bezier', (t) => {
-  const bezierCurve = bezier.create([[0, 0, 0], [5, 5, 5], [0, 0, 10], [-5, -5, 5]])
+  const bezierCurve = create([[0, 0, 0], [5, 5, 5], [0, 0, 10], [-5, -5, 5]])
   nearlyEqual(t, length(100, bezierCurve), 17.2116, 0.0001)
   t.true(true)
 })

package/src/curves/bezier/lengths.d.ts

@@ -1,5 +1,3 @@
-import Bezier from './type'
+import type { Bezier } from './type.d.ts'
 
-export default lengths
-
-declare function lengths(segments: number, bezier: Bezier): Array<number>
+export function lengths(segments: number, bezier: Bezier): Array<number>

package/src/curves/bezier/lengths.js

@@ -1,4 +1,4 @@
-const valueAt = require('./valueAt')
+import { valueAt } from './valueAt.js'
 
 /**
  * Divides the bezier curve into line segments and returns the cumulative length of those segments as an array.
@@ -8,11 +8,11 @@ const valueAt = require('./valueAt')
  * const b = bezier.create([[0, 0], [0, 10]]);
  * const totalLength = lengths(100, b).pop(); // the last element of the array is the curve's approximate length
  *
- * @param {Number} segments the number of segments to use when approximating the curve length.
- * @param {Object} bezier a bezier curve.
+ * @param {number} segments the number of segments to use when approximating the curve length.
+ * @param {object} bezier a bezier curve.
  * @returns an array containing the cumulative length of the segments.
  */
-const lengths = (segments, bezier) => {
+export const lengths = (segments, bezier) => {
   let sum = 0
   const lengths = [0]
   let previous = valueAt(0, bezier)
@@ -34,7 +34,7 @@ const lengths = (segments, bezier) => {
  *
  * @param {Array} a - first operand.
  * @param {Array} b - second operand.
- * @returns {Number} - distance.
+ * @returns {number} - distance.
  */
 const distanceBetween = (a, b) => {
   if (Number.isFinite(a) && Number.isFinite(b)) {
@@ -52,5 +52,3 @@ const distanceBetween = (a, b) => {
     throw new Error('The operands must be of the same type, either number or array.')
   }
 }
-
-module.exports = lengths

package/src/curves/bezier/lengths.test.js

@@ -1,12 +1,12 @@
-const test = require('ava')
+import test from 'ava'
 
-const { bezier } = require('../index')
-const lengths = require('./lengths')
+import { create } from './create.js'
+import { lengths } from './lengths.js'
 
-const { nearlyEqual } = require('../../../test/helpers/index')
+import { nearlyEqual } from '../../../test/helpers/nearlyEqual.js'
 
 test('calculate lengths for a 1D linear bezier with numeric control points', (t) => {
-  const bezierCurve = bezier.create([0, 10])
+  const bezierCurve = create([0, 10])
   const result = lengths(100, bezierCurve)
   t.is(result.length, 101) // with the default number of segments (100) the length of the array should be 101
   nearlyEqual(t, result[0], 0, 0.0001) // first element is always 0
@@ -15,7 +15,7 @@ test('calculate lengths for a 1D linear bezier with numeric control points', (t)
 })
 
 test('calculate lengths for a 1D linear bezier with array control points', (t) => {
-  const bezierCurve = bezier.create([[0], [10]])
+  const bezierCurve = create([[0], [10]])
   const result = lengths(100, bezierCurve)
   t.is(result.length, 101)
   nearlyEqual(t, result[0], 0, 0.0001)
@@ -24,7 +24,7 @@ test('calculate lengths for a 1D linear bezier with array control points', (t) =
 })
 
 test('calculate lengths for a 2D linear bezier', (t) => {
-  const bezierCurve = bezier.create([[0, 0], [10, 10]])
+  const bezierCurve = create([[0, 0], [10, 10]])
   const result = lengths(100, bezierCurve)
   t.is(result.length, 101)
   nearlyEqual(t, result[0], 0, 0.0001)
@@ -33,7 +33,7 @@ test('calculate lengths for a 2D linear bezier', (t) => {
 })
 
 test('calculate lengths for a 2D quadratic (3 control points) bezier', (t) => {
-  const bezierCurve = bezier.create([[0, 0], [0, 10], [10, 10]])
+  const bezierCurve = create([[0, 0], [0, 10], [10, 10]])
   const result = lengths(100, bezierCurve)
   t.is(result.length, 101)
   nearlyEqual(t, result[0], 0, 0.0001)
@@ -42,7 +42,7 @@ test('calculate lengths for a 2D quadratic (3 control points) bezier', (t) => {
 })
 
 test('calculate lengths for a 2D cubic (4 control points) bezier', (t) => {
-  const bezierCurve = bezier.create([[0, 0], [0, 10], [10, 10], [10, 0]])
+  const bezierCurve = create([[0, 0], [0, 10], [10, 10], [10, 0]])
   const result = lengths(100, bezierCurve)
   t.is(result.length, 101)
   nearlyEqual(t, result[0], 0, 0.0001)
@@ -51,7 +51,7 @@ test('calculate lengths for a 2D cubic (4 control points) bezier', (t) => {
 })
 
 test('calculate lengths for a 3D linear bezier', (t) => {
-  const bezierCurve = bezier.create([[0, 0, 0], [10, 10, 10]])
+  const bezierCurve = create([[0, 0, 0], [10, 10, 10]])
   const result = lengths(100, bezierCurve)
   t.is(result.length, 101)
   nearlyEqual(t, result[0], 0, 0.0001)
@@ -60,7 +60,7 @@ test('calculate lengths for a 3D linear bezier', (t) => {
 })
 
 test('calculate lengths for a 3D quadratic (3 control points) bezier', (t) => {
-  const bezierCurve = bezier.create([[0, 0, 0], [5, 5, 5], [0, 0, 10]])
+  const bezierCurve = create([[0, 0, 0], [5, 5, 5], [0, 0, 10]])
   const result = lengths(100, bezierCurve)
   t.is(result.length, 101)
   nearlyEqual(t, result[0], 0, 0.0001)
@@ -69,7 +69,7 @@ test('calculate lengths for a 3D quadratic (3 control points) bezier', (t) => {
 })
 
 test('calculate lengths for a 3D cubic (4 control points) bezier', (t) => {
-  const bezierCurve = bezier.create([[0, 0, 0], [5, 5, 5], [0, 0, 10], [-5, -5, 5]])
+  const bezierCurve = create([[0, 0, 0], [5, 5, 5], [0, 0, 10], [-5, -5, 5]])
   const result = lengths(100, bezierCurve)
   t.is(result.length, 101)
   nearlyEqual(t, result[0], 0, 0.0001)

package/src/curves/bezier/tangentAt.d.ts

@@ -1,5 +1,3 @@
-import Bezier from './type'
+import type { Bezier } from './type.d.ts'
 
-export default tangentAt
-
-declare function tangentAt(t: number, bezier: Bezier): Array<number> | number
+export function tangentAt(t: number, bezier: Bezier): Array<number> | number

package/src/curves/bezier/tangentAt.js

@@ -8,11 +8,11 @@
  * let tangent = bezier.tangentAt(t, b)
  *
  * @param {number} t : the position of which to calculate the bezier's tangent value; 0 < t < 1
- * @param {Object} bezier : an array with at least 2 elements of either all numbers, or all arrays of numbers that are the same size.
+ * @param {object} bezier : an array with at least 2 elements of either all numbers, or all arrays of numbers that are the same size.
  * @return {array | number} the tangent at the requested position.
  * @alias module:modeling/curves/bezier.tangentAt
  */
-const tangentAt = (t, bezier) => {
+export const tangentAt = (t, bezier) => {
   if (t < 0 || t > 1) {
     throw new Error('Bezier tangentAt() input must be between 0 and 1')
   }
@@ -41,5 +41,3 @@ const bezierTangent = function (bezier, p, t) {
   }
   return result
 }
-
-module.exports = tangentAt

package/src/curves/bezier/tangentAt.test.js

@@ -1,6 +1,6 @@
-const test = require('ava')
+import test from 'ava'
 
-const { bezier } = require('../index')
+import { bezier } from '../index.js'
 
 test('Linear bezier (straight line between two points)', (t) => {
   const straightLine = bezier.create([10, 20])

package/src/curves/bezier/type.d.ts

@@ -1,6 +1,4 @@
-export default Bezier
-
-declare interface Bezier {
+export interface Bezier {
   points: Array<number> | Array<Array<number>>
   pointType: string
   dimensions: number

package/src/curves/bezier/valueAt.d.ts

@@ -1,5 +1,3 @@
-import Bezier from './type'
+import type { Bezier } from './type.d.ts'
 
-export default valueAt
-
-declare function valueAt(t: number, bezier: Bezier): Array<number> | number
+export function valueAt(t: number, bezier: Bezier): Array<number> | number

package/src/curves/bezier/valueAt.js

@@ -9,11 +9,11 @@
  * let position = bezier.valueAt(t,b) // where 0 < t < 1
  *
  * @param {number} t : the position of which to calculate the value; 0 < t < 1
- * @param {Object} bezier : a bezier curve created with bezier.create().
+ * @param {object} bezier : a Bézier curve created with bezier.create().
  * @returns {array | number} the value at the requested position.
  * @alias module:modeling/curves/bezier.valueAt
  */
-const valueAt = (t, bezier) => {
+export const valueAt = (t, bezier) => {
   if (t < 0 || t > 1) {
     throw new Error('Bezier valueAt() input must be between 0 and 1')
   }
@@ -40,5 +40,3 @@ const bezierFunction = function (bezier, p, t) {
   }
   return result
 }
-
-module.exports = valueAt

package/src/curves/bezier/valueAt.test.js

@@ -1,6 +1,6 @@
-const test = require('ava')
+import test from 'ava'
 
-const { bezier } = require('../index')
+import { bezier } from '../index.js'
 
 test('Linear bezier (straight line between two points)', (t) => {
   const straightLine = bezier.create([10, 20])

package/src/curves/index.d.ts

@@ -1,3 +1 @@
-export * as bezier from './bezier'
-
-export as namespace curves
+export * as bezier from './bezier/index.js'

package/src/curves/index.js

@@ -1,10 +1,8 @@
 /**
- * Curves are n-dimensional mathematical constructs that define a path from point 0 to point 1.
+ * Curves are n-dimensional mathematical constructs that define a path from vertex 0 to vertex 1.
  * @module modeling/curves
  * @example
- * const { bezier } = require('@jscad/modeling').curves
-
+ * import { curves } from '@jscad/modeling'
+ * const { bezier } = curves
  */
-module.exports = {
-  bezier: require('./bezier')
-}
+export * as bezier from './bezier/index.js'

package/src/geometries/geom2/applyTransforms.js

@@ -1,26 +1,20 @@
-const mat4 = require('../../maths/mat4')
-const vec2 = require('../../maths/vec2')
+import * as mat4 from '../../maths/mat4/index.js'
+import * as vec2 from '../../maths/vec2/index.js'
 
 /*
  * Apply the transforms of the given geometry.
- * NOTE: This function must be called BEFORE exposing any data. See toSides().
- * @param {geom2} geometry - the geometry to transform
- * @returns {geom2} the given geometry
+ * NOTE: This function must be called BEFORE exposing any data. See toOutlines().
+ * @param {Geom2} geometry - the geometry to transform
+ * @returns {Geom2} the given geometry
  *
  * @example
  * geometry = applyTransforms(geometry)
  */
-const applyTransforms = (geometry) => {
+export const applyTransforms = (geometry) => {
   if (mat4.isIdentity(geometry.transforms)) return geometry
 
   // apply transforms to each side
-  geometry.sides = geometry.sides.map((side) => {
-    const p0 = vec2.transform(vec2.create(), side[0], geometry.transforms)
-    const p1 = vec2.transform(vec2.create(), side[1], geometry.transforms)
-    return [p0, p1]
-  })
+  geometry.outlines = geometry.outlines.map((outline) => outline.map((point) => vec2.transform(vec2.create(), point, geometry.transforms)))
   geometry.transforms = mat4.create()
   return geometry
 }
-
-module.exports = applyTransforms

package/src/geometries/geom2/applyTransforms.test.js

@@ -1,16 +1,16 @@
-const test = require('ava')
+import test from 'ava'
 
-const { fromPoints } = require('./index')
+import { create } from './index.js'
 
-const applyTransforms = require('./applyTransforms')
+import { applyTransforms } from './applyTransforms.js'
 
-test('applyTransforms: Updates a populated geom2 with transformed sides', (t) => {
+test('applyTransforms: Updates a populated geom2 with transforms', (t) => {
   const points = [[0, 0], [1, 0], [0, 1]]
   const expected = {
-    sides: [[[0, 1], [0, 0]], [[0, 0], [1, 0]], [[1, 0], [0, 1]]],
+    outlines: [[[0, 0], [1, 0], [0, 1]]],
     transforms: [1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1]
   }
-  const geometry = fromPoints(points)
+  const geometry = create([points])
   const updated = applyTransforms(geometry)
   t.is(geometry, updated)
   t.deepEqual(updated, expected)

package/src/geometries/geom2/clone.d.ts

@@ -1,5 +1,3 @@
-import Geom2 from './type'
+import type { Geom2 } from './type.d.ts'
 
-export default clone
-
-declare function clone(geometry: Geom2): Geom2
+export function clone(geometry: Geom2): Geom2

package/src/geometries/geom2/clone.js

@@ -1,9 +1,7 @@
 /**
  * Performs a shallow clone of the given geometry.
- * @param {geom2} geometry - the geometry to clone
- * @returns {geom2} new geometry
+ * @param {Geom2} geometry - the geometry to clone
+ * @returns {Geom2} new geometry
  * @alias module:modeling/geometries/geom2.clone
  */
-const clone = (geometry) => Object.assign({}, geometry)
-
-module.exports = clone
+export const clone = (geometry) => Object.assign({}, geometry)

package/src/geometries/geom2/clone.test.js

@@ -1,10 +1,10 @@
-const test = require('ava')
+import test from 'ava'
 
-const { clone, create, fromPoints } = require('./index')
+import { clone, create } from './index.js'
 
 test('clone: Creates a clone on an empty geom2', (t) => {
   const expected = {
-    sides: [],
+    outlines: [],
     transforms: [1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1]
   }
   const geometry = create()
@@ -16,10 +16,10 @@ test('clone: Creates a clone on an empty geom2', (t) => {
 test('clone: Creates a clone of a complete geom2', (t) => {
   const points = [[0, 0], [1, 0], [0, 1]]
   const expected = {
-    sides: [[[0, 1], [0, 0]], [[0, 0], [1, 0]], [[1, 0], [0, 1]]],
+    outlines: [[[0, 0], [1, 0], [0, 1]]],
     transforms: [1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1]
   }
-  const geometry = fromPoints(points)
+  const geometry = create([points])
   const another = clone(geometry)
   t.not(another, geometry)
   t.deepEqual(another, expected)

package/src/geometries/geom2/create.d.ts

@@ -1,6 +1,4 @@
-import Geom2 from './type'
-import Vec2 from '../../maths/vec2/type'
+import type { Geom2 } from './type.d.ts'
+import type { Vec2 } from '../../maths/vec2/type.d.ts'
 
-export default create
-
-declare function create(sides?: Array<[Vec2, Vec2]>): Geom2
+export function create(outlines?: Array<Array<Vec2>>): Geom2

package/src/geometries/geom2/create.js

@@ -1,26 +1,26 @@
-const mat4 = require('../../maths/mat4')
+import * as mat4 from '../../maths/mat4/index.js'
 
 /**
- * Represents a 2D geometry consisting of a list of sides.
- * @typedef {Object} geom2
- * @property {Array} sides - list of sides, each side containing two points
- * @property {mat4} transforms - transforms to apply to the sides, see transform()
+ * Represents a 2D geometry consisting of outlines, where each outline is an ordered list of points.
+ * @property {Array} outlines - list of polygon outlines
+ * @property {Mat4} transforms - transforms to apply to the geometry, see transform()
+ * @example
+ * // data structure
+ * {
+ *   "outlines": [[[-1,-1],[1,-1],[1,1],[-1,1]]],
+ *   "transforms": [1,0,0,0,0,1,0,0,0,0,1,0,0,0,0,1]
+ * }
  */
 
 /**
- * Create a new 2D geometry composed of unordered sides (two connected points).
- * @param {Array} [sides] - list of sides where each side is an array of two points
- * @returns {geom2} a new geometry
+ * Create a new 2D geometry composed of polygon outlines.
+ * @param {Array} [outlines] - list of outlines where each outline is an array of points
+ * @returns {Geom2} a new geometry
  * @alias module:modeling/geometries/geom2.create
+ * @example
+ * let myShape = create([ [[-1,-1], [1,-1], [1,1], [-1,1]] ])
  */
-const create = (sides) => {
-  if (sides === undefined) {
-    sides = [] // empty contents
-  }
-  return {
-    sides: sides,
-    transforms: mat4.create()
-  }
-}
-
-module.exports = create
+export const create = (outlines = []) => ({
+  outlines,
+  transforms: mat4.create()
+})

package/src/geometries/geom2/create.test.js

@@ -1,20 +1,20 @@
-const test = require('ava')
+import test from 'ava'
 
-const { create } = require('./index')
+import { create } from './index.js'
 
 test('create: Creates an empty geom2', (t) => {
   const expected = {
-    sides: [],
+    outlines: [],
     transforms: [1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1]
   }
   t.deepEqual(create(), expected)
 })
 
 test('create: Creates a populated geom2', (t) => {
-  const sides = [[[0, 0], [1, 1]]]
+  const points = [[0, 0], [1, 0], [0, 1]]
   const expected = {
-    sides: sides,
+    outlines: [[[0, 0], [1, 0], [0, 1]]],
     transforms: [1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1]
   }
-  t.deepEqual(create(sides), expected)
+  t.deepEqual(create([points]), expected)
 })

package/src/geometries/geom2/fromCompactBinary.d.ts

@@ -1,5 +1,3 @@
-import Geom2 from './type'
+import type { Geom2 } from './type.d.ts'
 
-export default fromCompactBinary
-
-declare function fromCompactBinary(data: Array<number> | Float32Array | Float64Array): Geom2
+export function fromCompactBinary(data: Array<number> | Float32Array | Float64Array): Geom2

package/src/geometries/geom2/fromCompactBinary.js

@@ -1,26 +1,36 @@
-const mat4 = require('../../maths/mat4')
-const vec2 = require('../../maths/vec2')
+import * as mat4 from '../../maths/mat4/index.js'
+import * as vec2 from '../../maths/vec2/index.js'
 
-const create = require('./create')
+import { create } from './create.js'
 
 /**
  * Create a new 2D geometry from the given compact binary data.
  * @param {Array} data - compact binary data
- * @returns {geom2} a new geometry
+ * @returns {Geom2} a new geometry
  * @alias module:modeling/geometries/geom2.fromCompactBinary
  */
-const fromCompactBinary = (data) => {
+export const fromCompactBinary = (data) => {
   if (data[0] !== 0) throw new Error('invalid compact binary data')
 
   const created = create()
 
   created.transforms = mat4.clone(data.slice(1, 17))
 
-  for (let i = 21; i < data.length; i += 4) {
-    const point0 = vec2.fromValues(data[i + 0], data[i + 1])
-    const point1 = vec2.fromValues(data[i + 2], data[i + 3])
-    created.sides.push([point0, point1])
+  for (let i = 21; i < data.length;) {
+    const length = data[i++] // number of points for this polygon
+    if (length < 0 || i + length * 2 > data.length) {
+      throw new Error('invalid compact binary data')
+    }
+    const outline = []
+    for (let j = 0; j < length; j++) {
+      const x = data[i + j * 2]
+      const y = data[i + j * 2 + 1]
+      outline.push(vec2.fromValues(x, y))
+    }
+    created.outlines.push(outline)
+    i += length * 2
   }
+
   // transfer known properties, i.e. color
   if (data[17] >= 0) {
     created.color = [data[17], data[18], data[19], data[20]]
@@ -28,5 +38,3 @@ const fromCompactBinary = (data) => {
   // TODO: how about custom properties or fields ?
   return created
 }
-
-module.exports = fromCompactBinary

package/src/geometries/geom2/fromSides.d.ts

@@ -0,0 +1,4 @@
+import type { Geom2 } from './type.d.ts'
+import type { Vec2 } from '../../maths/vec2/type.d.ts'
+
+export function fromSides(sides: Array<[Vec2, Vec2]>): Geom2