1
0
Fork 0
freesewing/sites/dev/docs/reference/macros/gore
Joost De Cock ab3204f9f1 chore: Port FreeSewing.dev to docusaurus
The replaces the NextJS site powering FreeSewing.dev with a Docusaurus
setup. It's part of my efforts to simplify FreeSewing's setup so we can
focus on our core value proposition.
2024-09-28 13:13:48 +02:00
..
readme.mdx chore: Port FreeSewing.dev to docusaurus 2024-09-28 13:13:48 +02:00

---
title: gore
---

The `gore` macro facilitates the drafting of [gores][1] to create spherical or other roundish objects. They are are typically used in hats.

:::note
##### Not a core-plugins macro

The `gore` macro is not provided by the [core plugins](/reference/plugins/core),
so you need to load the [gore plugin](/reference/plugins/gore) explicitly
if you want to use it.
:::

## Signature

```js
macro('gore', { 
  Point from,
  Number radius,
  Number gores,
  Number extraLength,
  Boolean hidden=true,
  String class='',
  String prefix='',
)
```

## Example

<Example caption="Example of the gore macro">
```js
({ Point, macro, part }) => {

  macro('gore', { 
    from: new Point(0,0),
    radius: 100,
    gores: 6,
    extraLength: 20,
    hidden: false,
    class: 'fabric',
  })
  
  return part
}
```
</Example>

## Configuration

| Property      | Default | Type       | Description                                  |
|--------------:|---------|------------|----------------------------------------------|
| `from`        |         | [Point][2] | The point to start drafting the gore from |
| `radius`      |         | number     | The radius of the sphere the gores should cover |
| `gores`       |         | number     | The number of gores into which the sphere is divided |
| `extraLength` |         | number     | The length of the straight section after a complete semisphere |
| `hidden`      | `true`  | boolean    | Whether or not to hide the generated path |
| `class`       |         | boolean    | Any classes to add to the generated path |
| `prefix`      |         | string     | A prefix to apply to the names of the generated path and points |

[1]: https://en.wikipedia.org/wiki/Gore_\(segment\)

[2]: /reference/api/point