@jscad/obj-deserializer

OBJ Deserializer for JSCAD

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
1,713112Jun 19, 2021Mar 10, 2013Minified + gzip package size for @jscad/obj-deserializer in KB

Readme

@jscad/obj-deserializer

Deserializer for OBJ 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 OBJ formatted data (files) to JSCAD scripts or geometries.

NOTE: At this time, only ASCII OBJ files are supported. BINARY OBJ files are not supported.

This deserializer converts only what is supported by JSCAD libraries. Full document conversion is NOT supported, so don't even try. However, conversion of the following OBJ commands are possible:

OBJ Command JSCAD Geometry Notes
V to geom3 vertices of polygons
F to geom3 indexes to polygon vertices
G to geom3 grouping of V and F to create polygons and geometry

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

Usage

const objDeserializer = require('@jscad/obj-deserializer')

const rawData = fs.readFileSync('PATH/TO/file.obj')
const geometries = objDeserializer.deserialize(rawData, 'file.obj', {output: 'geometry'})

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

  • 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)

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.