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:
```sh
npm install @freesewing/plugin-cutonfold
```
in the browser, simply include this script:
```html
```
## Loading this plugin
To load this plugin, add it to your instantiated pattern.
On node.js:
```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.
```html
```
## Usage
This plugin provides the `cutonfold` macro.
> The macro method is available from the `shorthand()` method on an instantiated pattern part.
```js
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
## Build
To build this plugin, run:
```sh
npm run build
```
## License: MIT
See [the license file](https://github.com/freesewing/plugin-theme/blob/master/LICENSE)
for details.