@jbroll/jscad-modeling 2.12.7

package/src/primitives/ellipsoid.js

@@ -0,0 +1,99 @@
+const { TAU } = require('../maths/constants')
+const vec3 = require('../maths/vec3')
+
+const geom3 = require('../geometries/geom3')
+const poly3 = require('../geometries/poly3')
+
+const { sin, cos } = require('../maths/utils/trigonometry')
+
+const { isGTE, isNumberArray } = require('./commonChecks')
+
+/**
+ * Construct an axis-aligned ellipsoid in three dimensional space.
+ * @param {Object} [options] - options for construction
+ * @param {Array} [options.center=[0,0,0]] - center of ellipsoid
+ * @param {Array} [options.radius=[1,1,1]] - radius of ellipsoid, along X, Y and Z
+ * @param {Number} [options.segments=32] - number of segments to create per full rotation
+ * @param {Array} [options.axes] -  an array with three vectors for the x, y and z base vectors
+ * @returns {geom3} new 3D geometry
+ * @alias module:modeling/primitives.ellipsoid
+ *
+ * @example
+ * let myshape = ellipsoid({radius: [5, 10, 20]})
+*/
+const ellipsoid = (options) => {
+  const defaults = {
+    center: [0, 0, 0],
+    radius: [1, 1, 1],
+    segments: 32,
+    axes: [[1, 0, 0], [0, -1, 0], [0, 0, 1]]
+  }
+  const { center, radius, segments, axes } = Object.assign({}, defaults, options)
+
+  if (!isNumberArray(center, 3)) throw new Error('center must be an array of X, Y and Z values')
+  if (!isNumberArray(radius, 3)) throw new Error('radius must be an array of X, Y and Z values')
+  if (!radius.every((n) => n >= 0)) throw new Error('radius values must be positive')
+  if (!isGTE(segments, 4)) throw new Error('segments must be four or more')
+
+  // if any radius is zero return empty geometry
+  if (radius[0] === 0 || radius[1] === 0 || radius[2] === 0) return geom3.create()
+
+  const xvector = vec3.scale(vec3.create(), vec3.normalize(vec3.create(), axes[0]), radius[0])
+  const yvector = vec3.scale(vec3.create(), vec3.normalize(vec3.create(), axes[1]), radius[1])
+  const zvector = vec3.scale(vec3.create(), vec3.normalize(vec3.create(), axes[2]), radius[2])
+
+  const qsegments = Math.round(segments / 4)
+  let prevcylinderpoint
+  const polygons = []
+  const p1 = vec3.create()
+  const p2 = vec3.create()
+  for (let slice1 = 0; slice1 <= segments; slice1++) {
+    const angle = TAU * slice1 / segments
+    const cylinderpoint = vec3.add(vec3.create(), vec3.scale(p1, xvector, cos(angle)), vec3.scale(p2, yvector, sin(angle)))
+    if (slice1 > 0) {
+      let prevcospitch, prevsinpitch
+      for (let slice2 = 0; slice2 <= qsegments; slice2++) {
+        const pitch = TAU / 4 * slice2 / qsegments
+        const cospitch = cos(pitch)
+        const sinpitch = sin(pitch)
+        if (slice2 > 0) {
+          let points = []
+          let point
+          point = vec3.subtract(vec3.create(), vec3.scale(p1, prevcylinderpoint, prevcospitch), vec3.scale(p2, zvector, prevsinpitch))
+          points.push(vec3.add(point, point, center))
+          point = vec3.subtract(vec3.create(), vec3.scale(p1, cylinderpoint, prevcospitch), vec3.scale(p2, zvector, prevsinpitch))
+          points.push(vec3.add(point, point, center))
+          if (slice2 < qsegments) {
+            point = vec3.subtract(vec3.create(), vec3.scale(p1, cylinderpoint, cospitch), vec3.scale(p2, zvector, sinpitch))
+            points.push(vec3.add(point, point, center))
+          }
+          point = vec3.subtract(vec3.create(), vec3.scale(p1, prevcylinderpoint, cospitch), vec3.scale(p2, zvector, sinpitch))
+          points.push(vec3.add(point, point, center))
+
+          polygons.push(poly3.create(points))
+
+          points = []
+          point = vec3.add(vec3.create(), vec3.scale(p1, prevcylinderpoint, prevcospitch), vec3.scale(p2, zvector, prevsinpitch))
+          points.push(vec3.add(vec3.create(), center, point))
+          point = vec3.add(point, vec3.scale(p1, cylinderpoint, prevcospitch), vec3.scale(p2, zvector, prevsinpitch))
+          points.push(vec3.add(vec3.create(), center, point))
+          if (slice2 < qsegments) {
+            point = vec3.add(point, vec3.scale(p1, cylinderpoint, cospitch), vec3.scale(p2, zvector, sinpitch))
+            points.push(vec3.add(vec3.create(), center, point))
+          }
+          point = vec3.add(point, vec3.scale(p1, prevcylinderpoint, cospitch), vec3.scale(p2, zvector, sinpitch))
+          points.push(vec3.add(vec3.create(), center, point))
+          points.reverse()
+
+          polygons.push(poly3.create(points))
+        }
+        prevcospitch = cospitch
+        prevsinpitch = sinpitch
+      }
+    }
+    prevcylinderpoint = cylinderpoint
+  }
+  return geom3.create(polygons)
+}
+
+module.exports = ellipsoid

package/src/primitives/ellipsoid.test.js

