VSinerva/freesewing
1
0
Fork 0
Code Activity

fix(docs): Add warning to curve intersection methods and functions

Browse source
This commit is contained in:
Benjamin F 2023-04-04 22:04:53 -07:00
parent b5f58fafd0
commit 080c75e733
7 changed files with 65 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

7
markdown/dev/reference/api/path/intersects/en.md
View file

@ -5,6 +5,13 @@ title: Path.intersects()
The `Path.intersects()` method returns the Point object(s) where the path The `Path.intersects()` method returns the Point object(s) where the path
intersects with a path you pass it. intersects with a path you pass it.
<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.
</Warning>
## Signature ## Signature
``` ```

7
markdown/dev/reference/api/path/intersectsx/en.md
View file

@ -5,6 +5,13 @@ title: Path.intersectsX()
The `Path.intersectsX()` method returns the Point object(s) where the path The `Path.intersectsX()` method returns the Point object(s) where the path
intersects with a given X-value. intersects with a given X-value.
<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.
</Warning>
## Signature ## Signature
```js ```js

7
markdown/dev/reference/api/path/intersectsy/en.md
View file

@ -5,6 +5,13 @@ title: Path.intersectsY()
The `Path.intersectsY()` method returns the Point object(s) where the path The `Path.intersectsY()` method returns the Point object(s) where the path
intersects with a given Y-value. intersects with a given Y-value.
<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.
</Warning>
## Signature ## Signature
```js ```js

18
markdown/dev/reference/api/utils/curveintersectsx/en.md
View file

