1
0
Fork 0
freesewing/packages/plugin-cutonfold/README.md
2019-04-19 08:21:00 +02:00

3.5 KiB

Freesewing logo

 freesewing
a library for made-to-measure sewing patterns

Travis build Version License Code coverage DeepScan grade Chat on Gitter Become a Patron

plugin-cutonfold

A freesewing plugin to add cut-on-fold indicators to your patterns.

Install

On node.js:

npm install @freesewing/plugin-cutonfold

in the browser, simply include this script:

<script type="text/javascript" src="https://unpkg.com/@freesewing/plugin-cutonfold"></script>

Loading this plugin

To load this plugin, add it to your instantiated pattern.

On node.js:

import pattern from '@freesewing/pattern-brian'
import cutonfold from '@freesewing/plugin-cutonfold'

pattern.with(cutonfold);

In the browser, this plugin will register as freesewing.plugins.cutonfold. Since it's a build-time plugin, it will be loaded by the pattern.

<script type="text/javascript" src="https://unpkg.com/freesewing"></script>
<script type="text/javascript" src="https://unpkg.com/@freesewing/plugin-cutonfold"></script>
<script type="text/javascript" src="https://unpkg.com/@freesewing/pattern-brian"></script>

<script>
var pattern = freesewing.patterns.brian;
</script>

Usage

This plugin provides the cutonfold macro.

The macro method is available from the shorthand() method on an instantiated pattern part.

macro('cutonfold', {
  from: points.cbNeck,
  to: points.cbHips
});

Parameters

  • to: A point object at the start of the cut-on-fold indicator
  • from: A point object at the end of the cut-on-fold indicator
  • offset: Distance in mm that the cut-on-fold line is offset from the line between from and to. Default: 50mm.
  • margin: Percentange the cut-on-fold line will remain from the from and to points. Default: 5%.
  • grainline: Whether this is also the grainline. Default: false

As all freesewing macros, bundle these parameters into a single object.

Example

Example of the output provided by this plugin

Build

To build this plugin, run:

npm run build

License: MIT

See the license file for details.