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

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

@ -5,6 +5,13 @@ 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
@ -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.

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

@ -5,6 +5,13 @@ 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
@ -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>

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

@ -6,6 +6,13 @@ 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
@ -51,4 +58,3 @@ array | false utils.lineIntersectsCurve(
} }
``` ```
</Example> </Example>