VSinerva/freesewing
1
0
Fork 0
Code Activity

chore(markdown): Updated utils docs for v3

Browse source
This commit is contained in:
Joost De Cock 2022-10-01 22:20:43 +02:00
parent acf1b72c4c
commit bc3b0cd770
23 changed files with 782 additions and 622 deletions
Download patch file Download diff file Expand all files Collapse all files

44
markdown/dev/reference/api/utils/beamintersectsx/en.md
View file

@ -1,38 +1,40 @@
---
title: beamIntersectsX()
title: utils.beamIntersectsX()
---
The `utils.beamIntersectsX()` function finds the intersection between an endless
line and a given X-value. Returns a [Point](/reference/api/point) object for
the intersection, or `false` there is no intersection.
## Signature
```js
Point | false utils.beamIntersectsX(Point A, Point B, float X)
```
Finds the intersection between an endless line and a given X-value. Returns a [Point](/reference/api/point) object
for the intersection, or `false` there is no intersection.
<Example part="utils_beamintersectsx">
A Utils.beamIntersectsX() example
</Example>
## Example
<Example caption="A Utils.beamIntersectsX() example">
```js
let {
Point,
points,
Path,
paths,
Snippet,
snippets,
utils
} = part.shorthand();
({ Point, points, Path, paths, Snippet, snippets, utils, part }) => {
points.A = new Point(10, 10);
points.B = new Point(90, 30);
points.A = new Point(10, 10)
points.B = new Point(90, 30)
paths.AB = new Path().move(points.A).line(points.B);
paths.AB = new Path().move(points.A).line(points.B)
snippets.x = new Snippet("notch", utils.beamIntersectsX(points.A, points.B, 40));
snippets.x = new Snippet(
"notch",
utils.beamIntersectsX(points.A, points.B, 40)
)
paths.help = new Path()
.move(new Point(40, 5))
.line(new Point(40, 35))
.attr("class", "note dashed");
.addClass("note dashed")
return part
}
```
</Example>