@jscad/modeling 2.12.5 → 3.0.1-alpha.0

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

@@ -1,11 +1,12 @@
-const test = require('ava')
+import test from 'ava'
 
-const { TAU } = require('../constants')
-const vec3 = require('../vec3/index')
+import { TAU } from '../constants.js'
 
-const { create, invert, fromTranslation, fromXRotation } = require('./index')
+import { vec3 } from '../index.js'
 
-const { compareVectors } = require('../../../test/helpers/index')
+import { create, invert, fromTranslation, fromXRotation } from './index.js'
+
+import { compareVectors } from '../../../test/helpers/index.js'
 
 test('mat4: invert() translate ', (t) => {
   const matrix = fromTranslation(create(), [10, 10, 0])

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

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

package/src/maths/mat4/isIdentity.js

@@ -4,17 +4,15 @@
  *
  *     mat4.equals(mat4.create(), matrix)
  *
- * @param {mat4} matrix - the matrix
- * @returns {Boolean} true if matrix is the identity transform
+ * @param {Mat4} matrix - the matrix
+ * @returns {boolean} true if matrix is the identity transform
  * @alias module:modeling/maths/mat4.isIdentity
  * @example
- * if (mat4.isIdentity(mymatrix)) ...
+ * if (mat4.isIdentity(myMatrix)) ...
  */
-const isIdentity = (matrix) => (
+export const isIdentity = (matrix) => (
   matrix[0] === 1 && matrix[1] === 0 && matrix[2] === 0 && matrix[3] === 0 &&
   matrix[4] === 0 && matrix[5] === 1 && matrix[6] === 0 && matrix[7] === 0 &&
   matrix[8] === 0 && matrix[9] === 0 && matrix[10] === 1 && matrix[11] === 0 &&
   matrix[12] === 0 && matrix[13] === 0 && matrix[14] === 0 && matrix[15] === 1
 )
-
-module.exports = isIdentity

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

@@ -1,6 +1,6 @@
-const test = require('ava')
+import test from 'ava'
 
-const { isIdentity, create, fromTranslation } = require('./index')
+import { isIdentity, create, fromTranslation } from './index.js'
 
 test('mat4: isIdentity() should return correct values', (t) => {
   const identity = create() // identity matrix

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

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

package/src/maths/mat4/isMirroring.js

@@ -1,24 +1,22 @@
 /**
  * Determine whether the given matrix is a mirroring transformation.
  *
- * @param {mat4} matrix - matrix of reference
+ * @param {Mat4} matrix - matrix of reference
  * @returns {Boolean} true if matrix is a mirroring transformation
  * @alias module:modeling/maths/mat4.isMirroring
  */
-const isMirroring = (matrix) => {
+export const isMirroring = (matrix) => {
   // const xVector = [matrix[0], matrix[4], matrix[8]]
   // const yVector = [matrix[1], matrix[5], matrix[9]]
   // const zVector = [matrix[2], matrix[6], matrix[10]]
 
   // for a true orthogonal, non-mirrored base, xVector.cross(yVector) == zVector
   // If they have an opposite direction then we are mirroring
-  // calcuate xVector.cross(yVector)
+  // calculate xVector.cross(yVector)
   const x = matrix[4] * matrix[9] - matrix[8] * matrix[5]
   const y = matrix[8] * matrix[1] - matrix[0] * matrix[9]
   const z = matrix[0] * matrix[5] - matrix[4] * matrix[1]
-  // calcualte dot(cross, zVector)
+  // calculate dot(cross, zVector)
   const d = x * matrix[2] + y * matrix[6] + z * matrix[10]
   return (d < 0)
 }
-
-module.exports = isMirroring

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

@@ -1,8 +1,8 @@
-const test = require('ava')
+import test from 'ava'
 
-const plane = require('../plane')
+import { plane } from '../index.js'
 
-const { isMirroring, fromScaling, create, mirrorByPlane, rotate, scale, translate } = require('./index')
+import { isMirroring, fromScaling, create, mirrorByPlane, rotate, scale, translate } from './index.js'
 
 test('mat4: isMirroring() should determine correctly', (t) => {
   let matrix = create()

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

@@ -0,0 +1,3 @@
+import type { Mat4 } from './type.d.ts'
+
+export function isOnlyTransformScale(matrix: Mat4): boolean

package/src/maths/mat4/isOnlyTransformScale.js

@@ -3,11 +3,11 @@
  * Determine whether the given matrix is only translate and/or scale.
  * This code returns true for TAU / 2 rotation as it can be interpreted as scale.
  *
- * @param {mat4} matrix - the matrix
- * @returns {Boolean} true if matrix is for translate and/or scale
+ * @param {Mat4} matrix - the matrix
+ * @returns {boolean} true if matrix is for translate and/or scale
  * @alias module:modeling/maths/mat4.isOnlyTransformScale
  */
-const isOnlyTransformScale = (matrix) => (
+export const isOnlyTransformScale = (matrix) => (
 
   // TODO check if it is worth the effort to add recognition of 90 deg rotations
 
@@ -17,6 +17,8 @@ const isOnlyTransformScale = (matrix) => (
   matrix[15] === 1
 )
 
+/**
+ * @param {number} num
+ * @returns {boolean}
+ */
 const isZero = (num) => Math.abs(num) < Number.EPSILON
-
-module.exports = isOnlyTransformScale

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

@@ -1,8 +1,8 @@
-const test = require('ava')
+import test from 'ava'
 
-const { TAU } = require('../constants')
+import { TAU } from '../constants.js'
 
-const { isOnlyTransformScale, create, fromTranslation, fromTaitBryanRotation, fromScaling, invert, multiply } = require('./index')
+import { isOnlyTransformScale, create, fromTranslation, fromTaitBryanRotation, fromScaling, invert, multiply } from './index.js'
 
 test('mat4: isOnlyTransformScale() should return true for right angles', (t) => {
   let someRotation = fromTaitBryanRotation(create(), TAU / 2, 0, 0)

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

@@ -1,6 +1,4 @@
-import Mat4 from './type'
-import Plane from '../plane/type'
+import type { Mat4 } from './type.d.ts'
+import type { Plane } from '../plane/type.d.ts'
 
-export default mirrorByPlane
-
-declare function mirrorByPlane(out: Mat4, plane: Plane): Mat4
+export function mirrorByPlane(out: Mat4, plane: Plane): Mat4

package/src/maths/mat4/mirrorByPlane.js

@@ -1,12 +1,12 @@
 /**
  * Create a matrix for mirroring about the given plane.
  *
- * @param {mat4} out - receiving matrix
- * @param {vec4} plane - plane of which to mirror the matrix
- * @returns {mat4} out
+ * @param {Mat4} out - receiving matrix
+ * @param {Vec4} plane - plane of which to mirror the matrix
+ * @returns {Mat4} out
  * @alias module:modeling/maths/mat4.mirrorByPlane
  */
-const mirrorByPlane = (out, plane) => {
+export const mirrorByPlane = (out, plane) => {
   const [nx, ny, nz, w] = plane
 
   out[0] = (1.0 - 2.0 * nx * nx)
@@ -28,5 +28,3 @@ const mirrorByPlane = (out, plane) => {
 
   return out
 }
-
-module.exports = mirrorByPlane

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

@@ -1,10 +1,10 @@
-const test = require('ava')
+import test from 'ava'
 
-const plane = require('../plane')
+import { plane } from '../index.js'
 
-const { mirrorByPlane, create } = require('./index')
+import { mirrorByPlane, create } from './index.js'
 
-const { compareVectors } = require('../../../test/helpers')
+import { compareVectors } from '../../../test/helpers/index.js'
 
 test('mat4: mirrorByPlane() called with out parameter should return a new mat4 with correct values', (t) => {
   const planeX = plane.fromPoints(plane.create(), [0, 0, 0], [0, 1, 1], [0, 1, 0])

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

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

package/src/maths/mat4/multiply.js

@@ -1,13 +1,13 @@
 /**
  * Multiplies the two matrices.
  *
- * @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.multiply
  */
-const multiply = (out, a, b) => {
+export const multiply = (out, a, b) => {
   const a00 = a[0]
   const a01 = a[1]
   const a02 = a[2]
@@ -63,5 +63,3 @@ const multiply = (out, a, b) => {
   out[15] = b0 * a03 + b1 * a13 + b2 * a23 + b3 * a33
   return out
 }
-
-module.exports = multiply

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

@@ -1,7 +1,8 @@
-const test = require('ava')
-const { multiply } = require('./index')
+import test from 'ava'
 
-const { compareVectors } = require('../../../test/helpers/index')
+import { multiply } from './index.js'
+
+import { compareVectors } from '../../../test/helpers/index.js'
 
 test('mat4: multiply() called with out parameter 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/rotate.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 rotate
-
-declare function rotate(out: Mat4, matrix: Mat4, radians: number, axis: Vec3): Mat4
+export function rotate(out: Mat4, matrix: Mat4, radians: number, axis: Vec3): Mat4

package/src/maths/mat4/rotate.js

@@ -1,20 +1,20 @@
-const { EPS } = require('../constants')
+import { EPS } from '../constants.js'
 
-const { sin, cos } = require('../utils/trigonometry')
+import { sin, cos } from '../utils/trigonometry.js'
 
-const copy = require('./copy')
+import { copy } from './copy.js'
 
 /**
  * Rotates a matrix by the given angle about the given axis.
  *
- * @param {mat4} out - receiving matrix
- * @param {mat4} matrix - matrix to rotate
- * @param {Number} radians - angle to rotate the matrix by
- * @param {vec3} axis - axis to rotate around
- * @returns {mat4} out
+ * @param {Mat4} out - receiving matrix
+ * @param {Mat4} matrix - matrix to rotate
+ * @param {number} radians - angle to rotate the matrix by
+ * @param {Vec3} axis - axis to rotate around
+ * @returns {Mat4} out
  * @alias module:modeling/maths/mat4.rotate
  */
-const rotate = (out, matrix, radians, axis) => {
+export const rotate = (out, matrix, radians, axis) => {
   let [x, y, z] = axis
   const lengthSquared = x * x + y * y + z * z
 
@@ -78,5 +78,3 @@ const rotate = (out, matrix, radians, axis) => {
   }
   return out
 }
-
-module.exports = rotate

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

@@ -1,7 +1,8 @@
-const test = require('ava')
-const { rotate, create } = require('./index')
+import test from 'ava'
 
-const { compareVectors } = require('../../../test/helpers/index')
+import { rotate, create } from './index.js'
+
+import { compareVectors } from '../../../test/helpers/index.js'
 
 test('mat4: rotate() called with out parameter should return a new mat4 with correct values', (t) => {
   const rotation = 90 * 0.017453292519943295
@@ -9,12 +10,12 @@ test('mat4: rotate() called with out parameter should return a new mat4 with cor
   const idn = create()
 
   // invalid condition when axis is 0,0,0
-  const out1 = [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]
+  const out1 = create()
   const ret1 = rotate(out1, idn, rotation, [0, 0, 0])
   t.is(out1, ret1)
   t.true(compareVectors(out1, [1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1]))
 
-  const out2 = [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]
+  const out2 = create()
   const ret2 = rotate(out2, idn, rotation, [0, 0, 1])
   t.true(compareVectors(out2, [0, 1, 0, 0, -1, 0, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1]))
   t.true(compareVectors(ret2, [0, 1, 0, 0, -1, 0, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1]))

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

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

package/src/maths/mat4/rotateX.js

@@ -1,15 +1,15 @@
-const { sin, cos } = require('../utils/trigonometry')
+import { sin, cos } from '../utils/trigonometry.js'
 
 /**
  * Rotates a matrix by the given angle around the X axis.
  *
- * @param {mat4} out - receiving matrix
- * @param {mat4} matrix - matrix to rotate
- * @param {Number} radians - angle to rotate the matrix by
- * @returns {mat4} out
+ * @param {Mat4} out - receiving matrix
+ * @param {Mat4} matrix - matrix to rotate
+ * @param {number} radians - angle to rotate the matrix by
+ * @returns {Mat4} out
  * @alias module:modeling/maths/mat4.rotateX
  */
-const rotateX = (out, matrix, radians) => {
+export const rotateX = (out, matrix, radians) => {
   const s = sin(radians)
   const c = cos(radians)
   const a10 = matrix[4]
@@ -43,5 +43,3 @@ const rotateX = (out, matrix, radians) => {
   out[11] = a23 * c - a13 * s
   return out
 }
-
-module.exports = rotateX

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

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

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

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

package/src/maths/mat4/rotateY.js

@@ -1,15 +1,15 @@
-const { sin, cos } = require('../utils/trigonometry')
+import { sin, cos } from '../utils/trigonometry.js'
 
 /**
  * Rotates a matrix by the given angle around the Y axis.
  *
- * @param {mat4} out - receiving matrix
- * @param {mat4} matrix - matrix to rotate
- * @param {Number} radians - angle to rotate the matrix by
- * @returns {mat4} out
+ * @param {Mat4} out - receiving matrix
+ * @param {Mat4} matrix - matrix to rotate
+ * @param {number} radians - angle to rotate the matrix by
+ * @returns {Mat4} out
  * @alias module:modeling/maths/mat4.rotateY
  */
-const rotateY = (out, matrix, radians) => {
+export const rotateY = (out, matrix, radians) => {
   const s = sin(radians)
   const c = cos(radians)
   const a00 = matrix[0]
@@ -43,5 +43,3 @@ const rotateY = (out, matrix, radians) => {
   out[11] = a03 * s + a23 * c
   return out
 }
-
-module.exports = rotateY

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

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

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

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

package/src/maths/mat4/rotateZ.js

@@ -1,15 +1,15 @@
-const { sin, cos } = require('../utils/trigonometry')
+import { sin, cos } from '../utils/trigonometry.js'
 
 /**
  * Rotates a matrix by the given angle around the Z axis.
  *
- * @param {mat4} out - receiving matrix
- * @param {mat4} matrix - matrix to rotate
- * @param {Number} radians - angle to rotate the matrix by
- * @returns {mat4} out
+ * @param {Mat4} out - receiving matrix
+ * @param {Mat4} matrix - matrix to rotate
+ * @param {number} radians - angle to rotate the matrix by
+ * @returns {Mat4} out
  * @alias module:modeling/maths/mat4.rotateZ
  */
-const rotateZ = (out, matrix, radians) => {
+export const rotateZ = (out, matrix, radians) => {
   const s = sin(radians)
   const c = cos(radians)
   const a00 = matrix[0]
@@ -43,5 +43,3 @@ const rotateZ = (out, matrix, radians) => {
   out[7] = a13 * c - a03 * s
   return out
 }
-
-module.exports = rotateZ

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

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

package/src/maths/mat4/scale.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 scale
-
-declare function scale(out: Mat4, matrix: Mat4, dimensions: Vec3): Mat4
+export function scale(out: Mat4, matrix: Mat4, dimensions: Vec3): Mat4

package/src/maths/mat4/scale.js

@@ -1,13 +1,13 @@
 /**
  * Scales the matrix by the given dimensions.
  *
- * @param {mat4} out - receiving matrix
- * @param {mat4} matrix - matrix to scale
- * @param {vec3} dimensions - dimensions to scale the matrix by
- * @returns {mat4} out
+ * @param {Mat4} out - receiving matrix
+ * @param {Mat4} matrix - matrix to scale
+ * @param {Vec3} dimensions - dimensions to scale the matrix by
+ * @returns {Mat4} out
  * @alias module:modeling/maths/mat4.scale
  */
-const scale = (out, matrix, dimensions) => {
+export const scale = (out, matrix, dimensions) => {
   const x = dimensions[0]
   const y = dimensions[1]
   const z = dimensions[2]
@@ -30,5 +30,3 @@ const scale = (out, matrix, dimensions) => {
   out[15] = matrix[15]
   return out
 }
-
-module.exports = scale

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

@@ -1,7 +1,8 @@
-const test = require('ava')
-const { scale } = require('./index')
+import test from 'ava'
 
-const { compareVectors } = require('../../../test/helpers/index')
+import { scale } from './index.js'
+
+import { compareVectors } from '../../../test/helpers/index.js'
 
 test('mat4: scale() called with out parameter 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/subtract.d.ts

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

package/src/maths/mat4/subtract.js

@@ -1,13 +1,13 @@
 /**
  * Subtracts matrix b from matrix a. (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.subtract
  */
-const subtract = (out, a, b) => {
+export const subtract = (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 subtract = (out, a, b) => {
   out[15] = a[15] - b[15]
   return out
 }
-
-module.exports = subtract

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

@@ -1,7 +1,8 @@
-const test = require('ava')
-const { subtract } = require('./index')
+import test from 'ava'
 
-const { compareVectors } = require('../../../test/helpers/index')
+import { subtract } from './index.js'
+
+import { compareVectors } from '../../../test/helpers/index.js'
 
 test('mat4: subtract() called with out parameter 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/toString.d.ts

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

package/src/maths/mat4/toString.js

@@ -1,10 +1,8 @@
 /**
  * Return a string representing the given matrix.
  *
- * @param {mat4} mat - matrix of reference
- * @returns {String} string representation
+ * @param {Mat4} mat - matrix of reference
+ * @returns {string} string representation
  * @alias module:modeling/maths/mat4.toString
  */
-const toString = (mat) => mat.map((n) => n.toFixed(7)).toString()
-
-module.exports = toString
+export const toString = (mat) => mat.map((n) => n.toFixed(7)).toString()

package/src/maths/mat4/translate.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 translate
-
-declare function translate(out: Mat4, matrix: Mat4, offsets: Vec3): Mat4
+export function translate(out: Mat4, matrix: Mat4, offsets: Vec3): Mat4