@jscad/amf-deserializer

2.3.7 • Public • Published

@jscad/amf-deserializer

Deserializer of AMF data to JSCAD geometries

NPM version NPM downloads Build Status Stability License

User Group Lerna JavaScript Style Guide

Backers Sponsors

Open Collective

Overview

This deserializer converts raw AMF formatted data (XML) to JSCAD scripts or geometries.

NOTE: At this time, only XML files are supported, so unzip the original AMF file before proceeding.

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

AMF Entity JSCAD Geometry Notes
mesh to geom3 conversion of vertices and volumes
color color color found at object, volume, and triangle are converted

Also, if the 'USEMTL' (material) matches the name of a CSS3 color then the color is applied to the geometry.

Table of Contents

Installation

npm install @jscad/amf-deserializer

Usage

const amfDeSerializer = require('@jscad/amf-deserializer')

const rawData = fs.readFileSync('PATH/TO/file.amf')
const jscadScript = amfDeSerializer.deserialize(rawData, 'file.amf', {output: 'jscad'})

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/amf-deserializer

Weekly Downloads

1,162

Version

2.3.7

License

MIT

Unpacked Size

42.3 kB

Total Files

13

Last publish

Collaborators

  • platypii
  • z3dev
  • mister-jscad
  • simon_clark