1
0
Fork 0
freesewing/markdown/dev/reference/api/path/roughlength/en.md

51 lines
1.2 KiB
Markdown
Raw Normal View History

2022-09-22 09:05:20 +02:00
---
title: Path.roughLength()
2022-09-22 09:05:20 +02:00
---
The `Path.roughLength()` method returns a (very) rough estimate of the path's length.
## Signature
2022-09-22 09:05:20 +02:00
```js
Number path.roughLength()
2022-09-22 09:05:20 +02:00
```
## Example
2022-09-22 09:05:20 +02:00
<Example caption="Example of the Path.attr() method">
```js
({ Point, points, Path, paths, macro, units, part }) => {
2022-09-29 17:50:53 +02:00
points.B = new Point(10, 30)
points.BCp2 = new Point(40, 20)
points.C = new Point(120, 30)
points.CCp1 = new Point(50, -30)
paths.example = new Path()
.move(points.B)
2022-09-29 17:50:53 +02:00
.curve(points.BCp2, points.CCp1, points.C)
macro("pd", {
path: paths.example,
d: -10,
text: `Path.roughLength() = ${units(paths.example.roughLength())}`
})
macro("pd", {
path: paths.example,
d: 10,
text: `Path.length() = ${units(paths.example.length())}`
2022-09-29 17:50:53 +02:00
})
return part
}
```
</Example>
2022-09-22 09:05:20 +02:00
## Notes
2022-09-22 09:05:20 +02:00
The `Path.roughLength()` is not intended to give an estimate that is accurate, but rather differentiatate between paths that are a few millimeter long, or meters long.
2022-09-22 09:05:20 +02:00
It calculates the length without *walking the (cubic) Bezier curve* making it very fast and very inaccurate (for curves).
It is typically used to determine how much precision to apply when walking a curve.