@jscad/modeling 2.11.1 → 2.12.1

package/src/primitives/roundedCuboid.js

@@ -8,7 +8,8 @@ const poly3 = require('../geometries/poly3')
 
 const { sin, cos } = require('../maths/utils/trigonometry')
 
-const { isGT, isGTE, isNumberArray } = require('./commonChecks')
+const { isGTE, isNumberArray } = require('./commonChecks')
+const cuboid = require('./cuboid')
 
 const createCorners = (center, size, radius, segments, slice, positive) => {
   const pitch = (TAU / 4) * slice / segments
@@ -135,10 +136,16 @@ const roundedCuboid = (options) => {
 
   if (!isNumberArray(center, 3)) throw new Error('center must be an array of X, Y and Z values')
   if (!isNumberArray(size, 3)) throw new Error('size must be an array of X, Y and Z values')
-  if (!size.every((n) => n > 0)) throw new Error('size values must be greater than zero')
-  if (!isGT(roundRadius, 0)) throw new Error('roundRadius must be greater than zero')
+  if (!size.every((n) => n >= 0)) throw new Error('size values must be positive')
+  if (!isGTE(roundRadius, 0)) throw new Error('roundRadius must be positive')
   if (!isGTE(segments, 4)) throw new Error('segments must be four or more')
 
+  // if any size is zero return empty geometry
+  if (size[0] === 0 || size[1] === 0 || size[2] === 0) return geom3.create()
+
+  // if roundRadius is zero, return cuboid
+  if (roundRadius === 0) return cuboid({ center, size })
+
   size = size.map((v) => v / 2) // convert to radius
 
   if (roundRadius > (size[0] - EPS) ||

package/src/primitives/roundedCuboid.test.js

@@ -14,6 +14,20 @@ test('roundedCuboid (defaults)', (t) => {
   t.deepEqual(pts.length, 614)
 })
 
+test('roundedCuboid (zero size)', (t) => {
+  const obs = roundedCuboid({ size: [1, 1, 0] })
+  const pts = geom3.toPoints(obs)
+  t.notThrows(() => geom3.validate(obs))
+  t.is(pts.length, 0)
+})
+
+test('roundedCuboid (zero radius)', (t) => {
+  const obs = roundedCuboid({ roundRadius: 0 })
+  const pts = geom3.toPoints(obs)
+  t.notThrows(() => geom3.validate(obs))
+  t.deepEqual(pts.length, 6)
+})
+
 test('roundedCuboid (options)', (t) => {
   // test segments
   let obs = roundedCuboid({ segments: 8 })

package/src/primitives/roundedCylinder.js

@@ -7,7 +7,8 @@ const poly3 = require('../geometries/poly3')
 
 const { sin, cos } = require('../maths/utils/trigonometry')
 
-const { isGT, isGTE, isNumberArray } = require('./commonChecks')
+const { isGTE, isNumberArray } = require('./commonChecks')
+const cylinder = require('./cylinder')
 
 /**
  * Construct a Z axis-aligned solid cylinder in three dimensional space with rounded ends.
@@ -34,12 +35,18 @@ const roundedCylinder = (options) => {
   const { center, height, radius, roundRadius, segments } = Object.assign({}, defaults, options)
 
   if (!isNumberArray(center, 3)) throw new Error('center must be an array of X, Y and Z values')
-  if (!isGT(height, 0)) throw new Error('height must be greater then zero')
-  if (!isGT(radius, 0)) throw new Error('radius must be greater then zero')
-  if (!isGT(roundRadius, 0)) throw new Error('roundRadius must be greater then zero')
-  if (roundRadius > (radius - EPS)) throw new Error('roundRadius must be smaller then the radius')
+  if (!isGTE(height, 0)) throw new Error('height must be positive')
+  if (!isGTE(radius, 0)) throw new Error('radius must be positive')
+  if (!isGTE(roundRadius, 0)) throw new Error('roundRadius must be positive')
+  if (roundRadius > radius) throw new Error('roundRadius must be smaller then the radius')
   if (!isGTE(segments, 4)) throw new Error('segments must be four or more')
 
+  // if size is zero return empty geometry
+  if (height === 0 || radius === 0) return geom3.create()
+
+  // if roundRadius is zero, return cylinder
+  if (roundRadius === 0) return cylinder({ center, height, radius })
+
   const start = [0, 0, -(height / 2)]
   const end = [0, 0, height / 2]
   const direction = vec3.subtract(vec3.create(), end, start)

package/src/primitives/roundedCylinder.test.js

@@ -14,6 +14,27 @@ test('roundedCylinder (defaults)', (t) => {
   t.is(pts.length, 544)
 })
 
+test('roundedCylinder (zero height)', (t) => {
+  const obs = roundedCylinder({ height: 0 })
+  const pts = geom3.toPoints(obs)
+  t.notThrows(() => geom3.validate(obs))
+  t.is(pts.length, 0)
+})
+
+test('roundedCylinder (zero radius)', (t) => {
+  const obs = roundedCylinder({ radius: 0, roundRadius: 0 })
+  const pts = geom3.toPoints(obs)
+  t.notThrows(() => geom3.validate(obs))
+  t.is(pts.length, 0)
+})
+
+test('roundedCylinder (zero roundRadius)', (t) => {
+  const obs = roundedCylinder({ roundRadius: 0 })
+  const pts = geom3.toPoints(obs)
+  t.notThrows(() => geom3.validate(obs))
+  t.is(pts.length, 96)
+})
+
 test('roundedCylinder (options)', (t) => {
   // test segments
   let obs = roundedCylinder({ segments: 5 })

package/src/primitives/roundedRectangle.js

@@ -4,7 +4,8 @@ const vec2 = require('../maths/vec2')
 
 const geom2 = require('../geometries/geom2')
 
-const { isGT, isGTE, isNumberArray } = require('./commonChecks')
+const { isGTE, isNumberArray } = require('./commonChecks')
+const rectangle = require('./rectangle')
 
 /**
  * Construct an axis-aligned rectangle in two dimensional space with rounded corners.
@@ -30,10 +31,16 @@ const roundedRectangle = (options) => {
 
   if (!isNumberArray(center, 2)) throw new Error('center must be an array of X and Y values')
   if (!isNumberArray(size, 2)) throw new Error('size must be an array of X and Y values')
-  if (!size.every((n) => n > 0)) throw new Error('size values must be greater than zero')
-  if (!isGT(roundRadius, 0)) throw new Error('roundRadius must be greater than zero')
+  if (!size.every((n) => n >= 0)) throw new Error('size values must be positive')
+  if (!isGTE(roundRadius, 0)) throw new Error('roundRadius must be positive')
   if (!isGTE(segments, 4)) throw new Error('segments must be four or more')
 
+  // if any size is zero return empty geometry
+  if (size[0] === 0 || size[1] === 0) return geom2.create()
+
+  // if roundRadius is zero, return rectangle
+  if (roundRadius === 0) return rectangle({ center, size })
+
   size = size.map((v) => v / 2) // convert to radius
 
   if (roundRadius > (size[0] - EPS) ||

package/src/primitives/roundedRectangle.test.js

@@ -14,6 +14,20 @@ test('roundedRectangle (defaults)', (t) => {
   t.deepEqual(obs.length, 36)
 })
 
+test('roundedRectangle (zero size)', (t) => {
+  const obs = roundedRectangle({ size: [1, 0] })
+  const pts = geom2.toPoints(obs)
+  t.notThrows(() => geom2.validate(obs))
+  t.is(pts.length, 0)
+})
+
+test('roundedRectangle (zero radius)', (t) => {
+  const obs = roundedRectangle({ roundRadius: 0 })
+  const pts = geom2.toPoints(obs)
+  t.notThrows(() => geom2.validate(obs))
+  t.deepEqual(pts.length, 4)
+})
+
 test('roundedRectangle (options)', (t) => {
   // test center
   let geometry = roundedRectangle({ center: [4, 5], segments: 16 })

package/src/primitives/sphere.js

@@ -1,6 +1,6 @@
 const ellipsoid = require('./ellipsoid')
 
-const { isGT } = require('./commonChecks')
+const { isGTE } = require('./commonChecks')
 
 /**
  * Construct a sphere in three dimensional space where all points are at the same distance from the center.
@@ -25,7 +25,7 @@ const sphere = (options) => {
   }
   let { center, radius, segments, axes } = Object.assign({}, defaults, options)
 
-  if (!isGT(radius, 0)) throw new Error('radius must be greater than zero')
+  if (!isGTE(radius, 0)) throw new Error('radius must be positive')
 
   radius = [radius, radius, radius]
 

package/src/primitives/sphere.test.js

@@ -163,3 +163,10 @@ test('sphere (options)', (t) => {
   t.is(pts.length, 32)
   t.true(comparePolygonsAsPoints(pts, exp))
 })
+
+test('sphere (zero radius)', (t) => {
+  const obs = sphere({ radius: 0 })
+  const pts = geom3.toPoints(obs)
+  t.notThrows(() => geom3.validate(obs))
+  t.is(pts.length, 0)
+})

package/src/primitives/square.js

@@ -1,6 +1,6 @@
 const rectangle = require('./rectangle')
 
-const { isGT } = require('./commonChecks')
+const { isGTE } = require('./commonChecks')
 
 /**
  * Construct an axis-aligned square in two dimensional space with four equal sides at right angles.
@@ -21,7 +21,7 @@ const square = (options) => {
   }
   let { center, size } = Object.assign({}, defaults, options)
 
-  if (!isGT(size, 0)) throw new Error('size must be greater than zero')
+  if (!isGTE(size, 0)) throw new Error('size must be positive')
 
   size = [size, size]
 

package/src/primitives/square.test.js

@@ -42,3 +42,10 @@ test('square (options)', (t) => {
   t.is(pts.length, 4)
   t.true(comparePoints(pts, exp))
 })
+
+test('square (zero size)', (t) => {
+  const geometry = square({ size: 0 })
+  const obs = geom2.toPoints(geometry)
+  t.notThrows(() => geom2.validate(geometry))
+  t.is(obs.length, 0)
+})