Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@jscad/3mf-deserializer

Package Overview
Dependencies
Maintainers
3
Versions
1
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@jscad/3mf-deserializer

3MF Deserializer for JSCAD

  • 3.0.0-alpha.0
  • alpha
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
4
increased by100%
Maintainers
3
Weekly downloads
 
Created
Source

@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 EntityJSCAD GeometryNotes
objectto geom3conversion of mesh with vertices and triangles
basematerialsRGBA colorsconvertion of materials found on objects and triangles
colorgroupsRGBA colorsconvertion 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)

Keywords

FAQs

Package last updated on 09 Oct 2023

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc