Global

Methods

beginRecord(p5Instance)

Begins recording embroidery data.

Parameters:

Name	Type	Description
`p5Instance`	p5	The p5.js sketch instance

Source: p5.embroider.js, line 750

Example

function setup() {
  createCanvas(400, 400);
  beginRecord(this);
  // Draw embroidery patterns here
  endRecord();
}

endRecord()

Ends recording and prepares for export.

Source: p5.embroider.js, line 775

Example

function setup() {
  createCanvas(400, 400);
  beginRecord(this);
  // Draw embroidery patterns
  endRecord();
}

exportDST(filenameopt)

Exports the recorded embroidery data as a DST file.

Parameters:

Name	Type	Attributes	Default	Description
`filename`	String	<optional>	'embroideryPattern.dst'	Output filename

Source: p5.embroider.js, line 2002

Example

function setup() {
  createCanvas(400, 400);
  beginRecord(this);
  // Draw embroidery patterns
  endRecord();
  exportDST('pattern.dst');
}

exportEmbroidery(filename)

Exports the recorded embroidery data as a file.

Parameters:

Name	Type	Description
`filename`	String	Output filename with extension

Source: p5.embroider.js, line 1928

Example

function setup() {
  createCanvas(400, 400);
  beginRecord(this);
  // Draw embroidery patterns here
  endRecord();
  exportEmbroidery('pattern.dst');
}

exportGcode(filename)

Exports the recorded embroidery data as a G-code file.

Parameters:

Name	Type	Description
`filename`	String	Output filename

Source: p5.embroider.js, line 1959

Example

function setup() {
  createCanvas(400, 400);
  beginRecord(this);
  // Draw embroidery patterns
  endRecord();
  exportGcode('pattern.gcode');
}

mmToPixel(mm, dpiopt) → {Number}

Converts millimeters to pixels.

Parameters:

Name	Type	Attributes	Default	Description
`mm`	Number			Millimeters
`dpi`	Number	<optional>	96	Dots per inch

Source: p5.embroider.js, line 2704

Returns:

Pixels

Type:: Number

Example

function setup() {
  let pixels = mmToPixel(10); // Convert 10mm to pixels
  if(_DEBUG) console.log(pixels);
}

pixelToMm(pixels, dpiopt) → {Number}

Converts pixels to millimeters.

Parameters:

Name	Type	Attributes	Default	Description
`pixels`	Number			Pixels
`dpi`	Number	<optional>	96	Dots per inch

Source: p5.embroider.js, line 2725

Returns:

Millimeters

Type:: Number

Example

function setup() {
  let mm = pixelToMm(100); // Convert 100 pixels to mm
  if(_DEBUG) console.log(mm);
}

setDrawMode(mode)

Sets the draw mode for embroidery.

Parameters:

Name	Type	Description
`mode`	String	The draw mode to set ('stitch', 'p5', 'realistic')

Source: p5.embroider.js, line 1476

Example

function setup() {
  createCanvas(400, 400);
  beginRecord(this);
  setDrawMode('stitch'); // Show stitch points and lines
  // Draw embroidery patterns
}

setFillMode(mode)

Sets the fill mode for embroidery fills.

Parameters:

Name	Type	Description
`mode`	string	The fill mode to use ('tatami', 'satin', or 'spiral')

Source: p5.embroider.js, line 673

setFillSettings(settings)

Sets the fill settings for embroidery.

Parameters:

Name Type Description

settings

Object

Fill settings object

Properties

Name	Type	Attributes	Description
`stitchLength`	number	<optional>	Length of each stitch in mm
`stitchWidth`	number	<optional>	Width of each stitch in mm
`minStitchLength`	number	<optional>	Minimum stitch length in mm
`resampleNoise`	number	<optional>	Amount of random variation (0-1)
`angle`	number	<optional>	Fill angle in degrees
`spacing`	number	<optional>	Space between rows in mm
`tieDistance`	number	<optional>	Distance between tie-down stitches in mm
`alternateAngle`	boolean	<optional>	Whether to alternate angles between shapes

Source: p5.embroider.js, line 687

setFillSettings(settings)

Sets the fill settings for embroidery.

Parameters:

Name	Type	Description
`settings`	Object	The settings for the fill

Source: p5.embroider.js, line 1464

setStitch(minLength, desiredLength, noise)

Sets the stitch parameters for embroidery.

Parameters:

Name	Type	Description
`minLength`	Number	Minimum stitch length in millimeters
`desiredLength`	Number	Desired stitch length in millimeters
`noise`	Number	Amount of random variation in stitch length (0-1)

Source: p5.embroider.js, line 1423

Example

function setup() {
  createCanvas(400, 400);
  beginRecord(this);
  setStitch(1, 3, 0.2); // min 1mm, desired 3mm, 20% noise
  // Draw embroidery patterns
}

setStrokeMode(mode)

Sets the stroke mode for embroidery stitches.

Parameters:

Name	Type	Description
`mode`	string	The stroke mode to use ('zigzag', 'lines', or 'sashiko')

Source: p5.embroider.js, line 650

Example

function setup() {
  createCanvas(400, 400);
  beginRecord(this);
  setStrokeMode('zigzag');
  line(10, 10, 50, 50); // Will use zigzag stitch pattern
}

setStrokeSettings(settings)

Sets the stroke settings for embroidery.

Parameters:

Name	Type	Description
`settings`	Object	The settings for the stroke

Source: p5.embroider.js, line 1452

trimThread()

Inserts a thread trim command at the current position.

Source: p5.embroider.js, line 2084

Example

function setup() {
  createCanvas(400, 400);
  beginRecord(this);
  line(10, 10, 50, 50);
  trimThread(); // Cut thread at current position
  line(60, 60, 100, 100);
}