2.2.5 • Public • Published


Deserializer of X3D data to JSCAD geometries

NPM version NPM downloads Build Status Stability License

User Group Lerna JavaScript Style Guide

Backers Sponsors

Open Collective


This deserializer converts X3D (XML encoded) formatted data (files) to JSCAD scripts or geometries.

X3D Implementation Notes

The X3D XML Coding changes as new releases are published.

This deserializer converts only what is supported by JSCAD libraries. Full document conversion is NOT supported, however conversion of the following X3D entities are possible:

X3D Entity JSCAD Geometry Notes
Arc2D arc 2D shape
ArcClose2D circle 2D shape
Box cuboid 3D shape
Circle2D arc 2D shape
Cone cylinder 3D shape
Cylinder cylinder 3D shape
Disk2D arc or circle 2D shape
ElevationGrid polyhedron 3D mesh
Extrusion extrudeFromSlices 3D mesh BUGGY
IndexedFaceSet polyhedron 3D mesh
IndexedLineSet line 2D shape or 3D shape (UNSUPPORTED)
IndexedQuadSet polyhedron 3D mesh
IndexedTriangleFanSet polyhedron 3D mesh
IndexedTriangleSet polyhedron 3D mesh
IndexedTriangleStripSet polyhedron 3D mesh
LineSet line 2D shape or 3D shape (UNSUPPORTED)
Polyline2D line 2D shape
Polypoint2D TBD
QuadSet polyhedron 3D mesh
Rectangle2D rectangle 2D shape
Sphere sphere 3D shape
TriangleFanSet polyhedron 3D mesh
TriangleSet polyhedron 3D mesh
TriangleSet2D one or more geom2 2D shape
TriangleStripSet polyhedron 3D mesh

UNIT can be changed by a 'unit' statement

  • length (meters * conversionFactor)
  • angle (radians * conversionFactor)

In addition, colors as part of materials are added to geometry. And colors as part of mesh are added to polygons of a geometry.

Finally, there are many applications that can save to X3D formats. All testing is performed with X3D files from Web3D.org, period.

Table of Contents


npm install @jscad/x3d-deserializer


const x3dDeSerializer = require('@jscad/x3d-deserializer')

const rawData = fs.readFileSync('PATH/TO/file.x3d')
const jscadScript = x3dDeSerializer.deserialize({filename: 'file.x3d', output: 'script'}, rawData)


The various JSCAD packages and all source code are part of the JSCAD Organization, and maintained by a group of volunteers. We welcome and encourage anyone to pitch in but please take a moment to read the following guidelines.

  • If you want to submit a bug report please make sure to follow the Reporting Issues guide. Bug reports are accepted as Issues via GitHub.

  • If you want to submit a change or a patch, please read the Contributing Guide. New contributions are accepted as Pull Requests via GitHub.

  • We only accept bug reports and pull requests on GitHub.

  • If you have a question about how to use JSCAD, then please start a conversation at the JSCAD User Group. You might find the answer in the JSCAD.org User Guide.

  • If you have a change or new feature in mind, please start a conversation with the Core Developers and start contributing changes.

Small Note: If editing this README, please conform to the standard-readme specification.


The MIT License (MIT) (unless specified otherwise)

Package Sidebar


Weekly Downloads






Unpacked Size

159 kB

Total Files


Last publish


  • z3dev
  • mister-jscad
  • simon_clark