1
0
Fork 0

Merge pull request #3761 from BenJamesBen/intersects-documentation-warnings

fix(docs): Add warning to curve intersection methods and functions
This commit is contained in:
Joost De Cock 2023-04-08 19:04:00 +02:00 committed by GitHub
commit 89a3207941
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 79 additions and 21 deletions

View file

@ -5,6 +5,15 @@ title: Path.intersects()
The `Path.intersects()` method returns the Point object(s) where the path
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
```

View file

@ -5,6 +5,15 @@ title: Path.intersectsX()
The `Path.intersectsX()` method returns the Point object(s) where the path
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
```js

View file

@ -5,6 +5,15 @@ title: Path.intersectsY()
The `Path.intersectsY()` method returns the Point object(s) where the path
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
```js

View file

@ -5,6 +5,15 @@ title: utils.curveIntersectsX()
The `utils.curveIntersectsX()` function finds the point(s) where a curve
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
```js
@ -72,4 +81,3 @@ This is a low-level (and faster) variant
of [`Path.intersectsX()`](/reference/api/path/intersectsx).
Instead of a path, you describe a single curve by passing the four
points that describes it.

View file

@ -5,6 +5,15 @@ title: utils.curveIntersectsY()
The `utils.curveIntersectsY()` function finds the point(s) where a curve
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
```js
@ -71,5 +80,3 @@ This is a low-level (and faster) variant
of [`Path.intersectsY()`](/reference/api/path/intersectsy).
Instead of a path, you describe a single curve by passing the four
points that describes it.

View file

@ -5,6 +5,15 @@ title: utils.curvesIntersect()
The `utils.curvesIntersect()` function finds the intersections between two curves
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
```js
@ -71,4 +80,3 @@ multiple intersections are found.
}
```
</Example>

View file

@ -6,6 +6,15 @@ The `utils.lineIntersectsCurve()` function finds the intersection between a line
segment from point `from` to point `to` and a curve described by points
`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
```js
@ -51,4 +60,3 @@ array | false utils.lineIntersectsCurve(
}
```
</Example>