Doodle3D-Slicer/README.md

63 lines
1.9 KiB
Markdown
Raw Normal View History

2015-07-26 15:34:57 +02:00
# Doodle3D-Slicer
2015-07-26 15:34:57 +02:00
JavaScript gcode slicer, Intended to use with the Doodle3D WiFi-Box
2015-07-26 15:34:57 +02:00
# Usage
```javascript
2017-07-18 12:38:03 +02:00
import * as THREE from 'three';
import { defaultSettings, sliceGeometry } from 'Doodle3D/Doodle3D-Slicer';
2015-07-26 15:34:57 +02:00
2017-07-18 12:43:27 +02:00
const settings = {
2017-12-24 14:46:00 +01:00
...defaultSettings.default,
2017-07-18 12:43:27 +02:00
...defaultSettings.material.pla,
...defaultSettings.printer.ultimaker2go,
...defaultSettings.quality.high
};
2015-07-26 15:34:57 +02:00
2017-07-07 18:11:37 +02:00
const geometry = new THREE.TorusGeometry(20, 10, 30, 30).clone();
2015-07-26 15:34:57 +02:00
const gcode = await sliceGeometry(settings, geometry);
```
# API
**Settings**
```javascript
import { defaultSettings } from 'Doodle3D/Doodle3D-Slicer';
const settings = {
2017-12-24 14:46:00 +01:00
...defaultSettings.default,
...defaultSettings.material.pla,
...defaultSettings.printer.ultimaker2go,
...defaultSettings.quality.high
};
```
Create settings object to be used by the slicer
**Slice Mesh**
```javascript
import { sliceMesh } from 'Doodle3D/Doodle3D-Slicer';
GCode: String = sliceMesh(settings: Object, mesh: THREE.Mesh, [sync: Boolean = false, onProgress: Func ])
2015-07-26 15:34:57 +02:00
```
Slice function that accepts Meshes
- Settings: settings object (see [settings](#settings))
- Mesh: THREE.Mesh instance that contains the geometry
- Sync: determines if the slicing progress will be sync (blocking) or async (non-blocking). A webworker is used to slice async
- onProgress: progress callback
**Slice Geometry**
```javascript
import { sliceGeometry } from 'Doodle3D/Doodle3D-Slicer';
GCode: String = sliceGeometry(settings: Object, geometry: THREE.Geometry | THREE.BufferGeometry, [matrix: THREE.Matrix, sync: Boolean = false, onProgress: Func ])
```
Slice function that accepts Geometry
- Settings: settings object (see [settings](#settings))
- Geometry: THREE.Geometry instance
- matrix: matrix that can control the scale, rotation and position of the model
- Sync: determines if the slicing progress will be sync (blocking) or async (non-blocking). A webworker is used to slice async
- onProgress: progress callback