VSinerva/freesewing
1
0
Fork 0
Code Activity

fix(docs): utils.curvesIntersect() has 3 different returns, not 2

Browse source
This commit is contained in:
Benjamin F 2023-01-04 16:33:53 -08:00
parent 66c0e9a4e8
commit 02c816a10d
1 changed files with 21 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -8,17 +8,23 @@ described by 4 points each.
## Signature ## Signature
```js ```js
array | false utils.curvesIntersect( array | Point | false utils.curvesIntersect(
Point startA, Point startA,
Point Cp1A, Point Cp1A,
Point Cp2A, Point Cp2A,
Point endA, Point endA,
Point startB, Point startB,
Point Cp1B, Point Cp1B,
Point Cp2B, Point Cp2B,
Point endB) Point endB)
``` ```
This returns `false` if no intersections are found,
a [Point](/reference/api/point) object if
a single intersection is found, and an array
of [Point](/reference/api/point) objects if
multiple intersections are found.
## Example ## Example
<Example caption="A Utils.curvesIntersect() example"> <Example caption="A Utils.curvesIntersect() example">
@ -29,7 +35,7 @@ array | false utils.curvesIntersect(
points.Acp = new Point(310, 40) points.Acp = new Point(310, 40)
points.B = new Point(110, 70) points.B = new Point(110, 70)
points.Bcp = new Point(-210, 40) points.Bcp = new Point(-210, 40)
points.C = new Point(20, -5) points.C = new Point(20, -5)
points.Ccp = new Point(60, 300) points.Ccp = new Point(60, 300)
points.D = new Point(100, 85) points.D = new Point(100, 85)
@ -40,8 +46,8 @@ array | false utils.curvesIntersect(
paths.curveB = new Path() paths.curveB = new Path()
.move(points.C) .move(points.C)
.curve(points.Ccp, points.Dcp, points.D) .curve(points.Ccp, points.Dcp, points.D)
for (const p of utils.curvesIntersect( const intersections = utils.curvesIntersect(
points.A, points.A,
points.Acp, points.Acp,
points.Bcp, points.Bcp,
@ -50,8 +56,15 @@ array | false utils.curvesIntersect(
points.Ccp, points.Ccp,
points.Dcp, points.Dcp,
points.D points.D
)) { )
snippets[getId()] = new Snippet("notch", p)
if (intersections) {
if (intersections instanceof Array) {
for (const p of intersections)
snippets[getId()] = new Snippet('notch', p)
} else {
snippets[getId()] = new Snippet('notch', intersections)
}
} }
return part return part