@@ -0,0 +1,216 @@
+const test = require('ava')
+
+const geom3 = require('../geometries/geom3')
+
+const { ellipsoid } = require('./index')
+
+const comparePolygonsAsPoints = require('../../test/helpers/comparePolygonsAsPoints')
+
+test('ellipsoid (defaults)', (t) => {
+  const obs = ellipsoid()
+  const pts = geom3.toPoints(obs)
+
+  t.notThrows(() => geom3.validate(obs))
+  t.is(pts.length, 512)
+})
+
+test('ellipsoid (options)', (t) => {
+  // test radius
+  let obs = ellipsoid({ radius: [3, 5, 7], segments: 12 })
+  let pts = geom3.toPoints(obs)
+  let exp = [
+    [[3, 0, 0], [2.598076211353316, -2.4999999999999996, 0],
+      [2.25, -2.1650635094610964, -3.4999999999999996], [2.598076211353316, 0, -3.4999999999999996]],
+    [[2.598076211353316, 0, 3.4999999999999996], [2.25, -2.1650635094610964, 3.4999999999999996],
+      [2.598076211353316, -2.4999999999999996, 0], [3, 0, 0]],
+    [[2.598076211353316, 0, -3.4999999999999996], [2.25, -2.1650635094610964, -3.4999999999999996],
+      [1.2990381056766582, -1.25, -6.06217782649107], [1.5000000000000004, 0, -6.06217782649107]],
+    [[1.5000000000000004, 0, 6.06217782649107], [1.2990381056766582, -1.25, 6.06217782649107],
+      [2.25, -2.1650635094610964, 3.4999999999999996], [2.598076211353316, 0, 3.4999999999999996]],
+    [[1.5000000000000004, 0, -6.06217782649107], [1.2990381056766582, -1.25, -6.06217782649107], [0, 0, -7]],
+    [[0, 0, 7], [1.2990381056766582, -1.25, 6.06217782649107], [1.5000000000000004, 0, 6.06217782649107]],
+    [[2.598076211353316, -2.4999999999999996, 0], [1.5000000000000004, -4.330127018922193, 0],
+      [1.2990381056766584, -3.75, -3.4999999999999996], [2.25, -2.1650635094610964, -3.4999999999999996]],
+    [[2.25, -2.1650635094610964, 3.4999999999999996], [1.2990381056766584, -3.75, 3.4999999999999996],
+      [1.5000000000000004, -4.330127018922193, 0], [2.598076211353316, -2.4999999999999996, 0]],
+    [[2.25, -2.1650635094610964, -3.4999999999999996], [1.2990381056766584, -3.75, -3.4999999999999996],
+      [0.7500000000000004, -2.165063509461097, -6.06217782649107], [1.2990381056766582, -1.25, -6.06217782649107]],
+    [[1.2990381056766582, -1.25, 6.06217782649107], [0.7500000000000004, -2.165063509461097, 6.06217782649107],
+      [1.2990381056766584, -3.75, 3.4999999999999996], [2.25, -2.1650635094610964, 3.4999999999999996]],
+    [[1.2990381056766582, -1.25, -6.06217782649107], [0.7500000000000004, -2.165063509461097, -6.06217782649107], [0, 0, -7]],
+    [[0, 0, 7], [0.7500000000000004, -2.165063509461097, 6.06217782649107], [1.2990381056766582, -1.25, 6.06217782649107]],
+    [[1.5000000000000004, -4.330127018922193, 0], [0, -5, 0],
+      [0, -4.330127018922194, -3.4999999999999996], [1.2990381056766584, -3.75, -3.4999999999999996]],
+    [[1.2990381056766584, -3.75, 3.4999999999999996], [0, -4.330127018922194, 3.4999999999999996],
+      [0, -5, 0], [1.5000000000000004, -4.330127018922193, 0]],
+    [[1.2990381056766584, -3.75, -3.4999999999999996], [0, -4.330127018922194, -3.4999999999999996],
+      [0, -2.5000000000000004, -6.06217782649107], [0.7500000000000004, -2.165063509461097, -6.06217782649107]],
+    [[0.7500000000000004, -2.165063509461097, 6.06217782649107], [0, -2.5000000000000004, 6.06217782649107],
+      [0, -4.330127018922194, 3.4999999999999996], [1.2990381056766584, -3.75, 3.4999999999999996]],
+    [[0.7500000000000004, -2.165063509461097, -6.06217782649107], [0, -2.5000000000000004, -6.06217782649107], [0, 0, -7]],
+    [[0, 0, 7], [0, -2.5000000000000004, 6.06217782649107], [0.7500000000000004, -2.165063509461097, 6.06217782649107]],
+    [[0, -5, 0], [-1.4999999999999993, -4.330127018922194, 0],
+      [-1.2990381056766576, -3.7500000000000004, -3.4999999999999996], [0, -4.330127018922194, -3.4999999999999996]],
+    [[0, -4.330127018922194, 3.4999999999999996], [-1.2990381056766576, -3.7500000000000004, 3.4999999999999996],
+      [-1.4999999999999993, -4.330127018922194, 0], [0, -5, 0]],
+    [[0, -4.330127018922194, -3.4999999999999996], [-1.2990381056766576, -3.7500000000000004, -3.4999999999999996],
+      [-0.7499999999999998, -2.1650635094610973, -6.06217782649107], [0, -2.5000000000000004, -6.06217782649107]],
+    [[0, -2.5000000000000004, 6.06217782649107], [-0.7499999999999998, -2.1650635094610973, 6.06217782649107],
+      [-1.2990381056766576, -3.7500000000000004, 3.4999999999999996], [0, -4.330127018922194, 3.4999999999999996]],
+    [[0, -2.5000000000000004, -6.06217782649107], [-0.7499999999999998, -2.1650635094610973, -6.06217782649107], [0, 0, -7]],
+    [[0, 0, 7], [-0.7499999999999998, -2.1650635094610973, 6.06217782649107], [0, -2.5000000000000004, 6.06217782649107]],
+    [[-1.4999999999999993, -4.330127018922194, 0], [-2.598076211353316, -2.4999999999999996, 0],
+      [-2.25, -2.1650635094610964, -3.4999999999999996], [-1.2990381056766576, -3.7500000000000004, -3.4999999999999996]],
+    [[-1.2990381056766576, -3.7500000000000004, 3.4999999999999996], [-2.25, -2.1650635094610964, 3.4999999999999996],
+      [-2.598076211353316, -2.4999999999999996, 0], [-1.4999999999999993, -4.330127018922194, 0]],
+    [[-1.2990381056766576, -3.7500000000000004, -3.4999999999999996], [-2.25, -2.1650635094610964, -3.4999999999999996],
+      [-1.2990381056766582, -1.25, -6.06217782649107], [-0.7499999999999998, -2.1650635094610973, -6.06217782649107]],
+    [[-0.7499999999999998, -2.1650635094610973, 6.06217782649107], [-1.2990381056766582, -1.25, 6.06217782649107],
+      [-2.25, -2.1650635094610964, 3.4999999999999996], [-1.2990381056766576, -3.7500000000000004, 3.4999999999999996]],
+    [[-0.7499999999999998, -2.1650635094610973, -6.06217782649107], [-1.2990381056766582, -1.25, -6.06217782649107], [0, 0, -7]],
+    [[0, 0, 7], [-1.2990381056766582, -1.25, 6.06217782649107], [-0.7499999999999998, -2.1650635094610973, 6.06217782649107]],
+    [[-2.598076211353316, -2.4999999999999996, 0], [-3, 0, 0],
+      [-2.598076211353316, 0, -3.4999999999999996], [-2.25, -2.1650635094610964, -3.4999999999999996]],
+    [[-2.25, -2.1650635094610964, 3.4999999999999996], [-2.598076211353316, 0, 3.4999999999999996],
+      [-3, 0, 0], [-2.598076211353316, -2.4999999999999996, 0]],
+    [[-2.25, -2.1650635094610964, -3.4999999999999996], [-2.598076211353316, 0, -3.4999999999999996],
+      [-1.5000000000000004, 0, -6.06217782649107], [-1.2990381056766582, -1.25, -6.06217782649107]],
+    [[-1.2990381056766582, -1.25, 6.06217782649107], [-1.5000000000000004, 0, 6.06217782649107],
+      [-2.598076211353316, 0, 3.4999999999999996], [-2.25, -2.1650635094610964, 3.4999999999999996]],
+    [[-1.2990381056766582, -1.25, -6.06217782649107], [-1.5000000000000004, 0, -6.06217782649107], [0, 0, -7]],
+    [[0, 0, 7], [-1.5000000000000004, 0, 6.06217782649107], [-1.2990381056766582, -1.25, 6.06217782649107]],
+    [[-3, 0, 0], [-2.5980762113533165, 2.4999999999999987, 0],
+      [-2.2500000000000004, 2.1650635094610955, -3.4999999999999996], [-2.598076211353316, 0, -3.4999999999999996]],
+    [[-2.598076211353316, 0, 3.4999999999999996], [-2.2500000000000004, 2.1650635094610955, 3.4999999999999996],
+      [-2.5980762113533165, 2.4999999999999987, 0], [-3, 0, 0]],
+    [[-2.598076211353316, 0, -3.4999999999999996], [-2.2500000000000004, 2.1650635094610955, -3.4999999999999996],
+      [-1.2990381056766584, 1.2499999999999996, -6.06217782649107], [-1.5000000000000004, 0, -6.06217782649107]],
+    [[-1.5000000000000004, 0, 6.06217782649107], [-1.2990381056766584, 1.2499999999999996, 6.06217782649107],
+      [-2.2500000000000004, 2.1650635094610955, 3.4999999999999996], [-2.598076211353316, 0, 3.4999999999999996]],
+    [[-1.5000000000000004, 0, -6.06217782649107], [-1.2990381056766584, 1.2499999999999996, -6.06217782649107], [0, 0, -7]],
+    [[0, 0, 7], [-1.2990381056766584, 1.2499999999999996, 6.06217782649107], [-1.5000000000000004, 0, 6.06217782649107]],
+    [[-2.5980762113533165, 2.4999999999999987, 0], [-1.5000000000000013, 4.330127018922193, 0],
+      [-1.2990381056766591, 3.75, -3.4999999999999996], [-2.2500000000000004, 2.1650635094610955, -3.4999999999999996]],
+    [[-2.2500000000000004, 2.1650635094610955, 3.4999999999999996], [-1.2990381056766591, 3.75, 3.4999999999999996],
+      [-1.5000000000000013, 4.330127018922193, 0], [-2.5980762113533165, 2.4999999999999987, 0]],
+    [[-2.2500000000000004, 2.1650635094610955, -3.4999999999999996], [-1.2990381056766591, 3.75, -3.4999999999999996],
+      [-0.7500000000000009, 2.165063509461097, -6.06217782649107], [-1.2990381056766584, 1.2499999999999996, -6.06217782649107]],
+    [[-1.2990381056766584, 1.2499999999999996, 6.06217782649107], [-0.7500000000000009, 2.165063509461097, 6.06217782649107],
+      [-1.2990381056766591, 3.75, 3.4999999999999996], [-2.2500000000000004, 2.1650635094610955, 3.4999999999999996]],
+    [[-1.2990381056766584, 1.2499999999999996, -6.06217782649107], [-0.7500000000000009, 2.165063509461097, -6.06217782649107], [0, 0, -7]],
+    [[0, 0, 7], [-0.7500000000000009, 2.165063509461097, 6.06217782649107], [-1.2990381056766584, 1.2499999999999996, 6.06217782649107]],
+    [[-1.5000000000000013, 4.330127018922193, 0], [0, 5, 0],
+      [0, 4.330127018922194, -3.4999999999999996], [-1.2990381056766591, 3.75, -3.4999999999999996]],
+    [[-1.2990381056766591, 3.75, 3.4999999999999996], [0, 4.330127018922194, 3.4999999999999996],
+      [0, 5, 0], [-1.5000000000000013, 4.330127018922193, 0]],
+    [[-1.2990381056766591, 3.75, -3.4999999999999996], [0, 4.330127018922194, -3.4999999999999996],
+      [0, 2.5000000000000004, -6.06217782649107], [-0.7500000000000009, 2.165063509461097, -6.06217782649107]],
+    [[-0.7500000000000009, 2.165063509461097, 6.06217782649107], [0, 2.5000000000000004, 6.06217782649107],
+      [0, 4.330127018922194, 3.4999999999999996], [-1.2990381056766591, 3.75, 3.4999999999999996]],
+    [[-0.7500000000000009, 2.165063509461097, -6.06217782649107], [0, 2.5000000000000004, -6.06217782649107], [0, 0, -7]],
+    [[0, 0, 7], [0, 2.5000000000000004, 6.06217782649107], [-0.7500000000000009, 2.165063509461097, 6.06217782649107]],
+    [[0, 5, 0], [1.5000000000000004, 4.330127018922193, 0],
+      [1.2990381056766584, 3.75, -3.4999999999999996], [0, 4.330127018922194, -3.4999999999999996]],
+    [[0, 4.330127018922194, 3.4999999999999996], [1.2990381056766584, 3.75, 3.4999999999999996],
+      [1.5000000000000004, 4.330127018922193, 0], [0, 5, 0]],
+    [[0, 4.330127018922194, -3.4999999999999996], [1.2990381056766584, 3.75, -3.4999999999999996],
+      [0.7500000000000004, 2.165063509461097, -6.06217782649107], [0, 2.5000000000000004, -6.06217782649107]],
+    [[0, 2.5000000000000004, 6.06217782649107], [0.7500000000000004, 2.165063509461097, 6.06217782649107],
+      [1.2990381056766584, 3.75, 3.4999999999999996], [0, 4.330127018922194, 3.4999999999999996]],
+    [[0, 2.5000000000000004, -6.06217782649107], [0.7500000000000004, 2.165063509461097, -6.06217782649107], [0, 0, -7]],
+    [[0, 0, 7], [0.7500000000000004, 2.165063509461097, 6.06217782649107], [0, 2.5000000000000004, 6.06217782649107]],
+    [[1.5000000000000004, 4.330127018922193, 0], [2.598076211353315, 2.500000000000002, 0],
+      [2.2499999999999996, 2.1650635094610986, -3.4999999999999996], [1.2990381056766584, 3.75, -3.4999999999999996]],
+    [[1.2990381056766584, 3.75, 3.4999999999999996], [2.2499999999999996, 2.1650635094610986, 3.4999999999999996],
+      [2.598076211353315, 2.500000000000002, 0], [1.5000000000000004, 4.330127018922193, 0]],
+    [[1.2990381056766584, 3.75, -3.4999999999999996], [2.2499999999999996, 2.1650635094610986, -3.4999999999999996],
+      [1.2990381056766578, 1.2500000000000013, -6.06217782649107], [0.7500000000000004, 2.165063509461097, -6.06217782649107]],
+    [[0.7500000000000004, 2.165063509461097, 6.06217782649107], [1.2990381056766578, 1.2500000000000013, 6.06217782649107],
+      [2.2499999999999996, 2.1650635094610986, 3.4999999999999996], [1.2990381056766584, 3.75, 3.4999999999999996]],
+    [[0.7500000000000004, 2.165063509461097, -6.06217782649107], [1.2990381056766578, 1.2500000000000013, -6.06217782649107], [0, 0, -7]],
+    [[0, 0, 7], [1.2990381056766578, 1.2500000000000013, 6.06217782649107], [0.7500000000000004, 2.165063509461097, 6.06217782649107]],
+    [[2.598076211353315, 2.500000000000002, 0], [3, 0, 0],
+      [2.598076211353316, 0, -3.4999999999999996], [2.2499999999999996, 2.1650635094610986, -3.4999999999999996]],
+    [[2.2499999999999996, 2.1650635094610986, 3.4999999999999996], [2.598076211353316, 0, 3.4999999999999996],
+      [3, 0, 0], [2.598076211353315, 2.500000000000002, 0]],
+    [[2.2499999999999996, 2.1650635094610986, -3.4999999999999996], [2.598076211353316, 0, -3.4999999999999996],
+      [1.5000000000000004, 0, -6.06217782649107], [1.2990381056766578, 1.2500000000000013, -6.06217782649107]],
+    [[1.2990381056766578, 1.2500000000000013, 6.06217782649107], [1.5000000000000004, 0, 6.06217782649107],
+      [2.598076211353316, 0, 3.4999999999999996], [2.2499999999999996, 2.1650635094610986, 3.4999999999999996]],
+    [[1.2990381056766578, 1.2500000000000013, -6.06217782649107], [1.5000000000000004, 0, -6.06217782649107], [0, 0, -7]],
+    [[0, 0, 7], [1.5000000000000004, 0, 6.06217782649107], [1.2990381056766578, 1.2500000000000013, 6.06217782649107]]
+  ]
+  t.notThrows(() => geom3.validate(obs))
+  t.is(pts.length, 72)
+  t.true(comparePolygonsAsPoints(pts, exp))
+
+  // test segments
+  obs = ellipsoid({ segments: 8 })
+  pts = geom3.toPoints(obs)
+  t.notThrows(() => geom3.validate(obs))
+  t.is(pts.length, 32)
+
+  obs = ellipsoid({ center: [-3, 5, 7], segments: 8 })
+  pts = geom3.toPoints(obs)
+  exp = [
+    [[-2, 5, 7], [-2.2928932188134525, 4.292893218813452, 7],
+      [-2.5, 4.5, 6.292893218813452], [-2.2928932188134525, 5, 6.292893218813452]],
+    [[-2.2928932188134525, 5, 7.707106781186548], [-2.5, 4.5, 7.707106781186548],
+      [-2.2928932188134525, 4.292893218813452, 7], [-2, 5, 7]],
+    [[-2.2928932188134525, 5, 6.292893218813452], [-2.5, 4.5, 6.292893218813452], [-3, 5, 6]],
+    [[-3, 5, 8], [-2.5, 4.5, 7.707106781186548], [-2.2928932188134525, 5, 7.707106781186548]],
+    [[-2.2928932188134525, 4.292893218813452, 7], [-3, 4, 7],
+      [-3, 4.292893218813452, 6.292893218813452], [-2.5, 4.5, 6.292893218813452]],
+    [[-2.5, 4.5, 7.707106781186548], [-3, 4.292893218813452, 7.707106781186548],
+      [-3, 4, 7], [-2.2928932188134525, 4.292893218813452, 7]],
+    [[-2.5, 4.5, 6.292893218813452], [-3, 4.292893218813452, 6.292893218813452], [-3, 5, 6]],
+    [[-3, 5, 8], [-3, 4.292893218813452, 7.707106781186548], [-2.5, 4.5, 7.707106781186548]],
+    [[-3, 4, 7], [-3.7071067811865475, 4.292893218813452, 7],
+      [-3.5, 4.5, 6.292893218813452], [-3, 4.292893218813452, 6.292893218813452]],
+    [[-3, 4.292893218813452, 7.707106781186548], [-3.5, 4.5, 7.707106781186548],
+      [-3.7071067811865475, 4.292893218813452, 7], [-3, 4, 7]],
+    [[-3, 4.292893218813452, 6.292893218813452], [-3.5, 4.5, 6.292893218813452], [-3, 5, 6]],
+    [[-3, 5, 8], [-3.5, 4.5, 7.707106781186548], [-3, 4.292893218813452, 7.707106781186548]],
+    [[-3.7071067811865475, 4.292893218813452, 7], [-4, 5, 7],
+      [-3.7071067811865475, 5, 6.292893218813452], [-3.5, 4.5, 6.292893218813452]],
+    [[-3.5, 4.5, 7.707106781186548], [-3.7071067811865475, 5, 7.707106781186548],
+      [-4, 5, 7], [-3.7071067811865475, 4.292893218813452, 7]],
+    [[-3.5, 4.5, 6.292893218813452], [-3.7071067811865475, 5, 6.292893218813452], [-3, 5, 6]],
+    [[-3, 5, 8], [-3.7071067811865475, 5, 7.707106781186548], [-3.5, 4.5, 7.707106781186548]],
+    [[-4, 5, 7], [-3.707106781186548, 5.707106781186548, 7],
+      [-3.5, 5.5, 6.292893218813452], [-3.7071067811865475, 5, 6.292893218813452]],
+    [[-3.7071067811865475, 5, 7.707106781186548], [-3.5, 5.5, 7.707106781186548],
+      [-3.707106781186548, 5.707106781186548, 7], [-4, 5, 7]],
+    [[-3.7071067811865475, 5, 6.292893218813452], [-3.5, 5.5, 6.292893218813452], [-3, 5, 6]],
+    [[-3, 5, 8], [-3.5, 5.5, 7.707106781186548], [-3.7071067811865475, 5, 7.707106781186548]],
+    [[-3.707106781186548, 5.707106781186548, 7], [-3, 6, 7],
+      [-3, 5.707106781186548, 6.292893218813452], [-3.5, 5.5, 6.292893218813452]],
+    [[-3.5, 5.5, 7.707106781186548], [-3, 5.707106781186548, 7.707106781186548],
+      [-3, 6, 7], [-3.707106781186548, 5.707106781186548, 7]],
+    [[-3.5, 5.5, 6.292893218813452], [-3, 5.707106781186548, 6.292893218813452], [-3, 5, 6]],
+    [[-3, 5, 8], [-3, 5.707106781186548, 7.707106781186548], [-3.5, 5.5, 7.707106781186548]],
+    [[-3, 6, 7], [-2.2928932188134525, 5.707106781186548, 7],
+      [-2.5, 5.5, 6.292893218813452], [-3, 5.707106781186548, 6.292893218813452]],
+    [[-3, 5.707106781186548, 7.707106781186548], [-2.5, 5.5, 7.707106781186548],
+      [-2.2928932188134525, 5.707106781186548, 7], [-3, 6, 7]],
+    [[-3, 5.707106781186548, 6.292893218813452], [-2.5, 5.5, 6.292893218813452], [-3, 5, 6]],
+    [[-3, 5, 8], [-2.5, 5.5, 7.707106781186548], [-3, 5.707106781186548, 7.707106781186548]],
+    [[-2.2928932188134525, 5.707106781186548, 7], [-2, 5, 7],
+      [-2.2928932188134525, 5, 6.292893218813452], [-2.5, 5.5, 6.292893218813452]],
+    [[-2.5, 5.5, 7.707106781186548], [-2.2928932188134525, 5, 7.707106781186548],
+      [-2, 5, 7], [-2.2928932188134525, 5.707106781186548, 7]],
+    [[-2.5, 5.5, 6.292893218813452], [-2.2928932188134525, 5, 6.292893218813452], [-3, 5, 6]],
+    [[-3, 5, 8], [-2.2928932188134525, 5, 7.707106781186548], [-2.5, 5.5, 7.707106781186548]]
+  ]
+
+  t.notThrows(() => geom3.validate(obs))
+  t.is(pts.length, 32)
+  t.true(comparePolygonsAsPoints(pts, exp))
+})
+
+test('ellipsoid (zero radius)', (t) => {
+  const obs = ellipsoid({ radius: [1, 1, 0] })
+  const pts = geom3.toPoints(obs)
+  t.notThrows(() => geom3.validate(obs))
+  t.is(pts.length, 0)
+})

