Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/assets/path_example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
111 changes: 111 additions & 0 deletions docs/outlines.md
Original file line number Diff line number Diff line change
Expand Up @@ -508,9 +508,120 @@ With this, let's see a list of what actual shapes we can place, what extra attri
:::


- **`path`**: A custom vector path shape made of connected segments.

- **`segments`**: A mandatory array of segment definitions. Each segment specifies a structural portion of the path using a **`type`** (such as `line` or `arc`) and an array of **`points`** using standard Ergogen anchors. Consecutive segments automatically start from where the previous segment left off.


<details><summary>Path Example - from b0b's board <a href="https://github.com/theb0b12/good-wings/blob/main/GW1.yaml" target="_blank">Good-Wings</a></summary>
<p>

<Tabs>
<TabItem default label="Config" value="config">

```yaml
outer_outline:
- what: path
segments:
- type: arc # thumb arc
points:
- ref: thumbs_far_thumb
shift: [0.6px, -0.6py]
- ref: thumbs_middle_thumb
shift: [0px, -0.6py]
- ref: thumbs_tuck_thumb
shift: [-0.6px, -0.6py]

- type: line # thumb to pinky line
points:
- ref: thumbs_tuck_thumb
shift: [-0.6px, 0ky]
- ref: matrix_pinky_bottom
shift: [0.6px, -0.6ky]
- ref: matrix_outer-pinky_bottom
shift: [-0.6px, -0.6ky]
- ref: matrix_outer-pinky_top
shift: [-0.6px, 0.6ky]

- type: line # top steplike lines
points:
- ref: matrix_ring_top
shift: [-0.6px, 0ky]
- ref: matrix_ring_top
shift: [-0.6px, 0.6ky]
- ref: matrix_middle_top
shift: [-0.6px, 0.15ky]
- ref: matrix_middle_top
shift: [-0.6px, 0.6ky]
- ref: matrix_middle_top
shift: [0.6px, 0.6ky]
- ref: matrix_middle_top
shift: [0.6px, 0.4ky]

- type: arc # top arc
points:
- ref.aggregate.parts: [matrix_inner_top, mirror_matrix_inner_top]
shift: [0px, 0.6py]
- ref: mirror_matrix_middle_top
shift: [0.6px, 0.4ky]

- type: line # top steplike lines mirror
points:
- ref: mirror_matrix_middle_top
shift: [0.6px, 0.4ky]
- ref: mirror_matrix_middle_top
shift: [0.6px, 0.6ky]
- ref: mirror_matrix_middle_top
shift: [-0.6px, 0.6ky]
- ref: mirror_matrix_middle_top
shift: [-0.6px, 0.15ky]
- ref: mirror_matrix_ring_top
shift: [-0.6px, 0.6ky]
- ref: mirror_matrix_ring_top
shift: [-0.6px, 0ky]

- type: line # thumb to pinky line mirror
points:
- ref: mirror_matrix_outer-pinky_top
shift: [-0.6px, 0.6ky]
- ref: mirror_matrix_outer-pinky_bottom
shift: [-0.6px, -0.6ky]
- ref: mirror_matrix_pinky_bottom
shift: [0.6px, -0.6ky]
- ref: mirror_thumbs_tuck_thumb
shift: [-0.6px, 0ky]
- ref: mirror_thumbs_tuck_thumb
shift: [-0.6px, -0.6ky]

- type: arc # thumb arc mirror
points:
- ref: mirror_thumbs_middle_thumb
shift: [0px, -0.6py]
- ref: mirror_thumbs_far_thumb
shift: [0.6px, -0.6py]

- type: line # thumb v shape thing bottom
points:
- ref: mirror_thumbs_far_thumb
shift: [0.6px, 0.3py]
- ref: thumbs_far_thumb
shift: [0.6px, 0.3py]

fillet: 1
```

</TabItem>
<TabItem value="visualization" label="Visualization">
<div style={{textAlign: 'center'}}>

![Good-Wings Path Example](./assets/path_example.png)

</div>
</TabItem>
</Tabs>

</p>
</details>



Expand Down