Adds support for accessing position and modal state with the toolpath

object

Methods:
* setPosition()
* getPosition()
* setModal()
* getModal()

Author: cheton

README.md

@@ -13,7 +13,11 @@ const Toolpath = require('gcode-toolpath');
 
 const toolpaths = [];
 const gcode = new Toolpath({
-    modal: { // [optional] initial modal state
+    // Initial position (optional)
+    position: { x: 0, y: 0, z: 0 },
+
+    // Initial modal state (optional)
+    modal: {
         motion: 'G0', // G0, G1, G2, G3, G38.2, G38.3, G38.4, G38.5, G80
         wcs: 'G54', // G54, G55, G56, G57, G58, G59
         plane: 'G17', // G17: xy-plane, G18: xz-plane, G19: yz-plane
@@ -25,6 +29,7 @@ const gcode = new Toolpath({
         coolant: 'M9', // M7, M8, M9
         tool: 0
     },
+
     // @param {object} modal The modal object.
     // @param {object} v1 A 3D vector of the start point.
     // @param {object} v2 A 3D vector of the end point.
@@ -33,6 +38,7 @@ const gcode = new Toolpath({
         const tool = modal.tool;
         toolpaths.push({ motion: motion, tool: tool, v1: v1, v2: v2 });
     },
+
     // @param {object} modal The modal object.
     // @param {object} v1 A 3D vector of the start point.
     // @param {object} v2 A 3D vector of the end point.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "gcode-toolpath",
-  "version": "2.0.1",
+  "version": "2.1.0",
   "description": "G-code Toolpath Generator",
   "author": "Cheton Wu <cheton@gmail.com>",
   "homepage": "https://github.com/cncjs/gcode-toolpath",

src/Toolpath.js

@@ -69,6 +69,7 @@ class Toolpath {
         // M7, M8, M9
         coolant: 'M9', // 'M7', 'M8', 'M7,M8', or 'M9'
 
+        // Tool Select
         tool: 0
     };
 
@@ -559,11 +560,25 @@ class Toolpath {
     };
 
     // @param {object} [options]
-    // @param {object} [options.modalState]
+    // @param {object} [options.position]
+    // @param {object} [options.modal]
     // @param {function} [options.addLine]
     // @param {function} [options.addArcCurve]
     constructor(options) {
-        const { modal, addLine = noop, addArcCurve = noop } = { ...options };
+        const {
+            modal,
+            position,
+            addLine = noop,
+            addArcCurve = noop
+        } = { ...options };
+
+        // Position
+        if (position) {
+            const { x, y, z } = { ...position };
+            this.setPosition(x, y, z);
+        }
+
+        // Modal
         const nextModal = {};
         Object.keys({ ...modal }).forEach(key => {
             if (!Object.prototype.hasOwnProperty.call(this.modal, key)) {
@@ -572,9 +587,20 @@ class Toolpath {
             nextModal[key] = modal[key];
         });
         this.setModal(nextModal);
+
         this.fn = { addLine, addArcCurve };
 
-        return new Interpreter({ handlers: this.handlers });
+        const interpreter = new Interpreter({ handlers: this.handlers });
+        interpreter.setPosition = (...pos) => {
+            return this.setPosition(...pos);
+        };
+        interpreter.getPosition = () => ({ ...this.position });
+        interpreter.setModal = (modal) => {
+            return this.setModal(modal);
+        };
+        interpreter.getModal = () => ({ ...this.modal });
+
+        return interpreter;
     }
     setModal(modal) {
         this.modal = {
@@ -604,10 +630,18 @@ class Toolpath {
     isYZPlane() {
         return this.modal.plane === 'G19';
     }
-    setPosition(x, y, z) {
-        this.position.x = (typeof x === 'number') ? x : this.position.x;
-        this.position.y = (typeof y === 'number') ? y : this.position.y;
-        this.position.z = (typeof z === 'number') ? z : this.position.z;
+    setPosition(...pos) {
+        if (typeof pos[0] === 'object') {
+            const { x, y, z } = { ...pos[0] };
+            this.position.x = (typeof x === 'number') ? x : this.position.x;
+            this.position.y = (typeof y === 'number') ? y : this.position.y;
+            this.position.z = (typeof z === 'number') ? z : this.position.z;
+        } else {
+            const [x, y, z] = pos;
+            this.position.x = (typeof x === 'number') ? x : this.position.x;
+            this.position.y = (typeof y === 'number') ? y : this.position.y;
+            this.position.z = (typeof z === 'number') ? z : this.position.z;
+        }
     }
     translateX(x, relative) {
         if (x !== undefined) {

test/index.js

@@ -81,6 +81,101 @@ describe('G-code Toolpath', () => {
         });
     });
 
+    describe('position', () => {
+        it('should match the specified position.', (done) => {
+            const toolpath = new Toolpath({
+                position: { x: 200, y: 100 }
+            });
+            expect(toolpath.getPosition()).to.deep.equal({ x: 200, y: 100, z: 0 });
+            toolpath.setPosition({ y: 200, z: 10 });
+            expect(toolpath.getPosition()).to.deep.equal({ x: 200, y: 200, z: 10 });
+            toolpath.setPosition(10, 10);
+            expect(toolpath.getPosition()).to.deep.equal({ x: 10, y: 10, z: 10 });
+            toolpath.setPosition(0, 0, 0);
+            expect(toolpath.getPosition()).to.deep.equal({ x: 0, y: 0, z: 0 });
+            done();
+        });
+    });
+
+    describe('modal', () => {
+        it('should match the specified modal state.', (done) => {
+            const toolpath = new Toolpath({
+                modal: {
+                    tool: 1
+                }
+            });
+            const expectedModal = {
+                // Moton Mode
+                // G0, G1, G2, G3, G38.2, G38.3, G38.4, G38.5, G80
+                motion: 'G0',
+
+                // Coordinate System Select
+                // G54, G55, G56, G57, G58, G59
+                wcs: 'G54',
+
+                // Plane Select
+                // G17: XY-plane, G18: ZX-plane, G19: YZ-plane
+                plane: 'G17',
+
+                // Units Mode
+                // G20: Inches, G21: Millimeters
+                units: 'G21',
+
+                // Distance Mode
+                // G90: Absolute, G91: Relative
+                distance: 'G90',
+
+                // Arc IJK distance mode
+                arc: 'G91.1',
+
+                // Feed Rate Mode
+                // G93: Inverse time mode, G94: Units per minute mode, G95: Units per rev mode
+                feedrate: 'G94',
+
+                // Cutter Radius Compensation
+                cutter: 'G40',
+
+                // Tool Length Offset
+                // G43.1, G49
+                tlo: 'G49',
+
+                // Program Mode
+                // M0, M1, M2, M30
+                program: 'M0',
+
+                // Spingle State
+                // M3, M4, M5
+                spindle: 'M5',
+
+                // Coolant State
+                // M7, M8, M9
+                coolant: 'M9', // 'M7', 'M8', 'M7,M8', or 'M9'
+
+                // Tool Select
+                tool: 0
+            };
+
+            expect(toolpath.getModal()).to.deep.equal({
+                motion: 'G0',
+                wcs: 'G54',
+                plane: 'G17',
+                units: 'G21',
+                distance: 'G90',
+                arc: 'G91.1',
+                feedrate: 'G94',
+                cutter: 'G40',
+                tlo: 'G49',
+                program: 'M0',
+                spindle: 'M5',
+                coolant: 'M9',
+                tool: 1
+            });
+            toolpath.setModal({ tool: 2 });
+            expect(toolpath.getModal().tool).to.equal(2);
+            done();
+        });
+    });
+
     describe('Linear Move: G0/G1', () => {
         it('should generate tool paths for linear movement.', (done) => {
             const expectedMotions = [