package/src/primitives/geodesicSphere.d.ts

@@ -0,0 +1,10 @@
+import Geom3 from '../geometries/geom3/type'
+
+export default geodesicSphere
+
+export interface GeodesicSphereOptions {
+  radius?: number
+  frequency?: number
+}
+
+declare function geodesicSphere(options?: GeodesicSphereOptions): Geom3

package/src/primitives/geodesicSphere.js

@@ -0,0 +1,140 @@
+const mat4 = require('../maths/mat4')
+const vec3 = require('../maths/vec3')
+
+const geom3 = require('../geometries/geom3')
+
+const polyhedron = require('./polyhedron')
+
+const { isGTE } = require('./commonChecks')
+
+/**
+ * Construct a geodesic sphere based on icosahedron symmetry.
+ * @param {Object} [options] - options for construction
+ * @param {Number} [options.radius=1] - target radius of sphere
+ * @param {Number} [options.frequency=6] - subdivision frequency per face, multiples of 6
+ * @returns {geom3} new 3D geometry
+ * @alias module:modeling/primitives.geodesicSphere
+ *
+ * @example
+ * let myshape = geodesicSphere({radius: 15, frequency: 18})
+ */
+const geodesicSphere = (options) => {
+  const defaults = {
+    radius: 1,
+    frequency: 6
+  }
+  let { radius, frequency } = Object.assign({}, defaults, options)
+
+  if (!isGTE(radius, 0)) throw new Error('radius must be positive')
+  if (!isGTE(frequency, 6)) throw new Error('frequency must be six or more')
+
+  // if radius is zero return empty geometry
+  if (radius === 0) return geom3.create()
+
+  // adjust the frequency to base 6
+  frequency = Math.floor(frequency / 6)
+
+  const ci = [ // hard-coded data of icosahedron (20 faces, all triangles)
+    [0.850651, 0.000000, -0.525731],
+    [0.850651, -0.000000, 0.525731],
+    [-0.850651, -0.000000, 0.525731],
+    [-0.850651, 0.000000, -0.525731],
+    [0.000000, -0.525731, 0.850651],
+    [0.000000, 0.525731, 0.850651],
+    [0.000000, 0.525731, -0.850651],
+    [0.000000, -0.525731, -0.850651],
+    [-0.525731, -0.850651, -0.000000],
+    [0.525731, -0.850651, -0.000000],
+    [0.525731, 0.850651, 0.000000],
+    [-0.525731, 0.850651, 0.000000]]
+
+  const ti = [[0, 9, 1], [1, 10, 0], [6, 7, 0], [10, 6, 0], [7, 9, 0], [5, 1, 4], [4, 1, 9], [5, 10, 1], [2, 8, 3], [3, 11, 2], [2, 5, 4],
+    [4, 8, 2], [2, 11, 5], [3, 7, 6], [6, 11, 3], [8, 7, 3], [9, 8, 4], [11, 10, 5], [10, 11, 6], [8, 9, 7]]
+
+  const geodesicSubDivide = (p, frequency, offset) => {
+    const p1 = p[0]
+    const p2 = p[1]
+    const p3 = p[2]
+    let n = offset
+    const c = []
+    const f = []
+
+    //           p3
+    //           /\
+    //          /__\     frequency = 3
+    //      i  /\  /\
+    //        /__\/__\       total triangles = 9 (frequency*frequency)
+    //       /\  /\  /\
+    //     0/__\/__\/__\
+    //    p1 0   j      p2
+
+    for (let i = 0; i < frequency; i++) {
+      for (let j = 0; j < frequency - i; j++) {
+        const t0 = i / frequency
+        const t1 = (i + 1) / frequency
+        const s0 = j / (frequency - i)
+        const s1 = (j + 1) / (frequency - i)
+        const s2 = frequency - i - 1 ? j / (frequency - i - 1) : 1
+        const q = []
+
+        q[0] = mix3(mix3(p1, p2, s0), p3, t0)
+        q[1] = mix3(mix3(p1, p2, s1), p3, t0)
+        q[2] = mix3(mix3(p1, p2, s2), p3, t1)
+
+        // -- normalize
+        for (let k = 0; k < 3; k++) {
+          const r = vec3.length(q[k])
+          for (let l = 0; l < 3; l++) {
+            q[k][l] /= r
+          }
+        }
+        c.push(q[0], q[1], q[2])
+        f.push([n, n + 1, n + 2]); n += 3
+
+        if (j < frequency - i - 1) {
+          const s3 = frequency - i - 1 ? (j + 1) / (frequency - i - 1) : 1
+          q[0] = mix3(mix3(p1, p2, s1), p3, t0)
+          q[1] = mix3(mix3(p1, p2, s3), p3, t1)
+          q[2] = mix3(mix3(p1, p2, s2), p3, t1)
+
+          // -- normalize
+          for (let k = 0; k < 3; k++) {
+            const r = vec3.length(q[k])
+            for (let l = 0; l < 3; l++) {
+              q[k][l] /= r
+            }
+          }
+          c.push(q[0], q[1], q[2])
+          f.push([n, n + 1, n + 2]); n += 3
+        }
+      }
+    }
+    return { points: c, triangles: f, offset: n }
+  }
+
+  const mix3 = (a, b, f) => {
+    const _f = 1 - f
+    const c = []
+    for (let i = 0; i < 3; i++) {
+      c[i] = a[i] * _f + b[i] * f
+    }
+    return c
+  }
+
+  let points = []
+  let faces = []
+  let offset = 0
+
+  for (let i = 0; i < ti.length; i++) {
+    const g = geodesicSubDivide([ci[ti[i][0]], ci[ti[i][1]], ci[ti[i][2]]], frequency, offset)
+    points = points.concat(g.points)
+    faces = faces.concat(g.triangles)
+    offset = g.offset
+  }
+
+  let geometry = polyhedron({ points: points, faces: faces, orientation: 'inward' })
+  if (radius !== 1) geometry = geom3.transform(mat4.fromScaling(mat4.create(), [radius, radius, radius]), geometry)
+  return geometry
+}
+
+module.exports = geodesicSphere

