@jscad/modeling 2.12.0 → 3.0.0-alpha.0

package/src/maths/line3/intersectPointOfLineAndPlane.js

@@ -1,4 +1,4 @@
-const vec3 = require('../vec3')
+import * as vec3 from '../vec3/index.js'
 
 /**
  * Determine the closest point on the given plane to the given line.
@@ -6,24 +6,21 @@ const vec3 = require('../vec3')
  * NOTES:
  * The point of intersection will be invalid if the line is parallel to the plane, e.g. NaN.
  *
- * @param {line3} line - line of reference
- * @param {plane} plane - plane of reference
- * @returns {vec3} a point on the line
+ * @param {Line3} line - line of reference
+ * @param {Plane} plane - plane of reference
+ * @returns {Vec3} a point on the line
  * @alias module:modeling/maths/line3.intersectPointOfLineAndPlane
  */
-const intersectToPlane = (line, plane) => {
+export const intersectPointOfLineAndPlane = (line, plane) => {
   // plane: plane.normal * p = plane.w
-  const pnormal = plane
+  const pNormal = plane
   const pw = plane[3]
 
-  const lpoint = line[0]
-  const ldirection = line[1]
+  const lPoint = line[0]
+  const lDirection = line[1]
 
   // point: p = line.point + labda * line.direction
-  const labda = (pw - vec3.dot(pnormal, lpoint)) / vec3.dot(pnormal, ldirection)
+  const labda = (pw - vec3.dot(pNormal, lPoint)) / vec3.dot(pNormal, lDirection)
 
-  const point = vec3.add(vec3.create(), lpoint, vec3.scale(vec3.create(), ldirection, labda))
-  return point
+  return vec3.add(vec3.create(), lPoint, vec3.scale(vec3.create(), lDirection, labda))
 }
-
-module.exports = intersectToPlane

package/src/maths/line3/intersectPointOfLineAndPlane.test.js

@@ -1,10 +1,10 @@
-const test = require('ava')
+import test from 'ava'
 
-const plane = require('../plane/')
+import { plane } from '../index.js'
 
-const { intersectPointOfLineAndPlane, fromPoints, create } = require('./index')
+import { intersectPointOfLineAndPlane, fromPoints, create } from './index.js'
 
-const { compareVectors } = require('../../../test/helpers/index')
+import { compareVectors } from '../../../test/helpers/index.js'
 
 test('line3: intersectPointOfLineAndPlane() should return a new line3 with correct values', (t) => {
   const planeXY = plane.fromPoints(plane.create(), [0, 0, 0], [1, 0, 0], [1, 1, 0]) // flat on XY

package/src/maths/line3/origin.d.ts

@@ -1,6 +1,4 @@
-import Line3 from './type'
-import Vec3 from '../vec3/type'
+import type { Line3 } from './type.d.ts'
+import type { Vec3 } from '../vec3/type.d.ts'
 
-export default origin
-
-declare function origin(line: Line3): Vec3
+export function origin(line: Line3): Vec3

package/src/maths/line3/origin.js

@@ -1,10 +1,8 @@
 /**
  * Return the origin of the given line.
  *
- * @param {line3} line - line of reference
- * @return {vec3} the origin of the line
+ * @param {Line3} line - line of reference
+ * @return {Vec3} the origin of the line
  * @alias module:modeling/maths/line3.origin
  */
-const origin = (line) => line[0]
-
-module.exports = origin
+export const origin = (line) => line[0]

package/src/maths/line3/origin.test.js

@@ -1,7 +1,8 @@
-const test = require('ava')
-const { origin, create, fromPoints } = require('./index')
+import test from 'ava'
 
-const { compareVectors } = require('../../../test/helpers/index')
+import { origin, create, fromPoints } from './index.js'
+
+import { compareVectors } from '../../../test/helpers/index.js'
 
 test('line3: origin() should return proper origins', (t) => {
   const line1 = create()

package/src/maths/line3/reverse.d.ts

@@ -1,5 +1,3 @@
-import Line3 from './type'
+import type { Line3 } from './type.d.ts'
 
-export default reverse
-
-declare function reverse(out: Line3, line: Line3): Line3
+export function reverse(out: Line3, line: Line3): Line3

package/src/maths/line3/reverse.js

@@ -1,19 +1,17 @@
-const vec3 = require('../vec3')
+import * as vec3 from '../vec3/index.js'
 
-const fromPointAndDirection = require('./fromPointAndDirection')
+import { fromPointAndDirection } from './fromPointAndDirection.js'
 
 /**
  * Create a line in the opposite direction as the given.
  *
- * @param {line3} out - receiving line
- * @param {line3} line - line to reverse
- * @returns {line3} out
+ * @param {Line3} out - receiving line
+ * @param {Line3} line - line to reverse
+ * @returns {Line3} out
  * @alias module:modeling/maths/line3.reverse
  */
-const reverse = (out, line) => {
+export const reverse = (out, line) => {
   const point = vec3.clone(line[0])
   const direction = vec3.negate(vec3.create(), line[1])
   return fromPointAndDirection(out, point, direction)
 }
-
-module.exports = reverse

package/src/maths/line3/reverse.test.js

@@ -1,7 +1,8 @@
-const test = require('ava')
-const { reverse, create, fromPoints } = require('./index')
+import test from 'ava'
 
-const { compareVectors } = require('../../../test/helpers/index')
+import { reverse, create, fromPoints } from './index.js'
+
+import { compareVectors } from '../../../test/helpers/index.js'
 
 test('line3: reverse() called with two parameters should update a line3 with proper values', (t) => {
   const line1 = create()

package/src/maths/line3/toString.d.ts

@@ -1,5 +1,3 @@
-import Line3 from './type'
+import type { Line3 } from './type.d.ts'
 
-export default toString
-
-declare function toString(line: Line3): string
+export function toString(line: Line3): string

package/src/maths/line3/toString.js

@@ -1,14 +1,12 @@
 /**
  * Return a string representing the given line.
  *
- * @param {line3} line - line of reference
- * @returns {String} string representation
+ * @param {Line3} line - line of reference
+ * @returns {string} string representation
  * @alias module:modeling/maths/line3.toString
  */
-const toString = (line) => {
+export const toString = (line) => {
   const point = line[0]
   const direction = line[1]
   return `line3: point: (${point[0].toFixed(7)}, ${point[1].toFixed(7)}, ${point[2].toFixed(7)}) direction: (${direction[0].toFixed(7)}, ${direction[1].toFixed(7)}, ${direction[2].toFixed(7)})`
 }
-
-module.exports = toString

package/src/maths/line3/transform.d.ts

@@ -1,6 +1,4 @@
-import Line3 from './type'
-import Mat4 from '../mat4/type'
+import type { Line3 } from './type.d.ts'
+import type { Mat4 } from '../mat4/type.d.ts'
 
-export default transform
-
-declare function transform(out: Line3, line: Line3, matrix: Mat4): Line3
+export function transform(out: Line3, line: Line3, matrix: Mat4): Line3

package/src/maths/line3/transform.js

@@ -1,26 +1,24 @@
-const vec3 = require('../vec3')
+import * as vec3 from '../vec3/index.js'
 
-const fromPointAndDirection = require('./fromPointAndDirection')
+import { fromPointAndDirection } from './fromPointAndDirection.js'
 
 /**
  * Transforms the given line using the given matrix.
  *
- * @param {line3} out - line to update
- * @param {line3} line - line to transform
- * @param {mat4} matrix - matrix to transform with
- * @returns {line3} a new unbounded line
+ * @param {Line3} out - line to update
+ * @param {Line3} line - line to transform
+ * @param {Mat4} matrix - matrix to transform with
+ * @returns {Line3} a new unbounded line
  * @alias module:modeling/maths/line3.transform
  */
-const transform = (out, line, matrix) => {
+export const transform = (out, line, matrix) => {
   const point = line[0]
   const direction = line[1]
   const pointPlusDirection = vec3.add(vec3.create(), point, direction)
 
-  const newpoint = vec3.transform(vec3.create(), point, matrix)
+  const newPoint = vec3.transform(vec3.create(), point, matrix)
   const newPointPlusDirection = vec3.transform(pointPlusDirection, pointPlusDirection, matrix)
-  const newdirection = vec3.subtract(newPointPlusDirection, newPointPlusDirection, newpoint)
+  const newDirection = vec3.subtract(newPointPlusDirection, newPointPlusDirection, newPoint)
 
-  return fromPointAndDirection(out, newpoint, newdirection)
+  return fromPointAndDirection(out, newPoint, newDirection)
 }
-
-module.exports = transform

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

@@ -1,7 +1,8 @@
-const test = require('ava')
-const { transform, create, fromPoints } = require('./index')
+import test from 'ava'
 
-const { compareVectors } = require('../../../test/helpers/index')
+import { transform, create, fromPoints } from './index.js'
+
+import { compareVectors } from '../../../test/helpers/index.js'
 
 test('line3: transform() called with three parameters should update a line3 with correct values', (t) => {
   const line1 = create()

package/src/maths/line3/type.d.ts

@@ -1,5 +1,3 @@
-import Vec3 from '../vec3/type'
+import type { Vec3 } from '../vec3/type.d.ts'
 
-export default Line3
-
-declare type Line3 = [Vec3, Vec3]
+export type Line3 = [Vec3, Vec3]

package/src/maths/mat4/add.d.ts

@@ -1,5 +1,3 @@
-import Mat4 from './type'
+import type { Mat4 } from './type.d.ts'
 
-export default add
-
-declare function add(out: Mat4, a: Mat4, b: Mat4): Mat4
+export function add(out: Mat4, a: Mat4, b: Mat4): Mat4

package/src/maths/mat4/add.js

@@ -1,13 +1,13 @@
 /**
  * Adds the two matrices (A+B).
  *
- * @param {mat4} out - receiving matrix
- * @param {mat4} a - first operand
- * @param {mat4} b - second operand
- * @returns {mat4} out
+ * @param {Mat4} out - receiving matrix
+ * @param {Mat4} a - first operand
+ * @param {Mat4} b - second operand
+ * @returns {Mat4} out
  * @alias module:modeling/maths/mat4.add
  */
-const add = (out, a, b) => {
+export const add = (out, a, b) => {
   out[0] = a[0] + b[0]
   out[1] = a[1] + b[1]
   out[2] = a[2] + b[2]
@@ -26,5 +26,3 @@ const add = (out, a, b) => {
   out[15] = a[15] + b[15]
   return out
 }
-
-module.exports = add

package/src/maths/mat4/add.test.js

@@ -1,7 +1,8 @@
-const test = require('ava')
-const { add } = require('./index')
+import test from 'ava'
 
-const { compareVectors } = require('../../../test/helpers/index')
+import { add } from './index.js'
+
+import { compareVectors } from '../../../test/helpers/index.js'
 
 test('mat4: add() with three parameters should return a new mat4 with correct values', (t) => {
   const obs1 = [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]

package/src/maths/mat4/clone.d.ts

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

package/src/maths/mat4/clone.js

@@ -1,13 +1,13 @@
-const create = require('./create')
+import { create } from './create.js'
 
 /**
  * Creates a clone of the given matrix.
  *
- * @param {mat4} matrix - matrix to clone
- * @returns {mat4} a new matrix
+ * @param {Mat4} matrix - matrix to clone
+ * @returns {Mat4} a new matrix
  * @alias module:modeling/maths/mat4.clone
  */
-const clone = (matrix) => {
+export const clone = (matrix) => {
   const out = create()
   out[0] = matrix[0]
   out[1] = matrix[1]
@@ -27,5 +27,3 @@ const clone = (matrix) => {
   out[15] = matrix[15]
   return out
 }
-
-module.exports = clone

package/src/maths/mat4/clone.test.js

@@ -1,7 +1,8 @@
-const test = require('ava')
-const { clone, fromValues } = require('./index')
+import test from 'ava'
 
-const { compareVectors } = require('../../../test/helpers/index')
+import { clone, fromValues } from './index.js'
+
+import { compareVectors } from '../../../test/helpers/index.js'
 
 test('mat4: clone() should return a new mat4 with same values', (t) => {
   const org1 = fromValues(0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0)

package/src/maths/mat4/copy.d.ts

@@ -1,5 +1,3 @@
-import Mat4 from './type'
+import type { Mat4 } from './type.d.ts'
 
-export default copy
-
-declare function copy(out: Mat4, matrix: Mat4): Mat4
+export function copy(out: Mat4, matrix: Mat4): Mat4

package/src/maths/mat4/copy.js

@@ -1,12 +1,12 @@
 /**
  * Creates a copy of the given matrix.
  *
- * @param {mat4} out - receiving matrix
- * @param {mat4} matrix - matrix to copy
- * @returns {mat4} out
+ * @param {Mat4} out - receiving matrix
+ * @param {Mat4} matrix - matrix to copy
+ * @returns {Mat4} out
  * @alias module:modeling/maths/mat4.copy
  */
-const copy = (out, matrix) => {
+export const copy = (out, matrix) => {
   out[0] = matrix[0]
   out[1] = matrix[1]
   out[2] = matrix[2]
@@ -25,5 +25,3 @@ const copy = (out, matrix) => {
   out[15] = matrix[15]
   return out
 }
-
-module.exports = copy

package/src/maths/mat4/copy.test.js

@@ -1,7 +1,8 @@
-const test = require('ava')
-const { create, copy, fromValues } = require('./index')
+import test from 'ava'
 
-const { compareVectors } = require('../../../test/helpers/index')
+import { create, copy, fromValues } from './index.js'
+
+import { compareVectors } from '../../../test/helpers/index.js'
 
 test('mat4: copy() with two params should update a mat4 with same values', (t) => {
   const org1 = create()

package/src/maths/mat4/create.d.ts

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

package/src/maths/mat4/create.js

@@ -1,20 +1,17 @@
 /**
  * Represents a 4x4 matrix which is column-major (when typed out it looks row-major).
  * See fromValues().
- * @typedef {Array} mat4
  */
 
 /**
  * Creates a new identity matrix.
  *
- * @returns {mat4} a new matrix
+ * @returns {Mat4} a new matrix
  * @alias module:modeling/maths/mat4.create
  */
-const create = () => [
+export const create = () => [
   1, 0, 0, 0,
   0, 1, 0, 0,
   0, 0, 1, 0,
   0, 0, 0, 1
 ]
-
-module.exports = create

package/src/maths/mat4/create.test.js

@@ -1,8 +1,8 @@
-const test = require('ava')
+import test from 'ava'
 
-const { create } = require('./index')
+import { create } from './index.js'
 
-const { compareVectors } = require('../../../test/helpers/index')
+import { compareVectors } from '../../../test/helpers/index.js'
 
 test('mat4: create() should return a mat4 with initial values', (t) => {
   const obs = create() // identity matrix

package/src/maths/mat4/equals.d.ts

@@ -1,5 +1,3 @@
-import Mat4 from './type'
+import type { Mat4 } from './type.d.ts'
 
-export default equals
-
-declare function equals(a: Mat4, b: Mat4): boolean
+export function equals(a: Mat4, b: Mat4): boolean

package/src/maths/mat4/equals.js

@@ -1,16 +1,14 @@
 /**
- * Returns whether or not the matrices have exactly the same elements in the same position.
+ * Returns whether the matrices have exactly the same elements in the same position.
  *
- * @param {mat4} a - first matrix
- * @param {mat4} b - second matrix
+ * @param {Mat4} a - first matrix
+ * @param {Mat4} b - second matrix
  * @returns {Boolean} true if the matrices are equal
  * @alias module:modeling/maths/mat4.equals
  */
-const equals = (a, b) => (
+export const equals = (a, b) => (
   a[0] === b[0] && a[1] === b[1] && a[2] === b[2] && a[3] === b[3] &&
   a[4] === b[4] && a[5] === b[5] && a[6] === b[6] && a[7] === b[7] &&
   a[8] === b[8] && a[9] === b[9] && a[10] === b[10] && a[11] === b[11] &&
   a[12] === b[12] && a[13] === b[13] && a[14] === b[14] && a[15] === b[15]
 )
-
-module.exports = equals

package/src/maths/mat4/equals.test.js

@@ -1,5 +1,6 @@
-const test = require('ava')
-const equals = require('./equals')
+import test from 'ava'
+
+import { equals } from './index.js'
 
 test('vec3: equals() should return correct booleans', (t) => {
   const veca = [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]

package/src/maths/mat4/fromRotation.d.ts

@@ -1,6 +1,4 @@
-import Mat4 from './type'
-import Vec3 from '../vec3/type'
+import type { Mat4 } from './type.d.ts'
+import type { Vec3 } from '../vec3/type.d.ts'
 
-export default fromRotation
-
-declare function fromRotation(out: Mat4, rad: number, axis: Vec3): Mat4
+export function fromRotation(out: Mat4, rad: number, axis: Vec3): Mat4

package/src/maths/mat4/fromRotation.js

@@ -1,8 +1,8 @@
-const { EPS } = require('../constants')
+import { EPS } from '../constants.js'
 
-const { sin, cos } = require('../utils/trigonometry')
+import { sin, cos } from '../utils/trigonometry.js'
 
-const identity = require('./identity')
+import { identity } from './identity.js'
 
 /**
  * Creates a matrix from a given angle around a given axis
@@ -11,15 +11,15 @@ const identity = require('./identity')
  *     mat4.identity(dest)
  *     mat4.rotate(dest, dest, rad, axis)
  *
- * @param {mat4} out - receiving matrix
- * @param {Number} rad - angle to rotate the matrix by
- * @param {vec3} axis - axis of which to rotate around
- * @returns {mat4} out
+ * @param {Mat4} out - receiving matrix
+ * @param {number} rad - angle to rotate the matrix by
+ * @param {Vec3} axis - axis of which to rotate around
+ * @returns {Mat4} out
  * @alias module:modeling/maths/mat4.fromRotation
  * @example
  * let matrix = fromRotation(create(), TAU / 4, [0, 0, 3])
  */
-const fromRotation = (out, rad, axis) => {
+export const fromRotation = (out, rad, axis) => {
   let [x, y, z] = axis
   const lengthSquared = x * x + y * y + z * z
 
@@ -56,5 +56,3 @@ const fromRotation = (out, rad, axis) => {
   out[15] = 1
   return out
 }
-
-module.exports = fromRotation

package/src/maths/mat4/fromRotation.test.js

@@ -1,7 +1,8 @@
-const test = require('ava')
-const { fromRotation, create } = require('./index')
+import test from 'ava'
 
-const { compareVectors } = require('../../../test/helpers/index')
+import { fromRotation, create } from './index.js'
+
+import { compareVectors } from '../../../test/helpers/index.js'
 
 test('mat4: fromRotation() should return a mat4 with correct values', (t) => {
   const rotation = 90 * 0.017453292519943295

package/src/maths/mat4/fromScaling.d.ts

@@ -1,6 +1,4 @@
-import Mat4 from './type'
-import Vec3 from '../vec3/type'
+import type { Mat4 } from './type.d.ts'
+import type { Vec3 } from '../vec3/type.d.ts'
 
-export default fromScaling
-
-declare function fromScaling(out: Mat4, vector: Vec3): Mat4
+export function fromScaling(out: Mat4, vector: Vec3): Mat4

package/src/maths/mat4/fromScaling.js

@@ -5,14 +5,14 @@
  *     mat4.identity(dest)
  *     mat4.scale(dest, dest, vec)
  *
- * @param {mat4} out - receiving matrix
- * @param {vec3} vector - X, Y, Z factors by which to scale
- * @returns {mat4} out
+ * @param {Mat4} out - receiving matrix
+ * @param {Vec3} vector - X, Y, Z factors by which to scale
+ * @returns {Mat4} out
  * @alias module:modeling/maths/mat4.fromScaling
  * @example
  * let matrix = fromScaling([1, 2, 0.5])
  */
-const fromScaling = (out, vector) => {
+export const fromScaling = (out, vector) => {
   out[0] = vector[0]
   out[1] = 0
   out[2] = 0
@@ -31,5 +31,3 @@ const fromScaling = (out, vector) => {
   out[15] = 1
   return out
 }
-
-module.exports = fromScaling

package/src/maths/mat4/fromScaling.test.js

@@ -1,7 +1,8 @@
-const test = require('ava')
-const { fromScaling, create } = require('./index')
+import test from 'ava'
 
-const { compareVectors } = require('../../../test/helpers/index')
+import { fromScaling, create } from './index.js'
+
+import { compareVectors } from '../../../test/helpers/index.js'
 
 test('mat4: fromScaling() should return a new mat4 with correct values', (t) => {
   const obs1 = fromScaling(create(), [2, 4, 6])

package/src/maths/mat4/fromTaitBryanRotation.d.ts

@@ -1,5 +1,3 @@
-import Mat4 from './type'
+import type { Mat4 } from './type.d.ts'
 
-export default fromTaitBryanRotation
-
-declare function fromTaitBryanRotation(out: Mat4, yaw: number, pitch: number, roll: number): Mat4
+export function fromTaitBryanRotation(out: Mat4, yaw: number, pitch: number, roll: number): Mat4

package/src/maths/mat4/fromTaitBryanRotation.js

@@ -1,4 +1,4 @@
-const { sin, cos } = require('../utils/trigonometry')
+import { sin, cos } from '../utils/trigonometry.js'
 
 /**
  * Creates a matrix from the given Tait–Bryan angles.
@@ -6,16 +6,16 @@ const { sin, cos } = require('../utils/trigonometry')
  * Tait-Bryan Euler angle convention using active, intrinsic rotations around the axes in the order z-y-x.
  * @see https://en.wikipedia.org/wiki/Euler_angles
  *
- * @param {mat4} out - receiving matrix
- * @param {Number} yaw - Z rotation in radians
- * @param {Number} pitch - Y rotation in radians
- * @param {Number} roll - X rotation in radians
- * @returns {mat4} out
+ * @param {Mat4} out - receiving matrix
+ * @param {number} yaw - Z rotation in radians
+ * @param {number} pitch - Y rotation in radians
+ * @param {number} roll - X rotation in radians
+ * @returns {Mat4} out
  * @alias module:modeling/maths/mat4.fromTaitBryanRotation
  * @example
  * let matrix = fromTaitBryanRotation(create(), TAU / 4, 0, TAU / 2)
  */
-const fromTaitBryanRotation = (out, yaw, pitch, roll) => {
+export const fromTaitBryanRotation = (out, yaw, pitch, roll) => {
   // precompute sines and cosines of Euler angles
   const sy = sin(yaw)
   const cy = cos(yaw)
@@ -51,5 +51,3 @@ const fromTaitBryanRotation = (out, yaw, pitch, roll) => {
   out[15] = 1
   return out
 }
-
-module.exports = fromTaitBryanRotation