VSinerva/freesewing
1
0
Fork 0
Code Activity

chore(markdown): Updated Point.shiftOutwards() docs

Browse source
This commit is contained in:
Joost De Cock 2022-09-29 16:19:29 +02:00
parent 1dd1c59c25
commit a28420f6f4
1 changed files with 28 additions and 25 deletions
Download patch file Download diff file Expand all files Collapse all files

53
markdown/dev/reference/api/point/shiftoutwards/en.md
View file

@ -2,37 +2,40 @@
title: Point.shiftOutwards()
---
Returns a new `Point` that is shifted `distance` (mm) beyond the `target` in the direction of the target point.
The `Point.shiftOutwards()` method returns a new `Point` that is shifted
`distance` (mm) beyond the `target` in the direction of the target point.
## Point.shiftOutwards() signature
## Signature
```js
Point point.shiftOutwards(Point target, float distance)
```
## Point.shiftOutwards() example
## Example
<Example part="point_shiftoutwards">
An example of the Point.shiftOutwards() method
<Example caption="An example of the Point.shiftOutwards() method">
```js
({ Point, points, Path, paths, macro, part }) => {
points.A = new Point(90, 70).setText("Point A", "text-sm right")
points.B = new Point(10, 10).setText("Point B", "text-sm")
points.C = points.A.shiftOutwards(points.B, 30)
.setText("Point C is point A shifted 3cm\nbeyond point B", "text-sm")
.attr("data-text-lineheight", 6)
paths.direction = new Path()
.move(points.A)
.line(points.C)
.addClass("note dashed")
macro("ld", {
from: points.C,
to: points.B,
d: -10
})
return part
}
```
</Example>
```js
let { Point, points, Path, paths, macro } = part.shorthand();
points.A = new Point(90, 70).attr("data-text", "Point A");
points.B = new Point(10, 10).attr("data-text", "Point B");
points.C = points.A.shiftOutwards(points.B, 30)
.attr("data-text", "Point C is point A shifted 3cm\nbeyond point B")
.attr("data-text-lineheight", 6);
paths.direction = new Path()
.move(points.A)
.line(points.C)
.attr("class", "note dashed");
macro("ld", {
from: points.C,
to: points.B,
d: -10
});
```