package/src/primitives/geodesicSphere.test.js

@@ -0,0 +1,60 @@
+const test = require('ava')
+
+const geom3 = require('../geometries/geom3')
+
+const { geodesicSphere } = require('./index')
+
+const comparePolygonsAsPoints = require('../../test/helpers/comparePolygonsAsPoints')
+
+test('geodesicSphere (defaults)', (t) => {
+  const obs = geodesicSphere()
+  const pts = geom3.toPoints(obs)
+  t.notThrows(() => geom3.validate(obs))
+  t.is(pts.length, 20)
+})
+
+test('geodesicSphere (options)', (t) => {
+  // test radius
+  let obs = geodesicSphere({ radius: 5 })
+  let pts = geom3.toPoints(obs)
+  const exp = [
+    [[4.253254557317035, 0, 2.628654726407001], [2.628654726407001, -4.253254557317035, 0], [4.253254557317035, 0, -2.628654726407001]],
+    [[4.253254557317035, 0, -2.628654726407001], [2.628654726407001, 4.253254557317035, 0], [4.253254557317035, 0, 2.628654726407001]],
+    [[4.253254557317035, 0, -2.628654726407001], [0, -2.628654726407001, -4.253254557317035], [0, 2.628654726407001, -4.253254557317035]],
+    [[4.253254557317035, 0, -2.628654726407001], [0, 2.628654726407001, -4.253254557317035], [2.628654726407001, 4.253254557317035, 0]],
+    [[4.253254557317035, 0, -2.628654726407001], [2.628654726407001, -4.253254557317035, 0], [0, -2.628654726407001, -4.253254557317035]],
+    [[0, -2.628654726407001, 4.253254557317035], [4.253254557317035, 0, 2.628654726407001], [0, 2.628654726407001, 4.253254557317035]],
+    [[2.628654726407001, -4.253254557317035, 0], [4.253254557317035, 0, 2.628654726407001], [0, -2.628654726407001, 4.253254557317035]],
+    [[4.253254557317035, 0, 2.628654726407001], [2.628654726407001, 4.253254557317035, 0], [0, 2.628654726407001, 4.253254557317035]],
+    [[-4.253254557317035, 0, -2.628654726407001], [-2.628654726407001, -4.253254557317035, 0], [-4.253254557317035, 0, 2.628654726407001]],
+    [[-4.253254557317035, 0, 2.628654726407001], [-2.628654726407001, 4.253254557317035, 0], [-4.253254557317035, 0, -2.628654726407001]],
+    [[0, -2.628654726407001, 4.253254557317035], [0, 2.628654726407001, 4.253254557317035], [-4.253254557317035, 0, 2.628654726407001]],
+    [[-4.253254557317035, 0, 2.628654726407001], [-2.628654726407001, -4.253254557317035, 0], [0, -2.628654726407001, 4.253254557317035]],
+    [[0, 2.628654726407001, 4.253254557317035], [-2.628654726407001, 4.253254557317035, 0], [-4.253254557317035, 0, 2.628654726407001]],
+    [[0, 2.628654726407001, -4.253254557317035], [0, -2.628654726407001, -4.253254557317035], [-4.253254557317035, 0, -2.628654726407001]],
+    [[-4.253254557317035, 0, -2.628654726407001], [-2.628654726407001, 4.253254557317035, 0], [0, 2.628654726407001, -4.253254557317035]],
+    [[-4.253254557317035, 0, -2.628654726407001], [0, -2.628654726407001, -4.253254557317035], [-2.628654726407001, -4.253254557317035, 0]],
+    [[0, -2.628654726407001, 4.253254557317035], [-2.628654726407001, -4.253254557317035, 0], [2.628654726407001, -4.253254557317035, 0]],
+    [[0, 2.628654726407001, 4.253254557317035], [2.628654726407001, 4.253254557317035, 0], [-2.628654726407001, 4.253254557317035, 0]],
+    [[0, 2.628654726407001, -4.253254557317035], [-2.628654726407001, 4.253254557317035, 0], [2.628654726407001, 4.253254557317035, 0]],
+    [[0, -2.628654726407001, -4.253254557317035], [2.628654726407001, -4.253254557317035, 0], [-2.628654726407001, -4.253254557317035, 0]]
+  ]
+
+  t.notThrows(() => geom3.validate(obs))
+  t.is(pts.length, 20)
+  t.true(comparePolygonsAsPoints(pts, exp))
+
+  // test frequency
+  obs = geodesicSphere({ radius: 5, frequency: 18 })
+  pts = geom3.toPoints(obs)
+
+  t.notThrows.skip(() => geom3.validate(obs))
+  t.is(pts.length, 180)
+})
+
+test('geodesicSphere (zero radius)', (t) => {
+  const obs = geodesicSphere({ radius: 0 })
+  const pts = geom3.toPoints(obs)
+  t.notThrows(() => geom3.validate(obs))
+  t.is(pts.length, 0)
+})

package/src/primitives/index.d.ts

@@ -0,0 +1,23 @@
+export { default as arc, ArcOptions } from './arc'
+export { default as circle, CircleOptions } from './circle'
+export { default as cube, CubeOptions } from './cube'
+export { default as cuboid, CuboidOptions } from './cuboid'
+export { default as cylinder, CylinderOptions } from './cylinder'
+export { default as cylinderElliptic, CylinderEllipticOptions } from './cylinderElliptic'
+export { default as ellipse, EllipseOptions } from './ellipse'
+export { default as ellipsoid, EllipsoidOptions } from './ellipsoid'
+export { default as geodesicSphere, GeodesicSphereOptions } from './geodesicSphere'
+export { default as line } from './line'
+export { default as polygon, PolygonOptions } from './polygon'
+export { default as polyhedron, PolyhedronOptions } from './polyhedron'
+export { default as rectangle, RectangleOptions } from './rectangle'
+export { default as roundedCuboid, RoundedCuboidOptions } from './roundedCuboid'
+export { default as roundedCylinder, RoundedCylinderOptions } from './roundedCylinder'
+export { default as roundedRectangle, RoundedRectangleOptions } from './roundedRectangle'
+export { default as sphere, SphereOptions } from './sphere'
+export { default as square, SquareOptions } from './square'
+export { default as star, StarOptions } from './star'
+export { default as torus, TorusOptions } from './torus'
+export { default as triangle, TriangleOptions } from './triangle'
+
+export as namespace primitives

