@jscad/modeling 2.7.0 → 2.7.1

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [2.7.1](https://github.com/jscad/OpenJSCAD.org/compare/@jscad/modeling@2.7.0...@jscad/modeling@2.7.1) (2021-12-26)
+
+
+### Bug Fixes
+
+* **modeling:** revert measureBoundingBox to only cache per geometry ([#967](https://github.com/jscad/OpenJSCAD.org/issues/967)) ([b18c02c](https://github.com/jscad/OpenJSCAD.org/commit/b18c02c333b225981a9093caf0593795bc0861ad))
+
+
+
+
+
 # [2.7.0](https://github.com/jscad/OpenJSCAD.org/compare/@jscad/modeling@2.6.1...@jscad/modeling@2.7.0) (2021-12-11)
 
 

package/dist/jscad-modeling.min.js

@@ -746,9 +746,9 @@ const flatten=require("../utils/flatten"),measureVolume=require("./measureVolume
 const flatten=require("../utils/flatten"),geom2=require("../geometries/geom2"),geom3=require("../geometries/geom3"),path2=require("../geometries/path2"),poly3=require("../geometries/poly3"),cache=new WeakMap,measureAreaOfPath2=()=>0,measureAreaOfGeom2=e=>{let r=cache.get(e);if(r)return r;return r=geom2.toSides(e).reduce((e,r)=>e+(r[0][0]*r[1][1]-r[0][1]*r[1][0]),0),r*=.5,cache.set(e,r),r},measureAreaOfGeom3=e=>{let r=cache.get(e);if(r)return r;return r=geom3.toPolygons(e).reduce((e,r)=>e+poly3.measureArea(r),0),cache.set(e,r),r},measureArea=(...e)=>{if(0===(e=flatten(e)).length)throw new Error("wrong number of arguments");const r=e.map(e=>path2.isA(e)?0:geom2.isA(e)?measureAreaOfGeom2(e):geom3.isA(e)?measureAreaOfGeom3(e):0);return 1===r.length?r[0]:r};module.exports=measureArea;
 
 },{"../geometries/geom2":22,"../geometries/geom3":36,"../geometries/path2":57,"../geometries/poly3":73,"../utils/flatten":379}],250:[function(require,module,exports){
-const flatten=require("../utils/flatten"),vec2=require("../maths/vec2"),vec3=require("../maths/vec3"),mat4=require("../maths/mat4"),geom2=require("../geometries/geom2"),geom3=require("../geometries/geom3"),path2=require("../geometries/path2"),poly3=require("../geometries/poly3"),cache=new WeakMap,measureBoundingBoxOfPath2Points=e=>{let o,n=cache.get(e);if(n)return n;o=0===e.length?vec2.create():vec2.clone(e[0]);const t=vec2.clone(o);return e.forEach(e=>{vec2.min(o,o,e),vec2.max(t,t,e)}),n=[[o[0],o[1],0],[t[0],t[1],0]],cache.set(e,n),n},measureBoundingBoxOfPath2=e=>{let o=cache.get(e);return o||(o=mat4.isOnlyTransformScale(e.transforms)?transformBoundingBox(measureBoundingBoxOfPath2Points(e.points),e.transforms):measureBoundingBoxOfPath2Points(path2.toPoints(e)),cache.set(e,o),o)},measureBoundingBoxOfGeom2Points=({points:e,sides:o})=>{const n=e||o;let t,r,s=cache.get(n);return s||(e?(t=0===e.length?vec2.create():vec2.clone(e[0]),r=vec2.clone(t),e.forEach(e=>{vec2.min(t,t,e),vec2.max(r,r,e)})):(t=0===o.length?vec2.create():vec2.clone(o[0][0]),r=vec2.clone(t),o.forEach(e=>{vec2.min(t,t,e[0]),vec2.max(r,r,e[0])})),s=[[t[0],t[1],0],[r[0],r[1],0]],cache.set(n,s),s)},measureBoundingBoxOfGeom2=e=>{let o=cache.get(e);return o||(o=mat4.isOnlyTransformScale(e.transforms)?transformBoundingBox(measureBoundingBoxOfGeom2Points(e),e.transforms):measureBoundingBoxOfGeom2Points({points:geom2.toPoints(e)}),cache.set(e,o),o)},measureBoundingBoxOfGeom3Polygons=e=>{let o=cache.get(e);if(o)return o;const n=vec3.create();if(e.length>0){const o=poly3.toPoints(e[0]);vec3.copy(n,o[0])}const t=vec3.clone(n);return e.forEach(e=>{poly3.toPoints(e).forEach(e=>{vec3.min(n,n,e),vec3.max(t,t,e)})}),o=[[n[0],n[1],n[2]],[t[0],t[1],t[2]]],cache.set(e,o),o},measureBoundingBoxOfGeom3=e=>{let o=cache.get(e);return o||(o=mat4.isOnlyTransformScale(e.transforms)?transformBoundingBox(measureBoundingBoxOfGeom3Polygons(e.polygons),e.transforms):measureBoundingBoxOfGeom3Polygons(geom3.toPolygons(e)),cache.set(e,o),o)},fixBound=(e,o,n)=>{if(o[e]>n[e]){const t=o[e];o[e]=n[e],n[e]=t}},transformBoundingBox=(e,o)=>(mat4.isIdentity(o)||(vec3.transform(e[0],e[0],o),vec3.transform(e[1],e[1],o),fixBound(0,...e),fixBound(1,...e),fixBound(2,...e)),e),measureBoundingBox=(...e)=>{if(0===(e=flatten(e)).length)throw new Error("wrong number of arguments");const o=e.map(e=>path2.isA(e)?measureBoundingBoxOfPath2(e):geom2.isA(e)?measureBoundingBoxOfGeom2(e):geom3.isA(e)?measureBoundingBoxOfGeom3(e):[[0,0,0],[0,0,0]]);return 1===o.length?o[0]:o};module.exports=measureBoundingBox;
+const flatten=require("../utils/flatten"),vec2=require("../maths/vec2"),vec3=require("../maths/vec3"),geom2=require("../geometries/geom2"),geom3=require("../geometries/geom3"),path2=require("../geometries/path2"),poly3=require("../geometries/poly3"),cache=new WeakMap,measureBoundingBoxOfPath2=e=>{let o=cache.get(e);if(o)return o;const t=path2.toPoints(e);let n;n=0===t.length?vec2.create():vec2.clone(t[0]);let r=vec2.clone(n);return t.forEach(e=>{vec2.min(n,n,e),vec2.max(r,r,e)}),n=[n[0],n[1],0],r=[r[0],r[1],0],o=[n,r],cache.set(e,o),o},measureBoundingBoxOfGeom2=e=>{let o=cache.get(e);if(o)return o;const t=geom2.toPoints(e);let n;n=0===t.length?vec2.create():vec2.clone(t[0]);let r=vec2.clone(n);return t.forEach(e=>{vec2.min(n,n,e),vec2.max(r,r,e)}),n=[n[0],n[1],0],r=[r[0],r[1],0],o=[n,r],cache.set(e,o),o},measureBoundingBoxOfGeom3=e=>{let o=cache.get(e);if(o)return o;const t=geom3.toPolygons(e);let n=vec3.create();if(t.length>0){const e=poly3.toPoints(t[0]);vec3.copy(n,e[0])}let r=vec3.clone(n);return t.forEach(e=>{poly3.toPoints(e).forEach(e=>{vec3.min(n,n,e),vec3.max(r,r,e)})}),n=[n[0],n[1],n[2]],r=[r[0],r[1],r[2]],o=[n,r],cache.set(e,o),o},measureBoundingBox=(...e)=>{if(0===(e=flatten(e)).length)throw new Error("wrong number of arguments");const o=e.map(e=>path2.isA(e)?measureBoundingBoxOfPath2(e):geom2.isA(e)?measureBoundingBoxOfGeom2(e):geom3.isA(e)?measureBoundingBoxOfGeom3(e):[[0,0,0],[0,0,0]]);return 1===o.length?o[0]:o};module.exports=measureBoundingBox;
 
-},{"../geometries/geom2":22,"../geometries/geom3":36,"../geometries/path2":57,"../geometries/poly3":73,"../maths/mat4":137,"../maths/vec2":183,"../maths/vec3":214,"../utils/flatten":379}],251:[function(require,module,exports){
+},{"../geometries/geom2":22,"../geometries/geom3":36,"../geometries/path2":57,"../geometries/poly3":73,"../maths/vec2":183,"../maths/vec3":214,"../utils/flatten":379}],251:[function(require,module,exports){
 const flatten=require("../utils/flatten"),vec2=require("../maths/vec2"),vec3=require("../maths/vec3"),geom2=require("../geometries/geom2"),geom3=require("../geometries/geom3"),path2=require("../geometries/path2"),poly3=require("../geometries/poly3"),cacheOfBoundingSpheres=new WeakMap,measureBoundingSphereOfPath2=e=>{let t=cacheOfBoundingSpheres.get(e);if(void 0!==t)return t;const r=vec3.create();let o=0;const c=path2.toPoints(e);if(c.length>0){let e=0;const t=vec3.create();c.forEach(o=>{vec3.add(r,r,vec3.fromVec2(t,o,0)),e++}),vec3.scale(r,r,1/e),c.forEach(e=>{o=Math.max(o,vec2.squaredDistance(r,e))}),o=Math.sqrt(o)}return t=[r,o],cacheOfBoundingSpheres.set(e,t),t},measureBoundingSphereOfGeom2=e=>{let t=cacheOfBoundingSpheres.get(e);if(void 0!==t)return t;const r=vec3.create();let o=0;const c=geom2.toSides(e);if(c.length>0){let e=0;const t=vec3.create();c.forEach(o=>{vec3.add(r,r,vec3.fromVec2(t,o[0],0)),e++}),vec3.scale(r,r,1/e),c.forEach(e=>{o=Math.max(o,vec2.squaredDistance(r,e[0]))}),o=Math.sqrt(o)}return t=[r,o],cacheOfBoundingSpheres.set(e,t),t},measureBoundingSphereOfGeom3=e=>{let t=cacheOfBoundingSpheres.get(e);if(void 0!==t)return t;const r=vec3.create();let o=0;const c=geom3.toPolygons(e);if(c.length>0){let e=0;c.forEach(t=>{poly3.toPoints(t).forEach(t=>{vec3.add(r,r,t),e++})}),vec3.scale(r,r,1/e),c.forEach(e=>{poly3.toPoints(e).forEach(e=>{o=Math.max(o,vec3.squaredDistance(r,e))})}),o=Math.sqrt(o)}return t=[r,o],cacheOfBoundingSpheres.set(e,t),t},measureBoundingSphere=(...e)=>{const t=(e=flatten(e)).map(e=>path2.isA(e)?measureBoundingSphereOfPath2(e):geom2.isA(e)?measureBoundingSphereOfGeom2(e):geom3.isA(e)?measureBoundingSphereOfGeom3(e):[[0,0,0],0]);return 1===t.length?t[0]:t};module.exports=measureBoundingSphere;
 
 },{"../geometries/geom2":22,"../geometries/geom3":36,"../geometries/path2":57,"../geometries/poly3":73,"../maths/vec2":183,"../maths/vec3":214,"../utils/flatten":379}],252:[function(require,module,exports){

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jscad/modeling",
-  "version": "2.7.0",
+  "version": "2.7.1",
   "description": "Constructive Solid Geometry (CSG) Library for JSCAD",
   "repository": "https://github.com/jscad/OpenJSCAD.org",
   "main": "src/index.js",
@@ -60,5 +60,5 @@
     "nyc": "15.1.0",
     "uglifyify": "5.0.2"
   },
-  "gitHead": "fbc9b90f0ae02bea4e6e7b974c65e751c3858269"
+  "gitHead": "c8ac21281a7acf5a5575b940c18353c598ffa1a4"
 }

package/src/curves/bezier/create.js

@@ -7,14 +7,6 @@
  * @property {Array} permutations - A pre-calculation of the bezier algorithm's co-efficients
  * @property {Array} tangentPermutations - A pre-calculation of the bezier algorithm's tangent co-efficients
  *
- * @example
- * const b = bezier.create([0,10]) // a linear progression from 0 to 10
- * const b = bezier.create([0, 0, 10, 10]) // a symmetrical cubic easing curve that starts slowly and ends slowly from 0 to 10
- * const b = bezier.create([0,0,0], [0,5,10], [10,0,-5], [10,10,10]]) // a cubic 3 dimensional easing curve that can generate position arrays for modelling
- * Usage:
- * let position = bezier.valueAt(t,b) // where 0 < t < 1
- * let tangent = bezier.tangentAt(t,b) // where 0 < t < 1
- *
  */
 
 /**
@@ -25,6 +17,9 @@
  * const b = bezier.create([0,10]) // a linear progression from 0 to 10
  * const b = bezier.create([0, 0, 10, 10]) // a symmetrical cubic easing curve that starts slowly and ends slowly from 0 to 10
  * const b = bezier.create([0,0,0], [0,5,10], [10,0,-5], [10,10,10]]) // a cubic 3 dimensional easing curve that can generate position arrays for modelling
+ * // Usage
+ * let position = bezier.valueAt(t,b) // where 0 < t < 1
+ * let tangent = bezier.tangentAt(t,b) // where 0 < t < 1
  *
  * @param {Array} points An array with at least 2 elements of either all numbers, or all arrays of numbers that are the same size.
  * @returns {bezier} a new bezier data object

package/src/curves/index.js

@@ -1,5 +1,5 @@
 /**
- * Curves are n-dimensional mathematical constructs that define a path from point 0 to point 1
+ * Curves are n-dimensional mathematical constructs that define a path from point 0 to point 1.
  * @module modeling/curves
  * @example
  * const { bezier } = require('@jscad/modeling').curves

package/src/geometries/geom3/create.js

@@ -4,7 +4,7 @@ const mat4 = require('../../maths/mat4')
  * Represents a 3D geometry consisting of a list of polygons.
  * @typedef {Object} geom3
  * @property {Array} polygons - list of polygons, each polygon containing three or more points
- * @property {mat4} transforms - transforms to apply to the sides, see transform()
+ * @property {mat4} transforms - transforms to apply to the polygons, see transform()
  */
 
 /**

package/src/maths/line3/create.js

@@ -3,7 +3,8 @@ const vec3 = require('../vec3')
 /**
  * Represents a unbounded line in 3D space, positioned at a point of origin.
  * A line is parametrized by a point of origin and a directional vector.
- * The array contents are two 3D vectors; origin and directional vector.
+ *
+ * The array contents are two 3D vectors; origin [0,0,0] and directional vector [0,0,1].
  * @see https://en.wikipedia.org/wiki/Hesse_normal_form
  * @typedef {Array} line3
  */

package/src/maths/mat4/isOnlyTransformScale.js

@@ -1,10 +1,11 @@
 
 /**
- * Determine whether the given matrix is translate+scale.
- * this code returns true for 180 rotation as it can be interpreted as scale (-1,-1)
- *
- * this method is primarily useful for measureBoundingBox
+ * Determine whether the given matrix is only translate and/or scale.
+ * This code returns true for PI rotation as it can be interpreted as 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) => (
 

package/src/measurements/measureBoundingBox.js

@@ -2,7 +2,6 @@ const flatten = require('../utils/flatten')
 
 const vec2 = require('../maths/vec2')
 const vec3 = require('../maths/vec3')
-const mat4 = require('../maths/mat4')
 
 const geom2 = require('../geometries/geom2')
 const geom3 = require('../geometries/geom3')
@@ -12,129 +11,86 @@ const poly3 = require('../geometries/poly3')
 const cache = new WeakMap()
 
 /*
- * Measure the min and max bounds of the given (path2) geometry.points.
- * @return {Array[]} the min and max bounds for the geometry.points
+ * Measure the min and max bounds of the given (path2) geometry.
+ * @return {Array[]} the min and max bounds for the geometry
  */
-const measureBoundingBoxOfPath2Points = (points) => {
-  let boundingBox = cache.get(points)
+const measureBoundingBoxOfPath2 = (geometry) => {
+  let boundingBox = cache.get(geometry)
   if (boundingBox) return boundingBox
 
+  const points = path2.toPoints(geometry)
+
   let minpoint
   if (points.length === 0) {
     minpoint = vec2.create()
   } else {
     minpoint = vec2.clone(points[0])
   }
-  const maxpoint = vec2.clone(minpoint)
+  let maxpoint = vec2.clone(minpoint)
 
   points.forEach((point) => {
     vec2.min(minpoint, minpoint, point)
     vec2.max(maxpoint, maxpoint, point)
   })
-  boundingBox = [[minpoint[0], minpoint[1], 0], [maxpoint[0], maxpoint[1], 0]]
+  minpoint = [minpoint[0], minpoint[1], 0]
+  maxpoint = [maxpoint[0], maxpoint[1], 0]
+
+  boundingBox = [minpoint, maxpoint]
+
+  cache.set(geometry, boundingBox)
 
-  cache.set(points, boundingBox)
   return boundingBox
 }
 
 /*
- * Measure the min and max bounds of the given (path2) geometry.
+ * Measure the min and max bounds of the given (geom2) geometry.
  * @return {Array[]} the min and max bounds for the geometry
  */
-const measureBoundingBoxOfPath2 = (geometry) => {
+const measureBoundingBoxOfGeom2 = (geometry) => {
   let boundingBox = cache.get(geometry)
   if (boundingBox) return boundingBox
 
-  if (mat4.isOnlyTransformScale(geometry.transforms)) {
-    // get boundingBox of original points and transform it
-    boundingBox = transformBoundingBox(measureBoundingBoxOfPath2Points(geometry.points), geometry.transforms)
+  const points = geom2.toPoints(geometry)
+
+  let minpoint
+  if (points.length === 0) {
+    minpoint = vec2.create()
   } else {
-    // transform the points and then caclulate the boundingBox
-    boundingBox = measureBoundingBoxOfPath2Points(path2.toPoints(geometry))
+    minpoint = vec2.clone(points[0])
   }
+  let maxpoint = vec2.clone(minpoint)
 
-  cache.set(geometry, boundingBox)
-  return boundingBox
-}
-
-/*
- * Measure the min and max bounds of the given (geom2) geometry.points/sides.
- * @return {Array[]} the min and max bounds for the geometr.points/sidesy
- */
-const measureBoundingBoxOfGeom2Points = ({ points, sides }) => {
-  const cacheKey = points || sides
-
-  let boundingBox = cache.get(cacheKey)
-  if (boundingBox) return boundingBox
+  points.forEach((point) => {
+    vec2.min(minpoint, minpoint, point)
+    vec2.max(maxpoint, maxpoint, point)
+  })
 
-  let minpoint, maxpoint
+  minpoint = [minpoint[0], minpoint[1], 0]
+  maxpoint = [maxpoint[0], maxpoint[1], 0]
 
-  if (points) {
-    if (points.length === 0) {
-      minpoint = vec2.create()
-    } else {
-      minpoint = vec2.clone(points[0])
-    }
-    maxpoint = vec2.clone(minpoint)
+  boundingBox = [minpoint, maxpoint]
 
-    points.forEach((point) => {
-      vec2.min(minpoint, minpoint, point)
-      vec2.max(maxpoint, maxpoint, point)
-    })
-  } else { // sides
-    // to avoid calling costly toPoints, we take advantage of the knowlege how the toPoints works
-    if (sides.length === 0) {
-      minpoint = vec2.create()
-    } else {
-      minpoint = vec2.clone(sides[0][0])
-    }
-    maxpoint = vec2.clone(minpoint)
-
-    sides.forEach((side) => {
-      vec2.min(minpoint, minpoint, side[0])
-      vec2.max(maxpoint, maxpoint, side[0])
-    })
-  }
-  boundingBox = [[minpoint[0], minpoint[1], 0], [maxpoint[0], maxpoint[1], 0]]
+  cache.set(geometry, boundingBox)
 
-  cache.set(cacheKey, boundingBox)
   return boundingBox
 }
 
 /*
- * Measure the min and max bounds of the given (geom2) geometry.
+ * Measure the min and max bounds of the given (geom3) geometry.
  * @return {Array[]} the min and max bounds for the geometry
  */
-const measureBoundingBoxOfGeom2 = (geometry) => {
+const measureBoundingBoxOfGeom3 = (geometry) => {
   let boundingBox = cache.get(geometry)
   if (boundingBox) return boundingBox
 
-  if (mat4.isOnlyTransformScale(geometry.transforms)) {
-    // get boundingBox of original points and transform it
-    boundingBox = transformBoundingBox(measureBoundingBoxOfGeom2Points(geometry), geometry.transforms)
-  } else {
-    // transform the points and then caclulate the boundingBox
-    boundingBox = measureBoundingBoxOfGeom2Points({ points: geom2.toPoints(geometry) })
-  }
-
-  cache.set(geometry, boundingBox)
-  return boundingBox
-}
-
-/*
- * Measure the min and max bounds of the given (geom3) geometry.polygons.
- * @return {Array[]} the min and max bounds for the geometry.polygons
- */
-const measureBoundingBoxOfGeom3Polygons = (polygons) => {
-  let boundingBox = cache.get(polygons)
-  if (boundingBox) return boundingBox
+  const polygons = geom3.toPolygons(geometry)
 
-  const minpoint = vec3.create()
+  let minpoint = vec3.create()
   if (polygons.length > 0) {
     const points = poly3.toPoints(polygons[0])
     vec3.copy(minpoint, points[0])
   }
-  const maxpoint = vec3.clone(minpoint)
+  let maxpoint = vec3.clone(minpoint)
 
   polygons.forEach((polygon) => {
     poly3.toPoints(polygon).forEach((point) => {
@@ -143,59 +99,13 @@ const measureBoundingBoxOfGeom3Polygons = (polygons) => {
     })
   })
 
-  boundingBox = [[minpoint[0], minpoint[1], minpoint[2]], [maxpoint[0], maxpoint[1], maxpoint[2]]]
+  minpoint = [minpoint[0], minpoint[1], minpoint[2]]
+  maxpoint = [maxpoint[0], maxpoint[1], maxpoint[2]]
 
-  cache.set(polygons, boundingBox)
-  return boundingBox
-}
-
-/*
- * Measure the min and max bounds of the given (geom3) geometry.
- * @return {Array[]} the min and max bounds for the geometry
- */
-const measureBoundingBoxOfGeom3 = (geometry) => {
-  let boundingBox = cache.get(geometry)
-  if (boundingBox) return boundingBox
-
-  if (mat4.isOnlyTransformScale(geometry.transforms)) {
-    // get boundingBox of original points and transform it
-    boundingBox = transformBoundingBox(measureBoundingBoxOfGeom3Polygons(geometry.polygons), geometry.transforms)
-  } else {
-    // transform the points and then caclulate the boundingBox
-    boundingBox = measureBoundingBoxOfGeom3Polygons(geom3.toPolygons(geometry))
-  }
+  boundingBox = [minpoint, maxpoint]
 
   cache.set(geometry, boundingBox)
-  return boundingBox
-}
 
-/*
- * swap values if specific axis value in the second vector has lower value than the axis value in first vector
- */
-const fixBound = (i, v1, v2) => {
-  if (v1[i] > v2[i]) {
-    const tmp = v1[i]
-    v1[i] = v2[i]
-    v2[i] = tmp
-  }
-}
-
-/*
- * Transform the given bounding box
- */
-const transformBoundingBox = (boundingBox, transforms) => {
-  if (!mat4.isIdentity(transforms)) {
-    vec3.transform(boundingBox[0], boundingBox[0], transforms)
-    vec3.transform(boundingBox[1], boundingBox[1], transforms)
-
-    // we now have a new 2 vectors:  [v1,v2] => [ [x1,y1,z1],  [x2,y2,z2] ]
-    // transform can move bounding box corner in such way that it is no longer true that
-    //  - v1 = [min(x1,x2),min(y1,y2),min(z1,z2)]
-    //  - v2 = [max(x1,x2),max(y1,y2),max(z1,z2)]
-    fixBound(0, ...boundingBox) // swap x, if higher value is in first vector
-    fixBound(1, ...boundingBox) // swap y, if higher value is in first vector
-    fixBound(2, ...boundingBox) // swap z, if higher value is in first vector
-  }
   return boundingBox
 }
 

package/src/operations/expansions/expand.js

@@ -10,6 +10,8 @@ const expandPath2 = require('./expandPath2')
 
 /**
  * Expand the given geometry using the given options.
+ * Both interal and external space is expanded for 2D and 3D shapes.
+ *
  * Note: Contract is expand using a negative delta.
  * @param {Object} options - options for expand
  * @param {Number} [options.delta=1] - delta (+/-) of expansion

package/src/operations/expansions/offset.js

@@ -8,6 +8,7 @@ const offsetPath2 = require('./offsetPath2')
 
 /**
  * Create offset geometry from the given geometry using the given options.
+ * Offsets from internal and external space are created.
  * @param {Object} options - options for offset
  * @param {Float} [options.delta=1] - delta of offset (+ to exterior, - from interior)
  * @param {String} [options.corners='edge'] - type of corner to create after offseting; edge, chamfer, round

package/src/operations/extrusions/extrudeRectangular.js

@@ -17,7 +17,8 @@ const extrudeRectangularGeom2 = require('./extrudeRectangularGeom2')
  * @alias module:modeling/extrusions.extrudeRectangular
  *
  * @example
- * let mywalls = extrudeRectangular({offset: [0,0,10]}, square())
+ * let mywalls = extrudeRectangular({size: 1, height: 3}, square({size: 20}))
+ * let mywalls = extrudeRectangular({size: 1, height: 300, twistAngle: Math.PI}, square({size: 20}))
  */
 const extrudeRectangular = (options, ...objects) => {
   const defaults = {

package/src/primitives/ellipse.js

@@ -7,7 +7,7 @@ const geom2 = require('../geometries/geom2')
 const { isGTE, isNumberArray } = require('./commonChecks')
 
 /**
- * Construct an axis-aligned ellispe in two dimensional space.
+ * Construct an axis-aligned ellipse in two dimensional space.
  * @see https://en.wikipedia.org/wiki/Ellipse
  * @param {Object} [options] - options for construction
  * @param {Array} [options.center=[0,0]] - center of ellipse

package/src/primitives/triangle.js

@@ -125,7 +125,7 @@ const createTriangle = (A, B, C, a, b, c) => {
  * @alias module:modeling/primitives.triangle
  *
  * @example
- * let myshape = triangle({type: 'AAS', values: [values: [degToRad(62), degToRad(35), 7]})
+ * let myshape = triangle({type: 'AAS', values: [degToRad(62), degToRad(35), 7]})
  */
 const triangle = (options) => {
   const defaults = {

package/src/utils/insertSorted.js

@@ -1,4 +1,5 @@
 /**
+ * Insert the given element into the give array using the compareFunction.
  * @alias module:modeling/utils.insertSorted
  */
 const insertSorted = (array, element, comparefunc) => {