ed8a166ea9
This PR reverts the incorrect lint/prettier changes applied to <Example> code in the reference Core API docs l by the husky pre-commit hook, the problem mentioned in Issue #333. (These are just the changes for the Core API docs. Additional PRs will be filed for changes in the other reference, howtos, and guides documentation.) Co-authored-by: Benjamin Fan <ben-git@swinglonga.com> Reviewed-on: https://codeberg.org/freesewing/freesewing/pulls/367 Reviewed-by: Joost De Cock <joostdecock@noreply.codeberg.org> Co-authored-by: Benjamin Fan <benjamesben@noreply.codeberg.org> Co-committed-by: Benjamin Fan <benjamesben@noreply.codeberg.org>
57 lines
1 KiB
Text
57 lines
1 KiB
Text
---
|
|
title: Path.circleSegment()
|
|
---
|
|
|
|
The `Path.circleSegment()` method draws a circle segment
|
|
starting from the current endpoint of the path around the given origin with a given angle.
|
|
|
|
A positive angle results in a counter-clockwise arc.
|
|
|
|
A negative angle results in a clockwise arc.
|
|
|
|
:::tip
|
|
The new endpoint of this path is the same point
|
|
that
|
|
|
|
```js
|
|
path.end().rotate(deg, origin)
|
|
```
|
|
|
|
would return.
|
|
:::
|
|
|
|
## Signature
|
|
|
|
```js
|
|
Path path.circleSegment(deg, origin)
|
|
```
|
|
|
|
:::tip
|
|
This method is chainable as it returns the `Path` object
|
|
:::
|
|
|
|
## Example
|
|
|
|
<Example caption="Example of the Path.circleSegment() method">
|
|
```js
|
|
({ Point, points, Path, paths, part }) => {
|
|
|
|
points.from = new Point(10, 20)
|
|
points.origin = new Point(40, 0)
|
|
|
|
paths.line = new Path()
|
|
.move(points.from)
|
|
.circleSegment(90, points.origin)
|
|
.setText("→ Path.circleSegment() →", "text-sm center fill-note")
|
|
|
|
paths.helper = new Path()
|
|
.move(paths.line.start())
|
|
.line(points.origin)
|
|
.line(paths.line.end())
|
|
.setClass('dotted stroke-sm')
|
|
|
|
return part
|
|
}
|
|
|
|
```
|
|
</Example>
|