package/src/primitives/index.js

@@ -0,0 +1,31 @@
+/**
+ * Primitives provide the building blocks for complex parts.
+ * Each primitive is a geometrical object that can be described mathematically, and therefore precise.
+ * Primitives can be logically combined, transformed, extruded, etc.
+ * @module modeling/primitives
+ * @example
+ * const { cube, ellipse, star } = require('@jscad/modeling').primitives
+ */
+module.exports = {
+  arc: require('./arc'),
+  circle: require('./circle'),
+  cube: require('./cube'),
+  cuboid: require('./cuboid'),
+  cylinder: require('./cylinder'),
+  cylinderElliptic: require('./cylinderElliptic'),
+  ellipse: require('./ellipse'),
+  ellipsoid: require('./ellipsoid'),
+  geodesicSphere: require('./geodesicSphere'),
+  line: require('./line'),
+  polygon: require('./polygon'),
+  polyhedron: require('./polyhedron'),
+  rectangle: require('./rectangle'),
+  roundedCuboid: require('./roundedCuboid'),
+  roundedCylinder: require('./roundedCylinder'),
+  roundedRectangle: require('./roundedRectangle'),
+  sphere: require('./sphere'),
+  square: require('./square'),
+  star: require('./star'),
+  torus: require('./torus'),
+  triangle: require('./triangle')
+}

