3.4 KiB
3.4 KiB
freesewing
a library for made-to-measure sewing patterns
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 indicatorfrom
: A point object at the end of the cut-on-fold indicatoroffset
: Distance in mm that the cut-on-fold line is offset from the line betweenfrom
andto
. Default: 50mm.margin
: Percentange the cut-on-fold line will remain from thefrom
andto
points. Default: 5%.
As all freesewing macros, bundle these parameters into a single object.
Example
Build
To build this plugin, run:
npm run build
License: MIT
See the license file for details.