Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/OpenWebCAD/node-occ

build BREP Solids with OpenCascade and NodeJS - 3D Modeling
https://github.com/OpenWebCAD/node-occ

3d 3d-models boundary-model cad computer-aided-design constructive-solid-geometries csg iges nodejs opencascade step threejs

Last synced: about 2 months ago
JSON representation

build BREP Solids with OpenCascade and NodeJS - 3D Modeling

Awesome Lists containing this project

README

        

# node-occ

OpenCascade NodeJS package for solid modeling.

This package provides _solid construction_ to NodeJS.
It provides a simple yet powerful javascript api to construct 3D geometry models.

This project comes with a set of V8 wrappers around OpenCascade API and a sample web application.

[![Build status](https://ci.appveyor.com/api/projects/status/s5eaux89v2c0wmu4?svg=true)](https://ci.appveyor.com/project/erossignon/node-occ-6ktv4)

### quick example

```javascript
var occ = require("node-occ").occ;

// construct a box
var box = occ.makeBox([0, 0, 0], [100, 100, 50]);

// construct a cylinder
var cyl = occ.makeCylinder([50, 50, -10], [50, 50, 60], 40);

// cut the box with cylinder
box = occ.cut(box, cyl);

// save result to a STEP file
occ.writeSTEP("somefile.step", box);
```

### video

node occ

### list of features

- creation of basic shapes ( box, cylinder , cone , torus )
- boolean operation ( fuse , common , cut )
- features ( draftAngle)
- solid properties ( faces, edges, vertices, area , volume )
- import export ( STEP BREP )

### sample web application

[node-occ-sample](https://github.com/erossignon/node-occ-sample): sample nodejs/express REST API server to build solid , based on threejs

## installing node-occ from npm

```
$npm install node-occ
```

## building node-occ from source : prerequisites

#### on (linux Ubuntu

(use nodejs 12 or 14)

```bash
# installing nodejs and gyp utility to build extensions
sudo apt-get install nodejs npm
sudo npm install node-pre-gyp -g
sudo npm install mocha@7 -g

#installing cmake
sudo apt-get install cmake cmake-curses-gui g++ build-essential libtbb2

# ------------------------------------
git clone --recursive https://github.com/erossignon/node-occ.git
cd node-occ

# download prebuild OpenCascade Library and header files
bash ./prepare_node.sh

#
export OCCT_PACKAGE=occt-7.2.0
export LD_LIBRARY_PATH=`pwd`/${OCCT_PACKAGE}/lib:$LD_LIBRARY_PATH
npm install --build-from-source

# verify that everything is working OK
make test
```

### on windows

- follow the tutorial in the [wiki](https://github.com/erossignon/node-occ/wiki)

## dependencies:

- threejs : https://github.com/mrdoob/three.js

## acknowledgment:

- OpenCascade : http://www.opencascade.org
- occmodel : https://github.com/tenko/occmodel
- ShapeSmith : https://github.com/bjnortier/shapesmith

## MIT License

Copyright © 2012-2022 E. Rossignon
Copyright © 2022 Sterfive SAS

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.