Have ideas to improve npm?Join in the discussion! »

    @jscad/dxf-deserializer

    2.2.0 • Public • Published

    @jscad/dxf-deserializer

    Deserializer of DXF data to JSCAD scripts or geometries

    GitHub version Build Status

    Overview

    This deserializer converts raw DXF formatted data (files) to JSCAD scripts or geometries. When converting unknown DXF data, converting to JSCAD scripts will provide more information on the converted DXF entities.

    DXF Implementation Notes

    The DXF(tm) file structure changes continously as AutoDesk releases new features and fixes. So, you can imagine that after 20 years, the contents of DXF files are pretty messed up. Expect the worst.

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

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

    DXF Entity JSCAD Geometry Notes
    3DFACE to geom3
    ARC to path2
    CIRCLE to geom2 Start and stop angles are ignored
    ELLIPSE to geom2 Start and stop angles are ignored
    LINE to path2
    LWPOLYLINE to path2 or geom2 Conversion to geom2 if LWPOLYLINE is closed
    MESH to geom3
    POLYLINE (line) to path2 or geom2 Conversion to geom2 if POLYLINE is closed
    POLYLINE (mesh) to geom3
    POLYLINE (face) to geom3

    In addition, colors are converted using the AutoCad 2017 standard color index (256 colors).

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

    Table of Contents

    Installation

    npm install @jscad/dxf-deserializer
    

    Usage

    const dxfDeserializer = require('@jscad/dxf-deserializer')
    
    const rawData = fs.readFileSync('PATH/TO/file.dxf')
    const jscadCode = dxfDeserializer.deserialize(rawData, 'file.dxf', {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 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.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.

    License

    The MIT License (MIT) (unless specified otherwise)

    Install

    npm i @jscad/dxf-deserializer

    DownloadsWeekly Downloads

    36

    Version

    2.2.0

    License

    MIT

    Unpacked Size

    113 kB

    Total Files

    20

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar