VSinerva/freesewing
1
0
Fork 0
Code Activity

chore(markdown): Restructuring dev docs

Browse source
This commit is contained in:
Joost De Cock 2021-12-27 17:33:49 +01:00
parent 9ef46c502a
commit d42d9a9377
114 changed files with 246 additions and 1462 deletions
Download patch file Download diff file Expand all files Collapse all files

58
markdown/dev/reference/plugins/round/en.md
View file

@ -1,50 +1,21 @@
---
title: round
title: "@freesewing/plugin-round"
---
[![Build-time plugin](https://img.shields.io/badge/Type-build--time-purple.svg)](/plugins)
 
[![License: MIT](https://img.shields.io/npm/l/@freesewing/plugin-round.svg?label=License)](https://www.npmjs.com/package/@freesewing/plugin-round)
 
[![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-round](https://img.shields.io/github/issues/freesewing/freesewing/pkg:plugin-round.svg?label=Issues)](https://github.com/freesewing/freesewing/issues?q=is%3Aissue+is%3Aopen+label%3Apkg%3Aplugin-round)
The **@freesewing/plugin-round** plugin provides [the
round macro](/reference/api/macros/round) which helps you round
corners on your designs.
The **round** plugin provides [the round macro](/reference/macros/round/):
<Warning>
<Example part="plugin_round" caption="An example of the round macro" design={false} />
##### Straight corners only
```js
points.topLeft = new Point(0, 0);
points.bottomLeft = new Point(0, 30);
points.topRight = new Point(100, 0);
points.bottomRight = new Point(100, 30);
The round macro is intended for rounding 90° angles.
It does not support rounding other angles/corners.
paths.demo = new Path()
.move(points.topLeft)
.line(points.bottomLeft)
.line(points.bottomRight)
.line(points.topRight)
.close()
.attr("class", "note dashed");
</Warning>
macro("round", {
from: points.topLeft,
to: points.bottomRight,
via: points.bottomLeft,
radius: 10,
prefix: 'bl',
render: true
});
macro("round", {
from: points.bottomRight,
to: points.topLeft,
via: points.topRight,
radius: 20,
prefix: 'tr',
render: true
});
```
<Example part="plugin_round">An example of the round macro</Example>
<Tip>
@ -60,8 +31,8 @@ npm install @freesewing/plugin-round
## 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:
Like all [build-time plugins](/guides/plugins/types-of-plugins#build-time-plugins), you
load them by passing them to the [freesewing.Design](/reference/api/design) super-constructor:
```js
import freesewing from "@freesewing/core";
@ -73,9 +44,4 @@ const Pattern = new freesewing.Design(config, round);
Now you can use [the round macro](/reference/macros/round/): in your parts.
<Warning>
The round macro is intended for rounding 90° angles
</Warning>