Fix and improve path intersection methods
- Add path.intersectsBeam() method - Add utils.beamIntersectsLine() method - Simplify calculation and improve precision on beam intersections - Document return types properly - beamIntersectsCurve now uses the proper function from Bezier library instead of emulating it by constructing a huge line - docs: path.intersect... methods never return false, they simply return an empty array in case of no intersection
This commit is contained in:
parent
adf83eda8c
commit
4b83212f41
10 changed files with 262 additions and 39 deletions
|
@ -17,7 +17,7 @@ for more information.
|
|||
## Signature
|
||||
|
||||
```
|
||||
array|false path.intersects(Path path)
|
||||
array path.intersects(Path path)
|
||||
```
|
||||
|
||||
|
||||
|
|
56
sites/dev/docs/reference/api/path/intersectsbeam/readme.mdx
Normal file
56
sites/dev/docs/reference/api/path/intersectsbeam/readme.mdx
Normal file
|
@ -0,0 +1,56 @@
|
|||
---
|
||||
title: Path.intersectsBeam()
|
||||
---
|
||||
|
||||
The `Path.intersectsBeam()` method returns the Point object(s) where the path
|
||||
intersects with an endless line (beam).
|
||||
|
||||
:::warning
|
||||
|
||||
This method can sometimes fail to find intersections in some curves
|
||||
due to a limitation in an underlying Bézier library.
|
||||
Please see [Bug #3367](https://github.com/freesewing/freesewing/issues/3367)
|
||||
for more information.
|
||||
|
||||
:::
|
||||
|
||||
## Signature
|
||||
|
||||
```js
|
||||
array path.intersectsBeam(Point a, Point b)
|
||||
```
|
||||
|
||||
<Example caption="Example of the Path.intersectsBeam() method">
|
||||
|
||||
```js
|
||||
;({ Point, points, Path, paths, snippets, Snippet, getId, part }) => {
|
||||
points.A = new Point(45, 60)
|
||||
points.B = new Point(10, 30)
|
||||
points.BCp2 = new Point(40, 20)
|
||||
points.C = new Point(90, 30)
|
||||
points.CCp1 = new Point(50, -30)
|
||||
|
||||
points.beamA = new Point(55, 30)
|
||||
points.beamB = new Point(0, 55)
|
||||
|
||||
paths.demo1 = new Path().move(points.A).line(points.B).curve(points.BCp2, points.CCp1, points.C)
|
||||
|
||||
paths.beam = new Path().move(points.beamA).line(points.beamB).addClass('dashed')
|
||||
|
||||
for (let p of paths.demo1.intersectsBeam(points.beamA, points.beamB)) {
|
||||
snippets[getId()] = new Snippet('notch', p)
|
||||
}
|
||||
|
||||
return part
|
||||
}
|
||||
```
|
||||
|
||||
</Example>
|
||||
|
||||
## Notes
|
||||
|
||||
This method works similar to `path.intersectsX(...)` and `path.intersectsY(...)`,
|
||||
but here the intersecting beam doesn't have to be horizontally or vertically.
|
||||
|
||||
If you need intersections with a limited line instead of a beam,
|
||||
use something like `path.intersects(new Path.move(pointA).line(pointB))` instead.
|
|
@ -17,7 +17,7 @@ for more information.
|
|||
## Signature
|
||||
|
||||
```js
|
||||
array|false path.intersectsX(float x)
|
||||
array path.intersectsX(float x)
|
||||
```
|
||||
|
||||
## Example
|
||||
|
|
|
@ -17,7 +17,7 @@ for more information.
|
|||
## Signature
|
||||
|
||||
```js
|
||||
array|false path.intersectsY(float y)
|
||||
array path.intersectsY(float y)
|
||||
```
|
||||
|
||||
## Example
|
||||
|
|
|
@ -0,0 +1,45 @@
|
|||
---
|
||||
title: utils.beamIntersectsLine()
|
||||
---
|
||||
|
||||
The `utils.beamIntersectsLine()` function finds the intersection between an endless
|
||||
line (beam) and a (limited) line segment. Returns a [Point](/reference/api/point) object for the
|
||||
intersection, or `false` if the beam doesn't intersect the line.
|
||||
|
||||
The first two points in the parameter list form the beam, the last two points form the line.
|
||||
|
||||
## Signature
|
||||
|
||||
```js
|
||||
Point | false utils.beamIntersectsLine(
|
||||
Point beamA,
|
||||
Point beamB,
|
||||
Point lineA,
|
||||
Point lineB
|
||||
)
|
||||
```
|
||||
|
||||
## Example
|
||||
|
||||
<Example caption="A Utils.beamIntersectsLine() example">
|
||||
|
||||
```js
|
||||
;({ Point, points, Path, paths, Snippet, snippets, utils, part }) => {
|
||||
points.A = new Point(45, 20)
|
||||
points.B = new Point(60, 15)
|
||||
points.C = new Point(10, 10)
|
||||
points.D = new Point(50, 40)
|
||||
|
||||
paths.AB = new Path().move(points.A).line(points.B).addClass('dotted')
|
||||
paths.CD = new Path().move(points.C).line(points.D)
|
||||
|
||||
snippets.x = new Snippet(
|
||||
'notch',
|
||||
utils.beamIntersectsLine(points.A, points.B, points.C, points.D)
|
||||
)
|
||||
|
||||
return part
|
||||
}
|
||||
```
|
||||
|
||||
</Example>
|
|
@ -19,7 +19,7 @@ Point | false utils.beamsIntersect(
|
|||
|
||||
## Example
|
||||
|
||||
<Example caption="A Utils.beamIntersect() example">
|
||||
<Example caption="A Utils.beamsIntersect() example">
|
||||
```js
|
||||
({ Point, points, Path, paths, Snippet, snippets, utils, part }) => {
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue