1
0
Fork 0
freesewing/markdown/dev/reference/macros/round/en.md
2022-12-09 20:59:53 -08:00

1.9 KiB

title
round

The round macro creates a rounded corner. It is provided by the round plugin.

Signature

macro('round', { 
  String class,
  Point from,
  Boolean hide,
  String prefix,
  Number radius,
  Point to,
  Point via,
})

Example

```js ({ Point, points, macro, part }) => {

macro('round', { from: new Point(0, 0), to: new Point(100, 40), via: new Point(100, 0), radius: 30, hide: false, })

return part }

</Example>

## Configuration

| Property    | Default | Type                | Description |
|------------:|---------|---------------------|-------------|
| `from`      |         | [Point](/reference/api/point) | The startpoint towards the corner to round |
| `to`        |         | [Point](/reference/api/point) | The endpoint away from the corner to round |
| `via`       |         | [Point](/reference/api/point) | The cornerpoint to round |
| `radius`    | Maximum | Number              | The radius in mm if not the maximum possible |
| `prefix`    |         | String              | A prefix to give to the points and paths created by this macro |
| `hide`      | `true`  | Boolean             | Whether to hide the path created by this macro |
| `class`     |         | String              | Class(es) to assign to the path created by this macro |

## Result

| Generated Element | Description |
|-------------------|-------------|
| `paths.${prefix}Rounded` | Path for the rounded corner |
| `points.${prefix}Start` | Point for the start of the rounded corner |
| `points.${prefix}End` | Point for the end of the rounded corner |
| `points.${prefix}Cp1` | Control Point used to create the curved path |
| `points.${prefix}Cp2` | Control Point used to create the curved path |

## Notes

This macro is only intended for 90 degree corners.