Skip to content

Commit 917efe2

Browse files
committed
Update README.md
1 parent eeb3525 commit 917efe2

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,17 @@ const gcode = new Toolpath({
2424
spindle: 'M5', // M3, M4, M5
2525
coolant: 'M9' // M7, M8, M9
2626
},
27+
// @param {object} modal The modal object.
28+
// @param {object} v1 A 3D vector of the start point.
29+
// @param {object} v2 A 3D vector of the end point.
2730
addLine: (modal, v1, v2) => {
2831
var motion = modal.motion;
2932
toolpaths.push({ motion: motion, v1: v1, v2: v2 });
3033
},
34+
// @param {object} modal The modal object.
35+
// @param {object} v1 A 3D vector of the start point.
36+
// @param {object} v2 A 3D vector of the end point.
37+
// @param {object} v0 A 3D vector of the fixed point.
3138
addArcCurve: (modal, v1, v2, v0) => {
3239
var motion = modal.motion;
3340
toolpaths.push({ motion: motion, v1: v1, v2: v2, v0: v0 });
@@ -72,10 +79,17 @@ const GCODE = [
7279

7380
const toolpaths = [];
7481
const gcode = new Toolpath({
82+
// @param {object} modal The modal object.
83+
// @param {object} v1 A 3D vector of the start point.
84+
// @param {object} v2 A 3D vector of the end point.
7585
addLine: (modal, v1, v2) => {
7686
const motion = modal.motion;
7787
toolpaths.push({ motion: motion, v1: v1, v2: v2 });
7888
},
89+
// @param {object} modal The modal object.
90+
// @param {object} v1 A 3D vector of the start point.
91+
// @param {object} v2 A 3D vector of the end point.
92+
// @param {object} v0 A 3D vector of the fixed point.
7993
addArcCurve: (modal, v1, v2, v0) => {
8094
const motion = modal.motion;
8195
toolpaths.push({ motion: motion, v1: v1, v2: v2, v0: v0 });

0 commit comments

Comments
 (0)