@ -5,11 +5,18 @@ title: utils.curveIntersectsX()
The `utils.curveIntersectsX()` function finds the point(s) where a curve The `utils.curveIntersectsX()` function finds the point(s) where a curve
intersects a given X-value. intersects a given X-value.
<Warning>
This function 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.
</Warning>
## Signature ## Signature
```js ```js
array | Point | false utils.curveIntersectsX( array | Point | false utils.curveIntersectsX(
Point start, Point start,
Point cp1, Point cp1,
Point cp2, Point cp2,
Point end, Point end,
@ -32,11 +39,11 @@ multiple intersections are found.
points.cp1 = new Point(80, 10) points.cp1 = new Point(80, 10)
points.cp2 = new Point(-50, 80) points.cp2 = new Point(-50, 80)
points.end = new Point(110, 70) points.end = new Point(110, 70)
paths.curve = new Path() paths.curve = new Path()
.move(points.start) .move(points.start)
.curve(points.cp1, points.cp2, points.end) .curve(points.cp1, points.cp2, points.end)
for (let x of [30, 40]) { for (let x of [30, 40]) {
points["from" + x] = new Point(x, 10) points["from" + x] = new Point(x, 10)
points["to" + x] = new Point(x, 80) points["to" + x] = new Point(x, 80)
@ -45,12 +52,12 @@ multiple intersections are found.
.line(points["to" + x]) .line(points["to" + x])
.addClass("lining dashed") .addClass("lining dashed")
} }
snippets.i40 = new Snippet( snippets.i40 = new Snippet(
"notch", "notch",
utils.curveIntersectsX(points.start, points.cp1, points.cp2, points.end, 40) utils.curveIntersectsX(points.start, points.cp1, points.cp2, points.end, 40)
) )
for (let p of utils.curveIntersectsX( for (let p of utils.curveIntersectsX(
points.start, points.start,
points.cp1, points.cp1,
@ -72,4 +79,3 @@ This is a low-level (and faster) variant
of [`Path.intersectsX()`](/reference/api/path/intersectsx). of [`Path.intersectsX()`](/reference/api/path/intersectsx).
Instead of a path, you describe a single curve by passing the four Instead of a path, you describe a single curve by passing the four
points that describes it. points that describes it.

19
markdown/dev/reference/api/utils/curveintersectsy/en.md
View file

@ -5,11 +5,18 @@ title: utils.curveIntersectsY()
The `utils.curveIntersectsY()` function finds the point(s) where a curve The `utils.curveIntersectsY()` function finds the point(s) where a curve
intersects a given Y-value. intersects a given Y-value.
<Warning>
This function 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.
</Warning>
## Signature ## Signature
```js ```js
array | Point | false utils.curveIntersectsY( array | Point | false utils.curveIntersectsY(
Point start, Point start,
Point cp1, Point cp1,
Point cp2, Point cp2,
Point end, Point end,
@ -32,11 +39,11 @@ multiple intersections are found.
points.cp1 = new Point(50, 10) points.cp1 = new Point(50, 10)
points.cp2 = new Point(0, 80) points.cp2 = new Point(0, 80)
points.end = new Point(110, 70) points.end = new Point(110, 70)
paths.curve = new Path() paths.curve = new Path()
.move(points.start) .move(points.start)
.curve(points.cp1, points.cp2, points.end) .curve(points.cp1, points.cp2, points.end)
for (let y of [40, 50]) { for (let y of [40, 50]) {
points["from" + y] = new Point(10, y) points["from" + y] = new Point(10, y)
points["to" + y] = new Point(110, y) points["to" + y] = new Point(110, y)
@ -45,12 +52,12 @@ multiple intersections are found.
.line(points["to" + y]) .line(points["to" + y])
.addClass("lining dashed") .addClass("lining dashed")
} }
snippets.i50 = new Snippet( snippets.i50 = new Snippet(
"notch", "notch",
utils.curveIntersectsY(points.start, points.cp1, points.cp2, points.end, 50) utils.curveIntersectsY(points.start, points.cp1, points.cp2, points.end, 50)
) )
for (let p of utils.curveIntersectsY( for (let p of utils.curveIntersectsY(
points.start, points.start,
points.cp1, points.cp1,
@ -71,5 +78,3 @@ This is a low-level (and faster) variant
of [`Path.intersectsY()`](/reference/api/path/intersectsy). of [`Path.intersectsY()`](/reference/api/path/intersectsy).
Instead of a path, you describe a single curve by passing the four Instead of a path, you describe a single curve by passing the four
points that describes it. points that describes it.

8
markdown/dev/reference/api/utils/curvesintersect/en.md
View file

@ -5,6 +5,13 @@ title: utils.curvesIntersect()
The `utils.curvesIntersect()` function finds the intersections between two curves The `utils.curvesIntersect()` function finds the intersections between two curves
described by 4 points each. described by 4 points each.
<Warning>
This function 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.
</Warning>
## Signature ## Signature
```js ```js
@ -71,4 +78,3 @@ multiple intersections are found.
} }
``` ```
</Example> </Example>

20
markdown/dev/reference/api/utils/lineintersectscurve/en.md
View file

@ -6,15 +6,22 @@ The `utils.lineIntersectsCurve()` function finds the intersection between a line
segment from point `from` to point `to` and a curve described by points segment from point `from` to point `to` and a curve described by points
`start`, `cp1`, `cp2, and `end\`. `start`, `cp1`, `cp2, and `end\`.
<Warning>
This function 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.
</Warning>
## Signature ## Signature
```js ```js
array | false utils.lineIntersectsCurve( array | false utils.lineIntersectsCurve(
Point from, Point from,
Point to, Point to,
Point start, Point start,
Point cp1, Point cp1,
Point cp2, Point cp2,
Point end Point end
) )
``` ```
@ -35,7 +42,7 @@ array | false utils.lineIntersectsCurve(
.move(points.A) .move(points.A)
.curve(points.Acp, points.Bcp, points.B) .curve(points.Acp, points.Bcp, points.B)
paths.line = new Path().move(points.E).line(points.D) paths.line = new Path().move(points.E).line(points.D)
for (let p of utils.lineIntersectsCurve( for (let p of utils.lineIntersectsCurve(
points.D, points.D,
points.E, points.E,
@ -51,4 +58,3 @@ array | false utils.lineIntersectsCurve(
} }
``` ```
</Example> </Example>