fix(modeling): expose hullPoints2 and hullPoints3

packages/modeling/src/operations/hulls/hullGeom2.js

@@ -7,6 +7,9 @@ const toUniquePoints = require('./toUniquePoints')
 
 /*
  * Create a convex hull of the given geom2 geometries.
+ *
+ * NOTE: The given geometries must be valid geom2 geometries.
+ *
  * @param {...geometries} geometries - list of geom2 geometries
  * @returns {geom2} new geometry
  */

packages/modeling/src/operations/hulls/hullGeom3.js

@@ -1,13 +1,15 @@
 const flatten = require('../../utils/flatten')
 
 const geom3 = require('../../geometries/geom3')
-const poly3 = require('../../geometries/poly3')
 
-const quickhull = require('./quickhull')
 const toUniquePoints = require('./toUniquePoints')
+const hullPoints3 = require('./hullPoints3')
 
 /*
- * Create a convex hull of the given geometries (geom3).
+ * Create a convex hull of the given geom3 geometries.
+ *
+ * NOTE: The given geometries must be valid geom3 geometries.
+ *
  * @param {...geometries} geometries - list of geom3 geometries
  * @returns {geom3} new geometry
  */
@@ -19,14 +21,7 @@ const hullGeom3 = (...geometries) => {
   // extract the unique vertices from the geometries
   const unique = toUniquePoints(geometries)
 
-  const faces = quickhull(unique, { skipTriangulation: true })
-
-  const polygons = faces.map((face) => {
-    const vertices = face.map((index) => unique[index])
-    return poly3.create(vertices)
-  })
-
-  return geom3.create(polygons)
+  return geom3.create(hullPoints3(unique))
 }
 
 module.exports = hullGeom3

packages/modeling/src/operations/hulls/hullPath2.js

@@ -6,7 +6,10 @@ const hullPoints2 = require('./hullPoints2')
 const toUniquePoints = require('./toUniquePoints')
 
 /*
- * Create a convex hull of the given geometries (path2).
+ * Create a convex hull of the given path2 geometries.
+ *
+ * NOTE: The given geometries must be valid path2 geometry.
+ *
  * @param {...geometries} geometries - list of path2 geometries
  * @returns {path2} new geometry
  */

packages/modeling/src/operations/hulls/hullPoints2.d.ts

@@ -0,0 +1,5 @@
+import Vec2 from '../../maths/vec2/type'
+
+export default hullPoints2
+
+declare function hullPoints2(uniquePoints: Array<Vec2>): Array<Vec2>

packages/modeling/src/operations/hulls/hullPoints2.js

@@ -1,10 +1,12 @@
 const vec2 = require('../../maths/vec2')
 
-/*
+/**
  * Create a convex hull of the given set of points, where each point is an array of [x,y].
- * Uses https://en.wikipedia.org/wiki/Graham_scan
+ * @see https://en.wikipedia.org/wiki/Graham_scan
+ *
  * @param {Array} uniquePoints - list of UNIQUE points from which to create a hull
  * @returns {Array} a list of points that form the hull
+ * @alias module:modeling/hulls.hullPoints2
  */
 const hullPoints2 = (uniquePoints) => {
   // find min point

packages/modeling/src/operations/hulls/hullPoints3.d.ts

@@ -0,0 +1,6 @@
+import Vec3 from '../../maths/vec3/type'
+import Poly3 from '../../geometries/poly3/type'
+
+export default hullPoints3
+
+declare function hullPoints3(uniquePoints: Array<Vec3>): Array<Poly3>

packages/modeling/src/operations/hulls/hullPoints3.js

@@ -0,0 +1,23 @@
+const poly3 = require('../../geometries/poly3')
+
+const quickhull = require('./quickhull')
+
+/**
+ * Create a convex hull of the given set of points, where each point is an array of [x,y,z].
+ *
+ * @param {Array} uniquePoints - list of UNIQUE points from which to create a hull
+ * @returns {Array} a list of polygons (poly3)
+ * @alias module:modeling/hulls.hullPoints3
+ */
+const hullPoints3 = (uniquePoints) => {
+  const faces = quickhull(uniquePoints, { skipTriangulation: true })
+
+  const polygons = faces.map((face) => {
+    const vertices = face.map((index) => uniquePoints[index])
+    return poly3.create(vertices)
+  })
+
+  return polygons
+}
+
+module.exports = hullPoints3

packages/modeling/src/operations/hulls/index.d.ts

@@ -1,4 +1,6 @@
 export { default as hull } from './hull'
 export { default as hullChain } from './hullChain'
+export { default as hullPoints2 } from './hullPoints2'
+export { default as hullPoints3 } from './hullPoints3'
 
 export as namespace hulls

packages/modeling/src/operations/hulls/index.js

@@ -8,5 +8,7 @@
  */
 module.exports = {
   hull: require('./hull'),
-  hullChain: require('./hullChain')
+  hullChain: require('./hullChain'),
+  hullPoints2: require('./hullPoints2'),
+  hullPoints3: require('./hullPoints3')
 }