1
0
Fork 0
freesewing/markdown/dev/reference/plugins/cutonfold/en.md

73 lines
2.2 KiB
Markdown
Raw Normal View History

---
title: cutonfold
---
[![Build-time plugin](https://img.shields.io/badge/Type-build--time-purple.svg)](/plugins)
 
[![License: MIT](https://img.shields.io/npm/l/@freesewing/plugin-cutonfold.svg?label=License)](https://www.npmjs.com/package/@freesewing/plugin-cutonfold)
 
[![Code quality on DeepScan](https://deepscan.io/api/teams/2114/projects/2993/branches/23256/badge/grade.svg)](https://deepscan.io/dashboard#view=project&tid=2114&pid=2993&bid=23256)
 
[![Open issues tagged pkg:plugin-cutonfold](https://img.shields.io/github/issues/freesewing/freesewing/pkg:plugin-cutonfold.svg?label=Issues)](https://github.com/freesewing/freesewing/issues?q=is%3Aissue+is%3Aopen+label%3Apkg%3Aplugin-cutonfold)
The **cutonfold** plugin provides [the cutonfold macro](/reference/macros/cutonfold/):
<Example part="plugin_cutonfold" caption="An example of the cutonfold macro" design={false} />
```js
let { Point, points, Path, paths, macro } = part.shorthand();
points.topLeft = new Point(0, 0);
points.topRight = new Point(150, 0);
points.bottomRight = new Point(150, 50);
points.bottomLeft = new Point(0, 50);
paths.box = new Path()
.move(points.topLeft)
.line(points.topRight)
.line(points.bottomRight)
.line(points.bottomLeft)
.close();
macro("cutonfold", {
from: points.bottomLeft,
to: points.bottomRight,
grainline: true
});
```
<Note>
###### It's safe to use a corner of your pattern part for this
Since this is typically used on corners, the generated cut-on-fold indicator
will not go all the way to the `to` and `from` points.
</Note>
<Tip>
The cutonfold plugin is part of our [plugin-bundle](/reference/plugins/bundle/)
</Tip>
## Installation
```bash
npm install @freesewing/plugin-cutonfold
```
## Usage
Like all [build-time plugins](/guides/plugins/#build-time-plugins), you load them
by passing them to the [`freesewing.Design`](/reference/api#design) constructor:
```js
import freesewing from "@freesewing/core";
import cutonfold from "@freesewing/plugin-cutonfold";
import config from "../config";
const Pattern = new freesewing.Design(config, cutonfold);
```
Now you can use [the cutonfold macro](/reference/macros/cutonfold/) in your parts.