package/src/primitives/line.d.ts

@@ -0,0 +1,6 @@
+import Vec2 from '../maths/vec2/type'
+import Path2 from '../geometries/path2/type'
+
+export default line
+
+declare function line(points: Array<Vec2>): Path2

package/src/primitives/line.js

@@ -0,0 +1,19 @@
+const path2 = require('../geometries/path2')
+
+/**
+ * Construct a new line in two dimensional space from the given points.
+ * The points must be provided as an array, where each element is a 2D point.
+ * @param {Array} points - array of points from which to create the path
+ * @returns {path2} new 2D path
+ * @alias module:modeling/primitives.line
+ *
+ * @example
+ * let myshape = line([[10, 10], [-10, 10]])
+ */
+const line = (points) => {
+  if (!Array.isArray(points)) throw new Error('points must be an array')
+
+  return path2.fromPoints({}, points)
+}
+
+module.exports = line

package/src/primitives/line.test.js

@@ -0,0 +1,17 @@
+const test = require('ava')
+
+const { line } = require('./index')
+
+const path2 = require('../geometries/path2')
+
+const comparePoints = require('../../test/helpers/comparePoints')
+
+test('line (defaults)', (t) => {
+  const exp = [[0, 0], [1, 1], [-3, 3]]
+  const geometry = line([[0, 0], [1, 1], [-3, 3]])
+  const obs = path2.toPoints(geometry)
+
+  t.notThrows(() => path2.validate(geometry))
+  t.deepEqual(obs.length, 3)
+  t.true(comparePoints(obs, exp))
+})

package/src/primitives/polygon.d.ts

@@ -0,0 +1,12 @@
+import Vec2 from '../maths/vec2/type'
+import Geom2 from '../geometries/geom2/type'
+
+export default polygon
+
+export interface PolygonOptions {
+  points: Array<Vec2> | Array<Array<Vec2>>
+  paths?: Array<number> | Array<Array<number>>
+  orientation?: 'counterclockwise' | 'clockwise'
+}
+
+declare function polygon(options: PolygonOptions): Geom2