@jscad/modeling 2.7.2 → 2.9.1

package/src/primitives/star.test.js

@@ -22,6 +22,7 @@ test('star (defaults)', (t) => {
     [0.3090169943749474, -0.22451398828979277]
   ]
 
+  t.notThrows(() => geom2.validate(geometry))
   t.deepEqual(pts.length, 10)
   t.true(comparePoints(pts, exp))
 })
@@ -43,6 +44,7 @@ test('star (options)', (t) => {
     [6.545084971874736, 3.8774300585510364]
   ]
 
+  t.notThrows(() => geom2.validate(geometry))
   t.deepEqual(pts.length, 10)
   t.true(comparePoints(pts, exp))
 
@@ -68,6 +70,7 @@ test('star (options)', (t) => {
     [3.535533905932737, -1.464466094067265]
   ]
 
+  t.notThrows(() => geom2.validate(geometry))
   t.deepEqual(pts.length, 16)
   t.true(comparePoints(pts, exp))
 
@@ -93,6 +96,7 @@ test('star (options)', (t) => {
     [2.4999999999999996, -1.0355339059327393]
   ]
 
+  t.notThrows(() => geom2.validate(geometry))
   t.deepEqual(pts.length, 16)
   t.true(comparePoints(pts, exp))
 
@@ -118,6 +122,7 @@ test('star (options)', (t) => {
     [0.9238795325112865, -0.3826834323650904]
   ]
 
+  t.notThrows(() => geom2.validate(geometry))
   t.deepEqual(pts.length, 16)
   t.true(comparePoints(pts, exp))
 
@@ -137,6 +142,7 @@ test('star (options)', (t) => {
     [0.2987632431673025, -1.8863168790768006]
   ]
 
+  t.notThrows(() => geom2.validate(geometry))
   t.deepEqual(pts.length, 10)
   t.true(comparePoints(pts, exp))
 })

package/src/primitives/torus.d.ts

@@ -1,4 +1,3 @@
-import Vec3 from '../maths/vec3/type'
 import Geom3 from '../geometries/geom3/type'
 
 export default torus

package/src/primitives/torus.test.js

@@ -10,30 +10,36 @@ test('torus (defaults)', (t) => {
   const obs = torus()
   const pts = geom3.toPoints(obs)
 
+  t.notThrows.skip(() => geom3.validate(obs))
   t.is(pts.length, 2048) // 32 * 32 * 2 (polys/segment) = 2048
 
   const bounds = measureBoundingBox(obs)
   const expectedBounds = [[-5, -5, -1], [5, 5, 1]]
+  t.notThrows.skip(() => geom3.validate(obs))
   t.true(comparePoints(bounds, expectedBounds), 'Bounding box was not as expected: ' + JSON.stringify(bounds))
 })
 
 test('torus (Simple options)', (t) => {
   const obs = torus({ innerRadius: 0.5, innerSegments: 4, outerRadius: 5, outerSegments: 8 })
   const pts = geom3.toPoints(obs)
+  t.notThrows.skip(() => geom3.validate(obs))
   t.is(pts.length, 64) // 4 * 8 * 2 (polys/segment) = 64
 
   const bounds = measureBoundingBox(obs)
   const expectedBounds = [[-5.5, -5.5, -0.5], [5.5, 5.5, 0.5]]
+  t.notThrows.skip(() => geom3.validate(obs))
   t.true(comparePoints(bounds, expectedBounds), 'Bounding box was not as expected: ' + JSON.stringify(bounds))
 })
 
 test('torus (complex options)', (t) => {
   const obs = torus({ innerRadius: 1, outerRadius: 5, innerSegments: 32, outerSegments: 72, startAngle: Math.PI / 2, outerRotation: Math.PI / 2 })
   const pts = geom3.toPoints(obs)
-  t.is(pts.length, 1154)
+  t.notThrows(() => geom3.validate(obs))
+  t.is(pts.length, 1212)
 
   const bounds = measureBoundingBox(obs)
   const expectedBounds = [[-6, 0, -1], [0, 6, 1]]
+  t.notThrows(() => geom3.validate(obs))
   t.true(comparePoints(bounds, expectedBounds), 'Bounding box was not as expected: ' + JSON.stringify(bounds))
 })
 
@@ -42,5 +48,6 @@ test('torus (square by square)', (t) => {
 
   const bounds = measureBoundingBox(obs)
   const expectedBounds = [[-5, -5, -1], [5, 5, 1]]
+  t.notThrows.skip(() => geom3.validate(obs))
   t.true(comparePoints(bounds, expectedBounds), 'Bounding box was not as expected: ' + JSON.stringify(bounds))
 })

package/src/primitives/triangle.js

@@ -119,7 +119,7 @@ const createTriangle = (A, B, C, a, b, c) => {
  * The triangle is always constructed CCW from the origin, [0, 0, 0].
  * @see https://www.mathsisfun.com/algebra/trig-solving-triangles.html
  * @param {Object} [options] - options for construction
- * @param {String} [options.type='SSS' - type of triangle to construct; A ~ angle, S ~ side
+ * @param {String} [options.type='SSS'] - type of triangle to construct; A ~ angle, S ~ side
  * @param {Array} [options.values=[1,1,1]] - angle (radians) of corners or length of sides
  * @returns {geom2} new 2D geometry
  * @alias module:modeling/primitives.triangle

package/src/primitives/triangle.test.js

@@ -16,6 +16,7 @@ test('triangle (defaults)', (t) => {
     [0.5000000000000002, 0.8660254037844387]
   ]
 
+  t.notThrows(() => geom2.validate(geometry))
   t.deepEqual(obs.length, 3)
   t.true(comparePoints(obs, exp))
 })
@@ -30,6 +31,7 @@ test('triangle (options)', (t) => {
     [1.5, 5.809475019311125]
   ]
 
+  t.notThrows(() => geom2.validate(geometry))
   t.deepEqual(obs.length, 3)
   t.true(comparePoints(obs, exp))
 
@@ -42,6 +44,7 @@ test('triangle (options)', (t) => {
     [0, 1.0000000000000002]
   ]
 
+  t.notThrows(() => geom2.validate(geometry))
   t.deepEqual(obs.length, 3)
   t.true(comparePoints(obs, exp))
 
@@ -54,6 +57,7 @@ test('triangle (options)', (t) => {
     [2.1348320069064197, 4.015035054457325]
   ]
 
+  t.notThrows(() => geom2.validate(geometry))
   t.deepEqual(obs.length, 3)
   t.true(comparePoints(obs, exp))
 
@@ -66,6 +70,7 @@ test('triangle (options)', (t) => {
     [1.295667368233083, 5.196637976713814]
   ]
 
+  t.notThrows(() => geom2.validate(geometry))
   t.deepEqual(obs.length, 3)
   t.true(comparePoints(obs, exp))
 
@@ -78,6 +83,7 @@ test('triangle (options)', (t) => {
     [0.4075867970664495, 5.282967061559405]
   ]
 
+  t.notThrows(() => geom2.validate(geometry))
   t.deepEqual(obs.length, 3)
   t.true(comparePoints(obs, exp))
 
@@ -90,6 +96,7 @@ test('triangle (options)', (t) => {
     [8.494946725906148, 12.990574573070846]
   ]
 
+  t.notThrows(() => geom2.validate(geometry))
   t.deepEqual(obs.length, 3)
   t.true(comparePoints(obs, exp))
 })

package/src/text/vectorText.js

@@ -26,7 +26,7 @@ const translateLine = (options, line) => {
  * @param {Float} [options.height=21] - font size (uppercase height)
  * @param {Float} [options.lineSpacing=1.4] - line spacing expressed as a percentage of font size
  * @param {Float} [options.letterSpacing=1] - extra letter spacing expressed as a percentage of font size
- * @param {String} [options.align='left'] - multi-line text alignement: left, center or right
+ * @param {String} [options.align='left'] - multi-line text alignment: left, center, right
  * @param {Float} [options.extrudeOffset=0] - width of the extrusion that will be applied (manually) after the creation of the character
  * @param {String} [options.input='?'] - ascii string (ignored/overwrited if provided as seconds parameter)
  * @param {String} [text='?'] - ascii string
@@ -47,7 +47,7 @@ const vectorText = (options, text) => {
     xOffset, yOffset, input, font, height, align, extrudeOffset, lineSpacing, letterSpacing
   } = vectorParams(options, text)
   let [x, y] = [xOffset, yOffset]
-  let [i, il, char, vect, width, diff] = []
+  let i, il, char, vect, width, diff
   let line = { width: 0, segments: [] }
   const lines = []
   let output = []

package/src/utils/areAllShapesTheSameType.js

@@ -10,7 +10,7 @@ const path2 = require('../geometries/path2')
  */
 const areAllShapesTheSameType = (shapes) => {
   let previousType
-  shapes.forEach((shape) => {
+  for (const shape of shapes) {
     let currentType = 0
     if (geom2.isA(shape)) currentType = 1
     if (geom3.isA(shape)) currentType = 2
@@ -18,7 +18,7 @@ const areAllShapesTheSameType = (shapes) => {
 
     if (previousType && currentType !== previousType) return false
     previousType = currentType
-  })
+  }
   return true
 }
 

package/src/utils/areAllShapesTheSameType.test.js

@@ -0,0 +1,17 @@
+const test = require('ava')
+
+const { cube, square } = require('../primitives')
+
+const { areAllShapesTheSameType } = require('./index')
+
+test('utils: areAllShapesTheSameType() should return correct values', (t) => {
+  const geometry2 = square()
+  const geometry3 = cube()
+
+  t.true(areAllShapesTheSameType([]))
+  t.true(areAllShapesTheSameType([geometry2]))
+  t.true(areAllShapesTheSameType([geometry3]))
+  t.true(areAllShapesTheSameType([geometry2, geometry2]))
+  t.true(areAllShapesTheSameType([geometry3, geometry3]))
+  t.false(areAllShapesTheSameType([geometry2, geometry3]))
+})

package/src/utils/index.d.ts

@@ -5,5 +5,6 @@ export { default as fnNumberSort } from './fnNumberSort'
 export { default as insertSorted } from './insertSorted'
 export { default as radiusToSegments } from './radiusToSegments'
 export { default as radToDeg } from './radToDeg'
+export * from './trigonometry'
 
 export as namespace utils

package/src/utils/index.js

@@ -6,10 +6,12 @@
  */
 module.exports = {
   areAllShapesTheSameType: require('./areAllShapesTheSameType'),
+  cos: require('./trigonometry').cos,
   degToRad: require('./degToRad'),
   flatten: require('./flatten'),
   fnNumberSort: require('./fnNumberSort'),
   insertSorted: require('./insertSorted'),
   radiusToSegments: require('./radiusToSegments'),
-  radToDeg: require('./radToDeg')
+  radToDeg: require('./radToDeg'),
+  sin: require('./trigonometry').sin
 }

package/src/utils/padArrayToLength.js

@@ -3,7 +3,7 @@
  * @param {Array} anArray - the source array to copy into the result.
  * @param {*} padding - the value to add to the new array to reach the desired length.
  * @param {Number} targetLength - The desired length of the return array.
- * @returns {Array} an array of at least 'targetLength" length
+ * @returns {Array} an array of at least 'targetLength' length
  * @alias module:modeling/utils.padArrayToLength
  */
 const padArrayToLength = (anArray, padding, targetLength) => {

package/src/utils/trigonometry.d.ts

@@ -0,0 +1,2 @@
+export function cos(radians: number): number
+export function sin(radians: number): number

package/src/utils/trigonometry.js

@@ -0,0 +1,35 @@
+
+const NEPS = 1e-13
+
+/*
+ * Returns zero if n is within epsilon of zero, otherwise return n
+ */
+const rezero = (n) => Math.abs(n) < NEPS ? 0 : n
+
+/**
+ * Return Math.sin but accurate for 90 degree rotations.
+ * Fixes rounding errors when sin should be 0.
+ *
+ * @param {Number} radians - angle in radians
+ * @returns {Number} sine of the given angle
+ * @alias module:modeling/utils.sin
+ * @example
+ * sin(Math.PI) == 0
+ * sin(2 * Math.PI) == 0
+ */
+const sin = (radians) => rezero(Math.sin(radians))
+
+/**
+ * Return Math.cos but accurate for 90 degree rotations.
+ * Fixes rounding errors when cos should be 0.
+ *
+ * @param {Number} radians - angle in radians
+ * @returns {Number} cosine of the given angle
+ * @alias module:modeling/utils.cos
+ * @example
+ * cos(0.5 * Math.PI) == 0
+ * cos(1.5 * Math.PI) == 0
+ */
+const cos = (radians) => rezero(Math.cos(radians))
+
+module.exports = { sin, cos }

package/src/utils/trigonometry.test.js

@@ -0,0 +1,25 @@
+const test = require('ava')
+
+const { cos, sin } = require('./trigonometry')
+
+test('utils: sin() should return rounded values', (t) => {
+  t.is(sin(0), 0)
+  t.is(sin(9), Math.sin(9))
+  t.is(sin(0.5 * Math.PI), 1)
+  t.is(sin(1.0 * Math.PI), 0)
+  t.is(sin(1.5 * Math.PI), -1)
+  t.is(sin(2.0 * Math.PI), 0)
+  t.is(sin(NaN), NaN)
+  t.is(sin(Infinity), NaN)
+})
+
+test('utils: cos() should return rounded values', (t) => {
+  t.is(cos(0), 1)
+  t.is(cos(9), Math.cos(9))
+  t.is(cos(0.5 * Math.PI), 0)
+  t.is(cos(1.0 * Math.PI), -1)
+  t.is(cos(1.5 * Math.PI), 0)
+  t.is(cos(2.0 * Math.PI), 1)
+  t.is(cos(NaN), NaN)
+  t.is(cos(Infinity), NaN)
+})

package/test/helpers/nearlyEqual.js

@@ -1,7 +1,10 @@
 // Compare two numeric values for near equality.
 // the given test is fails if the numeric values are outside the given epsilon
 const nearlyEqual = (t, a, b, epsilon, failMessage) => {
-  if (a === b) { // shortcut, also handles infinities and NaNs
+  if (typeof t !== 'object') {
+    throw new Error('first argument must be a test object')
+  }
+  if (a === b) { // shortcut, also handles infinities
     return true
   }