@jscad/3mf-deserializer

3.0.0-alpha.0 • Public • Published

@jscad/3mf-deserializer

Deserializer of 3MF data to JSCAD geometries

NPM version NPM downloads Build Status Stability License

User Group lerna--lite JavaScript Style Guide

Backers Sponsors

Open Collective

Overview

This deserializer converts 3MF data (OPC archives or XML strings) to JSCAD scripts or geometries.

This deserializer converts only what is supported by JSCAD libraries. Full document conversion of models and materials are NOT supported, so don't even try. However, conversion of 3MF objects and materials are possible:

3MF Entity JSCAD Geometry Notes
object to geom3 conversion of mesh with vertices and triangles
basematerials RGBA colors convertion of materials found on objects and triangles
colorgroups RGBA colors convertion of materials found on objects and triangles

Also, many attributes as found on objects are transferred to the geometry, e.g. id, type, etc.

Table of Contents

Installation

npm install @jscad/3mf-deserializer

Usage

// note: javascript variable names cannot start with a number
import { deserializer } from '@jscad/3mf-deserializer'

const rawData = fs.readFileSync('PATH/TO/file.3mf')
const jscadScript = deserialize({output: 'script'}, rawData)
// OR
const geometries = deserialize({output: 'geometry'}, rawData)

Contributing

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 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.

License

The MIT License (MIT) (unless specified otherwise)

Package Sidebar

Install

npm i @jscad/3mf-deserializer

Weekly Downloads

38

Version

3.0.0-alpha.0

License

MIT

Unpacked Size

372 kB

Total Files

21

Last publish

Collaborators

  • platypii
  • z3dev
  • mister-jscad
  • simon_clark