chore(markdown): Updated utils docs for v3
This commit is contained in:
parent
acf1b72c4c
commit
bc3b0cd770
23 changed files with 782 additions and 622 deletions
|
@ -1,38 +1,40 @@
|
|||
---
|
||||
title: beamIntersectsY()
|
||||
title: utils.beamIntersectsY()
|
||||
---
|
||||
|
||||
The `utils.beamIntersectsY()` function finds the intersection between an endless
|
||||
line and a given Y-value. Returns a [Point](/reference/api/point) object for
|
||||
the intersection, or `false` there is no intersection.
|
||||
|
||||
## Signature
|
||||
|
||||
```js
|
||||
Point | false utils.beamIntersectsY(Point A, Point B, float Y)
|
||||
```
|
||||
|
||||
Finds the intersection between an endless line and a given Y-value. Returns a [Point](/reference/api/point) object
|
||||
for the intersection, or `false` there is no intersection.
|
||||
## Example
|
||||
|
||||
<Example part="utils_beamintersectsy">
|
||||
A Utils.beamIntersectsY() example
|
||||
<Example caption="A Utils.beamIntersectsY() example">
|
||||
```js
|
||||
({ Point, points, Path, paths, Snippet, snippets, utils, part }) => {
|
||||
|
||||
points.A = new Point(10, 10)
|
||||
points.B = new Point(50, 40)
|
||||
|
||||
paths.AB = new Path().move(points.A).line(points.B)
|
||||
|
||||
snippets.x = new Snippet(
|
||||
"notch",
|
||||
utils.beamIntersectsY(points.A, points.B, 30)
|
||||
)
|
||||
|
||||
paths.help = new Path()
|
||||
.move(new Point(0, 30))
|
||||
.line(new Point(50, 30))
|
||||
.attr("class", "note dashed")
|
||||
|
||||
return part
|
||||
}
|
||||
```
|
||||
</Example>
|
||||
|
||||
```js
|
||||
let {
|
||||
Point,
|
||||
points,
|
||||
Path,
|
||||
paths,
|
||||
Snippet,
|
||||
snippets,
|
||||
utils
|
||||
} = part.shorthand();
|
||||
|
||||
points.A = new Point(10, 10);
|
||||
points.B = new Point(50, 40);
|
||||
|
||||
paths.AB = new Path().move(points.A).line(points.B);
|
||||
|
||||
snippets.x = new Snippet("notch", utils.beamIntersectsY(points.A, points.B, 30));
|
||||
|
||||
paths.help = new Path()
|
||||
.move(new Point(0, 30))
|
||||
.line(new Point(50, 30))
|
||||
.attr("class", "note dashed");
|
||||
```
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue