@jscad/x3d-serializer 2.4.4 → 3.0.0-alpha.0

package/src/index.js

@@ -1,20 +1,8 @@
-/*
-JSCAD Object to X3D (XML) Format Serialization
-
-## License
+import { generalize, geom2, geom3, path2, poly2, poly3 } from '@jscad/modeling'
 
-Copyright (c) 2018-2022 JSCAD Organization https://github.com/jscad
+import { flatten } from '@jscad/array-utils'
 
-All code released under MIT license
-
-Notes:
-1) geom2 conversion to:
-     Polyline2D with lineSegment and Color
-2) geom3 conversion to:
-     IndexedTriangleSet with Coordinates and Colors
-3) path2 conversion to:
-     Polyline2D with lineSegment and Color
-*/
+import { stringify } from '@jscad/io-utils'
 
 /**
  * Serializer of JSCAD geometries to X3D source data (XML).
@@ -31,23 +19,14 @@ Notes:
  * const { serializer, mimeType } = require('@jscad/x3d-serializer')
  */
 
-const { geometries, modifiers } = require('@jscad/modeling')
-const { geom2, geom3, path2, poly2, poly3 } = geometries
-
-const { flatten } = require('@jscad/array-utils')
-
-const stringify = require('onml/lib/stringify')
-
-// http://www.web3d.org/x3d/content/X3dTooltips.html
-// http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Meshes
-// https://x3dgraphics.com/examples/X3dForWebAuthors/Chapter13GeometryTrianglesQuadrilaterals/
-
 const mimeType = 'model/x3d+xml'
+const defNames = new Map()
 
 /**
  * Serialize the give objects to X3D elements (XML).
  * @param {Object} options - options for serialization, REQUIRED
  * @param {Array} [options.color=[0,0,1,1]] - default color for objects
+ * @param {Number} [options.shininess=8/256] - x3d shininess for specular highlights
  * @param {Boolean} [options.smooth=false] - use averaged vertex normals
  * @param {Number} [options.decimals=1000] - multiplier before rounding to limit precision
  * @param {Boolean} [options.metadata=true] - add metadata to 3MF contents, such at CreationDate
@@ -63,6 +42,7 @@ const mimeType = 'model/x3d+xml'
 const serialize = (options, ...objects) => {
   const defaults = {
     color: [0, 0, 1, 1.0], // default colorRGBA specification
+    shininess: 8 / 256,
     smooth: false,
     decimals: 1000,
     metadata: true,
@@ -117,7 +97,7 @@ const convertObjects = (objects, options) => {
 
     if (geom3.isA(object)) {
       // convert to triangles
-      object = modifiers.generalize({ snap: true, triangulate: true }, object)
+      object = generalize({ snap: true, triangulate: true }, object)
       const polygons = geom3.toPolygons(object)
       if (polygons.length > 0) {
         shapes.push(convertGeom3(object, options))
@@ -141,7 +121,7 @@ const convertObjects = (objects, options) => {
 const convertPath2 = (object, options) => {
   const points = path2.toPoints(object).slice()
   if (points.length > 1 && object.isClosed) points.push(points[0])
-  const shape = ['Shape', {}, convertPolyline2D(poly2.create(points), options)]
+  const shape = ['Shape', shapeAttributes(object), convertPolyline2D(poly2.create(points), options)]
   if (object.color) {
     shape.push(convertAppearance(object, 'emissiveColor', options))
   }
@@ -156,7 +136,7 @@ const convertGeom2 = (object, options) => {
   const group = ['Group', {}]
   outlines.forEach((outline) => {
     if (outline.length > 1) outline.push(outline[0]) // close the outline for conversion
-    const shape = ['Shape', {}, convertPolyline2D(poly2.create(outline), options)]
+    const shape = ['Shape', shapeAttributes(object), convertPolyline2D(poly2.create(outline), options)]
     if (object.color) {
       shape.push(convertAppearance(object, 'emissiveColor', options))
     }
@@ -165,11 +145,29 @@ const convertGeom2 = (object, options) => {
   return group
 }
 
+/*
+ * generate attributes for Shape node
+ */
+
+const shapeAttributes = (object, attributes = {}) => {
+  if (object.id) {
+    Object.assign(attributes, { DEF: checkDefName(object.id) })
+  }
+  return attributes
+}
+
+const checkDefName = (defName) => {
+  const count = defNames.get(defName) || 0
+  defNames.set(defName, count + 1)
+  if (count > 0) console.warn(`Warning: object.id set as DEF but not unique. ${defName} set ${count + 1} times.`)
+  return defName
+}
+
 /*
  * Convert the given object (poly2) to X3D source
  */
 const convertPolyline2D = (object, options) => {
-  const lineSegments = object.vertices.map((p) => `${p[0]} ${p[1]}`).join(' ')
+  const lineSegments = object.points.map((p) => `${p[0]} ${p[1]}`).join(' ')
   return ['Polyline2D', { lineSegments }]
 }
 
@@ -180,14 +178,20 @@ const convertAppearance = (object, colorField, options) => {
   const colorRGB = object.color.slice(0, 3)
   const color = colorRGB.join(' ')
   const transparency = roundToDecimals(1.0 - object.color[3], options)
-  return ['Appearance', ['Material', { [colorField]: color, transparency }]]
+  const materialFields = { [colorField]: color, transparency }
+  if (colorField === 'diffuseColor') {
+    Object.assign(
+      materialFields,
+      { specularColor: '0.2 0.2 0.2', shininess: options.shininess })
+  }
+  return ['Appearance', ['Material', materialFields]]
 }
 
 /*
  * Convert the given object (geom3) to X3D source
  */
 const convertGeom3 = (object, options) => {
-  const shape = ['Shape', {}, convertMesh(object, options)]
+  const shape = ['Shape', shapeAttributes(object), convertMesh(object, options)]
   let appearance = ['Appearance', {}, ['Material']]
   if (object.color) {
     appearance = convertAppearance(object, 'diffuseColor', options)
@@ -221,7 +225,7 @@ const convertToTriangles = (object, options) => {
   polygons.forEach((poly) => {
     const firstVertex = poly.vertices[0]
     for (let i = poly.vertices.length - 3; i >= 0; i--) {
-      const triangle = poly3.fromPoints([
+      const triangle = poly3.create([
         firstVertex,
         poly.vertices[i + 1],
         poly.vertices[i + 2]
@@ -285,7 +289,7 @@ const polygons2coordinates = (polygons, options) => {
   return [indexList, pointList, colorList]
 }
 
-module.exports = {
-  serialize,
-  mimeType
+export {
+  mimeType,
+  serialize
 }

package/tests/geom2ToX3D.test.js

@@ -1,13 +1,13 @@
-const test = require('ava')
+import test from 'ava'
 
-const countOf = require('../../test/helpers/countOf')
+import { countOf } from '../../test/helpers/countOf.js'
 
-const { colors, geometries, primitives } = require('@jscad/modeling')
+import { colorize, geom2, rectangle } from '@jscad/modeling'
 
-const { serialize } = require('../src/index.js')
+import { serialize } from '../src/index.js'
 
 test('serialize 2D geometry to X3D Polyline2D', (t) => {
-  const shape1 = geometries.geom2.create()
+  const shape1 = geom2.create()
 
   let results = serialize({}, shape1)
   t.is(results.length, 1)
@@ -22,9 +22,9 @@ test('serialize 2D geometry to X3D Polyline2D', (t) => {
   t.is(countOf('Scene', obs), 2)
   t.is(countOf('Group', obs), 1)
 
-  const shape2 = primitives.rectangle()
+  const shape2 = rectangle()
 
-  results = serialize({metadata: false}, shape2)
+  results = serialize({ metadata: false }, shape2)
   t.is(results.length, 1)
 
   obs = results[0]
@@ -39,9 +39,9 @@ test('serialize 2D geometry to X3D Polyline2D', (t) => {
   t.is(countOf('Shape', obs), 2)
   t.is(countOf('Polyline2D', obs), 1)
 
-  const shape3 = colors.colorize([0, 0, 0], shape2)
+  const shape3 = colorize([0, 0, 0], shape2)
 
-  results = serialize({metadata: false}, shape3)
+  results = serialize({ metadata: false }, shape3)
   t.is(results.length, 1)
 
   obs = results[0]
@@ -61,8 +61,7 @@ test('serialize 2D geometry to X3D Polyline2D', (t) => {
   t.is(countOf('diffuseColor', obs), 0)
   t.is(countOf('emissiveColor', obs), 1)
 
-
-  results = serialize({metadata: false}, shape2, shape3)
+  results = serialize({ metadata: false }, shape2, shape3)
   t.is(results.length, 1)
 
   obs = results[0]
@@ -80,6 +79,6 @@ test('serialize 2D geometry to X3D Polyline2D', (t) => {
   t.is(countOf('Appearance', obs), 2)
   t.is(countOf('Material', obs), 1)
   t.is(countOf('diffuseColor', obs), 0)
+  t.is(countOf('specularColor', obs), 0)
   t.is(countOf('emissiveColor', obs), 1)
 })
-

package/tests/geom3ToX3D.test.js

@@ -1,15 +1,15 @@
-const test = require('ava')
+import test from 'ava'
 
-const countOf = require('../../test/helpers/countOf')
+import { countOf } from '../../test/helpers/countOf.js'
 
-const { colors, geometries, primitives, transforms } = require('@jscad/modeling')
+import { center, colorize, cube, geom3 } from '@jscad/modeling'
 
-const serializer = require('../src/index.js')
+import { serialize } from '../src/index.js'
 
 test('serialize 3D geometry to X3D IndexedTriangleSet', (t) => {
-  const geom1 = geometries.geom3.create()
+  const g1 = geom3.create()
 
-  let results = serializer.serialize({}, geom1)
+  let results = serialize({}, g1)
   t.is(results.length, 1)
 
   let obs = results[0]
@@ -21,9 +21,9 @@ test('serialize 3D geometry to X3D IndexedTriangleSet', (t) => {
   t.is(countOf('Created by JSCAD', obs), 1)
   t.is(countOf('Scene', obs), 2)
 
-  const geom2 = primitives.cube()
+  const g2 = cube()
 
-  results = serializer.serialize({metadata: false}, geom2)
+  results = serialize({ metadata: false }, g2)
   t.is(results.length, 1)
 
   obs = results[0]
@@ -36,13 +36,15 @@ test('serialize 3D geometry to X3D IndexedTriangleSet', (t) => {
   t.is(countOf('Scene', obs), 2)
   t.is(countOf('Transform', obs), 2)
   t.is(countOf('Shape', obs), 2)
+  t.is(countOf('DEF', obs), 0)
   t.is(countOf('IndexedTriangleSet', obs), 2)
   t.is(countOf('Coordinate', obs), 1)
   t.is(countOf('Color', obs), 1)
 
-  const geom3 = colors.colorize([0.5, 1, 0.5, 1.0], transforms.center({ relativeTo: [5, 5, 5] }, primitives.cube()))
+  const g3 = colorize([0.5, 1, 0.5, 1.0], center({ relativeTo: [5, 5, 5] }, cube()))
+  g2.id = g3.id = 'g23'
 
-  results = serializer.serialize({metadata: false}, geom2, geom3)
+  results = serialize({ metadata: false }, g2, g3)
   t.is(results.length, 1)
 
   obs = results[0]
@@ -54,6 +56,7 @@ test('serialize 3D geometry to X3D IndexedTriangleSet', (t) => {
   t.is(countOf('Created by JSCAD', obs), 1)
   t.is(countOf('Scene', obs), 2)
   t.is(countOf('Shape', obs), 4)
+  t.is(countOf('DEF', obs), 2)
   t.is(countOf('IndexedTriangleSet', obs), 4)
   t.is(countOf('Coordinate', obs), 2)
   // for color
@@ -61,7 +64,7 @@ test('serialize 3D geometry to X3D IndexedTriangleSet', (t) => {
   t.is(countOf('Appearance', obs), 4)
   // for RGB
   t.is(countOf('diffuseColor="0.5 1 0.5"', obs), 1)
+  t.is(countOf('specularColor', obs), 1)
   // for facets
   t.is(countOf('normalPerVertex="false"', obs), 2)
-  
-})
+})

package/tests/path2ToX3D.test.js

@@ -1,15 +1,15 @@
-const test = require('ava')
+import test from 'ava'
 
-const countOf = require('../../test/helpers/countOf')
+import { countOf } from '../../test/helpers/countOf.js'
 
-const { colors, geometries, primitives } = require('@jscad/modeling')
+import { arc, colorize, path2 } from '@jscad/modeling'
 
-const { serialize } = require('../src/index.js')
+import { serialize } from '../src/index.js'
 
 test('serialize 2D path to X3D Polyline2D', (t) => {
-  const path1 = geometries.path2.create()
+  const p1 = path2.create()
 
-  let results = serialize({}, path1)
+  let results = serialize({}, p1)
   t.is(results.length, 1)
 
   let obs = results[0]
@@ -20,9 +20,9 @@ test('serialize 2D path to X3D Polyline2D', (t) => {
   t.is(countOf('content', obs), 3)
   t.is(countOf('Created by JSCAD', obs), 1)
 
-  const path2 = primitives.arc({ center: [5, 5], endAngle: 45, segments: 16 })
+  const p2 = arc({ center: [5, 5], endAngle: 45, segments: 16 })
 
-  results = serialize({metadata: false}, path2)
+  results = serialize({ metadata: false }, p2)
   t.is(results.length, 1)
 
   obs = results[0]
@@ -33,9 +33,9 @@ test('serialize 2D path to X3D Polyline2D', (t) => {
   t.is(countOf('Polyline2D', obs), 1)
   t.is(countOf('lineSegments', obs), 1)
 
-  const path3 = colors.colorize([0, 0, 0], path2)
+  const p3 = colorize([0, 0, 0], p2)
 
-  results = serialize({metadata: false}, path2, path3)
+  results = serialize({ metadata: false }, p2, p3)
   t.is(results.length, 1)
 
   obs = results[0]
@@ -50,6 +50,4 @@ test('serialize 2D path to X3D Polyline2D', (t) => {
   t.is(countOf('Material', obs), 1)
   t.is(countOf('diffuseColor', obs), 0)
   t.is(countOf('emissiveColor', obs), 1)
-
 })
-