@jscad/stl-serializer 2.1.20 → 3.0.1-alpha.0

package/rollup.config.js

@@ -0,0 +1,25 @@
+import banner from 'rollup-plugin-banner'
+import { nodeResolve } from '@rollup/plugin-node-resolve'
+import terser from '@rollup/plugin-terser'
+
+export default {
+  input: 'src/index.js',
+
+  output: [
+    {
+      file: 'dist/jscad-stl-serializer.min.js',
+      format: 'umd',
+      name: 'jscadStlSerializer'
+    },
+    {
+      file: 'dist/jscad-stl-serializer.es.js',
+      format: 'es'
+    }
+  ],
+
+  plugins: [
+    nodeResolve(),
+    banner('<%= pkg.description %>\n@module <%= pkg.name %>\n@version <%= pkg.version %>\n@license <%= pkg.license %>'),
+    terser({ compress: { module: true }, mangle: false, format: { comments: 'some' } })
+  ]
+}

package/{index.js → src/index.js}

@@ -1,21 +1,3 @@
-/*
-JSCAD Geometry to STL Format Serialization
-
-## License
-
-Copyright (c) 2018-2019 JSCAD Organization https://github.com/jscad
-
-All code released under MIT license
-
-Notes:
-1) geom2 conversion to:
-     none
-2) geom3 conversion to:
-     STL mesh
-3) path2 conversion to:
-     none
-*/
-
 /**
  * Serializer of JSCAD geometries to STL mesh.
  * @module io/stl-serializer
@@ -23,17 +5,18 @@ Notes:
  * const { serializer, mimeType } = require('@jscad/stl-serializer')
  */
 
-const { geometries, modifiers } = require('@jscad/modeling')
+import { generalize, geom3 } from '@jscad/modeling'
 
-const { flatten, toArray } = require('@jscad/array-utils')
+import { flatten, toArray } from '@jscad/array-utils'
 
-const { serializeBinary } = require('./CSGToStlb')
-const { serializeText } = require('./CSGToStla')
+import { serializeBinary } from './serializeBinary.js'
+import { serializeText } from './serializeText.js'
 
-const mimeType = 'application/sla'
+const mimeType = 'model/stl'
 
 /**
  * Serialize the give objects to STL mesh.
+ * @see http://en.wikipedia.org/wiki/STL_%28file_format%29#Binary_STL
  * @param {Object} options - options for serialization
  * @param {String} [options.binary='true'] - target format for data
  * @param {Function} [options.statusCallback] - call back function for progress ({ progress: 0-100 })
@@ -41,7 +24,7 @@ const mimeType = 'application/sla'
  * @returns {Array} serialized contents with one STL mesh (either string or binary data)
  * @alias module:io/stl-serializer.serialize
  * @example
- * const geometry = primitives.cube()
+ * const geometry = cube()
  * const stlData = serializer({binary: false}, geometry)
  */
 const serialize = (options, ...objects) => {
@@ -54,18 +37,18 @@ const serialize = (options, ...objects) => {
   objects = flatten(objects)
 
   // convert only 3D geometries
-  let objects3d = objects.filter((object) => geometries.geom3.isA(object))
+  let objects3d = objects.filter((object) => geom3.isA(object))
 
   if (objects3d.length === 0) throw new Error('only 3D geometries can be serialized to STL')
   if (objects.length !== objects3d.length) console.warn('some objects could not be serialized to STL')
 
   // convert to triangles
-  objects3d = toArray(modifiers.generalize({ snap: true, triangulate: true }, objects3d))
+  objects3d = toArray(generalize({ snap: true, triangulate: true }, objects3d))
 
   return options.binary ? serializeBinary(objects3d, options) : serializeText(objects3d, options)
 }
 
-module.exports = {
+export {
   mimeType,
   serialize
 }

package/{CSGToStlb.js → src/serializeBinary.js}

@@ -1,9 +1,9 @@
-const { geometries } = require('@jscad/modeling')
+import { geom3, poly3 } from '@jscad/modeling'
 
 // see http://en.wikipedia.org/wiki/STL_%28file_format%29#Binary_STL
 
 // objects must be an array of 3D geometries
-const serializeBinary = (objects, options) => {
+export const serializeBinary = (objects, options) => {
   options.statusCallback && options.statusCallback({ progress: 0 })
 
   // first check if the host is little-endian:
@@ -18,7 +18,7 @@ const serializeBinary = (objects, options) => {
   let numtriangles = 0
   let numpolygons = 0
   objects.forEach((object, i) => {
-    const polygons = geometries.geom3.toPolygons(object)
+    const polygons = geom3.toPolygons(object)
     polygons.forEach((polygon) => {
       const numvertices = polygon.vertices.length
       const thisnumtriangles = (numvertices >= 3) ? numvertices - 2 : 0
@@ -53,11 +53,11 @@ const serializeBinary = (objects, options) => {
   let byteoffset = 0
 
   objects.forEach((object) => {
-    const polygons = geometries.geom3.toPolygons(object)
+    const polygons = geom3.toPolygons(object)
     polygons.forEach((polygon, index) => {
       const vertices = polygon.vertices
       const numvertices = vertices.length
-      const plane = geometries.poly3.plane(polygon)
+      const plane = poly3.plane(polygon)
       for (let i = 0; i < numvertices - 2; i++) {
         triangleFloat32array[0] = plane[0]
         triangleFloat32array[1] = plane[1]
@@ -82,7 +82,3 @@ const serializeBinary = (objects, options) => {
   options.statusCallback && options.statusCallback({ progress: 100 })
   return [headerarray.buffer, ar1.buffer, allTrianglesBuffer] // 'blobable array'
 }
-
-module.exports = {
-  serializeBinary
-}

package/{CSGToStla.js → src/serializeText.js}

@@ -1,7 +1,7 @@
-const { geometries } = require('@jscad/modeling')
+import { geom3, poly3 } from '@jscad/modeling'
 
 // objects must be an array of 3D geomertries (with polygons)
-const serializeText = (objects, options) => {
+export const serializeText = (objects, options) => {
   options.statusCallback && options.statusCallback({ progress: 0 })
 
   const result = `solid JSCAD
@@ -23,7 +23,7 @@ const convertToStl = (objects, options) => {
 
 const convertToFacets = (object, options) => {
   const result = []
-  const polygons = geometries.geom3.toPolygons(object)
+  const polygons = geom3.toPolygons(object)
   polygons.forEach((polygon, i) => {
     result.push(convertToFacet(polygon))
   })
@@ -40,7 +40,7 @@ const convertToFacet = (polygon) => {
     // STL requires triangular polygons. If our polygon has more vertices, create multiple triangles:
     const firstVertexStl = vertextoStlString(polygon.vertices[0])
     for (let i = 0; i < polygon.vertices.length - 2; i++) {
-      const facet = `facet normal ${vector3DtoStlString(geometries.poly3.plane(polygon))}
+      const facet = `facet normal ${vector3DtoStlString(poly3.plane(polygon))}
 outer loop
 ${firstVertexStl}
 ${vertextoStlString(polygon.vertices[i + 1])}
@@ -52,7 +52,3 @@ endfacet`
   }
   return result.join('\n')
 }
-
-module.exports = {
-  serializeText
-}

package/tests/ascii.test.js

@@ -1,16 +1,16 @@
-const test = require('ava')
+import test from 'ava'
 
-const { primitives, transforms } = require('@jscad/modeling')
+import { cube, translate } from '@jscad/modeling'
 
-const serializer = require('../index.js')
+import { serialize } from '../src/index.js'
 
 test('serialize objects to stl (ascii)', (t) => {
-  const object1 = primitives.cube({ size: 10 }) // .setColor([0, 0, 1, 1])
-  const observed1 = serializer.serialize({ binary: false }, object1)
+  const object1 = cube({ size: 10 }) // .setColor([0, 0, 1, 1])
+  const observed1 = serialize({ binary: false }, object1)
   t.deepEqual(observed1, [expected1])
 
-  const object2 = transforms.translate([5, 5, 5], object1) // .setColor([1, 0, 0, 1])
-  const observed2 = serializer.serialize({ binary: false }, object1, object2)
+  const object2 = translate([5, 5, 5], object1) // .setColor([1, 0, 0, 1])
+  const observed2 = serialize({ binary: false }, object1, object2)
   t.deepEqual(observed2, [expected2])
 })
 

package/tests/binary.test.js

@@ -1,12 +1,12 @@
-const test = require('ava')
+import test from 'ava'
 
-const { primitives } = require('@jscad/modeling')
+import { cube } from '@jscad/modeling'
 
-const serializer = require('../index.js')
+import { serialize } from '../src/index.js'
 
 test('serialize objects to stl (binary)', (t) => {
-  const object1 = primitives.cube()
-  const observed = serializer.serialize({ binary: true }, object1)
+  const object1 = cube()
+  const observed = serialize({ binary: true }, object1)
 
   // TODO: VERY shallow testing ... improve
   t.deepEqual(observed[0].byteLength, 80)

package/tests/progress.test.js

@@ -1,16 +1,16 @@
-const test = require('ava')
+import test from 'ava'
 
-const { primitives } = require('@jscad/modeling')
+import { cube } from '@jscad/modeling'
 
-const serializer = require('../index.js')
+import { serialize } from '../src/index.js'
 
 test('progress status callback', (t) => {
-  const input = primitives.cube()
+  const input = cube()
   const progresses = []
   const statusCallback = (statusObj) => {
     progresses.push(statusObj.progress)
   }
-  const observed = serializer.serialize({ statusCallback: statusCallback }, input)
+  const observed = serialize({ statusCallback: statusCallback }, input)
 
   t.is(observed.length, 3)
   t.deepEqual(0, progresses[0])